Adding tests and rule description #28
Closed
+10,697
−2
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
Adding a suite of tests, based upon and extending the current examples. This reduces the risk of unintended breaking changes. It also makes developing changes eaiser. Run tests with \`terraform test\`. Tests are found in the \`tests/\` directory. They have the same name as the example files for the behaviour they are testing. In addition, there are WebAcl and WebAclAssociation files that test behaviour not covered in those examples.
Attempted to define a full type for the rule object. After 800 lines of type definition, it became clear that this would need to become around six times longer to work. Terraform can't reliably handle `any` types for elements within a list of typed objects. Adding a pseudo type in the description field instead. As this variable is marked as optional in its description, also giving it a default value.
benpriestman
force-pushed
the
adding-tests-and-rule-description
branch
from
7b4d484 to
a685177
Compare
Contributor
Author
|
Abandoning for now. Might be a useful reference for anyone wanting to do something similar, if - like us - they are wrapping this module in their own one. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 working with this module, I've found it very useful to add tests for different use-cases.
I'd hoped to be able to construct a type for the rule input but I've found this impracticable.
Presumably, this is why the underlying provider hasn't taken this route.
I have added more detail to the input's description.
I've also provided a default value, as the input's description claims its optional.
I tried adding
terraform testto the pre-commit hooks.However, we'd need antonbabenko/pre-commit-terraform#549 to support that with the current config.