Simple module enabling Django app testing via $ python setup.py test
Project description
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
Add the following to the app’s __init__.py file:
def test_suite(): import setuptest return setuptest.suite(__name__)
Provide a test_suite argument to the setup call specifying the test suite callback defined in the first step, e.g.:
setup( # ... test_suite='myapp.test_suite', )
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', ), )
Specify the test specific Django settings in a test_settings module in your app same path as your app’s __init__.py. These settings will be used when executing the tests, e.g. in myapp/test_settings.py:
DATABASE_ENGINE = 'sqlite3' INSTALLED_APPS = ( '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.
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 $
Changelog
0.0.4 (2011-09-06)
Refactored the app to use a callback style approach instead of monkey patching. Thanks jezdez.
0.0.3 (2011-08-30)
More robust test settings import.
0.0.2 (2011-08-29)
Repeat Pep 8 errors.
0.0.1 (2011-08-29)
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for django_setuptest-0.0.4-py2.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95595451b19de69d6a035e0f49b7d9b4c6a81da3a12da538b82e48b35fe181af |
|
MD5 | e3511b009424f82033db1ddbeb2bcbfe |
|
BLAKE2b-256 | 6171168dfea05c7546e747eacad3f17bfb10d12e3745fc82796ee3ecf52543e7 |
Hashes for django_setuptest-0.0.4-py2.6.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e0f95c8cee1f736fe47ae17df3daa584a85c0d6bc8f3dd2b6531ff42c39f00f |
|
MD5 | 81a395b80a97967eefff95f41a521edc |
|
BLAKE2b-256 | 1b94c4b2a6f8f1855b68632cf6823d36c7f69c0f7dc2de6618d46994e94f5d02 |