Skip to main content

A pytest plugin to help with testing pop projects

Project description

A pytest plugin to help with testing pop projects


Install with pip:

pip install pytest-pop


Clone the pytest-pop repo and install with pip:

git clone
pip install -e pytest-pop

Getting the Hub

Extend the hub fixture in your so that it includes your subs:

def hub(hub):
    # TODO Add dynes that will be used for your tests
    for dyne in ("exec", "states"):
        if dyne in ("corn", "exec", "states"):
            hub.pop.sub.load_subdirs(getattr(hub, dyne), recurse=True)

    args = [
        # TODO patch in whatever cli args are necessary to run your test
    with mock.patch("sys.argv", ["pytest-pop"] + args):
        hub.pop.config.load(["pytest_pop"], "pytest_pop")

    yield hub

    # TODO Hub cleanup


Make use of pytest markers from pytest-salt-factoroies


Marks a test as needing elevated privileges. On UNIX-like systems the test will be skipped if the user running the tests is not root. On Windows systems the test will be skipped if the tests aren’t run with admin privileges.


def test_root(hub):


Marks a test as being expensive. Run pytest with the ‘–run-expensive’ flag or set the EXPENSIVE_TESTS environment variable to “True” to run these tests. By default they will be skipped


def test_expensive(hub):


Marks a test as being destructive. Run pytest with the ‘–run-destructive’ flag or set the DESTRUCTIVE_TESTS environment variable to “True” to run these tests. By default they will be skipped


def test_destructive(hub):


You can use the hub to log without setting up a logger in every single file that uses a hub


hub.log.debug("debug message")

Be sure to run pytest with ‘–cli-log-level=10’ in order to see debug messages


Get access to a fully mocked/autospecced version of the hub with:

mock_hub = hub.pop.testing.mock_hub()

A mock_hub fixture with common substitutions of real plugins is available as a fixture:

def test_thing(mock_hub):

Extend the mock hub in your own fixture:

# Scope the mock_hub to a function so that the autospec gets reset after each use.
def mock_hub(mock_hub, hub):
    # replace mocked functions with necessary real ones
    # extend this on a per-module or per-function basis if necessary
    mock_hub.sub.func = hub.sub.func
    yield mock_hub

You can now do autospec assertions on contracted functions:

import project.sub.plugin as plugin

def test_cmd_run(mock_hub):
    plugin.func(mock_hub, "arg")


Some projects, specifically idem-cloud need credentials from idem’s ctx generator. A ctx fixture exists, but it won’t work unless you override the acct_file and acct_profile fixtures:

def acct_subs() -> List[str]:
    return ["azurerm", "vultr"]

def acct_profile() -> str:
    return "test_development_idem_cloud"

Once these fixtures are overridden, the ctx fixture will become available to your test:

test_cloud_instance_present(hub, ctx):, "instance_name")


Mock a hub exec function:

with patch.object(mock_hub.exec, 'dummy', return_value="some result") as mock_exec:

Set return value for mock_hub function:

mock_hub.sub.function.return_value = "Pass"

Mock hub assert called with:

mock_hub.sub.function.assert_called_with("myinput", True)

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-pop-12.0.0.tar.gz (14.8 kB view hashes)

Uploaded source

Built Distribution

pytest_pop-12.0.0-py3-none-any.whl (13.1 kB view hashes)

Uploaded py3

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