65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
|
### Build Requirements
|
||
|
|
* A recent Go distribution (>1.6)
|
||
|
|
* If you're not on Linux, you'll need a Docker installation
|
||
|
|
* Minikube requires at least 4GB of RAM to compile, which can be problematic when using docker-machine
|
||
|
|
|
||
|
|
### Build Instructions
|
||
|
|
|
||
|
|
```shell
|
||
|
|
make
|
||
|
|
```
|
||
|
|
|
||
|
|
### Run Instructions
|
||
|
|
|
||
|
|
Start the cluster using your built minikube with:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
$ ./out/minikube start
|
||
|
|
```
|
||
|
|
|
||
|
|
### Running Tests
|
||
|
|
|
||
|
|
#### Unit Tests
|
||
|
|
|
||
|
|
Unit tests are run on Travis before code is merged. To run as part of a development cycle:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
make test
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Integration Tests
|
||
|
|
|
||
|
|
Integration tests are currently run manually.
|
||
|
|
To run them, build the binary and run the tests:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
make integration
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Conformance Tests
|
||
|
|
|
||
|
|
These are kubernetes tests that run against an arbitrary cluster and exercise a wide range of kubernetes features.
|
||
|
|
You can run these against minikube by following these steps:
|
||
|
|
|
||
|
|
* Clone the kubernetes repo somewhere on your system.
|
||
|
|
* Run `make quick-release` in the k8s repo.
|
||
|
|
* Start up a minikube cluster with: `minikube start`.
|
||
|
|
* Set these two environment variables:
|
||
|
|
```shell
|
||
|
|
export KUBECONFIG=$HOME/.kube/config
|
||
|
|
export KUBERNETES_CONFORMANCE_TEST=y
|
||
|
|
```
|
||
|
|
* Run the tests (from the k8s repo):
|
||
|
|
```shell
|
||
|
|
go run hack/e2e.go -v --test --test_args="--ginkgo.focus=\[Conformance\]" --check_version_skew=false --check_node_count=false
|
||
|
|
```
|
||
|
|
|
||
|
|
To run a specific Conformance Test, you can use the `ginkgo.focus` flag to filter the set using a regular expression.
|
||
|
|
The hack/e2e.go wrapper and the e2e.sh wrappers have a little trouble with quoting spaces though, so use the `\s` regular expression character instead.
|
||
|
|
For example, to run the test `should update annotations on modification [Conformance]`, use this command:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
go run hack/e2e.go -v --test --test_args="--ginkgo.focus=should\supdate\sannotations\son\smodification" --check_version_skew=false --check_node_count=false
|
||
|
|
```
|
||
|
|
|