From 29fcefc67ad2005bd2ef4615d63c0e4876ffd794 Mon Sep 17 00:00:00 2001 From: kairat_kushaev Date: Mon, 1 Feb 2016 12:43:42 +0300 Subject: [PATCH] Fix warnings in glanceclient README README.rst file for functional tests and glanceclient itself raises some warnings when passing these docs through REST validator and build the doc: - Need additional empty line to provide correct indent in cloud.yaml example - Title should be with the same length as overline. The patch fixes these warnings. Change-Id: I2e2ef6f838ee639d1a88256b6e321181a62cc76b --- README.rst | 2 +- glanceclient/tests/functional/README.rst | 15 ++++++++++----- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 13350f57..4e08b6a1 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ Python bindings to the OpenStack Images API -============================================= +=========================================== .. image:: https://img.shields.io/pypi/v/python-glanceclient.svg :target: https://pypi.python.org/pypi/python-glanceclient/ diff --git a/glanceclient/tests/functional/README.rst b/glanceclient/tests/functional/README.rst index 123b82df..ff639508 100644 --- a/glanceclient/tests/functional/README.rst +++ b/glanceclient/tests/functional/README.rst @@ -1,9 +1,9 @@ -===================================== +====================================== python-glanceclient functional testing -===================================== +====================================== Idea ------- +---- Run real client/server requests in the gate to catch issues which are difficult to catch with a purely unit test approach. @@ -13,7 +13,7 @@ the gate. Testing Theory ----------------- +-------------- Since python-glanceclient has two uses, CLI and python API, we should have two sets of functional tests. CLI and python API. The python API @@ -23,7 +23,7 @@ would involve a non trivial amount of work. Functional Test Guidelines ---------------------------- +-------------------------- The functional tests require: @@ -39,10 +39,15 @@ with the following format: 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