Improve equality assertion failure message #241
+213
−153
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
9ae6d2c to
8ad0fcb
Compare
8ad0fcb to
3fc5b97
Compare
zainab-ali
commented
Nov 4, 2025
| loc: SourceLocation): Expectations = { | ||
| comparisonA.diff(expected, found) match { | ||
| case Comparison.Result.Success => Expectations(Validated.validNel(())) | ||
| case Comparison.Result.Failure(report) => |
There was a problem hiding this comment.
One problem with printing - expected and + found is that we assume the Comparison instance will respect the ANSI escape codes and + / - signs in the diff.
I think we can follow this up with some guidance on defining a Comparison.
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.
The
expect.sameandexpect.eqlmethods haveexpectedas their first parameter andobtainedas their second.expectedandobtainedare printed in the diff report in the failure message, but it's not obvious which parameter is which. To complicate things further, we usefoundas the parameter name in code, butobtainedas the name in the failure message.This PR improves the failure message to print
in expect.same(expected, found). This should help users correlate the diff report to their code.Before
After