Skip to content

doc : add ginkgo prerequisite and running tests section #1570

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
rohanKanojia wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

doc : add ginkgo prerequisite and running tests section #1570

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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ To build, test and debug the DevWorkspace Operator the following development too
- yq (python-yq from <https://github.com/kislyuk/yq#installation>, other distributions may not work)
- skopeo (if building the OLM catalogsource)
- podman or docker
- ginkgo (required for running tests locally)

Note: kustomize `v4.0.5` is required for most tasks. It is downloaded automatically to the `.kustomize` folder in this
repo when required. This downloaded version is used regardless of whether or not kustomize is already installed on the
Expand Down Expand Up @@ -258,6 +259,24 @@ when you are done debugging you have to manually uninstall the telepresence agen
make disconnect-debug-webhook-server
```

### Running Tests

To run tests locally, you need to have `ginkgo` installed. Install it using:

```bash
go install github.com/onsi/ginkgo/v2/ginkgo@latest
```

Ensure that `$GOPATH/bin` or `$GOBIN` is added to your `$PATH` so that `ginkgo` can be found.

Then run the tests:

```bash
make test
```

This will run all unit tests and controller tests. The Makefile will automatically use `ginkgo` if it's available in your `$PATH`, otherwise it will fall back to `go test` (though `ginkgo` is recommended for the full test suite).

### Updating devfile API

[devfile API](https://github.com/devfile/api) is the Kube-native API for cloud development workspaces specification and the core dependency of the devworkspace-operator that should be regularly updated to the latest version. In order to do the update:
Expand Down
Loading