From 8a4cd7916b86ae5c4b3948af1d3d5a8cd599ee4b Mon Sep 17 00:00:00 2001 From: Stuart McLaren Date: Wed, 26 Aug 2015 12:33:06 +0000 Subject: [PATCH] Add documentation for running the functional tests Change-Id: I824f6cd2aa988ed1e4025765971161b44993f00a --- glanceclient/tests/functional/README.rst | 25 ++++++++++++++++++------ tox.ini | 2 ++ 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/glanceclient/tests/functional/README.rst b/glanceclient/tests/functional/README.rst index 01b732f3..123b82df 100644 --- a/glanceclient/tests/functional/README.rst +++ b/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 - OS_PASSWORD - OS_TENANT_NAME - OS_AUTH_URL +1) A working Glance/Keystone installation (eg devstack) +2) A yaml file containing valid credentials -* 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 diff --git a/tox.ini b/tox.ini index 4065c137..9c9a3df4 100644 --- a/tox.ini +++ b/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