helper/resource: Clarify configuration step error messages #238
Conversation
This file contains 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
When using `TestStep.PlanOnly`, the error messaging errantly mentions: ``` After applying this test step, the plan was not empty. ``` Which is inaccurate and confusing for debugging. This also adjusts error messages to include refresh vs non-refresh wording. The error messages have no compatibility promises and it would be considered an errant provider developer implementation to rely on them, rather than properly fixing the test assertions (such as using `TestStep.ExpectNonEmptyPlan` instead of `TestCase.ErrorCheck` or `TestStep.ExpectError` with the error messaging without compatibility promises).
bendbennett
approved these changes
Dec 6, 2023
There was a problem hiding this comment.
LGTM 🚀
Wondering whether we might want to consider modifying the documentation to illustrate which specific terraform commands are being run when config, import, or refresh modes are being used?
6 tasks
|
Looks like you already created #240 so we can discuss that proposal over there. |
bflad
added a commit
that referenced
this pull request
Dec 7, 2023
…tError Reference: #238 This is a quick followup recent clarification changes in error messages to better mention intended use and message compatibility with `TestCase.ErrorCheck` and `TestStep.ExpectError`.
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
When using
TestStep.PlanOnly, the error messaging errantly mentions:Which is inaccurate and confusing for debugging. This also adjusts error messages to include refresh vs non-refresh wording consistently. The error messages have no compatibility promises and it would be considered an errant provider developer implementation to rely on them, rather than properly fixing the test assertions (such as using
TestStep.ExpectNonEmptyPlaninstead ofTestCase.ErrorCheckorTestStep.ExpectErroragainst the error messaging without compatibility promises).