Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Smoke tests for Django project.

Project description

https://badge.fury.io/py/django-smoke-tests.svg https://travis-ci.org/kamilkijak/django-smoke-tests.svg?branch=master https://codecov.io/gh/kamilkijak/django-smoke-tests/branch/master/graph/badge.svg

Django command that finds all endpoints in project, executes HTTP requests against them and checks if there are any unexpected responses.

https://i.imgur.com/cPK0y3W.gif

Requirements

  • Python (2.7, 3.4, 3.5, 3.6)
  • Django (1.8, 1.9, 1.10, 1.11)

Installation

Install using pip:

pip install django-smoke-tests

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_smoke_tests',
    ...
)

Quickstart

Execute smoke tests for the whole project:

python manage.py smoke_tests

Usage

Parameters

$ python manage.py smoke_tests --help
usage: manage.py smoke_tests [-h] [--http-methods HTTP_METHODS]
                             [--allow-status-codes ALLOW_STATUS_CODES]
                             [--disallow-status-codes DISALLOW_STATUS_CODES]
                             [--no-db]
                             [app_names]

Smoke tests for Django endpoints.

positional arguments:
  app_names             names of apps to test

optional arguments:
  -h, --help            show this help message and exit
  --http-methods HTTP_METHODS
                        comma separated HTTP methods that will be executed for
                        all endpoints, eg. GET,POST,DELETE
                        [default: GET,POST,PUT,DELETE]
  -g, --get-only        shortcut for --http-methods GET
  --allow-status-codes ALLOW_STATUS_CODES
                        comma separated HTTP status codes that will be
                        considered as success responses, eg. 200,201,204
                        [default: 200,201,301,302,304,405]
  --disallow-status-codes DISALLOW_STATUS_CODES
                        comma separated HTTP status codes that will be
                        considered as fail responses, eg. 404,500
  --no-db               flag for skipping database creation

Skipping tests

To skip tests for specific URLs add SKIP_SMOKE_TESTS option in your settings.

This setting should contain list of URLs’ names.

SKIP_SMOKE_TESTS = (
    'all-astronauts',  # to skip url(r'^astronauts/', AllAstronauts.as_view(), name='all-astronauts')
)

Reporting bugs

If you face any problems please report them to the issue tracker at https://github.com/kamilkijak/django-smoke-tests/issues

Contributing

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

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 django-smoke-tests, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size django_smoke_tests-0.2.2-py2.py3-none-any.whl (11.4 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size django-smoke-tests-0.2.2.tar.gz (10.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page