django-shareddb

Shared database connections for multi-threaded Django test setups.


Keywords
django, liveserver, shared connection
License
BSD-3-Clause
Install
pip install django-shareddb==0.1.2

Documentation

django-shareddb

This proxy database backend is designed to speed up multi-threaded testing setups.

It enables those setups (for instance using LiveServerTestCase) to use Django's standard TestCase - where each test runs in its own transaction - instead of the much slower TransactionTestCase that needs to flush the whole database between each tests.

It is NOT intended for production use, only for faster testing setups.

This project support Django versions 1.6, and Python 2.7, 3.2 and 3.3.

Setup

First, install django-shareddb:

$ pip install django-shareddb

Then, simply update your settings to use its wrapping engine:

DATABASES = {
    'default': {
        'ENGINE': 'shareddb.backends.shareddb',
        'INNER_ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'test-dbsharing',
    }
}

Since altering those settings is very frequent, django-shareddb also provides a simple patch_databases function:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'test-dbsharing',
    }
}

if os.environ['FAST_TESTS']:
    import shareddb
    DATABASES = shareddb.patch_databases(DATABASES)

Note

patch_databases accepts two keyword arguments, whitelist (only alter databases from that list) and blacklist (never alter databases from that list).

The blacklist has priority over the whitelist.

Once the settings are ready, simply replace your calls to Django's LiveServerTestCase with the django-shareddb variant:

from shareddb import testcases

class MyTests(testcases.LiveServerTestCase):
    def test_something(self):
        # Your test here

The django-shareddb LiveServerTestCase is simply a clone of Django's version, but uses django.test.TestCase instead of django.test.TransactionTestCase.

Links

Testing

This libraries has been succesfully tested with sqlite and postgresql.

If you want to test it with other databases, please clone it and alter dev/settings.py for your setup, then run ./manage.py test.