Skip to main content

A set of utilities to test django-rest-framework API's

Project description

django-rest-framework-supertest

An WORK IN PROGRESS set of utilities to write automated tests for APIS writen in django-rest-framework.

GitHub Workflow Status (with event) Coverage Status Ruff

Motivation

The django and django-rest-framework is an powerfull set of tools to create REST API's. But, testing these API', with automated tests, are a little more complex question. Write a lot of repeated code and the difficult to made all assertions along the REST API's responses is some of these problems for our apps.

This project wants to aggregate utilities to made assertions on the responses, like APIException responses, and utilities to work with other complex REST API's concepts, like pagination and authentication.

Under the Hood

Under the hood, this is only an set of utilities and this uses some libraries to work correctly. Actually, for fake data generation we use Faker, with some small custom provider's. For assertions, we use the default django and django-rest-framework unittest features. We provide some mixins with our own methods and some base classes.

Roadmap

  • Add Basic Faker Support
  • Assertions APIExceptions
  • Assert Validation Errors
  • Create Faker Shortcuts
  • Work with images and files
  • Assert Serializer Responses
  • Work with pagination
  • Work with multiple types of Authentication

This is an basic roadmap for the first version and, before the first version release, some new itens can be added here.

Project details


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_framework_supertest-0.0.5.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django_rest_framework_supertest-0.0.5.tar.gz.

File metadata

File hashes

Hashes for django_rest_framework_supertest-0.0.5.tar.gz
Algorithm Hash digest
SHA256 65728a90b65965e3b83c2b878a3641d71bfee9a112e04693b610311ea6ea2698
MD5 bf537a2b75575d73cb1ece7ef3647862
BLAKE2b-256 ea6f1cbb28475388cba35155c596463b7d17361e247a820f61994c8708501c82

See more details on using hashes here.

File details

Details for the file django_rest_framework_supertest-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for django_rest_framework_supertest-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3c8ee047f89da9d28b3d32475913fc008dd98ff4fd42d8733a682aa726879af6
MD5 2291bc78124f7642ec58ab2a629d7fc8
BLAKE2b-256 4bc7b76cb8de1049b95606c3a226de5f30a6d23c992a6eb7a073800af2531083

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page