-
Notifications
You must be signed in to change notification settings - Fork 28
/
README.md
99 lines (64 loc) · 3.62 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# hydrophone
![Kubernetes Logo](https://raw.githubusercontent.com/kubernetes-sigs/kubespray/master/docs/img/kubernetes-logo.png)
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
### 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:
```bash
$ go install sigs.k8s.io/hydrophone@latest
```
Alternatively you can download the latest release from the [releases page](https://github.com/kubernetes-sigs/hydrophone/releases)
### 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:
```bash
$ bin/hydrophone --conformance
```
To run a specific test use:
```bash
$ bin/hydrophone --focus 'Simple pod should contain last line of the log'
```
To specify a version of conformance image use:
```bash
$ bin/hydrophone --conformance-image 'registry.k8s.io/conformance:v1.30.2'
```
## 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].
<!--links-->
[Kubernetes Code of Conduct]: code-of-conduct.md
[community page]: https://kubernetes.io/community/
[contributor guide]: CONTRIBUTING.md
[issue tracker]: https://github.com/kubernetes-sigs/hydrophone/issues
[@dims]: https://github.com/dims
[@rjsadow]: https://github.com/rjsadow
[filing an issue]: https://github.com/kubernetes-sigs/hydrophone/issues/new
[Kubernetes Slack]: http://slack.k8s.io/C06E3NPR4A3
[SIG-Testing Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-testing
[SIG-Release Mailing List]: https://groups.google.com/forum/#!forum/kubernetes-sig-release
[Conformance suite]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md