test

README

flynn-test

flynn-test contains full-stack acceptance tests for Flynn.

Usage

Bootstrap Flynn

The tests need a running Flynn cluster, so you will need to boot one first.

To run Flynn locally, first boot and SSH to the Flynn dev box:

vagrant up
vagrant ssh

then build and bootstrap Flynn (this may take a few minutes):

make
script/bootstrap-flynn

Run the tests

Run the flynn cluster add command from the bootstrap output to add the cluster to your ~/.flynnrc file, then run the tests:

flynn cluster add ...
cd ~/go/src/github.com/flynn/flynn/test
bin/flynn-test --flynnrc ~/.flynnrc --cli `pwd`/../cli/bin/flynn

Auto booting clusters

The test binary is capable of booting its own cluster to run the tests against, provided you are using a machine capable of running KVM.

Build root filesystem + kernel

Before running the tests, you need a root filesystem and a Linux kernel capable of building and running Flynn.

To build these into /tmp/flynn:

mkdir -p /tmp/flynn
sudo rootfs/build.sh /tmp/flynn

You should now have /tmp/flynn/rootfs.img and /tmp/flynn/vmlinuz.

Build the tests

go build -o flynn-test

Download Flynn CLI

The tests interact with the VM cluster using the Flynn CLI, so you will need it locally.

Download it into the current directory:

curl -sL -A "`uname -sp`" https://dl.flynn.io/cli | zcat >flynn
chmod +x flynn

Run the tests

sudo ./flynn-test \
  --user `whoami` \
  --rootfs /tmp/flynn/rootfs.img \
  --kernel /tmp/flynn/vmlinuz \
  --cli `pwd`/flynn

CI

Bootstrap a Flynn cluster

Follow the installation docs to install and bootstrap a Flynn cluster with CLUSTER_DOMAIN=ci.flynn.io on the CI box:

curl -fsSL -o install-flynn https://dl.flynn.io/install-flynn
sudo bash install-flynn
sudo systemctl start flynn-host
CLUSTER_DOMAIN=ci.flynn.io flynn-host bootstrap
flynn cluster add -p <tls-pin> default ci.flynn.io <controller-key>

Create a directory to store CI build images (this should be on a fast disk to minimise IO wait when building clusters, ideally a large tmpfs):

sudo mkdir -p /opt/flynn-test

Create the CI app

In your dev environment, build Flynn:

make

run the CI setup script:

test/scripts/setup.sh

add the necessary environment variables (assuming the Flynn CI cluster is configured as flynn-ci in your ~/.flynnrc):

flynn -c flynn-ci -a ci env set AUTH_KEY=xxxxxxxxxx
flynn -c flynn-ci -a ci env set BLOBSTORE_S3_CONFIG=xxxxxxxxxx
flynn -c flynn-ci -a ci env set BLOBSTORE_GCS_CONFIG=xxxxxxxxxx
flynn -c flynn-ci -a ci env set BLOBSTORE_AZURE_CONFIG=xxxxxxxxxx
flynn -c flynn-ci -a ci env set GITHUB_TOKEN=xxxxxxxxxx
flynn -c flynn-ci -a ci env set AWS_ACCESS_KEY_ID=xxxxxxxxxx
flynn -c flynn-ci -a ci env set AWS_SECRET_ACCESS_KEY=xxxxxxxxxx

scale up the runner process:

flynn -c flynn-ci -a ci scale runner=1

add a route with the CI TLS key and certificate:

flynn -c flynn-ci -a ci route add http -s ci-web -c <ci.crt> -k <ci.key> ci.flynn.io

CI should now be up and running at https://ci.flynn.io.

Deploy the CI app

If the CI code has been changed, rebuild Flynn in your dev environment:

make

Then re-run the CI setup script which will upload the built CI image and deploy the app:

test/scripts/setup.sh

If the rootfs needs rebuilding, you will need to scale down the runner process and remove the existing image before deploying and then scaling the runner back up:

flynn -c flynn-ci -a ci scale runner=0
test/scripts/setup.sh
ssh <ci-box> sudo rm -rf /opt/flynn-test/build/{rootfs.img,vmlinuz}
flynn -c flynn-ci -a ci scale runner=1