Enable IntelliJ <Click to see difference> feature when result comparison fails#36
Merged
gmessinese merged 1 commit intoHubSpot:masterfrom Jan 10, 2024
Conversation
gmessinese
commented
Nov 3, 2023
| Objects.instance().assertNotNull(info, actual); | ||
| if (!actual.isErr() || !actual.unwrapErrOrElseThrow().equals(value)) { | ||
| throw failures.failure(info, ResultShouldBeErrWithValue.shouldBeOkWithValue(actual, value)); | ||
| throw failures.failure(info, ResultShouldBeErrWithValue.shouldBeErrWithValue(actual, value)); |
Contributor
Author
There was a problem hiding this comment.
shouldBeOkWithValue() is not the right name here, renamed it.
| } | ||
|
|
||
| public static <T, E> ErrorMessageFactory shouldBeOkWithValue(Result<T, E> actual, Object value) { | ||
| public static <T, E> ErrorMessageFactory shouldBeErrWithValue(Result<T, E> actual, Object error) { |
Contributor
Author
There was a problem hiding this comment.
as said above, we're comparing that a result is equal to the expected Error result
| if (actual.isErr()) { | ||
| return new ResultShouldBeErrWithValue("Expecting Result to be Err containing <%s> but contained <%s>", value, actual.unwrapErrOrElseThrow()); | ||
| E actualError = actual.unwrapErrOrElseThrow(); | ||
| return new ResultShouldBeErrWithValue("Expecting Result to be Err containing <%s> but contained <%s>. expected:<%s> but was:<%s>", error, actualError, error, actualError); |
Contributor
Author
There was a problem hiding this comment.
this is all this PR is doing, appending the expected:<%s> but was:<%s> to the error message.
| if (actual.isOk()) { | ||
| return new ResultShouldBeOkWithValue("Expecting Result to be Ok containing <%s> but contained <%s>", value, actual.unwrapOrElseThrow()); | ||
| T actualValue = actual.unwrapOrElseThrow(); | ||
| return new ResultShouldBeOkWithValue("Expecting Result to be Ok containing <%s> but contained <%s>. expected:<%s> but was:<%s>", value, actualValue, value, actualValue); |
Contributor
Author
There was a problem hiding this comment.
this is all this PR is doing, appending the expected:<%s> but was:<%s> to the error message.
| T actualValue = actual.unwrapOrElseThrow(); | ||
| return new ResultShouldBeOkWithValue("Expecting Result to be Ok containing <%s> but contained <%s>. expected:<%s> but was:<%s>", value, actualValue, value, actualValue); | ||
| } else { | ||
| return new ResultShouldBeOkWithValue("Expecting Result to be Ok containing <%s> but was Err containing <%s>", value, actual.unwrapErrOrElseThrow()); |
Contributor
Author
There was a problem hiding this comment.
No need to do the same for this case imo. If the actual Result is err while we're expecting an ok result, the two objects to compare are two different things conceptually.
| return new ResultShouldBeErrWithValue("Expecting Result to be Err containing <%s> but contained <%s>. expected:<%s> but was:<%s>", error, actualError, error, actualError); | ||
| } else { | ||
| return new ResultShouldBeErrWithValue("Expecting Result to be Err containing <%s> but was Ok containing <%s>", value, actual.unwrapOrElseThrow()); | ||
| return new ResultShouldBeErrWithValue("Expecting Result to be Err containing <%s> but was Ok containing <%s>", error, actual.unwrapOrElseThrow()); |
Contributor
Author
There was a problem hiding this comment.
No need to do the same for this case imo. If the actual Result is ok while we're expecting an err result, the two objects to compare are two different things conceptually.
|
🚢 |
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
2 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.
This PR enables the IntelliJ when comparing two Results. It doesn't change the comparison logic, but just the assertion message that is returned.
By appending
expected:<%s> but was:<%s>initelliJ recognizes there was an error comparing two different values and shows the very handy<Click to see difference>button in the error message.Before:
After:
