Merge "Add documentation for running the functional tests"

glanceclient/tests/functional/README.rst

@@ -25,11 +25,24 @@ would involve a non trivial amount of work.
 Functional Test Guidelines
 ---------------------------
 
-* Consume credentials via standard client environmental variables::
+The functional tests require:
 
-    OS_USERNAME
+1) A working Glance/Keystone installation (eg devstack)
-    OS_PASSWORD
+2) A yaml file containing valid credentials
-    OS_TENANT_NAME
-    OS_AUTH_URL
 
-* Try not to require an additional configuration file
+If you are using devstack a yaml file will have been created for you.
+
+If you are not using devstack you should create a yaml file
+with the following format:
+
+ clouds:
+   devstack-admin:
+     auth:
+       auth_url: http://10.0.0.1:35357/v2.0
+       password: example
+       project_name: admin
+       username: admin
+     identity_api_version: '2.0'
+     region_name: RegionOne
+
+and copy it to ~/.config/openstack/clouds.yaml

tox.ini

@@ -22,6 +22,8 @@ commands = flake8
 commands = {posargs}
 
 [testenv:functional]
+# See glanceclient/tests/functional/README.rst
+# for information on running the functional tests.
 setenv =
   OS_TEST_PATH = ./glanceclient/tests/functional