Skip to main content

Limit parallel tests with posix jobserver.

Project description

pytest-jobserver

PyPI version Python versions Code coverage Build status

Limit parallel tests with posix jobserver.

Installation

Install with pip:

pip install pytest-jobserver

The plugin officially supports Python >= 3.6 on a Linux OS. You may find other Python 3 versions/MacOS work as well.

Usage

The plugin uses a POSIX jobserver to manage parallel test loading.

Pass the --jobserver argument with a path, where this path points to a named pipe acting as a jobserver. You should probably also use pytest-xdist to enable parallelism in the first place:

pytest -n4 --jobserver /opt/jobserver

You can also pass this filepath via the PYTEST_JOBSERVER environment variable.

make

The plugin can also listen for an existing jobserver as created by make. If a jobserver is not configured by filepath, pytest-jobserver will check the following environment variables in order:

  • CARGO_MAKEFLAGS
  • MAKEFLAGS
  • MFLAGS

Please note: it is not possible to use one of these environment variables with pytest-xdist. The execnet protocol used by xdist does not support passing file descriptors to remote child processes.

Implementation

This plugin wraps pytest's call to pytest_runtest_protocol, which is called to actually run a collected item on the worker node.

Development

See the top level Makefile and .circleci/config.yml for the development flow. But in essence:

  • make dev to install deps
  • make lint to lint code (will change files)
  • make test to run lint/unit tests
  • make integrate to run integration tests

Changelog

1.0.0

Features

  • jobserver token int value can be accessed within a test using the jobserver_token fixture
  • bump to 1.0.0 as the plugin is now stable, and in use by other projects

0.3.1

Bugfixes

  • fix package installation with pip

0.3.0

Features

  • a jobserver filepath can also be configured by the PYTEST_JOBSERVER environment variable

0.2.2

Bugfixes

  • move jobserver status on startup to official pytest_report_header hook

0.2.1

Bugfixes

  • remove pytest-xdist from runtime dependencies

0.2.0

Features

  • can run against a jobserver specified with make environment variables
    • note that this will deliberately not work when also using pytest-xdist

0.1.1

Bugfixes

  • fix setup.py package metadata

0.1.0

Features

  • can run against a jobserver specified at the cli

TODO

  • [x] run against cli jobserver
  • [x] integrate with Make jobserver from environment variables
  • [ ] factor out creation of jobservers to seperate python 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 pytest-jobserver, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size pytest_jobserver-1.0.0-py2.py3-none-any.whl (12.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size pytest-jobserver-1.0.0.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page