**Podsmith** is a Python toolkit for managing Kubernetes-based test dependencies, enabling dynamic or pre-provisioned environments for integration testing.
Project description
Podsmith
Podsmith is a Python toolkit for managing Kubernetes-based test dependencies, enabling dynamic or pre-provisioned environments for integration testing.
Inspired by (and supports using) Testcontainers, Podsmith lets you define service dependencies as code and run your tests locally or remotely, with full control over whether resources are deployed on-the-fly or expected to be pre-provisioned.
✨ Features
- 🛠 Deploy Kubernetes resources from Python definitions
- 🔍 Optionally reuse existing resources
- ⏳ Built-in support for readiness checks (e.g., pod status, HTTP, service endpoints)
- 🧪 Integrates with
pytest - 🚀 Works with local clusters (e.g.,
k3s,kind) or remote (usingkubectl)
✨ Planned Features
- 📦 Snapshot current test environment for reusable kubernetes manifests
- 🐳 Pre-build test images locally for publishing to pre-populate a docker registry.
🔧 Installation
pip install podsmith
🚀 Quickstart
Simple example to deploy a redis testcontainer as a Kubernetes Pod.
from podsmith import Pod
from testcontainers.redis import RedisContainer
redis_container = RedisContainer()
with Pod("redis").with_testcontainer(redis_container, service_port_map={redis_container.port: "redis"}) as redis:
# Port-forward from k8s cluster to localhost, only needed if test needs to connect to the service directly.
with redis.port_forward("redis") as port:
url = f"redis://127.0.0.1:{port}"
# Use redis service in your test
This example deploys a redis pod using a testcontainer as template, and register a Service manifest for the redis service port. When the context manager exits, the pod is deleted.
📸 (Planned) Snapshot Test Manifests
WIP -- AI generated example, not accurate.
Generate a manifest snapshot of your test environment:
podsmith snapshot --namespace test-env --output ./snapshots/
Apply in CI:
kubectl apply -f ./snapshots/
📚 (Wishful thinking) Documentation
📝 License
MIT License
🤝 Contributing
Contributions, ideas, and bug reports are welcome! Please open an issue or PR on GitHub.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file podsmith-0.5.1-py3-none-any.whl.
File metadata
- Download URL: podsmith-0.5.1-py3-none-any.whl
- Upload date:
- Size: 16.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7c17a6bb2c23a03d87c4fa05a624b3dc896799f4446e2c920cd9b40405fefda
|
|
| MD5 |
a25e002db95ac476bf3e4f271ae70d2a
|
|
| BLAKE2b-256 |
4d98b5a9fd288aaf1aff680e01e49b584246fcc2395a94d8fa5af69a350efdcf
|