This repository has been archived by the owner on Oct 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Add basic dev guide about how to run tests #39
Closed
peterhaochen47
wants to merge
1
commit into
cloudfoundry-incubator:master
from
peterhaochen47:add-contributing-guide
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Contributing | ||
|
|
||
| ## Dev Guide | ||
|
|
||
| ### Running test | ||
| * Unit tests: `make test-unit` (see [Makefile](/Makefile)) | ||
| * Integration tests: `make test-cluster` (see [Makefile](/Makefile)) | ||
| * Pre-requisite: A locally running k8s cluster accessible via `kubectl`. | ||
| You can use [Minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) (with the command `minikube start`) | ||
| or [kind](https://kind.sigs.k8s.io/) to start a local cluster. | ||
| * Other tests: End-to-end tests for QuarksSecret examples | ||
| * [These tests](/e2e/kube) are still incomplete and under development. They use helm to install `QuarksSecret` | ||
| onto a running k8s cluster and apply the QuarksSecret examples included in the [/docs/examples](/docs/examples) directory. | ||
| * Pre-requisites: | ||
| * A locally running k8s cluster accessible via `kubectl` (same as the integration tests). | ||
| * Edit the values in the [helm chart values file](/deploy/helm/quarks-secret/values.yaml) | ||
| to specify a `QuarksSecret` image. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't be needed, we have the
bin/test-helm-e2ehelper which should be taking care of this