docs: cover binding tests for expensive commands#10757
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the testing strategy documentation to outline a strategy for testing expensive commands. It recommends validating arguments in C++ and separating the configuration/marshalling step from the execution step so that binding tests can spy on the execution without running the expensive algorithm. The review feedback focuses on improving the documentation's accuracy and consistency, specifically by standardizing the spelling of 'marshaling', correcting Python terminology (using 'function' instead of 'proc'), and clarifying how Python tests can mock or reassign functions similarly to Tcl's 'rename' command.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b57dd5bf87
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Add a 'Binding tests for expensive commands' section to docs/agents/testing-strategy.md: prefer validating arguments in C++ (via utl::Validator) so checks cover Tcl/Python/C++ uniformly, and prove the Tcl/Python->C++ translation by spying the thin execute free function instead of running the engine. Notes the three binding shapes and that pre-execute guards require a minimal DB for spy tests. Signed-off-by: Matt Liberty <mliberty@precisioninno.com>
db2ce18 to
713b984
Compare
daa0fbe
into
The-OpenROAD-Project:master
Extends
docs/agents/testing-strategy.mdto cover the case the Tier-2 recipe doesn't: commands whose execution is expensive (global_route,global_placement,clock_tree_synthesis,detailed_route), where "run it once on a trivial design" is the wrong cost trade-off..tclcheck only guards the Tcl path, while a check behind the C++ entry point (viautl::Validator) covers Tcl, Python, and direct C++ callers from one place.renamethe thin execute free function to a spy so argument handling runs but the algorithm doesn't.detailed_route_cmdcalled out as the fused outlier worth refactoring.