pytest-helm 0.1.0

Simple, ergonomic Helm manifest fixtures for pytest.

pytest-helm

pytest-helm makes Helm chart testing in pytest simple and repeatable.

It runs a helm template command, loads your manifest, and then allows you to make simple assertions about it's shape/contents.

Quickstart

Install:

uv add pytest-helm

Create tests/conftest.py:

from pytest_helm import manifest_fixture

default_manifest = manifest_fixture(
    "default_manifest",
    ["helm", "template", ".", "-f", "values.yaml"],
)

multi_tenant_manifest = manifest_fixture(
    "multi_tenant_manifest",
    ["helm", "template", ".", "-f", "multi-tenant-values.yaml"],
)

Write tests:

def test_it_works(default_manifest):
    cfg_map = default_manifest["ConfigMap"]["example-config"]
    assert cfg_map.data.AWS_DEFAULT_REGION == "us-east-2"


def test_it_works_for_multi_tenants(multi_tenant_manifest):
    cfg_map = multi_tenant_manifest["ConfigMap"]["example"]
    assert cfg_map.data.AWS_DEFAULT_REGION == "us-east-2"

Fixture Usage

manifest_fixture(
    name: str,                                               # The name of the fixture
    command: Sequence[str],                                  # Command list to render manifests
    *,
    on_duplicate: Literal["error", "overwrite"] = "error",   # Whether to raise an error on duplicate manifests
    scope: Literal["session"] = "session",                   # Currently session only, execute fixtures once per test sess
)