Skip to main content

TestCase extension for Django views unit testing.

Project description

djet

Django Extended Tests is set of helpers for easy unit testing of Django views.

Build Status

Installation

To install djet use PyPI:

$ pip install djet

Why djet?

Django test client performs integration tests. All middlewares, resolvers, decorators and so on are tested. Just a single failure in a middleware can break all the view tests.

One technique of performing the tests was presented at DjangoCon Europe 2013 Warsaw. We have always used a slightly different method, which we would like to present as an alternative to the DjangoCon approach.

djet makes performing unit tests for your views easier. Instead of self.client you will use self.factory which is an extended RequestFactory with with overridden shortcuts for creating requests (eg. path is not required parameter).

There are also some additional useful assertions in different mixins in assertions module.

Sometimes you would need middlewares to be applied in order to test the view. there is an option that helps specify which middlewares should be used in a single test or a whole test case by applying middleware_classes argument.

Developed by SUNSCRAPERS with passion & patience.

Examples

import djet
from django.contrib import messages
from django.contrib.messages.storage.base import Message
from django.contrib.messages.middleware import MessageMiddleware
from django.contrib.sessions.middleware import SessionMiddleware
from yourapp.views import YourView
from yourapp.factories import UserFactory

class YourViewTest(djet.RedirectsAssertionsMixin, djet.ViewTestCase):
    view_class = YourView
    view_kwargs = {'some_kwarg': 'value'}
    middleware_classes = [
        SessionMiddleware,
        MessageMiddleware,
    ]

    def test_post_should_redirect_and_add_message_when_next_parameter(self):
        request = self.factory.post(data={'next': '/'}, user=UserFactory())

        response = self.view(request)

        self.assert_redirect(response, '/')
        self.assertIn(
            Message(level=messages.SUCCESS, message='Success!'),
            messages.get_messages(request),
        )

If you want to test function-based view you should do it like this:

class YourFunctionViewTest(djet.ViewTestCase):
    view_function = your_view

There is special create_view_object helper for testing single view methods, which applies the view_kwargs specified to created view object. You can always create view object with different kwargs by using self.view_class constructor.

class YourViewObjectMethodTest(djet.ViewTestCase):
    view_class = YourView
    view_kwargs = {'redirect_url': '/'}

    def test_some_view_method(self):
        view_object = self.create_view_object()

        view_object.some_method()

        self.assertTrue(view_object.some_method_called)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for djet, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size djet-0.0.2.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page