Show data as text when an tokio_test::io assert fails #6690
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
The asserts used to show the bytes as numbers, which is unnecessary hard to debug when the data is textual. It seems generally, though not universally more useful to show it as text when possible.
|
The CI fails because of an error in regex-syntax v0.8.4 but I don't think that has anything to do with me |
Darksonn
reviewed
Jul 16, 2024
| @@ -23,6 +23,7 @@ async-stream = "0.3.3" | |||
|
|
|||
| bytes = "1.0.0" | |||
| futures-core = "0.3.0" | |||
| bstr = "1.6.2" | |||
There was a problem hiding this comment.
The MSRV failure is because you are adding this dependency.
There was a problem hiding this comment.
Thanks! I'll take a look if it is possible to downgrade bstr. Otherwise i'll just copy paste* the relevant formatting code or cobble something together myself.
That said, taking a step back, do you think this change is a good idea in the first place?
- Checking the license first, of course
There was a problem hiding this comment.
You should not add a new dependency for this. But you can put together something simple yourself.
snaow
approved these changes
Jul 19, 2024
| @@ -18,6 +18,7 @@ | |||
| //! [`AsyncRead`]: tokio::io::AsyncRead | |||
| //! [`AsyncWrite`]: tokio::io::AsyncWrite | |||
|
|
|||
| use bstr::BStr; | |||
|
Any updates on this PR? |
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.
Motivation
The mock object mimics a reader or writer. If the code under test performs different reads or writes than expected, an assertion fails. Currently, the assertion shows the expected and actual data as a series of numbers representing bytes. If the protocol is textual, the numbers are quite hard to read.
Solution
Essentially wrap the data in a BStr. This shows text as-is and shows non-text bytes as \xAA\xBB etc.
The newly added struct
ShowBytescontains a byte slice and a length limit. It has a PartialEq implementation and a fmt::Debug implementation. The Debug implementation shows only the given number of bytes, possibly followed by "plus N more bytes".The PartialEq implementation compares only the given number of bytes.
This is sufficient for the existing three
assert!statements in the code.