pytest-ansible-playbook 0.4.1

Installing stable release

You can install “pytest-ansible-playbook” via pip from PyPI:

$ pip install pytest-ansible-playbook

Installing latest development version

The suggested way to install from sources of current master branch is via python virtual enviroment:

$ cd pytest-ansible-playbook
$ virtualenv .env
$ source .env/bin/activate
$ pip install -e .

Note that you can use virtualenvwrapper to simplify this workflow.

Using ansible playbook fixture

The plugin provides a single pytest fixture called ansible_playbook. To specify playbooks to be executed by the fixture, use the following pytest markers:

• @pytest.mark.ansible_playbook_setup('playbook.yml')

• @pytest.mark.ansible_playbook_teardown('playbook.yml')

Note that you can list multiple playbooks in the marker if needed, eg.:

@pytest.mark.ansible_playbook_setup('playbook.01.yml', 'playbook.02.yml')

both playbooks would be executed in the given order.

Here is an example how to specify 2 playbooks to be run during setup phase of a test case and one for the teardown:

@pytest.mark.ansible_playbook_setup('setup_foo.yml', 'bar.yml')
@pytest.mark.ansible_playbook_teardown('teardown_foo.yml')
def test_foo(ansible_playbook):
    """
    Some testing is done here.
    """

While using markers without ansible_playbook fixture like this is valid:

@pytest.mark.ansible_playbook_setup('setup_foo.yml')
@pytest.mark.ansible_playbook_teardown('teardown_foo.yml')
def test_foo():
    """
    Some testing is done here.
    """

no playbook would be executed in such case.

Also note that using a marker without any playbook parameter or using the fixture without any marker is not valid and would cause an error.

Using ansible playbook runner function

Function pytest_ansible_playbook.runner is a context manager which can be used either to create a custom pytest fixture or to run playbooks within a test case.

Creating custom fixture this way is useful when you want to:

• define set of setup/teardown playbooks and use it with multiple test cases,

• run setup or teardown playbooks in any fixture scope (to overcome the fact that ansible_playbook has fuction scope),

• combine run of given setup/teardown playbooks with other non ansible setup or teardown steps (to overcome the fact that you can’t use ansible_playbook fixture to run setup/teardown for another fixture, because pytest doesn’t expect fixtures to have markers).

• specify that teardown playbooks are skipped when a test case fails

Example of simple custom fixture:

iport pytest
from pytest_ansible_playbook import runner

@pytest.fixture(scope="session")
def custom_fixture(request):
    setup_playbooks = ['setup_foo.yml', 'setup_bar.yml']
    teardown_playbooks = ['teardown_foo.yml', 'teardown_bar.yml']
    with runner(request, setup_playbooks, teardown_playbooks):
        # here comes code executed during setup, after running the setup
        # playbooks
        yield
        # here you can place code to be executed during teardown, but
        # before running the teardown playbooks

def test_bar(custom_fixture):
    assert 1 == 1

And here is an example of using the fixture inside a test case directly:

from pytest_ansible_playbook import runner

def test_foo(request):
    with runner(request, ['setup_foo.yml'], ['teardown_foo.yml']):
        # code here is executed after the setup playbooks, but before the
        # teardown ones
        assert 1 == 1

If you want to avoid running teardown playbook(s) when a test case fails, use skip_teardown argument of the runner:

with runner(
        request, teardown_playbooks=['teardown.yml'], skip_teardown=True):
    assert 1 == 0