kubernetes-sigs / hydrophone

Hydrophone is a lightweight Kubernetes conformance tests runner
Apache License 2.0
62 stars 30 forks source link

Incorrect description for --test-repo flag in hydrophone help output #206

Closed jonas-be closed 1 month ago

jonas-be commented 1 month ago

Hi all, as you can see in the hydrohpone -h output below, the --test-repo has the same description as the --skip flag.

Hydrophone is a lightweight runner for Kubernetes tests.

Usage:
  hydrophone [flags]

Flags:
      --busybox-image string        specify an alternate busybox container image. (default "registry.k8s.io/e2e-test-images/busybox:1.36.1-1")
      --cleanup                     cleanup resources (pods, namespaces etc).
  -c, --config string               path to an optional base configuration file.
      --conformance                 run conformance tests.
      --conformance-image string    specify a conformance container image of your choice.
      --continue                    connect to an already running conformance test pod.
      --dry-run                     run in dry run mode.
      --extra-args strings          Additional parameters to be provided to the conformance container. These parameters should be specified as key-value pairs, separated by commas. Each parameter should start with -- (e.g., --clean-start=true,--allowed-not-ready-nodes=2)
      --extra-ginkgo-args strings   Additional parameters to be provided to Ginkgo runner. This flag has the same format as --extra-args.
      --focus string                focus runs a specific e2e test. e.g. - sig-auth. allows regular expressions.
  -h, --help                        help for hydrophone
      --kubeconfig string           path to the kubeconfig file.
      --list-images                 list all images that will be used during conformance tests.
  -n, --namespace string            the namespace where the conformance pod is created. (default "conformance")
  -o, --output-dir string           directory for logs. (default ".")
  -p, --parallel int                number of parallel threads in test framework (automatically sets the --nodes Ginkgo flag). (default 1)
      --skip string                 skip specific tests. allows regular expressions.
      --startup-timeout duration    max time to wait for the conformance test pod to start up. (default 5m0s)
      --test-repo string            skip specific tests. allows regular expressions.
      --test-repo-list string       yaml file to override registries for test images.
  -v, --verbosity int               verbosity of test framework (values >= 6 automatically sets the -v Ginkgo flag). (default 4)

I believe the correct description for --test-repo should be registry for pulling Kubernetes test images or something similar. Can someone confirm if my understanding of this flag is correct? I would be happy to contribute by changing the description in both the documentation and the source code.

rjsadow commented 1 month ago

Hey @jonas-be, thanks for raising this. Whould be an easy fix. I'll get it updated this weekend.

jonas-be commented 1 month ago

Hi @rjsadow,

Thanks for confirming the issue! If it’s okay with you, I’d like to contribute by making the changes myself and submitting a PR. Please let me know if that works for you.

Thanks!

rjsadow commented 1 month ago

Absolutely! Please let me know if you have ant questions. /assign @jonas-be