docs: improve test suite documentation - #2
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 dev-docker test suite, following the standard used in the completed Studio, API Gateway and Workbench campaigns.
tests/test_dev_docker.py(the repo's only Python test file) keeps its module docstring and gains theDeveloper:attribution blocktest_*methods now have assertion-specific docstrings (117/117; previously 0/117)Test*classes were already documented; those docstrings are preserved_exposed_ports,_mod)Only docstrings changed: 1 file, +164 / -0. No Dockerfile,
run_ai_dev.sh, requirements, CI or config changes.Verification
a87b5d0: executable AST differences = 0git diff --checkcleanTestRunScript+TestBranchCoverage) 36 passed before and afterrun_ai_dev.shas text, or patches module helpers with mocks, so no Docker daemon, network or services were involvedDocumentation notes
Several tests assert less than their names suggest. The docstrings describe what is actually checked; the tests are unchanged:
test_gatk_in_path/test_snpeff_in_pathonly check the tool name appears in the Dockerfile, not PATH membershiptest_base_image_has_cuda_tagonly checks forpy3in the tagtest_pip_upgraded_before_install/test_pull_before_builddo not assert orderingtest_apt_update_without_install_failure_branchactually feeds an install-without-update stubPossible follow-up (not addressed here)
test_requirements_dgx_documents_local_installsassertsassertIn("DGX", content or "dgx" in content.lower()). Becausecontentis a non-empty string, theorshort-circuits and the check is effectively a case-sensitive"DGX" in content; the lowercase fallback never runs. Likely unintended, but out of scope for a documentation-only change.🤖 Generated with Claude Code