bpo-18232: Return unsuccessfully if no unit tests were run #24893
+69
−6
Conversation
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
Change unittest.TestResult.wasSuccessful() to return False if no tests were found. Update the runner to explicitly print "No tests found" to indicate the problem better. Add a test ensuring that wasSuccessful() still returns True if all tests were skipped, including the special case of SkipTest exception in setUpClass() method. This aids greatly with automated testing where an unexpected breakage of test discovery could not be caught cleanly, as the test runner returned success if no tests were found. This is unlikely to be the expected behavior in real usage.
|
This PR is stale because it has been open for 30 days with no activity. |
iritkatriel
reviewed
May 7, 2021
|
|
||
| .. versionchanged:: 3.4 | ||
| Returns ``False`` if there were any :attr:`unexpectedSuccesses` | ||
| from tests marked with the :func:`expectedFailure` decorator. | ||
|
|
||
| .. versionchanged:: 3.10b1 |
There was a problem hiding this comment.
This will probably need to be 3.11 now.
| Return ``True`` if all tests run so far have passed, otherwise returns | ||
| ``False``. | ||
| Return ``True`` if all tests run so far have passed and at least one test | ||
| was found, otherwise returns ``False``. |
There was a problem hiding this comment.
The code checks testsRun + testsSkipped > 0, so it's not exactly "was found" (what if many were found but we haven't started running anything yet?)
nit: I think it's easier to understand if the sentence lists the conditions chronologically, something like: "at least one test has been executed or skipped and no test has failed so far".
| @@ -184,8 +184,11 @@ def run(self, test): | |||
| if hasattr(result, 'separator2'): | |||
| self.stream.writeln(result.separator2) | |||
| run = result.testsRun | |||
| self.stream.writeln("Ran %d test%s in %.3fs" % | |||
| (run, run != 1 and "s" or "", timeTaken)) | |||
| if run > 0 or len(result.skipped) > 0: | |||
There was a problem hiding this comment.
I'd abstract the run > 0 or len(result.skipped) calculation as a method on TestResult, then you won't have it repeated twice. And you can give it a name indicating what it means.
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.
Change unittest.TestResult.wasSuccessful() to return False if no tests
were found. Update the runner to explicitly print "No tests found"
to indicate the problem better. Add a test ensuring that
wasSuccessful() still returns True if all tests were skipped, including
the special case of SkipTest exception in setUpClass() method.
This aids greatly with automated testing where an unexpected breakage
of test discovery could not be caught cleanly, as the test runner
returned success if no tests were found. This is unlikely to be
the expected behavior in real usage.
https://bugs.python.org/issue18232