skip to navigation
skip to content

django-setuptest 0.0.6

Simple test suite enabling Django app testing via $ python setup.py test

Downloads ↓

Django Setuptest

Simple module enabling Django app testing via $ python setup.py test.

Normally when you execute $ python setup.py test for Django related modules you're almost certain to run into DJANGO_SETTINGS_MODULE environment variable issues, e.g.:

ImportError: Settings cannot be imported, because environment variable
DJANGO_SETTINGS_MODULE is undefined.

This module overcomes this by configuring the DJANGO_SETTINGS_MODULE environment variable before executing your test suite. As a bonus it also generates Coverage and PEP 8 reports as part of the test.

Installation

  1. Provide a test_suite argument to the setup call specifying the the setuptest.SetupTestSuite test suite, e.g.:

    setup(
    # ...
    test_suite='setuptest.SetupTestSuite',
)

  2. Provide a tests_require argument to the setup call including django-setuptest (required) and other package dependencies needed to execute the tests, e.g.:

    setup(
    # ...
    tests_require=(
        'django-setuptest',
    ),
)

  3. Specify the test specific Django settings in a test_settings module in the same path as your app's setup.py. These settings will be used when executing the tests, e.g. in test_settings.py:

    DATABASE_ENGINE = 'sqlite3'

INSTALLED_APPS = (
    'myapp',
)

  4. In order for the test suite to find your tests you must provide either a packages or py_modules argument to the setup call, e.g.:

    from setuptools import setup, find_packages

setup(
    # ...
    packages=find_packages(),
)

# Or alternatively...

setup(
    # ...
    py_modules=['myapp'],
)

Usage

Once correctly configured you can execute tests from the command line:

$ python setup.py test

This should output your test results as well as Coverage and PEP 8 reports.

Note

An XML Coverage report is generated in a file called coverage.xml and a PEP8 report is generated in a file called pep8.txt

To mute the output of the Coverage and PEP 8 reports provide the --quiet option:

$ python setup.py test --quiet

Sample Output

Example output of dummy test including Coverage and PEP 8 reports:

$ python setup.py test
running test
running egg_info
writing django_dummy.egg-info/PKG-INFO
writing top-level names to django_dummy.egg-info/top_level.txt
writing dependency_links to django_dummy.egg-info/dependency_links.txt
reading manifest file 'django_dummy.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'django_dummy.egg-info/SOURCES.txt'
running build_ext
Creating test database for alias 'default'...
E
======================================================================
ERROR: test_something (dummy.tests.TestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/shaun/tmp/django-dummy/dummy/tests/__init__.py", line 6, in test_something
    raise NotImplementedError('Test not implemented. Bad developer!')
NotImplementedError: Test not implemented. Bad developer!

----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (errors=1)
Destroying test database for alias 'default'...

Coverage Report:
Name              Stmts   Miss  Cover   Missing
-----------------------------------------------
dummy/models      20      2    90%   22, 55

PEP8 Report:
dummy/tests/__init__.py:6:1: W391 blank line at end of file

$

Authors

Praekelt Foundation

  • Shaun Sephton

Contributors

  • Jannis Leidel

Changelog

0.0.6 (2011-09-08)

  1. Refactor, cleanup, self contained suite class.

0.0.5 (2011-09-06)

  1. Added frame hack to resolve packages and py_modules to test, no longer needs app specific test suite.

0.0.4 (2011-09-06)

  1. Refactored the app to use a callback style approach instead of monkey patching. Thanks jezdez.

0.0.3 (2011-08-30)

  1. More robust test settings import.

0.0.2 (2011-08-29)

  1. Repeat Pep 8 errors.

0.0.1 (2011-08-29)

  1. Initial release.
 
File Type Py Version Uploaded on Size # downloads
django-setuptest-0.0.6.tar.gz (md5) Source 2011-09-08 5KB 287
django_setuptest-0.0.6-py2.6.egg (md5) Python Egg 2.6 2011-09-08 7KB 331
django_setuptest-0.0.6-py2.7.egg (md5) Python Egg 2.7 2011-09-08 6KB 416