-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #149 from jabdoa2/update_ginkgo
Update ginkgo
- Loading branch information
Showing
20 changed files
with
56 additions
and
123 deletions.
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 |
---|---|---|
@@ -1,38 +1,45 @@ | ||
# Contributing | ||
|
||
To develop on this project, please fork the repo and clone into your `$GOPATH`. | ||
To develop on this project, please fork and clone the repo. | ||
|
||
Dependencies are **not** checked in so please download those separately. | ||
Download the dependencies using [`dep`](https://github.com/golang/dep). | ||
You can check dependencies using: | ||
|
||
```bash | ||
cd $GOPATH/src/github.com # Create this directory if it doesn't exist | ||
git clone [email protected]:<YOUR_FORK>/wave wave-k8s/wave | ||
go mod tidy | ||
make tidy | ||
``` | ||
|
||
## Testing | ||
|
||
Tests in Wave are run using a tool called [`ginkgo`](https://github.com/onsi/ginkgo). | ||
The tests use [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) tooling | ||
to run an etcd and kube-apiserver locally on during tests. | ||
|
||
To prepare your machine for testing, run the `configure` script: | ||
You can install dependencies (into `$PWD/bin`) using: | ||
|
||
```bash | ||
make envtest | ||
``` | ||
./configure | ||
|
||
Tests in Wave are run using `go test` (which can be used to run them selectively). | ||
|
||
You can run the full test suite locally using: | ||
|
||
```bash | ||
make test | ||
``` | ||
|
||
If you have any missing tools, there are `make` targets for setting up the testing | ||
environment, run one of the following to set up Kubernetes environments for Kubernetes | ||
versions 1.11, 1.12 and 1.13 respectively: | ||
You can run the linter locally using: | ||
|
||
- `touch .env && make prepare-env-1.11` | ||
- `touch .env && make prepare-env-1.12` | ||
- `touch .env && make prepare-env-1.13` | ||
```bash | ||
make lint | ||
``` | ||
|
||
If you want to debug/test github actions locally you can use [act](https://github.com/nektos/act). | ||
Follow the [act install instructions](https://nektosact.com/installation/index.html). | ||
Then simply run tests using: | ||
|
||
This target is defined in [Makefile.tools](Makefile.tools) and we recommend that | ||
you review the Makefile before you install the tooling. | ||
```bash | ||
act | ||
``` | ||
|
||
## Pull Requests and Issues | ||
|
||
|
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Oops, something went wrong.