pytest-helm-charts
A plugin to test helm charts on Kubernetes clusters.
Full documentation (including API) available on https://pytest-helm-charts.readthedocs.io/.
Features
This plugin provides a set of pytest fixtures that allow you to easily write tests for Helm charts and run them on Kubernetes clusters.
It can be also used to test Helm charts deployed using the Open Source Giant Swarm App Platform.
Most important features:
- provides pykube-ng interface to access Kubernetes clusters
- provides environment variables based options to configure the target cluster to run on
- provides fixtures to work with some standard Kubernetes resources as well as some custom ones:
- [Kubernetes objects](::: pytest_helm_charts.k8s)
- [Giant Swarm App Platform objects](::: pytest_helm_charts.giantswarm_app_platform)
- [Flux CD objects](::: pytest_helm_charts.flux)
- provides set of fixtures to easily work with Helm charts
Requirements
Please check [project.dependencies] list in the pyproject.toml file.
Installation
You can install "pytest-helm-charts" via pip from PyPI:
pip install pytest-helm-charts
Usage
Running your tests
When you want to run your tests, you invoke pytest as usual, just configuring cluster and chart information
using environment variables or command line options. The following options are available as environment
variables (start pytest with -h to check corresponding command line options):
- "KUBECONFIG" - (mandatory) a path to kube config file used to connect to a k8s cluster
- "ATS_CHART_PATH" - path to a chart being tested (if a chart is tested)
- "ATS_CHART_VERSION" - version of the chart being tested (if a chart is tested)
- "ATS_CLUSTER_TYPE" - type of the cluster used for testing
- "ATS_CLUSTER_VERSION" - k8s version of the cluster used for testing
- "ATS_APP_CONFIG_FILE_PATH" - optional path to a
values.yamlfile used to configure a chart under test (if a chart is tested) - "ATSEXTRA*" - any such arbitrary variable value will be extracted and included in the
test_extra_infofixture
Currently, the only supported cluster type is external, which means the cluster is not managed by the test
suite. You just point the test suite to a kube.config file, which can be used to connect to the Kubernetes
API with KUBECONFIG env variable option. For creating development time clusters, we recommend using
KinD.
If you use this project to test Helm charts against Giant Swarm App Platform, the existing cluster must
already have the platform components installed. Please refer to and use the
app-test-suite tool to easily create KinD based clusters
with all the components already installed.
Writing tests
The easiest way to get started is by checking our examples.
The list of available fixtures can be found by running pytest --fixtures, but you can also just check
the most important fixtures.
Full API docs are also available.
Contributing
Contributions are very welcome.
- Project is managed with
uv, to start developing runuv sync - Tests for all supported python versions can be run with
tox:tox -- --log-cli-level info tests/ - Please ensure the coverage at least stays the same before you submit a pull request.
Creating a new release
- merge your changes to
masterbranch - edit
pyproject.tomland update the project version; editCHANGELOG.md; commit - create a new tag with the same version in git, i.e.
git tag v1.1.1 - push your changes to GitHub to trigger a release
git push; git push origin v1.1.1
License
See LICENSE.
Changelog
See CHANGELOG.md.
Issues
If you encounter any problems, please file an issue along with a detailed description.
1 maintainer
Metadata
1 maintainer
Release files for pytest-helm-charts 1.3.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pytest_helm_charts-1.3.5.tar.gz | 31.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytest_helm_charts-1.3.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 82.3 kB
Release files / pytest_helm_charts-1.3.5.tar.gz
| Download URL | pytest_helm_charts-1.3.5.tar.gz |
|---|---|
| Size | 31.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
977ca141a09763de84f018236dcbd2c8b533c7adde97898b8c2a19537b44c872
|
|
BLAKE2b-256 checksum How to use checksums |
7b236a6cad43c09219fbd727be1da619d4c4df07a59968e4879603d7308f43d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / pytest_helm_charts-1.3.5-py3-none-any.whl
| Download URL | pytest_helm_charts-1.3.5-py3-none-any.whl |
|---|---|
| Size | 50.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e5b3db4418dc9560fc01c19b81b8e34bb8c5d749eaebf2fa9cb7dc3ec952300c
|
|
BLAKE2b-256 checksum How to use checksums |
621217e1b4fb9598b97d96b90de155725b67615c946717d2f5a396cdb7c7240b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
