(TF-18290) Early validation for Terraform Stack files #1776
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
jpogran
changed the title
jpogran
force-pushed
the
stack_early_validation
branch
from
98798d7 to
1ebed82
Compare
jpogran
force-pushed
the
stack_early_validation
branch
2 times, most recently
from
059eef6 to
7d4b95d
Compare
ansgarm
approved these changes
Jul 25, 2024
internal/features/stacks/decoder/validations/missing_required_attribute.go
Outdated
Show resolved
Hide resolved
jpogran
force-pushed
the
stack_early_validation
branch
from
7d4b95d to
c053e17
Compare
dbanck
reviewed
Jul 31, 2024
internal/features/stacks/decoder/validations/missing_required_attribute.go
Show resolved
Hide resolved
ansgarm
reviewed
Aug 5, 2024
internal/features/stacks/decoder/validations/missing_required_attribute.go
Show resolved
Hide resolved
jpogran
force-pushed
the
stack_early_validation
branch
from
fa30c00 to
625c109
Compare
This change enables early validation for Terraform Stacks in tfstack. hcl and tfdeploy.hcl files. Available validations: - Missing required attributes - Deprecated attributes - Deprecated blocks - Unexpected attributes - Unexpected blocks - Maximum number of blocks - Minimum number of blocks - Block labels length This adds a new job to validate the schema of the these files. The job is enqueued when the `EnableEnhancedValidation` option is set to true.
TODO: Revist checking Stack concepts in the static validators Other validators are more generic and can be applied to any block/attribute/etc, but this one is specific to the stack block types. I'm sure this could be done in a more generic way, but I'm not sure if it's worth it at the moment. The names of these blocks are used as identifiers in the stack and are used in the UI, so they have to be valid Terraform identifiers or else the stack will not be able to be created. This is a very basic check to ensure that the names are valid until we can do more advanced checks or use the cloud api. I tried adding this to the earlydecoder, but we do not seem to report the diagnostics there at all currently, so nothing was being reported. I'm not sure if that's a bug or intended.
jpogran
force-pushed
the
stack_early_validation
branch
from
625c109 to
d438014
Compare
|
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.
This change enables early validation for Terraform Stacks in tfstack. hcl and tfdeploy.hcl files.
Available validations:
This adds a new job to validate the schema of the these files. The job is enqueued when the
EnableEnhancedValidationoption is set to true.