Merge pull request #15 from devops-coop/feature-vagrant

Add Vagrant testing environment

Author: benwebber

.gitignore

@@ -1 +1,4 @@
 *~
+
+#Vagrant Files
+.vagrant/*

README.rst

@@ -205,8 +205,35 @@ If you'd like to help with the project itself, here are some other ways you can
 
 Testing
 ~~~~~~~
+Testing can be done using the provided Vagrantfile or by installing `Docker <https://docs.docker.com/engine/installation/>`__ and `Docker Compose <https://docs.docker.com/compose/>`__ locally.
 
-This role includes a Docker-based test harness for integration testing.
+Testing with Vagrant
+"""""""""""""""""""""
+This role includes a Vagrantfile used with a Docker-based test harness that approximates the Travis CI setup for integration testing. Using Vagrant allows all contributors to test on the same platform and avoid false test failures due to untested or incompatible docker versions.
+
+1. Install `Vagrant <https://www.vagrantup.com/>`__ and `VirtualBox <https://www.virtualbox.org/>`__.
+
+2. Run ``vagrant up`` from the same directory as the Vagrantfile in this repository.
+
+3. SSH into the VM with: ``vagrant ssh``
+
+4. Run tests with ``make``.
+
+   ::
+
+       make -C /vagrant xenial64 test
+
+Integration tests use **systemd** by default. Set ``PROCESS_CONTROL`` to change this:
+
+::
+
+    make -C /vagrant trusty64 test PROCESS_CONTROL=supervisor
+
+See ``make help`` for more information including a full list of available targets.
+
+Testing with Docker and Docker Compose locally
+""""""""""""""""""""""""""""""""""""""""""""""""
+Alternatively, you can install `Docker <https://docs.docker.com/engine/installation/>`__ and `Docker Compose <https://docs.docker.com/compose/>`__ to run these tests locally on your machine.
 
 1. Install `Docker <https://docs.docker.com/engine/installation/>`__ and `Docker Compose <https://docs.docker.com/compose/>`__.
 
@@ -222,7 +249,7 @@ Integration tests use **systemd** by default. Set ``PROCESS_CONTROL`` to change
 
     make trusty64 test PROCESS_CONTROL=supervisor
 
-See ``make help`` for more information.
+See ``make help`` for more information including a full list of available targets.
 
 License
 -------

Vagrantfile

@@ -0,0 +1,38 @@
+# Defines our Vagrant environment
+#
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+$setupScript = <<SCRIPT
+echo provisioning docker...
+sudo apt-get update
+sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
+sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-trusty main'
+sudo apt-get update
+sudo apt-get -o Dpkg::Options::="--force-confnew" install --force-yes -y docker-engine=1.10.2-0~trusty
+sudo usermod -a -G docker vagrant
+sudo apt-get install python3-pip -y && sudo pip3 install --upgrade pip
+sudo pip install docker-compose==1.6.2
+
+docker version
+
+docker-compose version
+SCRIPT
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "bento/ubuntu-14.04"
+  config.vm.define "server" do |host|
+    host.vm.hostname = "server"
+    host.vm.provider "virtualbox" do |vb|
+      vb.memory = "1024"
+      vb.cpus = "1"
+      vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
+      vb.customize ["modifyvm", :id, "--natdnsproxy1", "on"]
+      vb.customize ["modifyvm", :id, "--nictype1", "virtio"]
+    end
+    host.vm.provision :shell, :inline => $setupScript
+  end
+end