hydrophone

Lightweight runner for kubernetes tests. Uses the conformance image(s) released by the kubernetes release team to either run individual tests or the entire Conformance suite. Design is pretty simple, it starts the conformance image as a pod in the conformance namespace, waits for it to finish and then prints out the results.

Project Goals

Simplified Kubernetes Testing: Easy-to-use tool for running Kubernetes conformance tests.
Official Conformance Images: Utilize official conformance images from the Kubernetes Release Team.
Flexible Test Execution: Ability to run individual test, the entire Conformance Test Suite, or anything in between.

Project Non-Goals

Replacing Kubernetes Testing Frameworks: Not intended to replace existing frameworks, but to complement them.
Extensive Test Development: Focus is on running existing tests, not developing new ones.
Broad Tool Integration: Limited integration with third-party tools; maintains simplicity.

Getting Started

For a comprehensive quickstart guide, see our Quickstart Guide which will get you running Hydrophone in minutes!

Prerequisites

Ensure you have Go installed on your system and the GOPATH is set. You will also need access to a Kubernetes cluster.

Install

Install Hydrophone using the following command:

$ go install sigs.k8s.io/hydrophone@latest

Alternatively you can download the latest release from the releases page

Running Tests

Ensure there is a KUBECONFIG environment variable specified or $HOME/.kube/config file present before running hydrophone Alternatively, you can specify the path to the kubeconfig file with the --kubeconfig option.

To run conformance tests use:

$ bin/hydrophone --conformance

To run a specific test use:

$ bin/hydrophone --focus 'Simple pod should contain last line of the log'

To specify a version of conformance image use:

$ bin/hydrophone --conformance-image 'registry.k8s.io/conformance:v1.34.1'

Community

Please reach out for bugs, feature requests, and other issues! The maintainers of this project are reachable via:

Kubernetes Slack in the [#hydrophone], [#sig-testing] and [#k8s-conformance] channels
Filing an issue against this repo
The Kubernetes SIG-Testing Mailing List and SIG-Release Mailing List

Current maintainers are @dims and @rjsadow - feel free to reach out if you have any questions!

Pull Requests are very welcome! If you're planning a new feature, please file an issue to discuss first.

Check the issue tracker for help wanted issues if you're unsure where to start, or feel free to reach out to discuss. 🙂

See also: our own contributor guide and the Kubernetes community page.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!