
Security News
Browserslist-rs Gets Major Refactor, Cutting Binary Size by Over 1MB
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
pytest-kubernetes is a lightweight pytest plugin that makes managing (local) Kubernetes clusters a breeze. You can easily spin up a Kubernetes cluster with one pytest fixure and remove them again.
The fixture comes with some simple functions to interact with the cluster, for example kubectl(...)
that allows you to run typical kubectl commands against this cluster without worring
about the kubeconfig on the test machine.
Features:
This plugin can be installed from PyPI:
pip install pytest-kubernetes
poetry add -D pytest-kubernetes
Note that this package provides entrypoint hooks to be automatically loaded with pytest.
pytest-kubernetes expects the following components to be available on the test machine:
kubectl
minikube
(optional for minikube-based clusters)k3d
(optional for k3d-based clusters)kind
(optional for kind-based clusters)Please make sure they are installed to run pytest-kubernetes properly.
The k8s fixture provides access to an automatically selected Kubernetes provider (depending on the availability on the host). The priority is: k3d, kind, minikube-docker and minikube-kvm2.
The fixture passes a manager object of type AClusterManager.
It provides the following interface:
kubectl(...)
: Execute kubectl command against this cluster (defaults to dict
as returning format)apply(...)
: Apply resources to this cluster, either from YAML file, or Python dictload_image(...)
: Load a container image into this clusterwait(...)
: Wait for a target and a conditionport_forwarding(...)
: Port forward a targetlogs(...)
: Get the logs of a podversion()
: Get the Kubernetes version of this clustercreate(...)
: Create this cluster (pass special cluster arguments with options: List[str]
to the CLI command)delete()
: Delete this clusterreset()
: Delete this cluster (if it exists) and create it againThe interface provides proper typing and should be easy to work with.
Example
def test_a_feature_with_k3d(k8s: AClusterManager):
k8s.create()
k8s.apply(
{
"apiVersion": "v1",
"kind": "ConfigMap",
"data": {"key": "value"},
"metadata": {"name": "myconfigmap"},
},
)
k8s.apply("./dependencies.yaml")
k8s.load_image("my-container-image:latest")
k8s.kubectl(
[
"run",
"test",
"--image",
"my-container-image:latest",
"--restart=Never",
"--image-pull-policy=Never",
]
)
This cluster will be deleted once the test case is over.
Please note that you need to set "--image-pull-policy=Never" for images that you loaded into the cluster via the
k8s.load(name: str)
function (see example above).
pytest-kubernetes uses pytest marks for specifying the cluster configuration for a test case
Currently the following settings are supported:
Example
@pytest.mark.k8s(provider="minikube", cluster_name="test1", keep=True)
def test_a_feature_in_minikube(k8s: AClusterManager):
...
To write custom Kubernetes-based fixtures in your project you can make use of the following util functions.
select_provider_manager
This function returns a deriving class of AClusterManager that is not created and wrapped in a fixture yet.
select_provider_manager(name: Optional[str] = None) -> Type[AClusterManager]
The returning object gets called with the init parameters of AClusterManager, the cluster_name: str
.
Example
@pytest.fixture(scope="session")
def k8s_with_workload(request):
cluster = select_provider_manager("k3d")("my-cluster")
# if minikube should be used
# cluster = select_provider_manager("minikube")("my-cluster")
cluster.create()
# init the cluster with a workload
cluster.apply("./fixtures/hello.yaml")
cluster.wait("deployments/hello-nginxdemo", "condition=Available=True")
yield cluster
cluster.delete()
In this example, the cluster remains active for the entire session and is only deleted once pytest is done.
Note that
yield
notation that is prefered by pytest to express clean up tasks for this fixture.
You can pass more options using kwargs['options']: List[str]
to the create(options=...)
function when creating the cluster like so:
cluster = select_provider_manager("k3d")("my-cluster")
# bind ports of this k3d cluster
cluster.create(options=["--agents", "1", "-p", "8080:80@agent:0", "-p", "31820:31820/UDP@agent:0"])
Please find more examples in tests/vendor.py in this repository. These test cases are written as users of pytest-kubernetes would write test cases in their projects.
FAQs
Unknown package
We found that pytest-kubernetes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
Research
Security News
Eight new malicious Firefox extensions impersonate games, steal OAuth tokens, hijack sessions, and exploit browser permissions to spy on users.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.