Skip to main content

A py.test plugin providing fixtures to simplify inmanta modules testing.

Project description


A pytest plugin to test inmanta modules


pip install pytest-inmanta


This plugin provides a test fixture that can compile, export and deploy code without running an actual inmanta server.

def test_compile(project):
        Test compiling a simple model that uses std
host = std::Host(name="server", os=std::linux)
file = std::ConfigFile(host=host, path="/tmp/test", content="1234")

The fixture also provides access to the model internals

    assert len(project.get_instances("std::Host")) == 1
    assert project.get_instances("std::Host")[0].name == "server"

To the exported resources

    f = project.get_resource("std::ConfigFile")
    assert f.permissions == 644

To compiler output and mock filesystem

def test_template(project):
        Test the evaluation of a template
    project.add_mock_file("templates", "test.tmpl", "{{ value }}")
    project.compile("""import unittest
value = "1234"

    assert project.get_stdout() == "1234\n"

And allows deploy


And dryrun

    changes = project.dryrun_resource("testmodule::Resource")
    assert changes == {"value": {'current': 'read', 'desired': 'write'}}

Testing plugins

Take the following plugin as an example:

    # <module-name>/plugins/

    from inmanta.plugins import plugin

    def hostname(fqdn: "string") -> "string":
            Return the hostname part of the fqdn
        return fqdn.split(".")[0]

A test case, to test this plugin looks like this:

    # <module-name>/tests/

    def test_hostname(project):
        host = "test"
        fqdn = f"{host}"
        assert project.get_plugin_function("hostname")(fqdn) == host
  • Line 3: Creates a pytest test case, which requires the project fixture.
  • Line 6: Calls the function project.get_plugin_function(plugin_name: str): FunctionType, which returns the plugin function named plugin_name. As such, this line tests whether host is returned when the plugin function hostname is called with the parameter fqdn.


The following options are available.

  • --venv: folder in which to place the virtual env for tests (will be shared by all tests), overrides INMANTA_TEST_ENV. This options depends on symlink support. This does not work on all windows versions. On windows 10 you need to run pytest in an admin shell.
  • --module_repo: location to download modules from, overrides INMANTA_MODULE_REPO. The default value is the inmanta github organisation.

Use the generic pytest options --log-cli-level to show Inmanta logger to see any setup or cleanup warnings. For example, --log-cli-level=INFO

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-inmanta, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size pytest-inmanta-0.8.0.tar.gz (8.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page