From 8b929b30fb21b8c820555ce895dd4a87d5309e9f Mon Sep 17 00:00:00 2001 From: Chandan Kumar Date: Fri, 10 Nov 2017 17:35:16 +0530 Subject: [PATCH] Added docs for installation and running tests Change-Id: I2fef8374ff8efe9fcb5588de0c312f87f6a803e4 --- CONTRIBUTING.rst | 2 +- README.rst | 12 ++++++++++++ doc/source/installation.rst | 13 +++++++------ 3 files changed, 20 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ade0e70..9722e3f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -14,4 +14,4 @@ Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - https://bugs.launchpad.net/zaqar_tempest_plugin + https://bugs.launchpad.net/zaqar diff --git a/README.rst b/README.rst index 36fb51b..f7deecc 100644 --- a/README.rst +++ b/README.rst @@ -10,3 +10,15 @@ It contains the tempest plugin for the functional testing of Zaqar Project. * Documentation: http://docs.openstack.org/developer/zaqar * Source: http://git.openstack.org/cgit/openstack/zaqar-tempest-plugin * Bugs: http://bugs.launchpad.net/zaqar + +Running the tests +----------------- + +To run all tests from this plugin, install Zaqar into your environment +and from the tempest repo, run:: + + $ tox -e all-plugin -- zaqar_tempest_tests + +To run all tempest tests including this plugin, run:: + + $ tox -e all-plugin diff --git a/doc/source/installation.rst b/doc/source/installation.rst index ddf0fd4..a0b324b 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -2,11 +2,12 @@ Installation ============ +Tempest automatically discovers installed plugins. That's why you just need +to install the Python packages that contains the Zaqar Tempest plugin in +the same environment where Tempest is installed. + At the command line:: - $ pip install openstack - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv openstack - $ pip install openstack + $ git clone https://git.openstack.org/openstack/zaqar-tempest-plugin + $ cd zaqar-tempest-plugin/ + $ pip install zaqar-tempest-plugin