Skip to main content

Virtualenv fixture for py.test

Project description

# Py.test Virtualenv Fixture

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.

## Installation

Install using your favourite package installer:
```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):

```python
pytest_plugins = ['pytest_virtualenv']
```

## Configuration

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`


## Fixture Attributes

Here's a noddy test case to demonstrate the basic fixture attributes.
For more information on `path.py` see https://pythonhosted.org/path.py

```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')
```

## Installing Packages

You can install packages by name and query what's installed.

```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()]
```

## Developing Source Checkouts

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:

```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)
```


## Running Commands

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.

```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
```

## Running Commands With Coverage

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.

```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"])
```

## Changelog

### 1.2.2 (2016-10-2r70)
* Python 3 compatibility across most of the modules
* Fixed 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 function
* Added missing licence file
* Split up httpd server fixture config so child classes can override loaded modules easier
* Added '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 spec
* Ignore errors when tearing down workspaces to avoid race conditions in 'shutil.rmtree' implementation

### 1.2.1 (2016-3-1)
* Fixed pytest-verbose-parametrize for latest version of py.test

### 1.2.0 (2016-2-19)
* New plugin: git repository fixture

### 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)

* New plugin: devpi server fixture
* pytest-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 reasons
* Corrected virtualenv.run() method to handle arguments the same as the parent method workspace.run()
* Removed deprecated '--distribute' from virtualenv args

### 1.0.1 (2015-12-23)

* Packaging bugfix

### 1.0.0 (2015-12-21)

* Initial public release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-virtualenv-1.2.2.tar.gz (9.2 kB view details)

Uploaded Source

Built Distributions

pytest_virtualenv-1.2.2-py2.7.egg (6.3 kB view details)

Uploaded Source

pytest_virtualenv-1.2.2-py2-none-any.whl (9.4 kB view details)

Uploaded Python 2

File details

Details for the file pytest-virtualenv-1.2.2.tar.gz.

File metadata

File hashes

Hashes for pytest-virtualenv-1.2.2.tar.gz
Algorithm Hash digest
SHA256 3260acda0704f89c611c868e6bc68903ea65f78380967016187a8c523f75d8e3
MD5 900c966e1e1adf37a99359f0ad073767
BLAKE2b-256 15b4b3017d19959574a4eb7dc83d4ceea7e49ffd00cb20041f8675f2427ff5de

See more details on using hashes here.

Provenance

File details

Details for the file pytest_virtualenv-1.2.2-py2.7.egg.

File metadata

File hashes

Hashes for pytest_virtualenv-1.2.2-py2.7.egg
Algorithm Hash digest
SHA256 e09f9ba746fdccf4fc183ac04c34f2b475506cfb9e86fe181188832730ed6418
MD5 81f88c93ef9cbefbddb25f13cdea1634
BLAKE2b-256 51b0323c2c3072337a7c57f84528be9af0dd2ecebd4faa751b812d1fb1c4cd76

See more details on using hashes here.

Provenance

File details

Details for the file pytest_virtualenv-1.2.2-py2-none-any.whl.

File metadata

File hashes

Hashes for pytest_virtualenv-1.2.2-py2-none-any.whl
Algorithm Hash digest
SHA256 7f403cc68d07f552f2b2dd11dc52c1934d600676c4394ebacf9d7cad7856900d
MD5 8d707fa0a5f1d2c104dbc296b5cdecbf
BLAKE2b-256 1eec8507b5ec61874358f9eab5f1dd185628fc21ae78ec14b2dc7c365818c031

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page