-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CFn: add schema validation for resource providers #10795
Draft
simonrw
wants to merge
2
commits into
master
Choose a base branch
from
cfn/schema-validation
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
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
simonrw
added
aws:cloudformation
AWS CloudFormation
semver: patch
Non-breaking changes which can be included in patch releases
labels
May 8, 2024
simonrw
force-pushed
the
cfn/schema-validation
branch
2 times, most recently
from
May 11, 2024 20:11
26ad7e6
to
80b2c45
Compare
simonrw
requested review from
dominikschubert,
pinzon and
Morijarti
as code owners
May 13, 2024 08:24
simonrw
force-pushed
the
cfn/schema-validation
branch
from
May 13, 2024 08:25
80b2c45
to
e47046c
Compare
pinzon
approved these changes
May 13, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome!
simonrw
commented
May 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Notes from review pairing with @dominikschubert and @Morijarti :
- validation of
required
fields should be done before resource provider execution as this represents input values supplied by the user - we could validate no extra properties are assigned by the resource provider on
SUCCESS
- notes for the future:
- we could typecheck the fields, possibly depending on how we want to handle implicit typecasting
simonrw
force-pushed
the
cfn/schema-validation
branch
from
May 24, 2024 15:04
e47046c
to
557ec1b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
aws:cloudformation
AWS CloudFormation
semver: patch
Non-breaking changes which can be included in patch releases
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.
Motivation
We use the CloudFormation resource provider schema to generate our scaffolded resources, but we don't make any assertions that what is returned by a resource provider conforms to the schema. Now that we have migrated all resources to the new resource provider API we should be stricter about the responses coming back from the resource providers. This will help us ensure parity with AWS CFn.
Changes
ResourceProviderExecutor
PhysicalResourceId
is validated implicitly with the call toextract_physical_resource_id_from_model_with_schema
, which raises an exception (inresolve_json_pointer
) if the value is not presentTesting
The green CI pipeline run shows that all community resource providers already conform to the schema (:tada:). To check that the validation works, pick a resource provider and comment out setting one of the
required
fields.