django-async-test

asyncio unit tests with Django transactional support.

It supports Django 1.8+ for Python versions 3.5+ and uses asynctest under the covers to provide support for easily mocking coroutines.

Docs

Available at django-async-test.readthedocs.org

Installation

You can install django-async-test either via the Python Package Index (PyPI) or from github.

To install using pip;

$ pip install django-async-test

From github;

$ pip install git+https://github.com/alexhayes/django-async-test.git

Usage

asynctest.TestCase does a great job of mocking coroutines however if you're writing tests that manipulate the database in Django you'll most likely want to ensure that things are cleaned up after your test.

With django_async_test.TestCase you have the coroutine support of asynctest.TestCase but with the transaction support of Django's django.test.TestCase.

import django_async_test

class MyTestCase(django_async_test.TestCase):

    @django_async_test.patch('myapp.my_coroutine')
    def test_foo(self, MockMyCoroutine):

        # Mock our coroutine.
        MockMyCoroutine.return_value = 'Hello World'

        # Create an instance of MyModel
        MyModel.objects.create(...)

        ...
        ...

In the above example, the test is run inside a transaction by Django's TestCase, thus the creation of a MyModel will be rolled back, cleaning up the database.

Also, our co-routine will be patched correctly by asynctest.

License

This software is licensed under the MIT License. See the LICENSE file.

Author

Alex Hayes <alex@alution.com>