r/aws_sfn_state_machine: validate step-function definition at plan step #39229
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
github-actions
bot
added
tests
Community NoteVoting for Prioritization
For Submitters
|
github-actions
bot
added
the
needs-triage
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome @kevineor 👋
It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.
Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.
Thanks again, and welcome to the community! 😃
ewbankkit
added
enhancement
github-actions
bot
added
the
prioritized
ewbankkit
approved these changes
Sep 11, 2024
There was a problem hiding this comment.
LGTM 🚀.
% make testacc TESTARGS='-run=TestAccSFNStateMachine_' PKG=sfn ACCTEST_PARALLELISM=3
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/sfn/... -v -count 1 -parallel 3 -run=TestAccSFNStateMachine_ -timeout 360m
=== RUN TestAccSFNStateMachine_createUpdate
=== PAUSE TestAccSFNStateMachine_createUpdate
=== RUN TestAccSFNStateMachine_expressUpdate
=== PAUSE TestAccSFNStateMachine_expressUpdate
=== RUN TestAccSFNStateMachine_standardUpdate
=== PAUSE TestAccSFNStateMachine_standardUpdate
=== RUN TestAccSFNStateMachine_nameGenerated
=== PAUSE TestAccSFNStateMachine_nameGenerated
=== RUN TestAccSFNStateMachine_namePrefix
=== PAUSE TestAccSFNStateMachine_namePrefix
=== RUN TestAccSFNStateMachine_publish
=== PAUSE TestAccSFNStateMachine_publish
=== RUN TestAccSFNStateMachine_tags
=== PAUSE TestAccSFNStateMachine_tags
=== RUN TestAccSFNStateMachine_tracing
=== PAUSE TestAccSFNStateMachine_tracing
=== RUN TestAccSFNStateMachine_disappears
=== PAUSE TestAccSFNStateMachine_disappears
=== RUN TestAccSFNStateMachine_expressLogging
=== PAUSE TestAccSFNStateMachine_expressLogging
=== RUN TestAccSFNStateMachine_encryptionConfigurationCustomerManagedKMSKey
--- PASS: TestAccSFNStateMachine_encryptionConfigurationCustomerManagedKMSKey (125.52s)
=== RUN TestAccSFNStateMachine_encryptionConfigurationServiceOwnedKey
--- PASS: TestAccSFNStateMachine_encryptionConfigurationServiceOwnedKey (79.54s)
=== RUN TestAccSFNStateMachine_definitionValidation
=== PAUSE TestAccSFNStateMachine_definitionValidation
=== CONT TestAccSFNStateMachine_createUpdate
=== CONT TestAccSFNStateMachine_disappears
=== CONT TestAccSFNStateMachine_definitionValidation
--- PASS: TestAccSFNStateMachine_definitionValidation (27.25s)
=== CONT TestAccSFNStateMachine_expressLogging
--- PASS: TestAccSFNStateMachine_disappears (82.22s)
=== CONT TestAccSFNStateMachine_namePrefix
--- PASS: TestAccSFNStateMachine_createUpdate (117.24s)
=== CONT TestAccSFNStateMachine_tracing
--- PASS: TestAccSFNStateMachine_expressLogging (92.08s)
=== CONT TestAccSFNStateMachine_tags
--- PASS: TestAccSFNStateMachine_namePrefix (84.27s)
=== CONT TestAccSFNStateMachine_publish
--- PASS: TestAccSFNStateMachine_tracing (94.38s)
=== CONT TestAccSFNStateMachine_standardUpdate
--- PASS: TestAccSFNStateMachine_tags (98.51s)
=== CONT TestAccSFNStateMachine_nameGenerated
--- PASS: TestAccSFNStateMachine_publish (94.23s)
=== CONT TestAccSFNStateMachine_expressUpdate
--- PASS: TestAccSFNStateMachine_nameGenerated (63.98s)
--- PASS: TestAccSFNStateMachine_standardUpdate (92.44s)
--- PASS: TestAccSFNStateMachine_expressUpdate (102.08s)
PASS
ok github.com/hashicorp/terraform-provider-aws/internal/service/sfn 572.803s
|
@kevineor Thanks for the contribution 🎉 👏. |
|
This functionality has been released in v5.67.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
github-actions
bot
removed
the
prioritized
|
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 issues. |
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.
Description
This PR adds a validation in the plan step for
aws_sfn_state_machineressource.This validation uses the newly aws provided API
ValidateStateMachineDefinitionto validate the state machine definition.The validation takes place in the
CustomizeDifffunction and will fail theterraform planand output the list of errors or warnings returned by the API.However it does not cover the case where only
WARNINGare returned by the API, as it is not considered as an error.As a result it won't fail or log any warnings.
Improvements to discuss
We could add the possibility to log the warnings returned by the API, but it would require to migrate the ressource to the terraform-plugin-framework.
We would migrate this validation to the
ModifyPlanstep and logging all warnings and errors toresource.ModifyPlanResponse.Let me know if a such improvement is required.
Relations
Closes #39150
References
https://aws.amazon.com/about-aws/whats-new/2024/08/validation-api-step-functions/?nc1=h_ls
https://docs.aws.amazon.com/step-functions/latest/apireference/API_ValidateStateMachineDefinition.html
Output from Acceptance Testing