Skip to content
pytest external process plugin
Python
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.
example Restore .kill method on XProcessInfo for compatibility. Ref #1. Jun 1, 2017
.travis.yml Add py35 and py36 to CI and drop support for pytest<2.8 Jun 7, 2017
CHANGELOG Correct module in example fixture usage. Jun 7, 2017
LICENSE initial checkin Apr 5, 2013
MANIFEST.in initial checkin Apr 5, 2013
README.rst
appveyor.yml Add py35 and py36 to CI and drop support for pytest<2.8 Jun 7, 2017
pytest_xprocess.py
setup.cfg update versions, add setup.cfg for a wheel etc. Jul 15, 2015
setup.py
tox.ini Add py35 and py36 to CI and drop support for pytest<2.8 Jun 7, 2017
xprocess.py Assign pid in ternary operator Jun 7, 2017

README.rst

pytest-xprocess

https://travis-ci.org/pytest-dev/pytest-xprocess.svg?branch=master https://ci.appveyor.com/api/projects/status/ffx3jgyfoetmewna?svg=true

Experimental py.test 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 :method:`ProcessStarter.wait`. See the :class:`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.

You can’t perform that action at this time.