acceptance: document LOG.* files, gron.py over jq, --keep gotcha, and EnvMatrix scoping#5422
Open
pietern wants to merge 1 commit into
Open
acceptance: document LOG.* files, gron.py over jq, --keep gotcha, and EnvMatrix scoping#5422pietern wants to merge 1 commit into
pietern wants to merge 1 commit into
Conversation
… EnvMatrix scoping Four idioms surfaced in PR #5414 review that weren't captured in the acceptance-test guide: - Limit `EnvMatrix.DATABRICKS_BUNDLE_ENGINE` when the test inspects engine-specific state shape (resources.json vs terraform.tfstate). - Prefer `gron.py | grep <field>` over inline `jq` for single-value lookups — the gron output line includes the JSON path, so the test log is self-explanatory. - Don't pass `--keep` to print_requests.py if a later call follows; the second call re-reads the buffer and double-prints. - Use `LOG.<name>` for cleanup-noise stderr that should show up only under `go test -v` (not dropped with `2>/dev/null`). Each rule has a GOOD / BAD example and points at existing tests that already follow the pattern. Co-authored-by: Isaac
Contributor
Waiting for approvalBased on git history, these people are best suited to review:
Eligible reviewers: Suggestions based on git history. See OWNERS for ownership rules. |
Collaborator
|
Commit: bc8fb15 |
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
2 participants
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
Four acceptance-test idioms surfaced in #5414 review that aren't captured in
.agent/rules/testing.md:EnvMatrix.DATABRICKS_BUNDLE_ENGINEwhen the test inspects engine-specific state shape (resources.jsonvsterraform.tfstate). Cross-engine contract checks stay in a sibling test.gron.py | grep <field>over inlinejqfor single-value lookups — the gron output line includes the JSON path, so the test log is self-descriptive.--keeptoprint_requests.pyif a later call follows; the second call re-reads the buffer and double-prints earlier requests.LOG.<name>for cleanup-noise stderr that should show up only undergo test -v. Visible to humans debugging, but not part of the diffed output (so no spurious failures), unlike2>/dev/nullwhich drops the signal entirely.Each rule has a GOOD / BAD example and points at existing tests that already follow the pattern.
This pull request and its description were written by Isaac.