[Django] #32641: Log the number of tests found in DiscoverRunner.build_suite()
Django
-------------------------------------+-------------------------------------
Reporter: Chris | Owner: nobody
Jerdonek |
Type: | Status: new
Cleanup/optimization |
Component: Testing | Version: dev
framework | Keywords:
Severity: Normal | DiscoverRunner,build_suite
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Currently, when running tests with `DiscoverRunner`, the number of tests
is displayed only at the very end of the test run.
However, knowing this number at the ''beginning'' of a test run could I
think provide an increase in usability. For example, you'd be able to
notice right away if a new test you're working was or wasn't included as
expected, based on whether the number is the same or different from the
previous run. Similarly, the early feedback would be helpful as a sanity
check if you're trying to reduce the number of tests using different
command-line options, and you're not sure if your invocation is correct.
Thus, I'd like to suggest that `DiscoverRunner` display by default the
number of tests discovered (and that match any filters) at the earliest
point where this is known. This could be done inside
`DiscoverRunner.build_suite()`.
The code change could be as simple as:
{{{
diff --git a/django/test/runner.py b/django/test/runner.py
index f187107157..c975ed92be 100644
--- a/django/test/runner.py
+++ b/django/test/runner.py
@@ -652,7 +652,8 @@ class DiscoverRunner:
# _FailedTest objects include things like test modules that
couldn't be
# found or that couldn't be loaded due to syntax errors.
test_types = (unittest.loader._FailedTest, *self.reorder_by)
- all_tests = reorder_tests(all_tests, test_types, self.reverse)
+ all_tests = list(reorder_tests(all_tests, test_types,
self.reverse))
+ print('Found %d tests' % len(all_tests))
suite = self.test_suite(all_tests)
if self.parallel > 1:
}}}
If there is any concern about adding an additional message, another
possibility would be to display the current "Testing against Django
installed in ..." message later in the test run, only after the number of
tests is known, and include the test count in that message.
--
Ticket URL: <https://code.djangoproject.com/ticket/32641>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Testing framework | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
DiscoverRunner,build_suite | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Old description:
New description:
Currently, when running tests with `DiscoverRunner`, the number of tests
is displayed only at the very end of the test run.
However, knowing this number at the ''beginning'' of a test run could I
think provide an increase in usability. For example, you'd be able to
notice right away if a new test you're working on was or wasn't included
as expected, based on whether the number is the same or different from the
previous run. Similarly, the early feedback would be helpful as a sanity
check if you're trying to reduce the number of tests using different
command-line options, and you're not sure if your invocation is correct.
Thus, I'd like to suggest that `DiscoverRunner` display by default the
number of tests discovered (and that match any filters) at the earliest
point where this is known. This could be done inside
`DiscoverRunner.build_suite()`.
The code change could be as simple as:
{{{
diff --git a/django/test/runner.py b/django/test/runner.py
index f187107157..c975ed92be 100644
--- a/django/test/runner.py
+++ b/django/test/runner.py
@@ -652,7 +652,8 @@ class DiscoverRunner:
# _FailedTest objects include things like test modules that
couldn't be
# found or that couldn't be loaded due to syntax errors.
test_types = (unittest.loader._FailedTest, *self.reorder_by)
- all_tests = reorder_tests(all_tests, test_types, self.reverse)
+ all_tests = list(reorder_tests(all_tests, test_types,
self.reverse))
+ if self.verbosity >= 1:
+ print('Found %d tests' % len(all_tests))
suite = self.test_suite(all_tests)
if self.parallel > 1:
}}}
If there is any concern about adding an additional message, another
possibility would be to display the current "Testing against Django
installed in ..." message later in the test run, only after the number of
tests is known, and include the test count in that message.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:1>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Testing framework | Version: dev
Severity: Normal | Resolution:
DiscoverRunner,build_suite |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* easy: 0 => 1
* stage: Unreviewed => Accepted
Comment:
An extra line in the output should be fine.
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:2>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: assigned
Component: Testing framework | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
DiscoverRunner,build_suite |
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* owner: nobody => Girish Sontakke
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: assigned
Component: Testing framework | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
DiscoverRunner,build_suite |
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Girish Sontakke):
[https://github.com/django/django/pull/14261 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:4>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: assigned
Component: Testing framework | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
DiscoverRunner,build_suite |
Needs tests: 1 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
* needs_tests: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:5>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: assigned
Component: Testing framework | Version: dev
Severity: Normal | Resolution:
DiscoverRunner,build_suite | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* needs_tests: 1 => 0
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:6>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Component: Testing framework | Version: dev
Keywords: | Triage Stage: Ready for
DiscoverRunner,build_suite | checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"a815a6a3159d5f708866ca968e8994f201ea3e43" a815a6a3]:
{{{
#!CommitTicketReference repository=""
revision="a815a6a3159d5f708866ca968e8994f201ea3e43"
Fixed #32641 -- Made DiscoverRunner print the number of found tests.
Thanks Chris Jerdonek for reviews.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:7>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: closed
Component: Testing framework | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
DiscoverRunner,build_suite | checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Chris Jerdonek):
I was trying this out, and it looks great. Thanks, Mariusz and Girish. The
only thing is I noticed it can say:
{{{
Found 1 tests.
}}}
when there is just one test. So while not a big deal, it would be easy to
add polish to that one special case. :)
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:8>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: closed
Component: Testing framework | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
DiscoverRunner,build_suite | checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak):
> Here is how that's handled in the similar message saying, "System check
identified N issues...":
I would use `Found 1 test(s).`
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:9>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: closed
Component: Testing framework | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
DiscoverRunner,build_suite | checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Chris Jerdonek):
> I would use "Found 1 test(s)."
I made a PR for this: https://github.com/django/django/pull/14476
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:10>
Django
-------------------------------------+-------------------------------------
Type: | Sontakke
Cleanup/optimization | Status: closed
Component: Testing framework | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
DiscoverRunner,build_suite | checkin
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"1b4d1675b230cd6d47c2ffce41893d1881bf447b" 1b4d1675]:
{{{
#!CommitTicketReference repository=""
revision="1b4d1675b230cd6d47c2ffce41893d1881bf447b"
Refs #32641 -- Made DiscoverRunner's "Found X tests" message work for
finding one test.
This also removes passing level to log() as logging.INFO is the default.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32641#comment:11>