1. Installation¶

pip install django-test-addons

2. Requirements¶

Django test addons requires the following:

1. Python(2.7+)
2. Django(1.6, 1.7, 1.8, 1.9)

The following packages are optional:

• Mongoengine (0.8.7)+ - Testing support for Mongo DB.
• Django Redis (3.8.2)+ - Testing support Redis.
• Py2neo (2.0.6)+ - Testing support for Neo4j graph database.
• Python Memcached (1.53)+ - Testing support for Memcache.
• Django Rest Framework (3.0.5)+ - Testing support for Django Rest Framework Apis

3. Tutorial¶

This tutorial provides a step-by-step description on how to use django test addons for testing different database systems.

pip install django-test-addons

TEST_MONGO_DATABASE = {
    'db': 'test',
    'host': ['localhost'],
    'port': 27017,
}

MONGO_DATABASES = {
    'default': {
        'db': 'main',
        'host': ['193.34.32.11'], # random development server
        'port': 27017,
    },
    'miscellaneous': {
        'DB_NAME': 'misc',
        'HOST': ['193.34.32.11'],
        'PORT': 27017,
    }
}

# import MONGO_DATABASES variable from development settings file or just use the
# variable if you are using single file for testing with some environment settings.

import mongoengine

TEST_MONGO_DATABASE = {
    'db': 'test',
    'host': ['localhost'],
    'port': 27017,
}

map(lambda connection: mongoengine.connection.disconnect(connection), MONGO_DATABASES.keys())

MONGO_DATABASES = {connection: TEST_MONGO_DATABASE for connection in MONGO_DATABASES.keys()}

for connection_name, attrs in MONGO_DATABASES.items():
    mongoengine.connect(**dict(zip(['alias'] + attrs.keys(), [connection_name] + attrs.values())))

import test_addons

class TestSomething(test_addons.MongoTestCase):

    def test_instantiation(self):
        pass

import test_addons

class TestSomething(test_addons.MongoTestCase):

    CLEAR_CACHE = True

    def test_instantiation(self):
        pass

TEST_CACHES = {
    'default': {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379:0",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    'redis1': {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "127.0.0.1:6379:1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
}

import test_addons

class TestSomething(test_addons.RedisTestCase):

    def test_instantiation(self):
        pass

NEO4J_TEST_LINK = 'http://localhost:7474/db/data'

import test_addons

class TestSomething(test_addons.Neo4jTestCase):

    def test_instantiation(self):
        pass

import test_addons

class TestSomething(test_addons.APIMongoTestCase):

    def test_instantiation(self):
        pass

4. Changelog¶

5. Community¶

To get help with using MongoEngine, use the Django test addons mailing list , raise an issue on github or just mail me directly at hspandher@outlook.com.

6. Contributing¶

Yes please! I am always looking for contributions, additions and improvements. Support for testing more databases is specifically required.

The source is available on GitHub and contributions are always encouraged. Contributions can be as simple as minor tweaks to this documentation, the website or the core.

To contribute, fork the project on GitHub and send a pull request.

7. License¶

The MIT License (MIT)

Copyright (c) 2015, Hakampreet Singh Pandher

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

8. Indices and tables¶

• Index
• Search Page