pytest-order - a pytest plugin to order test execution

pytest-order is a pytest plugin that allows you to customize the order in which your tests are run. It uses the marker order that defines when a specific test shall run, either by using an ordinal number, or by specifying the relationship to other tests.

pytest-order is a fork of pytest-ordering that provides additional features like ordering relative to other tests.

pytest-order works with Python 3.7 - 3.12, with pytest versions >= 5.0.0 for all versions up to Python 3.9, and for pytest >= 6.2.4 for Python >= 3.10. pytest-order runs on Linux, macOS and Windows.

Documentation

Apart from this overview, the following information is available:

• usage documentation for the latest release
• usage documentation for the current main branch
• most examples shown in the documentation can also be found in the repository
• the Release Notes with a list of changes in the latest versions
• a list of open issues in the original project and their handling in pytest-order

Features

pytest-order provides the following features:

• ordering of tests by index
• ordering of tests both from the start and from the end (via negative index)
• ordering of tests relative to each other (via the before and after marker attributes)
• session-, module- and class-scope ordering via the order-scope option
• directory scope ordering via the order-scope-level option
• hierarchical module and class-level ordering via the order-group-scope option
• ordering tests with pytest-dependency markers if using the order-dependencies option, more information about pytest-dependency compatibility here
• sparse ordering of tests via the sparse-ordering option
• usage of custom markers for ordering using the order-marker-prefix option

Overview

(adapted from the original project)

Have you ever wanted to easily run one of your tests before any others run? Or run some tests last? Or run this one test before that other test? Or make sure that this group of tests runs after this other group of tests?

Now you can.

Install with:

pip install pytest-order

This defines the order marker that you can use in your code with different attributes.

For example, this code:

import pytest

@pytest.mark.order(2)
def test_foo():
    assert True

@pytest.mark.order(1)
def test_bar():
    assert True

yields the output:

$ pytest test_foo.py -vv
============================= test session starts ==============================
platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
plugins: order
collected 2 items

test_foo.py:7: test_bar PASSED
test_foo.py:3: test_foo PASSED

=========================== 2 passed in 0.01 seconds ===========================

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, pytest-order is free and open source software.

History

This is a fork of pytest-ordering. That project is not maintained anymore, and there are several helpful PRs that are now integrated into pytest-order. The idea and most of the initial code has been created by Frank Tobia, the author of that plugin, and contributors.

While derived from pytest_ordering, pytest-order is not compatible with pytest-ordering due to the changed marker name (order instead of run). Additional markers defined pytest_ordering are all integrated into the order marker (for a rationale see also this issue).

Ordering relative to other tests and all the configuration options are not available in the released version of pytest-ordering. However, most of these features are derived from or inspired by issues and pull requests already existing in pytest-ordering.