README.md

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:

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

    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:

    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:

    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:

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

There is also a version for yield_fixtures:

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