A plugin to test helm charts on Kubernetes clusters.
Full documentation (including API) available on https://pytest-helm-charts.readthedocs.io/.
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 command line options to configure the target cluster to run on
- supports custom resource for the Giant Swarm App Platform:
- provides set of fixtures to easily work with Helm charts
- python 3.7+
- pytest 5.4.2+
- pykube-ng = 20.7.0+
You can install "pytest-helm-charts" via pip
from PyPI
:
$ pip install pytest-helm-charts
When you want to run your tests, you invoke pytest
as usual, just passing additional
flags on the command line. You can inspect them directly by running pytest -h
and
checking the "helm-charts" section.
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 --kube-config
command line
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 kube-app-testing
tool to easily
create KinD based clusters with all the components already installed.
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.
Contributions are very welcome.
- Project is managed with
poetry
, to start developing runpoetry install
- Tests for all supported python versions can be run with
tox
:poetry run tox -- --log-cli-level info tests/
- Please ensure the coverage at least stays the same before you submit a pull request.
See LICENSE.
See CHANGELOG.md.
If you encounter any problems, please file an issue along with a detailed description.