Issue 7622: New properties template - Light by rtjd6554 · Pull Request #7703 · gchq/sleeper

rtjd6554 · 2026-07-20T09:55:33Z

Make sure you have checked all steps below.

Issue

My PR fully resolves the following issues. I've referenced an issue in the PR title, for example "Issue 1234 - My
Feature". Note that before an issue is finished, you can still make a pull request by raising a separate issue
for your progress.
- Resolves Add light Sleeper example to documentation #7622

Tests

My PR adds the following tests based on our test strategy OR does not need testing for this extremely good reason:
- Execution of existing test suite
- Additional new tests for the new templates

Documentation

In case of new functionality, my PR adds documentation that describes how to use it, or I have linked to a
separate issue for that below.
If I have added new Java code, I have added Javadoc that explains it following our conventions and style.
If I have added or removed any dependencies from the project, I have updated the NOTICES file.

patchwork01

The outstanding comment on the storage property also needs resolving.

patchwork01 · 2026-07-29T12:52:53Z

I don't think this file is needed?

Added for completeness sake and for future possible expansion.
Cost of inclusion is miminal so effort seemed warranted here.

This shows every property, which isn't necessary. I think it seems like overkill for a "light" example. It also won't be valid, because there's no schema file.

If you want completeness, please match the basic example, including the tags and schema files.

I think it's a bit misleading to have the light example header here, when there aren't properties set. Please match the basic example. Here's a link to the original thread: #7703 (comment)

patchwork01 · 2026-07-29T12:55:20Z

+
+    @Nested
+    @DisplayName("Generate basic table properties template")
+    class GenerateBasicTablePropertiesTemplate {


There's just one table properties template. Did you mean to revert this change?

I think the template tests should probably stay together, rather than have an example in between them.

Will move next to one another

The name and display name still need reverting.

Now the name and display name have been reverted but the template tests are split apart again. Here's a link to the original thread: #7703 (comment)

…ties

patchwork01

This is all pretty minor now, though a couple of them are unresolved threads from before.

patchwork01 · 2026-07-31T10:10:08Z

I think it's a bit misleading to have the light example header here, when there aren't properties set. Please match the basic example. Here's a link to the original thread: #7703 (comment)

patchwork01 · 2026-07-31T10:11:20Z

 public class GeneratePropertiesTemplates {

+    private static final String LIGHT_MODE_EXPLANATION = "#                                                                               #\n" +
+            "#                           --- LIGHT MODE ---                                  #\n" +


I think the idea of a "mode" is a bit misleading. It's just a collection of configuration properties, not a mode you can put an instance into. I'd just leave out this line, because the files are already under a "light" directory.

patchwork01 · 2026-07-31T10:12:51Z

+        writeFile(lightTemplateDir.resolve("instance.properties"),
+                GeneratePropertiesTemplates::writeExampleLightInstanceProperties);
+        writeFile(lightTemplateDir.resolve("table.properties"),
+                GeneratePropertiesTemplates::writeExampleLightTableProperties);


I think we can just use writeExampleBasicTableProperties here, rather than duplicating it?

patchwork01 · 2026-07-31T10:14:35Z

@@ -0,0 +1,108 @@
+#################################################################################
+#                           SLEEPER INSTANCE PROPERTIES                         #
+#################################################################################


I think this part of the header seems a bit unnecessary. We don't have a header like this in any of the other examples. I'd rather avoid matching how it's done in the templates, which we're going to delete.

patchwork01 · 2026-07-31T10:17:00Z

+
+    @Nested
+    @DisplayName("Generate basic table properties template")
+    class GenerateBasicTablePropertiesTemplate {


Now the name and display name have been reverted but the template tests are split apart again. Here's a link to the original thread: #7703 (comment)

rtjd6554 added 3 commits July 20, 2026 09:45

7622: Initial creation of new light properties template

704db43

7622: Refactor method usage

f0321b0

7622: Refinement of properties set

ddc1ed3

rtjd6554 force-pushed the 7622-Light-Sleeper-Example branch from 324018f to ddc1ed3 Compare July 24, 2026 10:57

7622: Update testing

fa69f8a

rtjd6554 changed the title ~~Issue 7622: Initial creation of new light properties template~~ Issue 7622: New properties template - Light Jul 24, 2026

Merge branch 'develop' into 7622-Light-Sleeper-Example

86f2332

rtjd6554 marked this pull request as ready for review July 24, 2026 11:40

rtjd6554 added the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 24, 2026

Rob9786 approved these changes Jul 28, 2026

View reviewed changes

patchwork01 requested changes Jul 29, 2026

View reviewed changes

Comment thread .../clients/src/main/java/sleeper/clients/deploy/documentation/GeneratePropertiesTemplates.java

Comment thread .../clients/src/main/java/sleeper/clients/deploy/documentation/GeneratePropertiesTemplates.java Outdated

patchwork01 assigned rtjd6554 Jul 29, 2026

patchwork01 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 29, 2026

patchwork01 reviewed Jul 29, 2026

View reviewed changes

Comment thread example/light/instance.properties

rtjd6554 and others added 4 commits July 29, 2026 10:14

Merge branch 'develop' into 7622-Light-Sleeper-Example

3c25eca

7622: Update location and properties set

42c349f

7622: Additional instance property

3e01890

7622: Update testing locations

f0fb3b9

patchwork01 reviewed Jul 29, 2026

View reviewed changes

rtjd6554 and others added 3 commits July 29, 2026 14:39

7622: Refactor to show only set properties as part of instance.proper…

db95ab2

…ties

7622: Update to EKS variables

7e69045

Merge branch 'develop' into 7622-Light-Sleeper-Example

961ac6c

rtjd6554 removed their assignment Jul 29, 2026

rtjd6554 added the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 29, 2026

patchwork01 reviewed Jul 30, 2026

View reviewed changes

Comment thread example/light/instance.properties Outdated

patchwork01 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 30, 2026

patchwork01 assigned rtjd6554 Jul 30, 2026

rtjd6554 and others added 3 commits July 30, 2026 12:57

Merge branch 'develop' into 7622-Light-Sleeper-Example

4f7d268

7622: Update methods names

0ca88a0

7622: Update optional stacks with default values

7068c1b

rtjd6554 added 4 commits July 30, 2026 12:31

7622: Correcting optional stacks

d4cfb2d

7622: Additional reference files

60fb7b0

7622: Update table.properties to basic level

c251a8e

7622: Additional explanation comment

f34d959

rtjd6554 removed their assignment Jul 31, 2026

rtjd6554 added the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 31, 2026

patchwork01 reviewed Jul 31, 2026

View reviewed changes

patchwork01 assigned rtjd6554 Jul 31, 2026

patchwork01 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 31, 2026

rtjd6554 and others added 4 commits July 31, 2026 14:23

7622: Update property templates

d867adc

7622: Re-ordered tests and correct typo

e17db8b

7622: Remove method no longer required

ebffff5

Merge branch 'develop' into 7622-Light-Sleeper-Example

235d786

rtjd6554 removed their assignment Aug 3, 2026

rtjd6554 added the needs-reviewer Pull requests that need a reviewer to be assigned label Aug 3, 2026

Uh oh!

Conversation

rtjd6554 commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Tests

Documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patchwork01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patchwork01 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rtjd6554 commented Jul 20, 2026 •

edited

Loading