aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 5d23c2b9fc707600b0060ec122b528fd96f4315f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV

=============
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