Skip to content
A pytest plugin which allows to (de-)select tests from a file.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
pytest_select
tests
.bumpversion.cfg
.flake8
.gitignore
README.rst
poetry.lock
pyproject.toml

README.rst

pytest-select

PyPI pyversions PyPI license PyPI version CircleCI build Codecov result

This is a pytest plugin which allows to (de-)select tests by name from a list loaded from a file.

Installation

It's recommended to install this package from PyPI:

pip install pytest-select

Usage

This plugin adds new command line options to pytest:

  • --select-from-file
  • --deselect-from-file
  • --select-fail-on-missing

The first two both expect an argument that resolves to a UTF-8 encoded text file containing one test name per line.

The third one changes the behaviour in case (de-)selected test names are missing from the to-be executed tests. By default a warning is emitted and the remaining selected tests are executed as normal. By using the --select-fail-on-missing flag this behaviour can be changed to instead abort execution in that case.

Test names are expected in the same format as seen in the output of pytest --collect-only --quiet for example.

Both plain test names or complete node ids (e.g. test_file.py::test_name) are accepted.

Example:

$~ cat selection.txt
test_something
test_parametrized[1]
tests/test_foo.py::test_other

$~ pytest --select-from-file selection.txt
$~ pytest --deselect-from-file selection.txt

Development

This package uses Poetry. To setup a development environment install Poetry and then run:

poetry install

Questions

Why not use pytest's builtin -k option

The -k selection mechanism is (currently) unable to deal with selecting multiple parametrized tests and is also a bit fragile since it matches more than just the test name. Additionally, depending on the number of tests, giving test names on the command line can overflow the maximum command length.

What is this useful for

The author uses this plugin to split tests across workers on Circle CI.

Example:

pytest --collect-only --quiet | \
    grep '::' | \
    circleci tests split --split-by=timings --timings-type=testname > selected.txt
pytest --select-from-file selected.txt

Version History

  • v0.1.2 - 2019-01-18:
    • Add informational pytest header report output
  • v0.1.1 - 2018-12-10:
    • Add --select-fail-on-missing option
    • Add basic mutation testing
  • v0.1.0post0 - 2018-12-08:
    • Fix README
  • v0.1.0 - 2018-12-08:
    • Initial release
You can’t perform that action at this time.