gh-62432: Return unsuccessfully if no unit tests were run #24893
Conversation
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. |
| 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".
| 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.
github-actions
bot
removed
the
stale
|
This was completed in 76632b8 |
StanFromIreland
changed the title
6 participants
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