feat(assertions): improve printing of match failures #23453
Merged
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
Debugging match failures with the `assertions` library used to be a bit
frustrating. The library used to guess the single closest matching
resource and print it fully, with a list of match failures underneath.
This has two problems:
- Matching the failures up to the data structure requires a lot of
scanning back and forth between different screen lines.
- The library could incorrectly guess at the closest match, giving
you useless information.
This change is a first (and by no means the last) stab at improving
the situation:
- Mismatch errors are printed in-line with the data structure, making
it very clear what they are referencing (removing the need for
scanning).
- Fields in complex data structures that aren't involved
in the mismatch at all are collapsed. For example, a complex
subobject that matches be printed as `{ ... }` so it doesn't take
up too much vertical space.
- Because we now have a lot of vertical space left, we can print
the N closest matches, lowering the chance that we guess wrong
and leave you without information to correct the test.
The last point can probably be improved more in the future, by
coming up with a more accurate metric for "closest match" than
"failure count", but this will do for now.
|
|
aws-cdk-automation
previously requested changes
Dec 23, 2022
rix0rrr
added
pr-linter/exempt-readme
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.
ryparker
approved these changes
Dec 27, 2022
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
brennanho
pushed a commit
to brennanho/aws-cdk
that referenced
this pull request
Jan 20, 2023
Debugging match failures with the `assertions` library used to be a bit frustrating. The library used to guess the single closest matching resource and print it fully, with a list of match failures underneath.
This has two problems:
- Matching the failures up to the data structure requires a lot of scanning back and forth between different screen lines.
- The library could incorrectly guess at the closest match, giving you useless information.
This change is a first (and by no means the last) stab at improving the situation:
- Mismatch errors are printed in-line with the data structure, making it very clear what they are referencing (removing the need for scanning).
- Fields in complex data structures that aren't involved in the mismatch at all are collapsed. For example, a complex subobject that matches be printed as `{ ... }` so it doesn't take up too much vertical space.
- Because we now have a lot of vertical space left, we can print the N closest matches, lowering the chance that we guess wrong and leave you without information to correct the test.
The last point can probably be improved more in the future, by coming up with a more accurate metric for "closest match" than "failure count", but this will do for now.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
brennanho
pushed a commit
to brennanho/aws-cdk
that referenced
this pull request
Feb 22, 2023
Debugging match failures with the `assertions` library used to be a bit frustrating. The library used to guess the single closest matching resource and print it fully, with a list of match failures underneath.
This has two problems:
- Matching the failures up to the data structure requires a lot of scanning back and forth between different screen lines.
- The library could incorrectly guess at the closest match, giving you useless information.
This change is a first (and by no means the last) stab at improving the situation:
- Mismatch errors are printed in-line with the data structure, making it very clear what they are referencing (removing the need for scanning).
- Fields in complex data structures that aren't involved in the mismatch at all are collapsed. For example, a complex subobject that matches be printed as `{ ... }` so it doesn't take up too much vertical space.
- Because we now have a lot of vertical space left, we can print the N closest matches, lowering the chance that we guess wrong and leave you without information to correct the test.
The last point can probably be improved more in the future, by coming up with a more accurate metric for "closest match" than "failure count", but this will do for now.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Debugging match failures with the
assertionslibrary used to be a bit frustrating. The library used to guess the single closest matching resource and print it fully, with a list of match failures underneath.This has two problems:
This change is a first (and by no means the last) stab at improving the situation:
{ ... }so it doesn't take up too much vertical space.The last point can probably be improved more in the future, by coming up with a more accurate metric for "closest match" than "failure count", but this will do for now.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license