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.
Metadata
Release files for podsmith 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| podsmith-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for podsmith-0.5.2-py3-none-any.whl |
Release files / podsmith-0.5.2-py3-none-any.whl
| Download URL | podsmith-0.5.2-py3-none-any.whl |
|---|---|
| Size | 17.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b899439753593e497ae35ca81830aee8a8b9bd6752751dee282a844ff21413b
|
|
BLAKE2b-256 checksum How to use checksums |
11972cdb1f4680c40895bd204a070cdc0feb598a5f43525873fd87ee212e511b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.13
|
Security for podsmith 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.