project-ize testAPI
[releng.git] / utils / test / result_collection_api / README.rst
1 =============
2 opnfv-testapi
3 =============
4
5 Test Results Collector of OPNFV Test Projects
6
7 Start Server
8 ==============
9
10 Getting setup
11 ^^^^^^^^^^^^^
12
13 Requirements for opnfv-testapi:
14
15 * tornado
16 * epydoc
17
18 These requirements are expressed in the requirements.txt file and may be
19 installed by running the following (from within a virtual environment)::
20
21     pip install -r requirements.txt
22
23 How to install
24 ^^^^^^^^^^^^^^
25
26 From within your environment, just run:
27
28     python setup.py install
29
30 How to run
31 ^^^^^^^^^^
32
33 From within your environment, just run:
34
35     opnfv-testapi
36
37 This will start a server on port 8000.  Just visit http://localhost:8000
38
39 For swagger website, just visit http://localhost:8000/swagger/spec.html
40
41 Unittest
42 =====================
43
44 Getting setup
45 ^^^^^^^^^^^^^
46
47 Requirements for unittest:
48
49 * testtools
50 * discover
51 * futures
52
53 These requirements are expressed in the test-requirements.txt file and may be
54 installed by running the following (from within a virtual environment)::
55
56     pip install -r test-requirements.txt
57
58 How to run
59 ^^^^^^^^^^
60
61 From within your environment, just run::
62
63     bash run_test.sh
64