Add terraform-plugin-testing documentation for query mode and query checks
#1451
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
…ation to refer to new testing mode
12 tasks
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerNo broken links found! 🎉 |
SBGoods
approved these changes
Dec 8, 2025
| "path": "acceptance-tests/query-checks" | ||
| }, | ||
| { | ||
| "title": "Query Result Query Checks", |
Contributor
There was a problem hiding this comment.
I think having "Query" here twice is a little wordy and we can just shorten it to "Query Result Checks"
Suggested change
| "title": "Query Result Query Checks", | |
| "title": "Query Result Checks", |
| @@ -0,0 +1,95 @@ | |||
| --- | |||
| page_title: 'Plugin Development - Acceptance Testing: Query Checks' | |||
Contributor
There was a problem hiding this comment.
Suggested change
| page_title: 'Plugin Development - Acceptance Testing: Query Checks' | |
| page_title: 'Plugin Development - Acceptance Testing: Custom Query Checks' |
| --- | ||
|
|
||
| # Query Checks | ||
| During the **Query** [mode](/terraform/plugin/testing/acceptance-tests/teststep#test-modes) of a `TestStep`, the configuration supplied is used as the contents of a `.tfquery.hcl` query file and the testing framework will run `terraform query`. |
Contributor
There was a problem hiding this comment.
Suggested change
| During the **Query** [mode](/terraform/plugin/testing/acceptance-tests/teststep#test-modes) of a `TestStep`, the configuration supplied is used as the contents of a `.tfquery.hcl` query file and the testing framework will run `terraform query`. | |
| During the **Query** [mode](/terraform/plugin/testing/acceptance-tests/teststep#test-modes) of a `TestStep`, the configuration supplied is used as the content of a `.tfquery.hcl` query file and the testing framework will run `terraform query`. |
| provides built-in Query Checks for common use-cases. | ||
| --- | ||
|
|
||
| # Query Result Query Checks |
Contributor
There was a problem hiding this comment.
Suggested change
| # Query Result Query Checks | |
| # Query Result Checks |
| @@ -0,0 +1,338 @@ | |||
| --- | |||
| page_title: 'Plugin Development - Acceptance Testing: Query Checks' | |||
Contributor
There was a problem hiding this comment.
Suggested change
| page_title: 'Plugin Development - Acceptance Testing: Query Checks' | |
| page_title: 'Plugin Development - Acceptance Testing: Query Result Checks' |
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.
What
This PR adds documentation for the newly introduced query testing mode as well as the accompanying query checks
What was added:
query-checkscontainingTestStepssubsection forquery modeWhat changed:
TestStepspage was updated to include mentions and references to the new query modeWhy
Terraform introduced a new language construct which users will likely want to know how to test.
Screenshots
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
content/terraform-docs-common/redirects.jsoncfor moved, renamed, or deleted pages across all affected versions. Refer to Redirects for examples and guidance.Reviews