diff --git a/doc/source/index.rst b/doc/source/index.rst index 3897497..15abfa7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ Contents: installation usage develsetup + testing classesdoc contributing help diff --git a/doc/source/installation.rst b/doc/source/installation.rst index f39d78b..2698e3f 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -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. diff --git a/doc/source/testing.rst b/doc/source/testing.rst new file mode 100644 index 0000000..ac94b45 --- /dev/null +++ b/doc/source/testing.rst @@ -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 `_. +#. Install docker using the `procedure `_. +#. 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 +