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.2.tar.gz (25.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django-rest-framework-supertest-0.0.2.tar.gz.

File metadata

File hashes

Hashes for django-rest-framework-supertest-0.0.2.tar.gz
Algorithm Hash digest
SHA256 96087ef27cca7a10583507c5b3d481868f3f39d5a09bcb12afb393d9d64b363b
MD5 33fc7008f207ac9f1f0c5f3e74969b28
BLAKE2b-256 bc6d036639ee2d9e44bf3d8634afdc8abe928ddeb6852944bbae747e71f75bf9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_rest_framework_supertest-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 84408dfb21f364ae7c6794067c17ec5d3b818ab53194a8d592808541abedd091
MD5 689b5ca83010c3f76519cb9295d8d64e
BLAKE2b-256 50c4b753d3ae4bdbe8441e242891288700137e4d5bad9e6c72a96812cf395981

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