/hatbox

A Vagrant Behat Box

Primary LanguageShell

Hatbox - A Vagrant Behat Box

Vagrant files to build a Vagrant Box for Behat behavior-driven development tests of PHP applications and websites.

This code will build a virtual machine to run Behat and Mink behavior-driven tests, also known as functional or acceptance testing.

  • Behat is an open source behavior-driven development framework for PHP (version 5.3 and greater).
  • Mink is a browser emulator abstraction layer. It hides emulator differences behind a single, consistent API.

Installation

Prerequisites: Vagrant should be installed and working on your system with NFS file sharing. If it is not, see: Prerequisites below.

Step 1: Clone the Hatbox Repo

git clone git@github.com:seanbuscay/hatbox.git

Step 2: (Optional) Configure the Vagrant Box

You may make changes to some of the configurations for the Vagrant box.

To do so, edit the file: config/default/default/vagrant_config.yml.

Comments in the config file provide explanations about the variables which may be changed and their settings.

Step 3: Start the Vagrant Box

Use the terminal to move into the directory in which you cloned the repo. For example:

cd ~/workspace/hatbox

Start the Vagrant Box with:

vagrant up

It will take several minutes to configure the virtual machine when running this command for the first time.

Subsequent runs will be much faster.

In order to use NFS (set by default) Vagrant may ask you to enter your host machine password. You should enter your sudo user password.

Usage

Login

After you have started the virtual machine, you may ssh into hatbox with the following command:

vagrant ssh

You will be logged into the virtual machine and you should see a prompt like: vagrant@hatbox:/vagrant$

Run the Example Tests

The Behat documentation site provides a tutorial about developing web applications with behat and mink. The example tests in this tutorial are already in hatbox. To run the example tests, within your Vagrant shell:

  1. Move into the examples directory: cd /vagrant/examples
  2. Run the tests with the behat command: behat

See the following sections of the Behat and Mink tutorial for an explanation of what the tests are doing and what you should expect to see when the tests run.

Run Your Own Tests

From your host machine, clone or copy your behat tests into share/workspace .

You can just clone your whole project into the workspace directory if you like.

Then:

  1. Login - vagrant ssh
  2. Change directories into your project's tests directory.
  3. Run behat

An example workflow

  1. As a QA manager, you oversee QA on a number of websites.
  2. You have three websites you want to run behat tests on.
  3. Each website exists at its own git repo:
  • github.com:your-org/site-a.git
  • github.com:your-org/site-b.git
  • github.com:client-org/site-c.git

  1. Each website repo has a directory structure like:

     tests
 tests/features
 docroot
 docroot/index.php
 ...

  2. On your host system, you clone each repo into the hatbox workspace:

     cd cd ~/workspace/hatbox/share/workspace
 git clone git@github.com:your-org/site-a.git
 git clone git@github.com:your-org/site-b.git
 git clone git@github.com:client-org/site-c.git

  3. Then login to hatbox - vagrant ssh

  4. And run the tests for each site, putting the results into an html report per site:

     behat site-a/tests -c site-a/tests/behat.yml -f html --out site-a.html
 behat site-b/tests -c site-b/tests/behat.yml -f html --out site-b.html
 behat site-c/tests -c site-c/tests/behat.yml -f html --out site-c.html

  5. Now read the html reports :)

Shutting Down

Exit the hatbox (Vagrant ssh) shell with this command:

exit;

Suspend hatbox (save it in its current state) with:

vagrant suspend

After a suspend, you can resume using hatbox by running:

vagrant resume

You can also shutdown hatbox with the command:

vagrant halt

Important: If you shutdown hatbox, you must start it with the --provision option like so:

vagrant up --provision

This command will not re-install all the software again. It will force a restart of the selenium server and the dependencies required to run headless browser tests.

Prerequisites

Install Vagrant and Virtual Box

To get Vagrant running on your system, follow these steps:

  1. Install VirtualBox - https://www.virtualbox.org/wiki/Downloads
  2. Install Vagrant - http://docs.vagrantup.com/v2/installation/index.html
  3. (Optional) To keep your Vagrant Box Utilities in sync with your Virtual Box Version, install the "vbguest plugin" with the following command:
vagrant plugin install vagrant-vbguest

Verify NFS is Running

Make sure NFS is running on your (host) system.

NFS comes pre-installed on OSX 10.5+.

See: Network File System (NFS) for Linux systems.

Troubleshooting NFS

In OSX, to verify NFS is running, run the following command in the terminal:

sudo nfsd start

You should see an output like this:

The nfsd service is already running.

If you do not see the output above, follow the instructions in this wiki:

http://wiki.xbmc.org/?title=NFS#NFS_sharing_from_OS_X

If you get a message about the NFS Export File being invalid, this is a known issue with Vagrant.

Run the commands below to fix it:

sudo rm /etc/exports
sudo touch /etc/exports
vagrant halt
vagrant up --provision

Finally, if you cannot get NFS to work on your host system, you may turn off NFS file sharing by editing the Vagrant file and changing the following:

from:

config.vm.synced_folder vm_conf['host_path'], vm_conf['guest_path'], type: "nfs"

to:

config.vm.synced_folder vm_conf['host_path'], vm_conf['guest_path']

Roadmap

TODO: Add Jenkins or other tool to graph results over time.