summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2015-05-14 07:06:05 -0400
committerSean Dague <sean@dague.net>2015-05-14 10:48:01 -0400
commit6379287480bf6bc0a8f80bc93f01005a31882aec (patch)
tree247067c738811458e74d835713a01c521ee42010 /README.rst
parent0e35f2a2fabe5beae065cc92c44f653ff76e6558 (diff)
downloadpython-novaclient-6379287480bf6bc0a8f80bc93f01005a31882aec.tar.gz
pass credentials via config file instead of magic
Passing credentials via an assumed environment inheritance is bad form, and breaks under new tox. Honestly, we only really need 2 vars passed in, so we might as well make it a config file that we'll parse. Add a functional_creds.conf.sample for people to know what one should look like. Update README to explain it. Related-Bug: #1455102 Change-Id: Ifdab38a03c94f51d30449149c0dbd9c6265460a5
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 84bf9c17..edf26ec6 100644
--- a/README.rst
+++ b/README.rst
@@ -83,3 +83,16 @@ To use with nova, with keystone as the authentication system::
* Documentation: http://docs.openstack.org/developer/python-novaclient
* Source: http://git.openstack.org/cgit/openstack/python-novaclient
* Bugs: http://bugs.launchpad.net/python-novaclient
+
+Testing
+-------
+
+There are multiple test targets that can be run to validate the code.
+
+* tox -e pep8 - style guidelines enforcement
+* tox -e py27 - traditional unit testing
+* tox -e functional - live functional testing against an existing
+ openstack
+
+Functional testing assumes the existance of a functional_creds.conf in
+the root directory. See the .sample for example format.