From a4b6a5a341dfbbcce04705525bfd272db3a84aec Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Thu, 12 Dec 2013 13:44:16 -0800 Subject: [PATCH] Update README --- test/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/test/README.md b/test/README.md index 60d43922d..12b99ea86 100644 --- a/test/README.md +++ b/test/README.md @@ -12,7 +12,9 @@ real-world cost associated with running the tests. Be aware of that prior to running the tests. Additionally, many tests will leave left-over artifacts (AMIs) that you'll have to manually clean up. -## Required Software +## Running Tests + +### Required Software Before running the tests, you'll need the following installed. If you're running on Mac OS X, most of these are available with `brew`: @@ -21,7 +23,7 @@ running on Mac OS X, most of these are available with `brew`: * [AWS cli](http://aws.amazon.com/cli/) -## Configuring Tests +### Configuring Tests **For tests that require AWS credentials:** @@ -30,7 +32,7 @@ Set the following self-explanatory environmental variables: * `AWS_ACCESS_KEY_ID` * `AWS_SECRET_ACCESS_KEY` -## Running Tests +### Running These tests are meant to be run _one file at a time_. There are some test files (such as the amazon-chroot builder test) that simply won't @@ -40,3 +42,10 @@ never work. If you're working on Packer and want to test that your change didn't adversely affect something, try running only the test that is related to your change. + +``` +$ bats builder_amazon_ebs.bats +``` + +Note: Working directory doesn't matter. You can call the bats test file +from any directory.