Skip to content

NO-ISSUE: OTA-1605 Adding descriptions for building the binary and running the tests #1263

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

NO-ISSUE: OTA-1605 Adding descriptions for building the binary and running the tests #1263

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
21 changes: 17 additions & 4 deletions cmd/cluster-version-operator-tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,35 @@ It integrates [openshift-tests-extension](https://github.com/openshift-eng/opens
cluster-version-operator which allows openshift components to contribute tests to openshift-tests' suites with
extension binaries.

## Build the executable binary
In the root folder, run the following command to build the executable binary:
```console
$ make build
```

## Run the tests locally

## Using the framework
### Using the binary
- run a test-suite
```console
$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-suite <test suite name>
```
where test suites can be listed by `_output/<OS>/<ARCH>/cluster-version-operator-tests info`.

- run a single test case
```console
$ hack/build-go.sh
$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-suite cluster-version-operator
$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-test <test case name>
```
where test names can be listed by `_output/<OS>/<ARCH>/cluster-version-operator-tests list`.

## Using ginko-cli
### Using ginkgo-cli

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

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

The output looks nicer this way.

Expand Down