Skip to main content

A Kubernetes integration test framework in Python.

Project description

kubetest

Build Status PyPI Documentation Status

Kubetest is a pytest plugin that makes it easier to manage a Kubernetes cluster within your integration tests. While you can use the Kubernetes Python client directly, this plugin provides some cluster and object management on top of that so you can spend less time setting up and tearing down tests and more time actually writing your tests. In particular, this plugin is useful for testing your Kubernetes infrastructure (e.g., ensure it deploys and behaves correctly) and for testing disaster recovery scenarios (e.g. delete a pod or deployment and inspect the aftermath).

Features:

  • Simple API for common cluster interactions.
  • Uses the Kubernetes Python client as the backend, so more complex custom actions are possible.
  • Load Kubernetes manifest YAMLs into their Kubernetes models.
  • Each test is run in its own namespace and the namespace is created and deleted automatically.
  • Detailed logging to help debug error cases.
  • Wait functions for object readiness and for object deletion.
  • Get container logs and search for expected logging output.
  • Plugin-managed RBAC permissions at test-case granularity using pytest markers.

For more information, see the kubetest documentation.

Installation

This plugin can be installed with pip

pip install kubetest

Note that the kubetest package has entrypoint hooks defined in its setup.py which allow it to be automatically made available to pytest. This means that it will run whenever pytest is run. Since kubetest expects a cluster to be set up and to be given configuration for that cluster, pytest will fail if those are not present. It is therefore recommended to only install kubetest in a virtual environment or other managed environment, such as a CI pipeline, where you can assure that cluster access and configuration are available.

Documentation

See the kubetest documentation page for details on command line usage, available fixtures and markers, and general pytest integration.

Feedback

Feedback for kubetest is greatly appreciated! If you experience any issues, find the documentation unclear, have feature requests, or just have questions about it, we'd love to know. Feel free to open an issue for any feedback you may have.

License

kubetest is released under the GPL-3.0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kubetest-0.2.1.tar.gz (46.7 kB view details)

Uploaded Source

Built Distribution

kubetest-0.2.1-py2.py3-none-any.whl (62.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file kubetest-0.2.1.tar.gz.

File metadata

  • Download URL: kubetest-0.2.1.tar.gz
  • Upload date:
  • Size: 46.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

File hashes

Hashes for kubetest-0.2.1.tar.gz
Algorithm Hash digest
SHA256 4ee93261e65b561af25095ee1bcfd51ef2b1eb5a201f1c0cc666e1c98ec448ad
MD5 23b5fdf2a1de551355b52447f1bc48cf
BLAKE2b-256 6bbc72107f5171c3f2419cae1b2955773491e092907b93535b49958b38eeca79

See more details on using hashes here.

Provenance

File details

Details for the file kubetest-0.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: kubetest-0.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 62.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

File hashes

Hashes for kubetest-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d6617adfc393c24688ca3ea6f39731cc32b99db7e881545d2f78fd5c55541c93
MD5 10898552ddbe2e7b8d3e68526a74b919
BLAKE2b-256 3ce9cd28fdce0b43f9ea6653c2b537bf9a4d1b018ec6369002d62b32883a2eb0

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page