2017-05-15 22:05:58 +00:00
|
|
|
# CRIO Integration Tests
|
2016-09-24 07:55:08 +00:00
|
|
|
|
2017-05-15 22:05:58 +00:00
|
|
|
Integration tests provide end-to-end testing of CRIO.
|
2016-09-24 07:55:08 +00:00
|
|
|
|
|
|
|
Note that integration tests do **not** replace unit tests.
|
|
|
|
|
|
|
|
As a rule of thumb, code should be tested thoroughly with unit tests.
|
|
|
|
Integration tests on the other hand are meant to test a specific feature end
|
|
|
|
to end.
|
|
|
|
|
|
|
|
Integration tests are written in *bash* using the
|
|
|
|
[bats](https://github.com/sstephenson/bats) framework.
|
|
|
|
|
|
|
|
## Running integration tests
|
|
|
|
|
2017-01-26 09:21:59 +00:00
|
|
|
### Containerized tests
|
|
|
|
|
2016-09-24 07:55:08 +00:00
|
|
|
The easiest way to run integration tests is with Docker:
|
|
|
|
```
|
|
|
|
$ make integration
|
|
|
|
```
|
2017-01-26 09:21:59 +00:00
|
|
|
|
2016-09-24 07:55:08 +00:00
|
|
|
To run a single test bucket:
|
|
|
|
```
|
|
|
|
$ make integration TESTFLAGS="runtimeversion.bats"
|
|
|
|
```
|
|
|
|
|
2017-01-26 09:21:59 +00:00
|
|
|
### On your host
|
2016-09-24 07:55:08 +00:00
|
|
|
|
2017-01-26 09:21:59 +00:00
|
|
|
To run the integration tests on your host, you will first need to setup a development environment plus
|
2016-09-24 07:55:08 +00:00
|
|
|
[bats](https://github.com/sstephenson/bats#installing-bats-from-source)
|
|
|
|
For example:
|
|
|
|
```
|
|
|
|
$ cd ~/go/src/github.com
|
|
|
|
$ git clone https://github.com/sstephenson/bats.git
|
|
|
|
$ cd bats
|
|
|
|
$ ./install.sh /usr/local
|
|
|
|
```
|
|
|
|
|
2017-04-06 21:57:27 +00:00
|
|
|
You will also need to install the [CNI](https://github.com/containernetworking/cni) plugins as
|
|
|
|
the the default pod test template runs without host networking:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ go get github.com/containernetworking/cni
|
|
|
|
$ cd "$GOPATH/src/github.com/containernetworking/cni"
|
|
|
|
$ git checkout -q d4bbce1865270cd2d2be558d6a23e63d314fe769
|
|
|
|
$ ./build.sh \
|
|
|
|
$ mkdir -p /opt/cni/bin \
|
|
|
|
$ cp bin/* /opt/cni/bin/
|
|
|
|
```
|
|
|
|
|
2017-01-26 09:21:59 +00:00
|
|
|
Then you can run the tests on your host:
|
|
|
|
```
|
|
|
|
$ sudo make localintegration
|
|
|
|
```
|
|
|
|
|
|
|
|
To run a single test bucket:
|
|
|
|
```
|
|
|
|
$ make localintegration TESTFLAGS="runtimeversion.bats"
|
|
|
|
```
|
|
|
|
|
|
|
|
Or you can just run them directly using bats
|
|
|
|
```
|
|
|
|
$ sudo bats test
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Runtime selection
|
|
|
|
Tests on the host will run with `runc` as the default runtime.
|
|
|
|
However you can select other OCI compatible runtimes by setting
|
|
|
|
the `RUNTIME` environment variable.
|
|
|
|
|
2018-01-18 17:47:56 +00:00
|
|
|
For example one could use the [Clear Containers](https://github.com/clearcontainers/runtime)
|
2017-01-26 09:21:59 +00:00
|
|
|
runtime instead of `runc`:
|
|
|
|
|
|
|
|
```
|
2018-01-18 17:47:56 +00:00
|
|
|
make localintegration RUNTIME=cc-runtime
|
2017-01-26 09:21:59 +00:00
|
|
|
```
|
|
|
|
|
2016-09-24 07:55:08 +00:00
|
|
|
## Writing integration tests
|
|
|
|
|
2017-11-13 15:05:27 +00:00
|
|
|
[Helper functions](https://github.com/kubernetes-incubator/cri-o/blob/master/test/helpers.bash)
|
2016-09-24 07:55:08 +00:00
|
|
|
are provided in order to facilitate writing tests.
|
|
|
|
|
|
|
|
```sh
|
|
|
|
#!/usr/bin/env bats
|
|
|
|
|
|
|
|
# This will load the helpers.
|
|
|
|
load helpers
|
|
|
|
|
|
|
|
# setup is called at the beginning of every test.
|
|
|
|
function setup() {
|
|
|
|
}
|
|
|
|
|
|
|
|
# teardown is called at the end of every test.
|
|
|
|
function teardown() {
|
|
|
|
cleanup_test
|
|
|
|
}
|
|
|
|
|
2017-11-15 15:24:20 +00:00
|
|
|
@test "crictl runtimeversion" {
|
2017-05-12 13:36:15 +00:00
|
|
|
start_crio
|
2017-11-15 15:24:20 +00:00
|
|
|
crictl runtimeversion
|
2016-09-24 07:55:08 +00:00
|
|
|
[ "$status" -eq 0 ]
|
|
|
|
}
|
|
|
|
|
|
|
|
```
|