Test utility for BytesReference equality
#138668
Conversation
Today if you assert two `BytesReference` objects are equal, and they aren't, then the test output is unhelpful because `BytesReference` instances do not include their contents in their default string representations. This commit introduces a new matcher specifically for testing `BytesReference` instances for equality which generates more useful output.
DaveCTurner
added
>test
elasticsearchmachine
added
the
Team:Distributed Coordination
|
Pinging @elastic/es-distributed-coordination (Team:Distributed Coordination) |
|
Review notes: apart from |
joshua-adams-1
left a comment
joshua-adams-1
left a comment
There was a problem hiding this comment.
LGTM. General question: how did you find every instance of assertEquals that had two ByteReference's passed in, or an existing assertThat that had equalsTo(ByteReference) ? When I look on Intellij, I see a function definition such as private static boolean isEquals(Object expected, Object actual) { which isn't helpful in this case.
| import java.util.Objects; | ||
|
|
||
| public enum BytesReferenceTestUtils { | ||
| ; |
There was a problem hiding this comment.
[Nit] Extra semicolon?
There was a problem hiding this comment.
That's required - omitting it is a compile error 😁
There was a problem hiding this comment.
Is using enums for static utilities a pattern we're using now? Curious about this choice vs an abstract class or final class with a private constructor to accomplish the same thing.
There was a problem hiding this comment.
We do both and this is my preference purely because it involves less boilerplate than declaring a private constructor.
Structural search & replace (under Edit -> Find -> Replace Structurally...) 
|
SSR is incredibly powerful. I used it extensively in our work to remove old usages of unsupported transport versions. |
4 participants
Today if you assert two
BytesReferenceobjects are equal, and theyaren't, then the test output is unhelpful because
BytesReferenceinstances do not include their contents in their default string
representations. This commit introduces a new matcher specifically for
testing
BytesReferenceinstances for equality which generates moreuseful output.