docs: improve test suite documentation - #7
Merged
Merged
Conversation
Add module docstrings, per-test docstrings and developer attribution across tests/, documenting the precise behavior or security invariant each test exercises. Documentation only: no executable test semantics changed (verified via AST comparison against the pre-change baseline for every modified file). 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
Developer: Manish Kumar <manish@omnibioai.org>attribution to all 14 test modules undertests/.test_*functions (98 were undocumented), each stating the specific behavior or security invariant the test asserts. Documents the fixtures. Existing docstrings are preserved verbatim.Verification
git diff --checkis clean and only files undertests/changed.Notes for reviewers
omnibioai-hpc-policy-engine, this repo ships Cython-compiled.sofiles next to their.pysources; Redis is mocked throughout the test suite, so all runs used a network-blocking pytest plugin as an extra check — 0 blocked connection attempts.xfail(strict=True)and are documented as such rather than as passing behavior:test_unknown_action_should_fail_closedandtest_wildcard_action_should_not_bypass_authorizationtrack known fail-open gaps in the production policy engine.tests/test_role_hierarchy_fixtures.pymaps a conceptual Platform Owner → Org Admin → Scientist → Viewer hierarchy onto this engine's real role/permission vocabulary; that framing is preserved in the docstrings since it's load-bearing context from the module's own docstring, not decoration.🤖 Generated with Claude Code