# Running the Test Suite

`django-treebeard` includes a comprehensive test suite. It is highly recommended that you run and update the test suite when you send patches.

## pytest

You will need pytest to run the test suite:

    $ pip install pytest

Then just run the test suite:

    $ pytest

You can use all the features and plugins of pytest this way.

By default the test suite will run using a sqlite3 database in RAM, but you can change this setting environment variables:

DATABASE_ENGINE

DATABASE_NAME

DATABASE_USER

DATABASE_PASSWORD

DATABASE_HOST

DATABASE_PORT

  Sets the database settings to be used by the test suite. Useful if you want to test the same database engine/version you use in production.

## tox

`django-treebeard` uses tox to run the test suite in all the supported environments - permutations of:

> - Python 3.6, 3.7 and 3.8

> - Django 2.2, 3.0 and 3.1

> - Sqlite, MySQL and PostgreSQL

This means that the test suite will run 24 times to test every environment supported by `django-treebeard`. This takes a long time. If you want to test only one or a few environments, please use the -e option in tox, like:

    $ tox -e py36-dj22-pgsql