docs: improve test suite documentation - #86
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 Control Center backend test suite, following the standard used in the completed Studio, API Gateway and Workbench campaigns.
Developer:attribution block (86/86)test_*methods, aTestCasebase, or aTest*name; 225/225 by the strictTest*prefix)test_*functions have assertion-specific docstrings (1,707/1,707, including 115/115 async)Only docstrings changed: 86 files, all under
backend/tests/, +4,003 / -47. No production code, config, compose, or dependency changes.Verification
0504838: executable AST differences = 0 across all 86 filesgit diff --checkclean; no secret-like patterns in added lines-o addopts="", i.e. without the coverage gate), baseline taken from a clean export of0504838:backend/tests: 1,744 passed + 51 subtests before, identical afterDocstring corrections
TestGetIntegrations: replaced "its guarantee to never leak a secret value" with a bounded statement; the test only checks that secret values set in the environment do not appear in the response bodytest_routes_infra.py: two tests (/licenseand/audit-trail) shared identical docstrings; each now names its routetest_route_requires_manage_infra_permissiononly asserts that arequire_permissiondependency exists, andtest_empty_string_returns_zerofeeds"0B")Notes for review
def test_x(self): ...methods intest_main.pywere split across lines to hold a docstring. AST-identical, but the diff there is not purely additive (the only non-docstring line changes in the PR).test_routes_*_proxy.pyfiles (e.g. "A 403 from the upstream auth-service is relayed as a 403." on 25 tests). Each sits in a class whose docstring names the exact route, so they are left as is. Happy to make every docstring self-contained in a follow-up if preferred.certified/CERTIFIED; that is the value of acertification_statusfield the tests assert on, not a compliance claim.--cov-fail-under=98; I did not run the suite with coverage, so that gate is not covered by the numbers above.🤖 Generated with Claude Code