Skip to main content

pytest plugin to manage external processes across test runs

Project description

https://img.shields.io/pypi/v/pytest-xprocess.svg https://img.shields.io/pypi/pyversions/pytest-xprocess.svg https://github.com/pytest-dev/pytest-xprocess/workflows/build/badge.svg

Experimental pytest plugin for managing processes across test runs.

Usage

install via:

pip install pytest-xprocess

This will provide a xprocess fixture which helps you to ensure that one ore more longer-running processes are present for your tests. You can use it to start and pre-configure test-specific databases (Postgres, Couchdb, …).

Additionally there are two new command line options:

--xkill  # terminates all external processes
--xshow  # shows currently running processes and log files

xprocess fixture usage

You typically define a project-specific fixture which uses the xprocess fixture internally:

# content of conftest.py

import pytest
from xprocess import ProcessStarter

@pytest.fixture
def myserver(xprocess):
    class Starter(ProcessStarter):
        pattern = "PATTERN"
        args = ['command', 'arg1', 'arg2']

    logfile = xprocess.ensure("myserver", Starter)
    conn = # create a connection or url/port info to the server
    return conn

The xprocess.ensure function takes a name for the external process because you can have multiple external processes.

The Starter is a subclass that gets initialized with the working directory created for this process. If the server has not yet been started:

  • the args are used to invoke a new subprocess.
  • the pattern is waited for in the logfile before returning. It should thus match a state of your server where it is ready to answer queries.
  • env may be defined to customize the environment in which the new subprocess is invoked. To inherit the main test process environment, leave env set to the default (None).
  • stdout is redirected to a logfile, which is returned pointing to the line right after the match

else, if the server is already running simply the logfile is returned.

To customize the startup behavior, override other methods of the ProcessStarter. For example, to extend the number of lines searched for the startup info:

class Starter(ProcessStarter):
    pattern = 'process started at .*'
    args = ['command', 'arg1']

    def filter_lines(self, lines):
        return itertools.islice(lines, 500)

To override the wait behavior, override ProcessStarter.wait. See the xprocess.ProcessStarter interface for more details.

Note that the plugin needs to persist the process ID and logfile information. It does this in a sub directory of the directory which contains a pytest.ini or setup.py file.

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-xprocess, version 0.13.1
Filename, size File type Python version Upload date Hashes
Filename, size pytest_xprocess-0.13.1-py2.py3-none-any.whl (7.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pytest-xprocess-0.13.1.tar.gz (10.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page