query: refactor query test step logic into testStepNewQuery()
#568
+203
−32
Conversation
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
SBGoods
changed the title
RunQueryChecks()RunQueryChecks()
austinvalle
reviewed
Oct 28, 2025
SBGoods
changed the title
RunQueryChecks()testStepNewQuery()
austinvalle
approved these changes
Oct 29, 2025
| } | ||
| } | ||
| `, | ||
| ExpectError: regexp.MustCompile(`Diagnostic summary`), |
There was a problem hiding this comment.
Something worth noting that might not be an immediate problem, but more of a potential future confusion for folks familiar with
ExpectError
Since Query is using the machine readable output, the error message it is running the regex on with that mode is the formatted %+v of the diagnostics, which is different then other modes that use the formatted Terraform CLI output of the diagnostics. That can make the output hard to read / different to match than the other modes:
--- FAIL: TestQuery_ExpectError_ValidationError (0.49s)
/Users/austin.valle/code/terraform-plugin-testing/helper/resource/query/query_test.go:111: Step 2/2 error running query, expected an error with pattern (Not the correct diagnostic summary), no match on: running terraform query command returned diagnostics: [{baseLogMessage:{Lvl:error Msg:Error: Diagnostic summary Time:2025-10-29 09:10:02.151561 -0400 EDT} Diagnostic:{Severity:error Summary:Diagnostic summary Detail:Diagnostic details Range:0x140004547c0 Snippet:0x14000030640}} {baseLogMessage:{Lvl:error Msg:Error: Diagnostic summary Time:2025-10-29 09:10:02.151735 -0400 EDT} Diagnostic:{Severity:error Summary:Diagnostic summary Detail:Diagnostic details Range:0x14000454900 Snippet:0x14000030690}}]There was a problem hiding this comment.
Yeah, that's a good point. Maybe we should introduce a string formatter for machine readable error messaging in a follow-up PR.
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.
Related Issue
Relates: #561
Description
Refactors query test step logic into
testStepNewQuery()allowing query errors to be used withExpectError.Rollback Plan
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
N/A