Merge "script to launch Rally bench scenario per module or all one after the other...
[functest.git] / docs / main.rst
1 ===========================\r
2 OPNFV functional test guide\r
3 ===========================\r
4 \r
5 The goal of this document consists in describing how to run functional tests on OPNFV solution and how to automate these tests.\r
6 \r
7 For release 1, several test cases have been selected:\r
8  * Rally Bench test suite\r
9  * Tempest tes suite\r
10  * OpenDaylight test suite\r
11  * vPing\r
12  * vIMS\r
13   \r
14 \r
15 .. _prereqs:\r
16 \r
17 -------------\r
18 Prerequisites\r
19 -------------\r
20 We assume that an OPNFV solution has been installed (System Under Test). \r
21 For release 1, the tools needed for functional testing are not part of the installer and are not automatically installed.\r
22 \r
23 .. _pharos: https://wiki.opnfv.org/pharos\r
24  \r
25 It is recommended to install the tools on the jump host server as defined in the Pharos project.\r
26 \r
27 .. _installation:\r
28 \r
29 ------------\r
30 Installation\r
31 ------------\r
32 \r
33 Rally bench test suite\r
34 ======================\r
35 \r
36 Create or enter a folder where you want to check out the tool repos. Follow `Rally installation procedure`_.\r
37 \r
38 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html\r
39 \r
40 \r
41 Tempest\r
42 =======\r
43 \r
44 It is possible to use Rally to perform Tempest tests. See `tempest installation guide using Rally`_.\r
45 \r
46 .. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/ \r
47 \r
48 OpenDaylight \r
49 ============\r
50 \r
51 vPing\r
52 =====\r
53 \r
54 vIMS\r
55 ====\r
56 \r
57 \r
58 .. _manualtest:\r
59 \r
60 --------------\r
61 Manual testing\r
62 --------------\r
63 \r
64 Rally\r
65 =====\r
66 Check your deployment::\r
67 \r
68     # rally deployment check\r
69     keystone endpoints are valid and following service are available:\r
70     +-------------+-----------+------------+\r
71     | Services  | Type        | Status     |\r
72     +-----------+-------------+------------+\r
73     | cinder    | volume      | Available  |\r
74     | cinderv2  | volumev2    | Available  |\r
75     | glance    | image       | Available  |\r
76     | keystone  | identity    | Available  | \r
77     | neutron   | network     | Available  |\r
78     | nova      | compute     | Available  |\r
79     | nova_ec2  | compute_ec2 | Available  |\r
80     | novav3    | computev3   | Available  |\r
81     +-----------+-------------+------------+\r
82 \r
83 Create a new opnfv scenario directory and run test suite::\r
84 \r
85     # cd ~/rally/samples/tasks/scenario/\r
86     # mkdir opnfv \r
87     # wget http://git.opnfv.org/.. <TODO>\r
88     # rally task start --abort-on-sla-failure ./opnfv.json\r
89 \r
90 Tempest\r
91 =======\r
92 \r
93 If we consider running Tempest suite with Rally::\r
94 \r
95     # rally verify start\r
96     # rally verify list\r
97 \r
98 \r
99 \r
100 \r
101 OpenDaylight \r
102 ============\r
103 \r
104 vPing\r
105 =====\r
106 \r
107 vIMS\r
108 ====\r
109 \r
110 \r
111 .. _automatictest:\r
112 \r
113 ------------------\r
114 Testing Automation\r
115 ------------------\r
116 \r
117 Connection of your platform\r
118 ===========================\r
119 If you want to add your platform to the community automation, you need to declare your machine as a Jenkins slave.\r
120  * Send a mail to OPNFV LF Helpdesk (opnfv-helpdesk@rt.linuxfoundation.org)\r
121  * Create a local user jenkins on your machine\r
122  * wget http://mirrors.jenkins-ci.org/war/1.599/jenkins.war\r
123  * Extract contents, find the file named slave.jar and copy it to somewhere which jenkins user created in first step can access.\r
124  * Create a directory /home/jenkins/opnfv_slave_root\r
125  * check the java version (>1.7.0_75)\r
126  * Contact Linux Foundation to manage authentication of your server \r
127  * A key/token will be produced. Establish connection towards OPNFV Jenkins by using below command: java -jar slave.jar -jnlpUrl https://build.opnfv.org/ci/computer/<slave_name>/slave-agent.jnlp -secret <token>\r
128 \r
129 Continuous integration scripts\r
130 ==============================\r
131 \r
132 .. _references:\r
133 \r
134 ----------\r
135 References\r
136 ----------\r
137 \r
138 OPNFV main site: opnfvmain_.\r
139 \r
140 OPNFV functional test page: opnfvfunctest_.\r
141 \r
142 IRC support chan: #opnfv-testperf\r
143 \r
144 .. _opnfvmain: http://www.opnfv.org\r
145 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing\r