Virtualenv fixture for py.test
Create a Python virtual environment in your test that cleans up on teardown. The fixture has utility methods to install packages and list what's installed.
Install using your favourite package installer:
.. code:: bash
pip install pytest-virtualenv
# or
easy_install pytest-virtualenv
Enable the fixture explicitly in your tests or conftest.py (not required when using setuptools entry points):
.. code:: python
pytest_plugins = ['pytest_virtualenv']
This fixture is configured using the following evironment variables
+-----------------------------------+----------------------------------------------------------------+------------------+
| Setting | Description | Default |
+===================================+================================================================+==================+
| VIRTUALENV_FIXTURE_EXECUTABLE | Which virtualenv executable will be used to create new venvs | virtualenv
|
+-----------------------------------+----------------------------------------------------------------+------------------+
Here's a noddy test case to demonstrate the basic fixture attributes.
For more information on path.py
see https://pathpy.readthedocs.io/
.. code:: python
def test_virtualenv(virtualenv):
# the 'virtualenv' attribute is a `path.py` object for the root of the virtualenv
dirnames = virtualenv.virtualenv.dirs()
assert {'bin', 'include', 'lib'}.intersection(set(dirnames))
# the 'python' attribute is a `path.py` object for the python executable
assert virtualenv.python.endswith('/bin/python')
You can install packages by name and query what's installed.
.. code:: python
def test_installing(virtualenv):
virtualenv.install_package('coverage', installer='pip')
# installed_packages() will return a list of `PackageEntry` objects.
assert 'coverage' in [i.name for i in virtualenv.installed_packages()]
Any packages set up in the test runner's python environment (ie, the
same runtime that py.test
is installed in) as source checkouts using
python setup.py develop
will be detected as such and can be
installed by name using install_package
. By default they are
installed into the virtualenv using python setup.py develop
, there
is an option to build and install an egg as well:
.. code:: python
def test_installing_source(virtualenv):
# Install a source checkout of my_package as an egg file
virtualenv.install_package('my_package', build_egg=True)
The test fixture has a run
method which allows you to run commands
with the correct paths set up as if you had activated the virtualenv
first.
.. code:: python
def test_run(virtualenv):
python_exe_path = virtualenv.python
runtime_exe = virtualenv.run("python -c 'import sys; print sys.executable'", capture=True)
assert runtime_exe == python_exe_path
The test fixture has a run_with_coverage
method which is like
run
but runs the command under coverage inside the virtualenv.
This is useful for capturing test coverage on tools that are being
tested outside the normal test runner environment.
.. code:: python
def test_coverage(virtualenv):
# You will have to install coverage first
virtualenv.install_package(coverage)
virtualenv.run_with_coverage(["my_entry_point", "--arg1", "--arg2"])
1.7.0
- All: Support pytest >= 4.0.0
- All: Support Python 3.7
- pytest-server-fixtures: if host not defined on your machine, default
to localhost
- pytest-server-fixture: Pin to rethinkdb < 2.4.0 due to upstream API
changes
- pytest-verbose-parametrize: Add support for revamped marker
infrastructure
- pytest-verbose-parametrize: Fix integration tests to support pytest
>= 4.1.0
- pytest-virtualenv: Add virtualenv as install requirement. Fixes #122
- pytest-webdriver: Fix RemovedInPytest4Warning using getfixturevalue
- circleci: Fix checks by skipping coverall submission for developer
without push access
- wheels: Generate universal wheels installable with both python 2.x
and 3.x
- dist: Remove support for building and distributing \*.egg files
- VagrantFile: Install python 3.7 and initialize python 3.7 by default
- Fix DeprecationWarning warnings using "logger.warning()" function
1.6.2 (2019-02-21)
1.6.1 (2019-02-12)
- pytest-server-fixtures: fix exception when attempting to access
hostname while server is not started
1.6.0 (2019-02-12)
1.5.1 (2019-01-24)
- pytest-verbose-parametrize: fixed unicode parameters when using
``@pytest.mark.parametrize``
1.5.0 (2019-01-23)
1.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)
1.3.1 (2018-06-28)
- Use pymongo list\_database\_names() instead of the deprecated
database\_names(), added pymongo>=3.6.0 dependency
1.3.0 (2017-11-17)
1.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)
1.2.10 (2017-2-23)
- Handle custom Pytest test items in pytest-webdriver
1.2.9 (2017-2-23)
~~~~~~~~~~~~~~~~~
- Add username into mongo server fixture tempdir path to stop
collisions on shared multiuser filesystems
1.2.8 (2017-2-21)
~~~~~~~~~~~~~~~~~
- Return function results in shutil.run.run\_as\_main
1.2.7 (2017-2-20)
~~~~~~~~~~~~~~~~~
- More handling for older versions of path.py
- Allow virtualenv argument passing in pytest-virtualenv
1.2.6 (2017-2-16 )
1.2.5 (2016-12-09)
- Improvements for server runner host and port generation, now supports
random local IPs
- Bugfix for RethinkDB fixture config
1.2.4 (2016-11-14)
1.2.3 (2016-11-7)
- Improve resiliency of Mongo fixture startup checks
1.2.2 (2016-10-27)
1.2.1 (2016-3-1)
- Fixed pytest-verbose-parametrize for latest version of py.test
1.2.0 (2016-2-19)
1.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)
1.0.1 (2015-12-23)
- Packaging bugfix
1.0.0 (2015-12-21)