What Django TEST_RUNNER supports xunit xml and logging capture?

Question

I'm attempting to set up a new django project, and I've configured TEST_RUNNER in settings.py to be django_nose.NoseTestSuiteRunner.

I chose this test runner because it seems to be the only one I can find that has the following features:

writes xunit xml test report
captures logging/stdout and only displays for failed tests.

However I've heard that nose is unmaintained and I'm having a hard time finding a suitable replacement. The standard test runner doesn't capture logging nor writes xunit as far as I'm able to tell (would love to be proven wrong!)

I run tests like so:

python -m coverage run manage.py test --noinput
python -m coverage report --include="app/*" --show-missing --fail-under=100
python -m coverage xml --include="app/*" -o ./reports/coverage.xml

With this in settings.py:

TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'

And this setup.cfg:

[nosetests]
verbosity=0
with-xunit=1
xunit-file=./reports/xunit.xml
logging-clear-handlers=1

The last two lines are the real juicy bits I can't seem to find in other test runners. nose captures the logging and clears other logging handlers (eg, the handler that dumps on stdout) so the test runs output is much cleaner (you only see logging for tests that failed).

In other non-django projects I typically use nose2 but django-nose2 project appears to be 6 years old and lacking python3 support??

Please let me know which test runner is the "recommended" one (eg, most popular) with django support, thanks.

score 12 · Answer 1 · edited Oct 18 '21 at 18:54

12

I have had success with unittest-xml-reporting:

TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'

https://github.com/xmlrunner/unittest-xml-reporting#django-support

The output directory can be configured with the TEST_OUTPUT_DIR setting.

edited Oct 18 '21 at 18:54

Zags

37,389
14
105
140

answered Feb 06 '19 at 07:50

Juuso Ohtonen

8,826
9
65
98

1

is there a way to define the folder to use for the reports? – MikeSchem Jan 21 '21 at 00:29
1

never mind, found it in the link you posted `TEST_OUTPUT_DIR`, thx – MikeSchem Jan 21 '21 at 00:40

score 5 · Answer 2 · answered Jun 19 '19 at 12:55

You may still use nose runner:

INSTALLED_APPS += ['django_nose']
TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
NOSE_ARGS = [
    '--with-xunit',
    '--xunit-file=nosetests.xml',
    '--with-coverage',
    '--cover-erase',
    '--cover-xml',
    '--cover-xml-file=nosecover.xml',
]

score 2 · Answer 3 · answered Oct 02 '17 at 20:42

So pytest produces some very nice test output. I've unset TEST_RUNNER in settings.py and changed my test script to:

python -m coverage run -m pytest --junitxml=./reports/junit.xml
python -m coverage report --include="app/*" --show-missing --fail-under=100
python -m coverage xml --include="app/*" -o ./reports/coverage.xml

This works, and captures ALL logging output (nose was a little buggy and let one or two logging statements slip through, very strange behavior).

The only thing is that I'm a django novice so I don't know if there are any bad side-effects of not using manage.py test for testing django. Any guidance is appreciated, thanks!

I tried to follow your instructions and it doesn't work - I think you might have something else that you did to actually make this all work. — Ash Berlin-Taylor, Nov 06 '17 at 14:58

What Django TEST_RUNNER supports xunit xml and logging capture?

3 Answers3