diff options
author | Salim Alam <salam@chef.io> | 2016-01-27 10:41:14 -0800 |
---|---|---|
committer | John Keiser <john@johnkeiser.com> | 2016-01-27 11:23:10 -0800 |
commit | adf5c3412787e04f7e4347e160c5b33ef6cfad5e (patch) | |
tree | 4475b8a0a47cf49c43c6e9c5947204a0cc171d54 /acceptance | |
parent | 4b6c344fecf547b0bb949db70eef4504ab6599fd (diff) | |
download | chef-adf5c3412787e04f7e4347e160c5b33ef6cfad5e.tar.gz |
Update README
Diffstat (limited to 'acceptance')
-rw-r--r-- | acceptance/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/acceptance/README.md b/acceptance/README.md index 8f957debb2..19bd535548 100644 --- a/acceptance/README.md +++ b/acceptance/README.md @@ -13,6 +13,36 @@ Before running chef-acceptance, you *MUST* do the following on your current sess export APPBUNDLER_ALLOW_RVM=true ``` +## Pre-requisites / One time set up + +### Set up for local VM (Vagrant) + +If you intend to run the acceptance tests on a local VM, the supported solution is to use Vagrant. +Ensure that Vagrant is installed on the machine that tests will run from, along with a +virtualization driver (E.g.: VirtualBox). + +Set up the KITCHEN_DRIVER environment variable appropriately (value should be "vagrant"). E.g.: +``` +export KITCHEN_DRIVER=vagrant +``` +Add this to your shell profile or startup script as needed. + +### Set up for cloud VM (EC2) + +If you intend to run the acceptance tests on a cloud VM, the supported solution is to use EC2. + +The steps you will need to do are: + +1. Add your AWS credentials to the machine - e.g., to the ~/.aws/credentials directory. +2. Create or import a SSH key to AWS. Make sure the key name is the same as the username. +3. Copy or move the private key file (USERNAME.pem) to the SSH folder (e.g. `~/.ssh/`. Change the mode so that the file is only read-able by root (E.g.: chmod 0400 USERNAME.pem) + +4. Set up the KITCHEN_DRIVER environment variable appropriately (value should be "ec2"). E.g.: +``` +export KITCHEN_DRIVER=ec2 +``` +Add this to your shell profile or startup script as needed. + ### Setting up and running a test suite To get started, do a bundle install from the acceptance directory: ```shell @@ -35,3 +65,5 @@ To restrict which OS's will run, use the KITCHEN_INSTANCES environment variable: chef/acceptance$ export KITCHEN_INSTANCES=*-ubuntu-1404 chef/acceptance$ bin/chef-acceptance test cookbook-git ``` + +If KITCHEN_INSTANCES is not specified, the default instances are default-ubuntu-1404 and default-windows-windows-2012r2. |