gchq / gchq/sleeper

Prevent accidentally running scripts with a mismatched Sleeper version

Open
#8,182 0 comments 0 reactions 0 assignees View on GitHub
clients-module enhancement
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

### User Story

As a user of Sleeper, I want scripts to fail if I run them against an instance of a different version, so that I won't see unexpected behaviour.

### Description / Background

We'd like to ensure that if a user runs scripts to interact with an instance of Sleeper, they will refuse to act if the version of Sleeper is incompatible.

### Technical Notes / Implementation Details

We can introduce a factory method in S3InstanceProperties that also compares the version in InstanceProperties with the version in SleeperVersion. If it doesn't match it should throw an exception with a useful message.

Everywhere one of our scripts loads the instance properties it should use that method.

Contributor guide

Open the contributing guide

Research direction

Start by reading S3InstanceProperties, InstanceProperties, and SleeperVersion, then find the scripts that load instance properties. Trace how those scripts obtain the properties and identify the existing version representation and exception patterns. Done means every script uses the new factory method and rejects a mismatched Sleeper version with a useful exception.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.