Metadata-Version: 2.0
Name: pytest-fixture-config
Version: 1.0.1
Summary: Fixture configuration utils for py.test
Home-page: https://github.com/manahl/pytest-plugins
Author: Edward Easton
Author-email: eeaston@gmail.com
License: MIT license
Platform: unix
Platform: linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: pytest

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:

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

.. code:: 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:

.. code:: 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:

.. code:: 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::

.. code:: 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::

.. code:: 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.0.1 (2015-12-23)
~~~~~~~~~~~~~~~~~~

-  Packaging bugfix

1.0.0 (2015-12-21)
~~~~~~~~~~~~~~~~~~

-  Initial public release



