Refs #32552 -- Added DiscoverRunner.log() to allow customization.

[abbasidaniyal]

ticket-32552

Add a method log(self, message, level) to DiscoverRunner class which prints the message by comparing the level with self.verbosity.
Replace the use of print with self.log

[abbasidaniyal]

The tests for DiscoverRunner

django/tests/test_runner/test_discover_runner.py

Lines 336 to 337 in 3704481

	class DiscoverRunnerGetDatabasesTests(SimpleTestCase):
	runner = DiscoverRunner(verbosity=2)

and

django/tests/test_runner/test_discover_runner.py

Lines 252 to 262 in 3704481

	def test_included_tags_displayed(self):
	runner = DiscoverRunner(tags=['foo', 'bar'], verbosity=2)
	with captured_stdout() as stdout:
	runner.build_suite(['test_runner_apps.tagged.tests'])
	self.assertIn('Including test tag(s): bar, foo.\n', stdout.getvalue())
	def test_excluded_tags_displayed(self):
	runner = DiscoverRunner(exclude_tags=['foo', 'bar'], verbosity=3)
	with captured_stdout() as stdout:
	runner.build_suite(['test_runner_apps.tagged.tests'])
	self.assertIn('Excluding test tag(s): bar, foo.\n', stdout.getvalue())

only check for verbosity >= 2. I believe we should add tests for verbosity < 2 as well. Thoughts?

[cjerdonek]

Thanks. One comment..

[cjerdonek]

Also, the title of the PR should be something like "Added a DiscoverRunner.log() method" since you're not actually changing DiscoverRunner to use a logger here.

[cjerdonek]

I believe we should add tests for verbosity < 2 as well. Thoughts?

I would add a single new test called test_log(). It can use subTest() to test the following matrix of 12 possibilities: verbosity (0, 1, 2, 3) times level (DEBUG, INFO, WARN).

[abbasidaniyal]

Just made few changes. Let me know if this seems better. Working on the tests!

[cjerdonek]

Just made few changes. Let me know if this seems better.

It looks like you didn't finish addressing my previous comments: #14150 (comment)

I've repeated them inline with some additional explanation and added a couple other comments.

[carltongibson]

Hi @abbasidaniyal — Thanks for updating this.

• Please look at the existing test failures.
• Also see Chris' comment about adding a new test_log(), with the appropriate matrix of combinations. (See subTest Python docs and examples in the test suite for usage.)

Once those are in place and addition to the DiscoverRunner docs and a release note in releases/4.0.txt would be appropriate.

[abbasidaniyal]

Hi @abbasidaniyal — Thanks for updating this.

• Please look at the existing test failures.
• Also see Chris' comment about adding a new test_log(), with the appropriate matrix of combinations. (See subTest Python docs and examples in the test suite for usage.)

Once those are in place and addition to the DiscoverRunner docs and a release note in releases/4.0.txt would be appropriate.

Just made these changes. Not sure if the docs and the release notes are under the appropriate heading, let me know if I need to make amends.

[cjerdonek]

Some comments.

[cjerdonek]

Okay, last round of comments (I think?). They're more minor than before. Thanks again for keeping at it, @abbasidaniyal.

[cjerdonek]

Backticks are needed around INFO, 1, DEBUG, and 2.

[smithdc1]

Please also add a .. versionadded 4.0 directive. With a shirt note saying this method was added.

https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/#documenting-new-features

[cjerdonek]

You can remove the empty line above and the two empty lines below.

[smithdc1]

Your prompt for a review made me look at this again. 😄

A few small questions/comments, I suspect most can be ignored.

[felixxm]

Thanks y'all 🚀

I rebased and pushed small edits.

Stale