add test that checks README.rst against usbsdmux -h output #65
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
A README that does not match the behaviour of the program can be quite confusing. Sync the usbsdmux -h output with the actual output. Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Jan Luebbe <[email protected]>
hnez
approved these changes
Dec 21, 2023
There was a problem hiding this comment.
I find this a lot harder to read than than what I did in #64 (I am obviously biased here because I wrote it) because of the pytest trickery that I am not too familiar with and because it actually tries to "parse" the output in README.rst, which I did avoid on purpose to keep it simple.
But I agree that adding it as a pytest test is better than adding yet another workflow, so I'd say lets not over-bikeshed this and:
LGTM.
|
I had the simple variant first as well, but found the diff output was worth the additional code. |
SmithChart
approved these changes
Dec 22, 2023
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.
The usbsdmux -h output in the README.rst has become out of date with the actual output of the tool.
This can be quite confusing, as it makes it unclear which features the tool has.
Update the README.rst content and make sure it stays up to date via a pytest test case.
This is an alternative to #64. Instead of adding a custom Actions workflow for a special check, integrate it as a test into the pytest testsuite. This also gives us the diff output through assertions (see https://github.com/jluebbe/usbsdmux/actions/runs/7288823489/job/19862144881#step:4:84 as an example).