Skip to content

Commit 1cc621c

Browse files
committed
README: Enhancement for OTE
Adding descriptions for building the binary and running the tests
1 parent df1ec55 commit 1cc621c

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

cmd/cluster-version-operator-tests/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,35 @@ It integrates [openshift-tests-extension](https://github.com/openshift-eng/opens
44
cluster-version-operator which allows openshift components to contribute tests to openshift-tests' suites with
55
extension binaries.
66

7+
## Build the executable binary
8+
In the root folder, run the following command to build the executable binary:
9+
```console
10+
$ make build
11+
```
712

813
## Run the tests locally
914

10-
## Using the framework
15+
### Using the binary
16+
- run a test-suite
17+
```console
18+
$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-suite <test suite name>
19+
```
20+
where test suites can be listed by `_output/<OS>/<ARCH>/cluster-version-operator-tests info`.
21+
22+
- run a single test case
1123
```console
12-
$ hack/build-go.sh
13-
$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-suite cluster-version-operator
24+
$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-test <test case name>
1425
```
26+
where test names can be listed by `_output/<OS>/<ARCH>/cluster-version-operator-tests list`.
1527

16-
## Using ginko-cli
28+
### Using ginkgo-cli
1729

1830
After [installing-ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo):
1931

2032
```console
2133
$ ginkgo ./test/...
2234
```
35+
or run a specific test via `--focus` provided by [ginkgo-cli](https://onsi.github.io/ginkgo/#description-based-filtering).
2336

2437
The output looks nicer this way.
2538

0 commit comments

Comments
 (0)