test: combine the asserts for output and errors #253
Merged
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
With the output and error asserts separate, the test case ends on the first failing assertion, and we never know what was in errors. But the clue to the output mismatch might be in the errors. For example, an include file was not found. By combining the asserts into one, we get all the differences in the pytest results.
BrunoMSantos
approved these changes
Sep 12, 2024
| @@ -104,8 +104,7 @@ def run_test(self): | |||
|
|
|||
| assert output_docs, 'empty output' | |||
| assert expect_docs, 'empty expected' | |||
| assert output_docs == expect_docs | |||
| assert output_errors == expect_errors | |||
| assert output_docs + output_errors == expect_docs + expect_errors | |||
There was a problem hiding this comment.
Is it worth to '\n'.join(...) to improve the diff or is output_docs guaranteed to end in a new line?
There was a problem hiding this comment.
Per my testing, there's always been a newline, and the diff has looked fine with this. (And I've looked at plenty when trying to debug the macos CI issues.)
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.
With the output and error asserts separate, the test case ends on the first failing assertion, and we never know what was in errors. But the clue to the output mismatch might be in the errors. For example, an include file was not found. By combining the asserts into one, we get all the differences in the pytest results.