fix and clarify tests READMEs #190
Conversation
openshift-ci-robot
added
retest-not-required-docs-only
size/S
tests/smoke/README.md
Outdated
| This binary accepts the `--cluster` flag to specify which tests suites should be run, e.g.: | ||
|
|
||
| ```sh | ||
| bazel-bin/tests/smoke/linux_amd64_stripped/go_default_test --cluster |
There was a problem hiding this comment.
The -cluster flag still exists, although it looks like it should be -cluster and not --cluster.
There was a problem hiding this comment.
I thought it was repeated here is all. I was thinking we could get rid of the extra explanation of the --cluster flag (I've been using --cluster, not -cluster), bc isn't it explained below, too? maybe I'm wrong, I'll take another look.
tests/smoke/README.md
Outdated
| @@ -21,29 +21,19 @@ export SMOKE_KUBECONFIG=/path/to/kubeconfig | |||
| Compile the smoke test binary from the root directory of the project: | |||
|
|
|||
| ```sh | |||
| bazel build tests/smoke | |||
| bazel build tarball smoke_tests | |||
| tar -zxf bazel-bin/tectonic-dev.tar.gz | |||
There was a problem hiding this comment.
You don't actually need to build tarball or run this tar command, do you?
+1 on the tests/smoke -> smoke_tests change. Maybe I'd broke that in #143.
There was a problem hiding this comment.
I'll check, maybe not
There was a problem hiding this comment.
yes, removed tarball and tar -zxf not required
tests/smoke/README.md
Outdated
| For example, to run the cluster suite verbosely, use the `--test.v` flag: | ||
|
|
||
| ```sh | ||
| bazel-bin/tests/smoke/linux_amd64_stripped/go_default_test --cluster --test.v |
There was a problem hiding this comment.
The -test.v flag still exists, but again, it looks like it only takes one dash.
There was a problem hiding this comment.
I've edited to take only 1 dash, but 2 dashes also still works lol
|
|
||
| * whether or not Calico network policy support is enabled; |
tests/smoke/README.md
Outdated
| @@ -56,7 +46,9 @@ export SMOKE_MANIFEST_PATHS=/path/to/kubernetes/manifests | |||
| export SMOKE_MANIFEST_EXPERIMENTAL=true | |||
| ``` | |||
|
|
|||
| To run the cluster test suite, invoke the smoke test binary with the `--cluster` flag: | |||
| To run the cluster test suite, invoke the smoke test binary with the `--cluster` flag. | |||
| To run the cluster suite verbosely, add the `--test.v` flag: | |||
There was a problem hiding this comment.
Ah, you're just consolidating the above flag examples. I'm fine with either the old way or your new consolidation there. Wherever they end up, we'll want the single-dash forms.
There was a problem hiding this comment.
ok! It felt redundant to me, as I was following along, but I'm also ok with either. The double dash 'works' because that's what I've been using, I didn't realize the single-dash was a possibility. I'll change to the single, confirm they work, also.
There was a problem hiding this comment.
edited all to have the single dash
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sallyom, wking The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
This PR adds a bit of clarity when running smoke tests (locally) against an already running cluster, as opposed to running tests/run.sh to launch a cluster for you (Does anyone use that?).