Skip to content

fix and clarify tests READMEs #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-robot merged 1 commit into from
Aug 29, 2018
Merged

fix and clarify tests READMEs #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ AWS_REGION

### 2. Launch the tests
Once the environment variables are set, run `./tests/run.sh`.

## Or, if you already have a cluster running

### Follow the [smoke/README.md](./smoke/README.md).
23 changes: 7 additions & 16 deletions tests/smoke/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,18 @@ 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 smoke_tests
```

The tests can then be run by invoking the `go_default_test` binary in the `bazel-bin/tests/smoke/linux_amd64_stripped` directory.
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
```

*Note*: the `go_default_test` binary accepts several flags available to the `go test` command; to list them, invoke the `go_default_test` binary with the `--help` flag.
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
```
*Note*: the `go_default_test` binary accepts several flags available to the `go test` command; to list them, invoke the `go_default_test` binary with the `-help` flag.

## Cluster Suite

The cluster test suite runs a series of tests designed to verify the overall health of the cluster and ensure that all expected components are present.
The cluster test suite requires four additional parameters:
The cluster test suite requires additional parameters:

* whether or not Calico network policy support is enabled;
Copy link
Member

@wking wking Aug 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I'd missed this in #99.

* the number of nodes in the cluster;
* the paths of manifests deployed on the cluster; and
* whether or not to test for experimental manifests.
Expand All @@ -56,7 +45,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:

```sh
bazel-bin/tests/smoke/linux_amd64_stripped/go_default_test --cluster
bazel-bin/tests/smoke/linux_amd64_stripped/go_default_test -cluster -test.v
```