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 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
projectfixture. - 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 whetherhostis returned when the plugin functionhostnameis 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), 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
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.
Source Distribution
File details
Details for the file pytest-inmanta-0.7.0.tar.gz.
File metadata
- Download URL: pytest-inmanta-0.7.0.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8109bad6782d85fe4653bd015211faad85fca888c7203aaf4924204afbd40d5f |
|
| MD5 | 5b8718d3dfdb6bcde8db39e1c7ffda46 |
|
| BLAKE2b-256 | cc36b205e0488dcde2667ecf59ee52f34796498a42a7e669883870d3ddb6054a |
