skip to navigation
skip to content

pytest-fixture-config 1.2.11

Fixture configuration utils for py.test

# Py.test Fixture Configuration

Simple configuration objects for Py.test fixtures.
Allows you to skip tests when their required config variables aren't set.

## Installation

Install using your favourite package manager:

```bash
pip install pytest-fixture-config
# or..
easy_install pytest-fixture-config
```

Enable the fixture explicitly in your tests or conftest.py (not required when using setuptools entry points):

```python
pytest_plugins = ['pytest_fixture_config']
```


## Specifying Configuration

To specify your variables you create a class somewhere in your plugin module,
and a singleton instance of the class which reads the variables from wherever
you want. In this example we read them from the shell environment:

```python
import os
from pytest_fixture_config import Config

class FixtureConfig(Config):
__slots__ = ('log_dir', 'log_watcher')

CONFIG=FixtureConfig(
log_dir=os.getenv('LOG_DIR', '/var/log'), # This has a default
log_watcher=os.getenv('LOG_WATCHER'), # This does not
)
```

## Using Configuration

Simply reference the singleton at run-time in your fixtures:

```python
import pytest

@pytest.fixture
def log_watcher():
return subprocess.popen([CONFIG.log_watcher, '--log-dir', CONFIG.log_dir])

def test_log_watcher(watcher):
watcher.communicate()
```

## Skipping tests when things are missing

There are some decorators that allow you to skip tests when settings aren't set.
This is useful when you're testing something you might not have installed
but don't want your tests suite to fail:

```python
from pytest_fixture_config import requires_config

@requires_config(CONFIG, ['log_watcher', 'log_dir'])
@pytest.fixture
def log_watcher():
return subprocess.popen([CONFIG.log_watcher, '--log-dir', CONFIG.log_dir])
```

There is also a version for yield_fixtures:

```python
from pytest_fixture_config import yield_requires_config

@yield_requires_config(CONFIG, ['log_watcher', 'log_dir'])
@pytest.fixture
def log_watcher():
watcher = subprocess.popen([CONFIG.log_watcher, '--log-dir', CONFIG.log_dir])
yield watcher
watcher.kill()
```

## Changelog

### 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.0
* Fix for #46 sourcing gprof2dot when the local venv has not been activated

### 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 )
* Updated devpi server server setup for devpi-server >= 2.0
* Improvements for random port picking
* HTTPD server now binds to 0.0.0.0 by default to aid Selenium-style testing
* Updated mongodb server args for mongodb >= 3.2
* Corrections for mongodb fixture config and improve startup logic
* Added module-scoped mongodb fixture
* Handling for older versions of path.py
* Fix for #40 where tests that chdir break pytest-profiling

### 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)
* Bugfix for pymongo extra dependency
* Windows compatibility fix for pytest-virtualenv (Thanks to Jean-Christophe Fillion-Robin for PR)
* Fix symlink handling for pytest-shutil.cmdline.get_real_python_executable

### 1.2.3 (2016-11-7)
* Improve resiliency of Mongo fixture startup checks

### 1.2.2 (2016-10-27)
* 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



 
File Type Py Version Uploaded on Size
pytest-fixture-config-1.2.11.tar.gz (md5) Source 2017-07-21 6KB
pytest_fixture_config-1.2.11-py2-none-any.whl (md5) Python Wheel py2 2017-07-21 7KB
pytest_fixture_config-1.2.11-py2.7.egg (md5) Python Egg 2.7 2017-07-21 4KB