docs: add C++-first testing strategy guide#10731
Open
maliberty wants to merge 2 commits into
Open
Conversation
Add docs/agents/testing-strategy.md describing the target test pyramid (C++ unit tests as default, thin Tcl/Python binding smoke tests, a small curated set of full-flow golden tests), how to handle DB/STA dependencies via the existing tst::Fixture / SimpleDbFixture / IntegratedFixture stack, and a decision tree for placing a new test. Include a runbook for incrementally retiring golden tests: the C++ test and the removal of the Tcl/Python test it replaces land in the same change, gated on coverage equivalence, with a step to preserve residual binding coverage (a command is often also exercised by a broader binding test like test_inst.py). Link the guide from testing.md. Signed-off-by: Matt Liberty <mliberty@precisioninno.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a new testing strategy document (testing-strategy.md) outlining a C++-first test pyramid, dependency management, and a runbook for retiring legacy golden tests, while also updating testing.md to link to it. The review feedback suggests clarifying whether the mentioned command linter is an existing or planned tool, and correcting the referenced test registration file paths to module-specific directories to avoid developer confusion.
Address PR review feedback: mark the binding-coverage linter as a not-yet-implemented future tool, and reference the module-specific src/<module>/test/ paths for CMake/Bazel registration. Signed-off-by: Matt Liberty <mliberty@precisioninno.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.
Add docs/agents/testing-strategy.md describing the target test pyramid (C++ unit tests as default, thin Tcl/Python binding smoke tests, a small curated set of full-flow golden tests), how to handle DB/STA dependencies via the existing tst::Fixture / SimpleDbFixture / IntegratedFixture stack, and a decision tree for placing a new test.
Include a runbook for incrementally retiring golden tests: the C++ test and the removal of the Tcl/Python test it replaces land in the same change, gated on coverage equivalence, with a step to preserve residual binding coverage (a command is often also exercised by a broader binding test like test_inst.py). Link the guide from testing.md.