chore(cfnspec): improve error meesaging when spec validation fails#16991
Merged
mergify[bot] merged 1 commit intomasterfrom Oct 15, 2021
Merged
chore(cfnspec): improve error meesaging when spec validation fails#16991mergify[bot] merged 1 commit intomasterfrom
mergify[bot] merged 1 commit intomasterfrom
Conversation
Print the node of the CFN spec where validation fails, so the erroneous
part of the spec can be located.
Currently, when a Property in a PropertyType has two "Type" fields
specified, the message looks like below. Only the resource type being
validated is printed.
```
FAIL test/filtered-specification.test.js (8.522 s)
filteredSpecification("AWS::Synthetics::Canary")
expect(received).toEqual(expected)
- Expected - 1
+ Received + 3
- Array []
+ Array [
+ "Type",
+ ]
```
With this change, the message will look like -
```
FAIL test/filtered-specification.test.js (8.522 s)
filteredSpecification("AWS::Synthetics::Canary") › PropertyType AWS::Synthetics::Canary.ArtifactConfig › Property S3Encryption
expect(received).toEqual(expected)
- Expected - 1
+ Received + 3
- Array []
+ Array [
+ "Type",
+ ]
```
|
|
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
rix0rrr
approved these changes
Oct 15, 2021
Contributor
rix0rrr
left a comment
There was a problem hiding this comment.
Oh I see what you did, added describes to show where the error is cropping up.
That's a good start. I would say that the "empty array expected, found Type" is still quite cryptic, but I suppose it's a start.
Contributor
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
…ws#16991) Print the node of the CFN spec where validation fails, so the erroneous part of the spec can be located. Currently, when a Property in a PropertyType has two "Type" fields specified, the message looks like below. Only the resource type being validated is printed. ``` FAIL test/filtered-specification.test.js (8.522 s) filteredSpecification("AWS::Synthetics::Canary") expect(received).toEqual(expected) - Expected - 1 + Received + 3 - Array [] + Array [ + "Type", + ] ``` With this change, the message will look like - ``` FAIL test/filtered-specification.test.js (8.522 s) filteredSpecification("AWS::Synthetics::Canary") › PropertyType AWS::Synthetics::Canary.ArtifactConfig › Property S3Encryption expect(received).toEqual(expected) - Expected - 1 + Received + 3 - Array [] + Array [ + "Type", + ] ``` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Print the node of the CFN spec where validation fails, so the erroneous
part of the spec can be located.
Currently, when a Property in a PropertyType has two "Type" fields
specified, the message looks like below. Only the resource type being
validated is printed.
With this change, the message will look like -
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license