openstack/python-manilaclient
Code Issues Proposed changes

Add info about functional tests run to docs

Browse Source 
Make doc with tests description up-to-date and provide there information
that describes how to run functional tests.

Partially implements bp functional-tests

Change-Id: Iad6b1d97a9c43dd24c2c6837bb71739a6f09bb1e
This commit is contained in:
vponomaryov 2015-01-14 15:57:30 +02:00 committed by Valeriy Ponomaryov
parent c36d1cd182
commit a05a48b59c
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/index.rst
View File

@ -31,12 +31,31 @@ openstack/python-manilaclient project using `Gerrit`_.
Testing
-------
The preferred way to run the unit tests is using ``tox``.
Manilaclient has two types of tests - 'unit' and 'functional'.
The preferred way to run tests is using ``tox``.
See `Consistent Testing Interface`_ for more details.
.. _Consistent Testing Interface: http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst
Functional tests
----------------
Functional CLI tests require several things to be able to run:
- Deployed and working manila service.
- Configured config file.
Config file is used to get information like 'auth_url', 'username',
'tenant_name' and 'password'.
To get config sample need to run following 'tox' job:
$ tox -e genconfig
This will create file 'etc/manilaclient/manilaclient.conf.sample' with all
available config opts.
Then rename it removing ".sample" and set values for opts there. After it,
tests can be run using following tox job:
$ tox -e functional
Indices and tables
==================