Package: pytest-shutil
This library is a goodie-bag of Unix shell and environment management
tools for automated tests. A summary of the available functions is
below, look at the source for the full listing.InstallationInstall using your favourite package manager:.. code:: bashpip install pytest-shutil
#  or..
easy_install pytest-shutilWorkspace FixtureThe workspace fixture is simply a temporary directory at function-scope
with a few bells and whistles:.. code:: python# Enable the fixture explicitly in your tests or conftest.py (not required when using setuptools entry points)
pytest_plugins = [‘pytest_shutil’]def test_something(workspace):# Workspaces contain a handle to the path.py path object (seehttps://pathpy.readthedocs.io/)
path = workspace.workspace
script = path / ‘hello.sh’
script.write_text(‘#!/bin/shn echo hello world!’)# There is a ‘run’ method to execute things relative to the workspace root
workspace.run(‘hello.sh’)pytest_shutil.env: Shell helpersfunctiondescriptionset_envcontextmanager to set env varsunset_envcontextmanager to unset env varsno_envcontextmanager to unset a single env varno_covcontextmanager to disable coverage in subprocessespytest_shutil.cmdline: Command-line helpersfunctiondescriptionumaskcontextmanager to set the umaskchdircontextmanager to change to a directoryTempDircontextmanager for a temporary directoryPrettyFormattersimple text formatter for drawing title, paragrahs, hrs.copy_filescopy all files from one directory to anothergetchcross-platform read of a single character from the screenwhichanaloge of unixwhichget_real_python_executablefind our system Python, useful when running under virtualenvpytest_shutil.run: Running things in subprocessesfunctiondescriptionrunrun a command, with options for capturing output, checking return codes.run_as_mainrun a function as if it was the system entry pointrun_module_as_mainrun a module as if it was the system entry pointrun_in_subprocessrun a function in a subprocessrun_with_coveragerun a command with coverage enabledChangelog1.7.0All: Support pytest >= 4.0.0All: Support Python 3.7pytest-server-fixtures: if host not defined on your machine, default
to localhostpytest-server-fixture: Pin to rethinkdb < 2.4.0 due to upstream API
changespytest-verbose-parametrize: Add support for revamped marker
infrastructurepytest-verbose-parametrize: Fix integration tests to support pytest
>= 4.1.0pytest-virtualenv: Add virtualenv as install requirement. Fixes #122pytest-webdriver: Fix RemovedInPytest4Warning using getfixturevaluecircleci: Fix checks by skipping coverall submission for developer
without push accesswheels: Generate universal wheels installable with both python 2.x
and 3.xdist: Remove support for building and distributing *.egg filesVagrantFile: Install python 3.7 and initialize python 3.7 by defaultFix DeprecationWarning warnings using “logger.warning()” function1.6.2 (2019-02-21)pytest-server-fixtures: suppress stacktrace if kill() is calledpytest-server-fixtures: fix random port logic in TestServerV21.6.1 (2019-02-12)pytest-server-fixtures: fix exception when attempting to access
hostname while server is not started1.6.0 (2019-02-12)pytest-server-fixtures: added previously removed TestServerV2.kill()
functionpytest-profiling: pin more-itertools==5.0.0 in integration tests, as
that’s a PY3 only release1.5.1 (2019-01-24)pytest-verbose-parametrize: fixed unicode parameters when using@pytest.mark.parametrize1.5.0 (2019-01-23)pytest-server-fixtures: made postgres fixtures and its tests
optional, like all other fixturespytest-server-fixtures: reverted a fix for pymongo deprecation
warning, as this will break compatibility with pymongo 3.6.0pytest-server-fixtures: dropped RHEL5 support in httpd1.4.1 (2019-01-18)pytest-server-fixtures: server fixture binary path specified in ENV
now only affect server class ‘thread’1.4.0 (2019-01-15)Fixing python 3 compatibility in Simple HTTP Server fixtureFixed broken tests in pytest-profilingPinned pytest<4.0.0 until all deprecation warnings are fixed.pytest-webdriver: replaced deprecated phantomjs with headless Google
Chrome.Add Vagrantfile to project to make test environment portable.Add .editorconfig file to project.pytest-server-fixtures: add TestServerV2 with Docker and Kubernetes
support.pytest-server-fixtures: fix for an issue where MinioServer is not
cleaned up after use.pytest-server-fixtures: fix deprecation warnings when calling
pymongo.pytest-server-fixtures: close pymongo client on MongoTestServer
teardown.pytest-server-fixtures: upgrade Mongo, Redis and RethinkDB to
TestServerV2.coveralls: fix broken coveralls1.3.1 (2018-06-28)Use pymongo list_database_names() instead of the deprecated
database_names(), added pymongo>=3.6.0 dependency1.3.0 (2017-11-17)Fixed workspace deletion when teardown is NoneFixed squash of root logger in pytest-listenerAdded S3 Minio fixture (many thanks to Gavin Bisesi)Added Postgres fixture (many thanks to Gavin Bisesi)Use requests for server fixtures http gets as it handles redirects
and proxies properly1.2.12 (2017-8-1)Fixed regression on cacheing ephemeral hostname, some clients were
relying on this. This is now optional.1.2.11 (2017-7-21)Fix for OSX binding to illegal local IP range (Thanks to Gavin
Bisesi)Setup and Py3k fixes for pytest-profiling (Thanks to xoviat)We no longer try and bind port 5000 when reserving a local IP host,
as someone could have bound it to 0.0.0.0Fix for #46 sourcing gprof2dot when the local venv has not been
activated1.2.10 (2017-2-23)Handle custom Pytest test items in pytest-webdriver1.2.9 (2017-2-23)Add username into mongo server fixture tempdir path to stop
collisions on shared multiuser filesystems1.2.8 (2017-2-21)Return function results in shutil.run.run_as_main1.2.7 (2017-2-20)More handling for older versions of path.pyAllow virtualenv argument passing in pytest-virtualenv1.2.6 (2017-2-16 )Updated devpi server server setup for devpi-server >= 2.0Improvements for random port pickingHTTPD server now binds to 0.0.0.0 by default to aid Selenium-style
testingUpdated mongodb server args for mongodb >= 3.2Corrections for mongodb fixture config and improve startup logicAdded module-scoped mongodb fixtureHandling for older versions of path.pyFix for #40 where tests that chdir break pytest-profiling1.2.5 (2016-12-09)Improvements for server runner host and port generation, now supports
random local IPsBugfix for RethinkDB fixture config1.2.4 (2016-11-14)Bugfix for pymongo extra dependencyWindows compatibility fix for pytest-virtualenv (Thanks to
Jean-Christophe Fillion-Robin for PR)Fix symlink handling for
pytest-shutil.cmdline.get_real_python_executable1.2.3 (2016-11-7)Improve resiliency of Mongo fixture startup checks1.2.2 (2016-10-27)Python 3 compatibility across most of the modulesFixed deprecated Path.py imports (Thanks to Bryan Moscon)Fixed deprecated multicall in pytest-profiling (Thanks to Paul van
der Linden for PR)Added devpi-server fixture to create an index per test functionAdded missing licence fileSplit up httpd server fixture config so child classes can override
loaded modules easierAdded ‘preserve_sys_path’ argument to TestServer base class which
exports the current python sys.path to subprocesses.Updated httpd, redis and jenkins runtime args and paths to current
Ubuntu specIgnore errors when tearing down workspaces to avoid race conditions
in ‘shutil.rmtree’ implementation1.2.1 (2016-3-1)Fixed pytest-verbose-parametrize for latest version of py.test1.2.0 (2016-2-19)New plugin: git repository fixture1.1.1 (2016-2-16)pytest-profiling improvement: escape illegal characters in .prof
files (Thanks to Aarni Koskela for the PR)1.1.0 (2016-2-15)New plugin: devpi server fixturepytest-profiling improvement: overly-long .prof files are saved as
the short hash of the test name (Thanks to Vladimir Lagunov for PR)Changed default behavior of workspace.run() to not use a subshell for
security reasonsCorrected virtualenv.run() method to handle arguments the same as the
parent method workspace.run()Removed deprecated ‘–distribute’ from virtualenv args1.0.1 (2015-12-23)Packaging bugfix1.0.0 (2015-12-21)Initial public release