pytest-django-queries 1.0.0.dev1

Generate performance rapports from your django database performance tests.

pytest-django-queries

Generate performance rapports from your django database performance tests (inspired by coverage.py).

Usage

Simply install pytest-django-queries, write your pytest tests and mark any test that should be counted or use the count_queries fixture.

import pytest


@pytest.mark.count_queries
def test_query_performances():
    Model.objects.all()


# Or...
def test_another_query_performances(count_queries):
    Model.objects.all()

Each test file and/or package is considered as a category. Each test inside a "category" compose its data, see Visualising Results for more details.

Integrating with GitHub

Testing locally

Simply install pytest-django-queries through pip and run your tests using pytest. A report should have been generated in your current working directory in a JSON file prefixed with .pytest-queries.

Note: to override the save path, set the PYTEST_QUERIES_SAVE_PATH environment variable to any given valid path.

Visualising Results

You can generate a table from the tests results by using the show command:

django-queries show <json file>

You will get something like this to represent the results:

+---------+-------------------------+
| Module  |          Tests          |
+---------+-------------------------+
| module1 | +-----------+---------+ |
|         | | Test Name | Queries | |
|         | +-----------+---------+ |
|         | |   test1   |    0    | |
|         | +-----------+---------+ |
|         | |   test2   |    1    | |
|         | +-----------+---------+ |
+---------+-------------------------+
| module2 | +-----------+---------+ |
|         | | Test Name | Queries | |
|         | +-----------+---------+ |
|         | |   test1   |   123   | |
|         | +-----------+---------+ |
+---------+-------------------------+
| module3 |                         |
+---------+-------------------------+

Exporting the results (HTML)

For a nicer presentation, use the html command, to export the results as HTML.

django-queries html <json file> > results.html

Comparing results

Development

First of all, clone the project locally. Then, install it using the below command.

./setup.py develop

After that, you need to install the development requirements. For that, run the below command.

pip install -e .[dev]