Skip to content

testing.rst

Latest commit

 

History

History
197 lines (143 loc) · 6.24 KB

testing.rst

File metadata and controls

197 lines (143 loc) · 6.24 KB
title:Testing Deis
description:How to test Deis

Testing Deis

Deis is a distributed system with many moving parts, which makes it of paramount importance to test every change thoroughly.

Deis is also a set of components that correspond to directories in the source code repository. Most components are Docker containers, two are command-line clients, and one contains the documentation. Components have source-code level unit tests and black-box type functional tests. integration tests verify the behavior of the components together as a system.

GitHub pull requests for Deis are tested automatically by a Jenkins continuous integration (CI) system at http://ci.deis.io. Contributors should run the same tests locally before proposing any changes to the Deis codebase.

Set Up the Environment

To run all tests, you will need:

  • Vagrant 1.6.5 or later
  • VirtualBox 4.3 or later
  • Docker 1.3.0
  • PostgreSQL server

The tests assume that you have Deis' source code in your $GOPATH:

$ go get -u -v github.com/deis/deis
$ cd $GOPATH/src/github.com/deis/deis

Disable Docker TLS

If you aren't using Linux, your Docker client probably talks to a Docker server over a TCP connection, as in boot2docker. Since Docker 1.3.0, that connection is secured with TLS. Deis' tests use Docker client code directly, but don't yet incorporate TLS changes.

For now, you must disable Docker TLS to run Deis' functional tests. Here is how to revert to plain TCP for boot2docker 1.3.0. You will add the line DOCKER_TLS="" to line 24 of /etc/init.d/docker in your boot2docker VM, so that section will look like this:

start() {
    DOCKER_TLS=""  # <- Add this line and save!
    # Not enabling Docker daemon TLS by default.
    if [ "$DOCKER_TLS" != "" ]; then

Open a shell to the boot2docker VM, make the change, and restart docker:

$ boot2docker up && boot2docker ssh
$ sudo vi /etc/init.d/docker  # edit as above, and save
$ sudo /etc/init.d/docker restart
$ exit

Back on your host machine, ensure your DOCKER_HOST environment variable uses port 2375:

$ export DOCKER_HOST=tcp://192.168.59.103:2375
$ unset DOCKER_TLS_VERIFY
$ docker info
Containers: 34
...

Start a Docker Registry

Deis' functional tests build Docker images and test them locally. The images are then pushed to a Docker registry so that integration tests can test them as binary artifacts--just as a real-world provisioning of Deis pulls images from the Docker Hub.

If you don't have a Docker registry already accessible for your testing or for continuous deployment, start one locally:

$ make dev-registry
registry

To use local boot2docker registry for Deis development:
    export DEV_REGISTRY=192.168.59.103:5000

Run the Tests

The unit and functional tests for each component are in their respective directories. The integration tests, scripts, and supporting go packages are in the tests/ directory in the project root.

Scripts in the tests/bin directory are the best place to start. These test individual pieces of Deis, then bring up a Vagrant cluster and test all of them as a system. They call tests/bin/test-setup.sh to test for important environment variables and will exit with a helpful message if any are missing.

test-integration.sh

  • runs documentation tests
  • builds Docker images tagged with $BUILD_TAG
  • runs unit and functional tests
  • creates a 3-node Vagrant CoreOS cluster
  • pushes the Docker images to a registry
  • provisions the cluster for Deis with the registry images
  • runs all integration tests
  • takes roughly an hour
$ ./tests/bin/test-integration.sh

>>> Preparing test environment <<<

DEIS_ROOT=/Users/matt/Projects/src/github.com/deis/deis
DEIS_TEST_APP=example-go
...
>>> Running integration suite <<<

make -C tests/ test-full
...
>>> Test run complete <<<

test-smoke.sh

  • runs documentation tests
  • builds Docker images tagged with $BUILD_TAG
  • runs unit and functional tests
  • creates a 3-node Vagrant CoreOS cluster
  • pushes the Docker images to a registry
  • provisions the cluster for Deis with the registry images
  • runs a "smoke test" that pushes and scales an app
  • takes roughly 45 minutes

test-latest.sh

  • installs the latest deis and deisctl client releases
  • creates a 3-node Vagrant CoreOS cluster
  • provisions the cluster for Deis with latest release images
  • runs a "smoke test" that pushes and scales an app
  • takes roughly 30 minutes

Run Specific Tests

Run the tests for a single component this way:

$ make -C logger test             # unit + functional
$ make -C controller test-unit
$ make -C router test-functional

Customize Test Runs

The file tests/bin/test-setup.sh is the best reference to environment variables that can affect the tests' behavior. Here are some important ones:

  • HOST_IPADDR - address on which Docker containers can communicate for the functional tests, probably the host's IP or the one assigned to boot2docker.
  • DEIS_TEST_APP - name of the Deis example app to use, which is cloned from GitHub (default: example-go)
  • DEIS_TEST_AUTH_KEY - SSH key used to register with the Deis controller (default: ~/.ssh/deis)
  • DEIS_TEST_SSH_KEY - SSH key used to login to the controller machine (default: ~/.vagrant.d/insecure_private_key)
  • DEIS_TEST_DOMAIN - the domain to use for testing (default: local3.deisapp.com)