Add documentation about tests

This commit is contained in:
Uggla 2016-03-04 14:21:12 +01:00
parent bf69f3b642
commit 23d2b09562
3 changed files with 27 additions and 1 deletions

View File

@ -15,6 +15,7 @@ Contents:
installation
usage
develsetup
testing
classesdoc
contributing
help

View File

@ -47,7 +47,7 @@ Using pip and virtualenv
4. Install using pip::
pip install python-virtualenv
pip install python-redfish
All files are installed under your virtualenv.

25
doc/source/testing.rst Normal file
View File

@ -0,0 +1,25 @@
=============
Running tests
=============
redfish module tests
--------------------
Tests are not functional for the redfish module yet.
refish-client tests
-------------------
#. Create your development environment following `Developer setup <develsetup.html>`_.
#. Install docker using the `procedure <https://docs.docker.com/engine/installation/>`_.
#. Ensure you can use docker with your current user.
#. Jump into redfish-python directory containing the sources.
#. Install required modules for testings::
pip install -t test-requirements.txt
#. Run the test::
py.test redfish-client