Geek asks and answers

Django-Discover-runner and XML reports?

I have a working Django application that I successfully use unittest-xml-reportingto generate XML reports from my unittests.

However, the project is growing rapidly, and I want to split my tests into separate files in each application. Therefore, I installed django-discover-runnerone that finds all my test files and successfully runs them.

However, it django-discover-runnerdoes not generate the XML reports that I need (for Bamboo).

I found this:

http://www.stevetrefethen.com/blog/Publishing-Python-unit-test-results-in-Jenkins.aspx

and tried to implement this sentence (in each of my test.py files), but XML is not created.

How can I use both django-discover-runner, and unittest-xml-reportingto detect my tests and generate XML reports?

+5
source share
2 answers

So it turns out that the solution to this is much simpler than I expected. For any other n00bs that might look like this:

The short answer is that I simply combined the two test runs provided by django-discover-runnerand unittest-xml-reportinginto a custom test runner:

from django.conf import settings
from django.test.utils import setup_test_environment, teardown_test_environment
import xmlrunner
from django.core.exceptions import ImproperlyConfigured
from django.test import TestCase
from django.test.simple import DjangoTestSuiteRunner, reorder_suite
from django.utils.importlib import import_module

try:
    from django.utils.unittest import defaultTestLoader
except ImportError:
    try:
        from unittest2 import defaultTestLoader  # noqa
    except ImportError:
        raise ImproperlyConfigured("Couldn't import unittest2 default "
                               "test loader. Please use Django >= 1.3 "
                               "or go install the unittest2 library.")

### CUSTOM RUNNER NAME
class myTestRunner(DjangoTestSuiteRunner):
    ### THIS SECTION FROM UNITTESTS-XML-REPORTING
    def build_suite(self, test_labels, extra_tests=None, **kwargs):
        suite = None
        root = getattr(settings, 'TEST_DISCOVER_ROOT', '.')
        top_level = getattr(settings, 'TEST_DISCOVER_TOP_LEVEL', None)
        pattern = getattr(settings, 'TEST_DISCOVER_PATTERN', 'test*.py')

        if test_labels:
            suite = defaultTestLoader.loadTestsFromNames(test_labels)
            # if single named module has no tests, do discovery within it
            if not suite.countTestCases() and len(test_labels) == 1:
                suite = None
                root = import_module(test_labels[0]).__path__[0]

        if suite is None:
            suite = defaultTestLoader.discover(root,
                pattern=pattern, top_level_dir=top_level)

        if extra_tests:
            for test in extra_tests:
                suite.addTest(test)

        return reorder_suite(suite, (TestCase,))

    ###THIS SECTION FROM DJANGO-DISCOVER-RUNNER
    def run_tests(self, test_labels, extra_tests=None, **kwargs):
        """
        Run the unit tests for all the test labels in the provided list.
        Labels must be of the form:
         - app.TestClass.test_method
        Run a single specific test method
         - app.TestClass
        Run all the test methods in a given class
         - app
        Search for doctests and unittests in the named application.

        When looking for tests, the test runner will look in the models and
        tests modules for the application.

        A list of 'extra' tests may also be provided; these tests
        will be added to the test suite.

        Returns the number of tests that failed.
        """
        setup_test_environment()

        settings.DEBUG = False

        verbosity = getattr(settings, 'TEST_OUTPUT_VERBOSE', 1)
        if isinstance(verbosity, bool):
            verbosity = (1, 2)[verbosity]
        descriptions = getattr(settings, 'TEST_OUTPUT_DESCRIPTIONS', False)
        output = getattr(settings, 'TEST_OUTPUT_DIR', '.')

        suite = self.build_suite(test_labels, extra_tests)

        old_config = self.setup_databases()

        result = xmlrunner.XMLTestRunner(
            verbosity=verbosity, descriptions=descriptions,
            output=output).run(suite)

        self.teardown_databases(old_config)
        teardown_test_environment()

        return len(result.failures) + len(result.errors)

This should be kept somewhere suitable in your project. In the test settings file ( test_settings.py- in accordance with the instructions django-discover-runner) install Test Runner:

TEST_RUNNER = '<your-django-project>.customTestRunner.myTestRunner'

Then you should use (again, according to the instructions django-discover-runner):

django-admin.py test --settings=myapp.test_settings

django-discover-runner , django-discover-runner TEST_DISCOVER_PATTERN, - XML- Bamboo. :

django-discover-runner

unittest-xml-reports

+3

unittest-xml- Django DiscoverRunner. Django:

TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'

, DiscoverRunner.

+3

More articles:


All Articles