Skip to main content
Build Downloads Latest Version License

Instantly test-cover your Django REST Framework based API.

Django-REST-Assured adds another layer on top of Django REST Framework’s APITestCase which allows covering a set of RESTful resource’s endpoints with a single class declaration.

This gives both a quick coverage of sanity tests to your API and a more DRY and more friendly platform for writing additional, more comprehensive tests.

As easy as

class CategoryTestCase(ReadWriteRESTAPITestCaseMixin, BaseRESTAPITestCase):

    base_name = 'category'
    factory_class = CategoryFactory
    create_data = {'name': 'comedy'}
    update_data = {'name': 'horror'}

Django-REST-Assured is designed to work with factory_boy for mocking objects to test against. However, you can easily extend the BaseRESTAPITestCase to work directly with Django Models or any other factory.

Main features

  • Class-based declarative API for creating tests.

  • Covers the stack through: route > view > serializer > model.

  • Uses Django REST Framework’s conventions to minimize configuration.

  • All tests return the response object for more extensive assertions.

  • Automatic mocking of authentication if a user factory is provided.

Usage

The basic form of usage is simply to create a class that extends any mixin from rest_assured.testcases, according to the endpoints you wish to cover, and the BaseRESTAPITestCase class.

Then just set the required attributes, and continue extending it from there.

If your API requires authentication and/or authorization just add a user factory class. Assuming you use factory_boy:

Supports

Tests run against:

  • Django 1.6, 1.7, 1.8 & 1.9.

  • Django REST Framework 2.4.3, 2.4.4, 3.0, 3.1, 3.2 & 3.3.

  • Python 2.7, 3.3, 3.4 & 3.5 (3.2 should work but is not tested).

Installation

PyPI: https://pypi.python.org/pypi/django-rest-assured

$ pip install django-rest-assured

Source: https://github.com/ydaniv/django-rest-assured

$ git clone https://github.com/ydaniv/django-rest-assured
$ python setup.py install

Contributing

Issues are tracked in the github repository.

Pull requests are welcome!

Running tests

$ pip install pytest pytest-django
$ py.test

License

Django-REST-Assured is distributed under the BSD license.

Download files

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

Source Distribution

django-rest-assured-0.2.1.tar.gz (9.9 kB view details)

Uploaded Source

File details

Details for the file django-rest-assured-0.2.1.tar.gz.

File metadata

File hashes

Hashes for django-rest-assured-0.2.1.tar.gz
Algorithm Hash digest
SHA256 542ca4e70c8df78c574a930061d0ff84450b121ad1e59c4a285938ce76dcb568
MD5 cf577cc42b6be39acdc7a5eb7f7fda46
BLAKE2b-256 e15b65f0383b84fbfac21eacfe16d862e2693c6f47bfc4fe3128ce699b389314

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page