diff options
Diffstat (limited to 'utils/test/testapi/README.rst')
| -rw-r--r-- | utils/test/testapi/README.rst | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/utils/test/testapi/README.rst b/utils/test/testapi/README.rst new file mode 100644 index 000000000..44ab2a475 --- /dev/null +++ b/utils/test/testapi/README.rst @@ -0,0 +1,64 @@ +============= +opnfv-testapi +============= + +Test Results Collector of OPNFV Test Projects + +Start Server +============== + +Getting setup +^^^^^^^^^^^^^ + +Requirements for opnfv-testapi: + +* tornado +* epydoc + +These requirements are expressed in the requirements.txt file and may be +installed by running the following (from within a virtual environment):: + + pip install -r requirements.txt + +How to install +^^^^^^^^^^^^^^ + +From within your environment, just run: + + ./install.sh + +How to run +^^^^^^^^^^ + +From within your environment, just run: + + opnfv-testapi + +This will start a server on port 8000. Just visit http://localhost:8000 + +For swagger website, just visit http://localhost:8000/swagger/spec.html + +Unittest +===================== + +Getting setup +^^^^^^^^^^^^^ + +Requirements for unittest: + +* testtools +* discover +* futures + +These requirements are expressed in the test-requirements.txt file and may be +installed by running the following (from within a virtual environment):: + + pip install -r test-requirements.txt + +How to run +^^^^^^^^^^ + +From within your environment, just run:: + + bash run_test.sh + |