Django + mongoengine: Isolated test database

README.md

Isolated Test database for Django

This gist contains a few snippets that make creating an isolated test database in Django simple when using mongoengine.

The database identified by settings.MY_TEST_DB_NAME will be deleted every time a test is run.

If your test class needs additional tearDown functionality, make sure to call the super(MyClassName, self).tearDown() method within your overridden version of tearDown to handle deleting the database when you are finished.

example_tests.py

# Example usage

from my_app.tests.test_utils import TestDatabaseCleanup


class MyModelTests(TestDatabaseCleanup, unittest.TestCase):
    """Common usage """
    def test_my_models(self):
        # create some models
        # no need to clean up
        pass


class MyOtherModelTests(TestDatabaseCleanup, unittest.TestCase):
    """Handle additional tearDown functionality """
    def test_my_other_models(self):
        # create some models
        # no need to clean up
        pass

    def tearDown(self):
        # Do some other tearDown related work
        # Then call the super() method to clean up the database
        super(MyOtherModelTests, self).tearDown()

settings.py

# Add this to settings.py

TESTING = 'test' in sys.argv

CONNECTION_STRING = 'localhost'
MY_DB_CONN = pymongo.Connection(CONNECTION_STRING, safe=True)
MY_DB_NAME = 'mydb'
MY_TEST_DB_NAME = 'mydb-testing'
if TESTING:
    mongoengine.connect(MY_TEST_DB_NAME)
else:
    mongoengine.connect(MY_DB_NAME)

test_utils.py

# Add this somewhere it can be imported into tests

from django.conf import settings


class TestDatabaseCleanup(object):
    def tearDown(self):
        settings.MY_DB_CONN.drop_database(settings.MY_TEST_DB_NAME)