docs: improve test suite documentation - #96
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only pass over the Studio Python test suite, following the standard used in the completed API Gateway / Workbench campaigns.
Developer:attribution block (30/30)Test*classes are documented (70/70)test_*functions have assertion-specific docstrings (394/394)Only docstrings changed: 30 test files, +794 / -6. No production code, compose files, Redis/ACL config, or dependencies touched.
Verification
b7dd2a3: executable AST differences = 0 across all 30 filesgit diff --checkclean--collect-onlyidentical before/after (463 ids for the whole suite)Excluded from execution (documented only):
tests/integration/(needs the live stack, creates users) anddocker-socket-proxy/tests/test_proxy_live_integration.py(drives the host Docker daemon).Docstring corrections
test_redis_aof_config_is_identical_across_all_profilescited a test that does not exist and described two files when it compares three profiles; it now states its actual contract. Two recovery-drill docstrings were reworded to say they check script text rather than runtime behavior.Known issues, not addressed here (need separate disposition)
tests/test_compose_network_exposure.py::test_redis_aof_config_is_identical_across_all_profilesfails onmain(b7dd2a3):docker-compose.ymlruns redis with--aclfile /data/users.acl, butdocker-compose.release.ymlanddocker-compose-release.ymldo not. Either the test is stale or the release profiles have a Redis ACL configuration gap. This PR does not change that behavior.test_proxy_live_integration.pyis described as opt-in, but it only skips when no docker CLI/socket exists, so a plainpyteston a Docker host will run realdocker run/exec/rm -f.🤖 Generated with Claude Code