A py.test plugin providing fixtures to simplify inmanta modules testing.
Project description
pytest-inmanta
A pytest plugin to test inmanta modules
Installation
pip install pytest-inmanta
Usage
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
"""
project.compile("""
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"
std::print(std::template("unittest/test.tmpl"))
""")
assert project.get_stdout() == "1234\n"
And allows deploy
project.deploy_resource("std::ConfigFile")
And dryrun
changes = project.dryrun_resource("testmodule::Resource")
assert changes == {"value": {'current': 'read', 'desired': 'write'}}
Testing functions and classes defined in a module is also possible by simply importing them inside a test case, after the project fixture is initialized
def test_example(project):
from inmanta_plugins.testmodule import regular_function
regular_function("example")
Testing plugins
Take the following plugin as an example:
# <module-name>/plugins/__init__.py
from inmanta.plugins import plugin
@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/test_hostname.py
def test_hostname(project):
host = "test"
fqdn = f"{host}.something.com"
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 namedplugin_name
. As such, this line tests whetherhost
is returned when the plugin functionhostname
is called with the parameterfqdn
.
Options
The following options are available.
--venv
: folder in which to place the virtual env for tests (will be shared by all tests), overridesINMANTA_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.--use-module-in-place
: makes inmanta add the parent directory of your module directory to it's directory path, instead of copying your module to a temporary libs directory.--module_repo
: location to download modules from, overridesINMANTA_MODULE_REPO
. The default value is the inmanta github organisation.--install_mode
: install mode to use for modules downloaded during this test, overridesINMANTA_INSTALL_MODE
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.