diff --git a/AUTHORS.rst b/AUTHORS.rst index 4b0e627..45cc98a 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -29,6 +29,7 @@ These non-maintainers have contributed code to a django-nose release: * Camilo Nova (`camilonova `_) * Carl Meyer (`carljm `_) * Conrado Buhrer (`conrado `_) +* Daniel Miller (`millerdev `_) * David Baumgold (`singingwolfboy `_) * David Cramer (`dcramer `_) * Dmitry Gladkov (`dgladkov `_) diff --git a/changelog.rst b/changelog.rst index b9fea48..1f3dfde 100644 --- a/changelog.rst +++ b/changelog.rst @@ -1,6 +1,10 @@ Changelog --------- +*Unreleased* +~~~~~~~~~~~~ +* Add support for custom database contexts. + 1.4.2 (2015-10-07) ~~~~~~~~~~~~~~~~~~ * Warn against using REUSE_DB=1 and FastFixtureTestCase in docs diff --git a/docs/usage.rst b/docs/usage.rst index ffbc1ca..a5a32db 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -150,6 +150,54 @@ course of loading tests. For example, if the tests that need it are in sure its DB table gets created. +Custom Database Contexts +------------------------ + +Django-nose can be instructed to use custom contexts for database and non- +database tests. What this means is that you can write a "context" class to do +custom setup and/or teardown for database tests (i.e., tests that extend +``TransactionTestCase`` or one of its subclasses) and/or non-database tests +(i.e., tests that do not extend ``TransactionTestCase``). This might mean +creating a new database that Django does not support or patching Django's +database machinery to assert that tests that should not access a database fail +if they try to do so. + +Custom contexts can be specified with the following options: + + NOSE_PLUGINS = [ + '--db-test-context=django_nose.plugin.DatabaseContext', + '--non-db-test-context=django_nose.plugin.NullContext', + ] + +While this example uses contexts that come with django-nose, you can of +course specify paths for your own custom context classes. A custom context +class might look something like this: + + class CustomContext(django_nose.plugin.DatabaseContext): + + """Setup/teardown custom database and standard Django databases.""" + + def setup(self): + """Setup database.""" + + # do custom database setup here + + super(CustomContext, self).setup() + + def teardown(self): + """Tear down database.""" + + # do custom database teardown here + + super(CustomContext, self).teardown() + +For each type of context, ``context.setup()`` is called once before the first +test of its type is run, and ``context.teardown()`` is called once after the +last test of its type is run. The database context will be used for all tests, +including "non-database" tests, unless ``--non-db-test-context=...`` is +specified. + + Assertions ----------