Skip to content

Issue 6039: Generate system test suite documentation - #7680

Merged
patchwork01 merged 1 commit into
gchq:developfrom
TheOnlyOrchid:generate-system-test-suite-docs
Jul 16, 2026
Merged

Issue 6039: Generate system test suite documentation#7680
patchwork01 merged 1 commit into
gchq:developfrom
TheOnlyOrchid:generate-system-test-suite-docs

Conversation

@TheOnlyOrchid

@TheOnlyOrchid TheOnlyOrchid commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Issue

Tests

  • I added a unit test for SystemTestSuiteTable, verifying standard functionality.

  • I added an integration test for GenerateSystemTestSuiteDocumentation

Changes

Documentation

  • I changed the documentation in docs/development/dev-scripts.md and docs/development/system-tests.md to accurately reflect the new state of the repo with my changes applied.

  • SystemTestSuiteTable.java has a class-level comment as per repo style. SystemTestSuitable.create has a Javadoc.

  • GenerateSystemTestSuiteDocumentation.java has a class-level comment as per repo style. Added a Javadoc to both methods I thought needed a Javadoc.

Notes

  • I chose to keep the styling consistent with the old format by removing empty cells, however in my experience it is cleaner and easier to parse when you have explicitly empty cells. I am open to implementing this is preferred.

  • I added a note to dev-scripts.md to clarify that generateDocumentation.sh touches docker image documentation. I do recognise that this could be out of the scope of this PR, and I am happy to disregard the change, open a new PR or follow any procedure needed. I also added docs/deployment/docker-images.md to the workflow trigger list (located in java-status.yaml).

  • I noticed what could potentially be a bug - in the workflow trigger list (located in java-status.yaml) there is an entry referencing a root level directory "examples", which seems to not exist, however a directory called "example" does exist.

  • I implemented an atomic write using a temporary file, however I do not know if it was too convoluted for this repo. I felt that the safety and predictability it gave was worth it in a repo that prioritises such values, however I am open to making it a standard file write.

@TheOnlyOrchid TheOnlyOrchid changed the title Generate system test suite documentation Issue 6039: Generate system test suite documentation Jul 15, 2026
@patchwork01 patchwork01 added the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 16, 2026
@patchwork01

Copy link
Copy Markdown
Collaborator

Thanks very much for this! Waiting on a second review.

@Rob9786 Rob9786 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Jul 16, 2026
@patchwork01
patchwork01 merged commit a6632f8 into gchq:develop Jul 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate documenting slow and expensive system tests by suite

4 participants