summaryrefslogtreecommitdiff
path: root/acceptance/README.md
diff options
context:
space:
mode:
authorSalim Alam <salam@chef.io>2016-01-11 16:46:00 -0800
committerSalim Alam <salam@chef.io>2016-01-12 13:29:27 -0800
commit3135bcc201d60710b4bad76f427b603869e7adb1 (patch)
tree1042dcd8a2d1c847763002747b251e585e22417d /acceptance/README.md
parent67904eae428dcd2158bd3654fad7aec7c6875f20 (diff)
downloadchef-3135bcc201d60710b4bad76f427b603869e7adb1.tar.gz
Initial 'trivial' acceptance test suite
Diffstat (limited to 'acceptance/README.md')
-rw-r--r--acceptance/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/acceptance/README.md b/acceptance/README.md
new file mode 100644
index 0000000000..b14fbbb376
--- /dev/null
+++ b/acceptance/README.md
@@ -0,0 +1,30 @@
+# Acceptance Testing for Chef Client
+This folder contains acceptance tests that are required for Chef client
+release readiness.
+
+## Getting started
+The tests use the _chef-acceptance_ gem as the high level framework.
+All the gems needed to run these tests can be installed with Bundler.
+
+```shell
+chef/acceptance$ bundle install
+```
+
+To ensure everything is working properly, run:
+
+```shell
+chef/acceptance$ bundle exec chef-acceptance info
+```
+
+To run a particular test suite, do the following:
+```shell
+chef/acceptance$ bundle exec chef-acceptance test TEST_SUITE
+```
+
+### Important Note!
+
+Before running chef-acceptance, you *MUST* do the following on your current session:
+
+```
+export APPBUNDLER_ALLOW_RVM=true
+```