Login

Breaking tests.py into multiple files

Author:
gsakkis
Posted:
April 1, 2010
Language:
Python
Version:
1.1
Score:
3 (after 3 ratings)

Django loads tests found in models.py and tests.py (if present) or actually a module or package named 'tests' under the app. Since tests can be a package, one can create a 'tests' directory, split the test cases across multiple files under 'tests' and import them from tests/init.py with:

# tests/__init__.py
from test_mod1 import *
from test_mod2 import *
...
from test_modN import *

For a small number of files that's not too bad but it gets old as more files are added, plus it is error prone (e.g. test cases shadowing others with the same name). The snippet above simplifies the test splitting without importing everything into the same namespace.

Typical usage:

# tests/__init__.py
from ... import get_suite
suite = lambda: get_suite(__name__)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
import os
import re
import unittest

from django.utils.importlib import import_module
from django.test._doctest import DocTestSuite
from django.test.testcases import DocTestRunner
from django.test.simple import doctestOutputChecker

loadTestsFromModule = unittest.defaultTestLoader.loadTestsFromModule

DEFAULT_TESTFILE_PATTERN = re.compile(r'test_.*\.py')

def get_suite(*names, **kwargs):
    '''Creates (or updates) a ``TestSuite`` consisting of the tests under one or
    more modules.

    This is useful for splitting a Django ``tests.py`` module into multiple test
    modules under a ``tests`` directory without having to import them manually
    in ``tests/__init__.py``. All you have to write in ``tests/__init__.py`` is::

        from ... import get_suite

        # django.test looks for a function named suite that returns a TestSuite
        suite = lambda: get_suite(__name__)

    This creates a suite consisting of all ``TestCase`` instances defined under
    any ``test_.*py`` module under ``tests``.

    :param names: One or more module or package names to be added in the suite.
        For module names, the respective module's TestCases are loaded. For package
        names, the TestCases of all modules in the package directory satisfying
        ``is_test_module`` are loaded.
    :keyword is_test_module: Determines whether a file is a test module. It can
        be a callable ``f(filename)`` or a regular expression (string or compiled)
        that test module file names should ``match()``.
    :keyword suite: If given, update this suite instead of creating a new one.
    '''

    suite = kwargs.get('suite') or unittest.TestSuite()
    # determine is_test_module
    is_test_module = kwargs.get('is_test_module', DEFAULT_TESTFILE_PATTERN)
    if isinstance(is_test_module, basestring): # look for exact match
        is_test_module = re.compile(is_test_module + '$').match
    elif hasattr(is_test_module, 'match'):
        is_test_module = is_test_module.match
    # determine the test modules to be added in the suite and import them
    modules = set()
    for name in names:
        package = import_module(name)
        # if it's a single module just add it
        if os.path.splitext(os.path.basename(package.__file__))[0] != '__init__':
            modules.add(package)
        else: # otherwise it's a package; add all test modules under the dir
            modules.update(
                import_module('.' + os.path.splitext(f)[0], package=name)
                for f in os.listdir(os.path.dirname(package.__file__))
                if is_test_module(f))
    # add the modules to the suite
    for module in modules:
        # copied from django.test.simple.build_suite
        if hasattr(module, 'suite'):
            # if module has a suite() method, use it
            suite.addTest(module.suite())
        else: # otherwise build the test suite ourselves.
            suite.addTest(loadTestsFromModule(module))
            try:
                suite.addTest(DocTestSuite(module, runner=DocTestRunner,
                                           checker=doctestOutputChecker))
            except ValueError: # No doc tests
                pass
    return suite

More like this

  1. Template tag - list punctuation for a list of items by shapiromatron 3 months, 1 week ago
  2. JSONRequestMiddleware adds a .json() method to your HttpRequests by cdcarter 3 months, 2 weeks ago
  3. Serializer factory with Django Rest Framework by julio 10 months, 2 weeks ago
  4. Image compression before saving the new model / work with JPG, PNG by Schleidens 11 months ago
  5. Help text hyperlinks by sa2812 12 months ago

Comments

diegueus (on July 14, 2011):

how i must name the file, and shoulbe in the app root or project root?

#

Please login first before commenting.