Skip to content
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

Jump to bottom

Coverage target and docs #1011

Merged
merged 3 commits into from
Aug 25, 2023
Merged

Coverage target and docs #1011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04a1c87
Add coverage target
nirs Jul 30, 2023
bf1eaee
Fix spelling in quick start guide
nirs Jul 30, 2023
a19593e
Document running the tests and inspecting coverage
nirs Jul 30, 2023
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
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,9 @@ test-drcluster: generate manifests envtest
test-util-pvc: generate manifests envtest
KUBEBUILDER_ASSETS=$(KUBEBUILDER_ASSETS) go test ./controllers/util -coverprofile cover.out $(GO_TEST_GINKGO_ARGS) -ginkgo.focus PVCS_Util

coverage:
go tool cover -html=cover.out

.PHONY: venv
venv:
hack/make-venv
Expand Down
26 changes: 25 additions & 1 deletion docs/devel-quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,30 @@ enough resources:

That's all! You are ready to submit your first pull request!

## Running the tests

To run all unit tests run:

```
make test
```

To run only part of the test suite you can use one of the `test-*`
targets, for example:

```
make test-vrg-vr
```

To open an HTML coverage report in the default browser run:

```
make coverage
```

The coverage report depends on the tests ran before inspecting the
coverage.

## Setting up the `drenv` tool

*Ramen* uses the `drenv` tool to build a development environment
Expand Down Expand Up @@ -156,7 +180,7 @@ you are ready for the next steps:

## Undeploying the ramen operator

If you want to clean up your environment, you can uncofigure *Ramen* and
If you want to clean up your environment, you can unconfigure *Ramen* and
undeploy it.

```
Expand Down