CSIT doc gen: Add configurations and operational data.
[csit.git] / bootstrap-vpp-verify-semiweekly.sh
1 #!/bin/bash
2 # Copyright (c) 2016 Cisco and/or its affiliates.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a ght (c) 2016 Cisco and/or its affiliates.
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not usecopy of the License at:
8 #
9 #     http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 set -x
18
19 RETURN_STATUS=0
20
21 cat /etc/hostname
22 cat /etc/hosts
23
24 PYBOT_ARGS="--noncritical MULTI_THREAD"
25
26 ARCHIVE_ARTIFACTS=(log.html output.xml report.html)
27
28 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
29 export PYTHONPATH=${SCRIPT_DIR}
30
31 if [ -f "/etc/redhat-release" ]; then
32     DISTRO="CENTOS"
33     sudo yum install -y python-devel python-virtualenv
34 else
35     DISTRO="UBUNTU"
36     export DEBIAN_FRONTEND=noninteractive
37     sudo apt-get -y update
38     sudo apt-get -y install libpython2.7-dev python-virtualenv
39 fi
40
41 # 1st step: Download and prepare VPP packages
42
43 # Temporarily download VPP packages from nexus.fd.io
44 if [ "${#}" -ne "0" ]; then
45     arr=(${@})
46     echo ${arr[0]}
47 else
48     case "$DISTRO" in
49         CENTOS )
50             PACKAGE=rpm
51             ;;
52         UBUNTU )
53             PACKAGE=deb
54     esac
55     # Download the latest VPP build install packages
56     rm -f *.${PACKAGE}
57     echo Downloading VPP packages...
58     bash ${SCRIPT_DIR}/resources/tools/download_install_vpp_pkgs.sh --skip-install
59 fi
60
61 # Take vpp package and get the vpp version
62 VPP_PKGS=(*.$PACKAGE)
63 case "$DISTRO" in
64         CENTOS )
65             VPP_VER="$( expr match $(ls *.rpm | head -n 1) 'vpp-\(.*\).rpm' )"
66             ;;
67         UBUNTU )
68             VPP_VER="$( expr match $(ls *.deb | head -n 1) 'vpp-\(.*\)-deb.deb' )"
69 esac
70
71 echo ${VPP_PKGS[@]}
72
73 set +x
74 echo "****************************************************************************************************************************************"
75 echo "1st step: Download VPP packages                                                                                                 FINISHED"
76 echo "VPP version to be tested: ${VPP_VER}"
77 echo "****************************************************************************************************************************************"
78 set -x
79
80
81 # 2nd step: Start virtual env and install requirements
82
83 echo Starting virtual env...
84 virtualenv --system-site-packages env
85 . env/bin/activate
86
87 echo Installing requirements...
88 pip install -r ${SCRIPT_DIR}/requirements.txt
89
90 set +x
91 echo "****************************************************************************************************************************************"
92 echo "2nd step: Start virtual env and install requirements                                                                            FINISHED"
93 echo "****************************************************************************************************************************************"
94 set -x
95
96
97 # 3rd step: Prepare VIRL system
98 echo Preparing VIRL system...
99
100 VIRL_SERVERS=("10.30.51.28" "10.30.51.29" "10.30.51.30")
101 VIRL_SERVER=""
102
103 VIRL_USERNAME=jenkins-in
104 VIRL_PKEY=priv_key
105 VIRL_SERVER_STATUS_FILE="status"
106 VIRL_SERVER_EXPECTED_STATUS="PRODUCTION"
107
108 case "$DISTRO" in
109         CENTOS )
110             VIRL_TOPOLOGY=$(cat ${SCRIPT_DIR}/VIRL_TOPOLOGY_CENTOS)
111             VIRL_RELEASE=$(cat ${SCRIPT_DIR}/VIRL_RELEASE_CENTOS)
112             ;;
113         UBUNTU )
114             VIRL_TOPOLOGY=$(cat ${SCRIPT_DIR}/VIRL_TOPOLOGY_UBUNTU)
115             VIRL_RELEASE=$(cat ${SCRIPT_DIR}/VIRL_RELEASE_UBUNTU)
116 esac
117
118 SSH_OPTIONS="-i ${VIRL_PKEY} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o BatchMode=yes -o LogLevel=error"
119
120 function ssh_do() {
121     echo
122     echo "### "  ssh $@
123     ssh ${SSH_OPTIONS} $@
124 }
125
126 rm -f ${VIRL_PKEY}
127 cat > ${VIRL_PKEY} <<EOF
128 -----BEGIN RSA PRIVATE KEY-----
129 MIIEpQIBAAKCAQEA+IHXq87GcqMR1C47rzx6Cbip5Ghq8pKrbqKrP5Nf41HcYrT6
130 GOXl9nFWKsMOzIlIn+8y7Il27eZh7csQGApbg8QLiHMtcYEmWNzKZpkqg4nuAPxX
131 VXwlKgnKX902SrET9Gp9TDayiHtCRWVfrlPPPSA0UEXW6BjLN/uHJ+W/Xzrrab+9
132 asBVa05vT2W6n0KJ66zfCaeDM912mQ6SttscAwFoWDmdHlegiVqrlIG2ABxOvxxz
133 L3dM3iSmlmQlzv9bThjo+nI4KFYh6m5wrZmAo5r/4q9CIJc21HVnTqkGOWJIZz6J
134 73lePJVSq5gYqaoGw3swFEA/MDkOx7baWKSoLQIDAQABAoIBAQCNBeolNp+JWJ76
135 gQ4fwLsknyXSV6sxYyhkDW4PEwwcTU06uqce0AAzXVffxne0fMe48x47+zqBgPbb
136 4huM+Pu8B9nfojUMr5TaYtl9Zbgpk3F8H7dT7LKOa6XrxvZTZrADSRc30+Z26zPN
137 e9zTaf42Gvt0/l0Zs1BHwbaOXqO+XuwJ3/F9Sf3PQYWXD3EOWjpHDP/X/1vAs6lV
138 SLkm6J/9KKE1m6I6LTYjIXuYt4SXybW6N2TSy54hhQtYcDUnIU2hR/PHVWKrGA0J
139 kELgrtTNTdbML27O5gFWU4PLUEYTZ9fN11D6qUZKxLcPOiPPHXkiILMRCCnG5DYI
140 ksBAU/YlAoGBAPxZO9VO18TYc8THV1nLKcvT2+1oSs1UcA2wNQMU55t910ZYinRa
141 MRwUhMOf8Mv5wOeiZaRICQB1PnVWtDVmGECgPpK6jUxqAwn8rgJcnoafLGL5YKMY
142 RVafTe6N5LXgCaOcJrk21wxs6v7ninEbUxxc575urOvZMBkymDw91dwbAoGBAPwa
143 YRhKhrzFKZzdK0RadVjnxKvolUllpoqqg3XuvmeAJHAOAnaOgVWq68NAcp5FZJv0
144 2D2Up7TX8pjf9MofP1SJbcraKBpK4NzfNkA0dSdEi+FhVofAJ9umB2o5LW1n7sab
145 UIrjsdzSJK/9Zb9yTTHPyibYzNEgaJV1HsbxfEFXAoGAYO2RmvRm0phll18OQVJV
146 IpKk9kLKAKZ/R/K32hAsikBC8SVPQTPniyaifFWx81diblalff2hX4ipTf7Yx24I
147 wMIMZuW7Im/R7QMef4+94G3Bad7p7JuE/qnAEHJ2OBnu+eYfxaK35XDsrq6XMazS
148 NqHE7hOq3giVfgg+C12hCKMCgYEAtu9dbYcG5owbehxzfRI2/OCRsjz/t1bv1seM
149 xVMND4XI6xb/apBWAZgZpIFrqrWoIBM3ptfsKipZe91ngBPUnL9s0Dolx452RVAj
150 yctHB8uRxWYgqDkjsxtzXf1HnZBBkBS8CUzYj+hdfuddoeKLaY3invXLCiV+PpXS
151 U4KAK9kCgYEAtSv0m5+Fg74BbAiFB6kCh11FYkW94YI6B/E2D/uVTD5dJhyEUFgZ
152 cWsudXjMki8734WSpMBqBp/J8wG3C9ZS6IpQD+U7UXA+roB7Qr+j4TqtWfM+87Rh
153 maOpG56uAyR0w5Z9BhwzA3VakibVk9KwDgZ29WtKFzuATLFnOtCS46E=
154 -----END RSA PRIVATE KEY-----
155 EOF
156 chmod 600 ${VIRL_PKEY}
157
158 #
159 # Pick a random host from the array of VIRL servers, and attempt
160 # to reach it and verify it's status.
161 #
162 # The server must be reachable, and have a "status" file with
163 # the content "PRODUCTION", to be selected.
164 #
165 # If the server is not reachable, or does not have the correct
166 # status, remove it from the array and start again.
167 #
168 # Abort if there are no more servers left in the array.
169 #
170 while [[ ! "$VIRL_SERVER" ]]
171 do
172     num_hosts=${#VIRL_SERVERS[@]}
173     if [ $num_hosts == 0 ]
174     then
175         echo "No more VIRL candidate hosts available, failing."
176         exit 127
177     fi
178     element=$[ $RANDOM % $num_hosts ]
179     virl_server_candidate=${VIRL_SERVERS[$element]}
180     virl_server_status=$(ssh ${SSH_OPTIONS} ${VIRL_USERNAME}@${virl_server_candidate} cat $VIRL_SERVER_STATUS_FILE 2>&1)
181     echo VIRL HOST $virl_server_candidate status is \"$virl_server_status\"
182     if [ "$virl_server_status" == "$VIRL_SERVER_EXPECTED_STATUS" ]
183     then
184         # Candidate is in good status. Select this server.
185         VIRL_SERVER="$virl_server_candidate"
186     else
187         # Candidate is in bad status. Remove from array.
188         VIRL_SERVERS=("${VIRL_SERVERS[@]:0:$element}" "${VIRL_SERVERS[@]:$[$element+1]}")
189     fi
190 done
191
192
193 VIRL_DIR_LOC="/tmp"
194 VPP_PKGS_VIRL=(${VPP_PKGS[@]})
195
196 # Prepend directory location at remote host to deb file list
197 for index in "${!VPP_PKGS_VIRL[@]}"; do
198     VPP_PKGS_VIRL[${index}]=${VIRL_DIR_LOC}/${VPP_PKGS_VIRL[${index}]}
199 done
200
201 echo "Updated file names: " ${VPP_PKGS_VIRL[@]}
202
203 cat ${VIRL_PKEY}
204 # Copy the files to VIRL host
205 scp ${SSH_OPTIONS} *.${PACKAGE} \
206     ${VIRL_USERNAME}@${VIRL_SERVER}:${VIRL_DIR_LOC}/
207
208 result=$?
209 if [ "${result}" -ne "0" ]; then
210     echo "Failed to copy vpp deb files to virl host"
211     echo ${result}
212     exit ${result}
213 fi
214
215 # Start a simulation on VIRL server
216 echo "Starting simulation on VIRL server"
217
218 function stop_virl_simulation {
219     ssh ${SSH_OPTIONS} ${VIRL_USERNAME}@${VIRL_SERVER}\
220         "stop-testcase ${VIRL_SID}"
221 }
222
223 VIRL_SID=$(ssh ${SSH_OPTIONS} \
224     ${VIRL_USERNAME}@${VIRL_SERVER} \
225     "start-testcase -c ${VIRL_TOPOLOGY} -r ${VIRL_RELEASE} ${VPP_PKGS_VIRL[@]}")
226 retval=$?
227 if [ ${retval} -ne "0" ]; then
228     echo "VIRL simulation start failed"
229     exit ${retval}
230 fi
231
232 if [[ ! "${VIRL_SID}" =~ session-[a-zA-Z0-9_]{6} ]]; then
233     echo "No VIRL session ID reported."
234     exit 127
235 fi
236
237 # Upon script exit, cleanup the VIRL simulation execution
238 trap stop_virl_simulation EXIT
239 echo ${VIRL_SID}
240
241 ssh_do ${VIRL_USERNAME}@${VIRL_SERVER} cat /scratch/${VIRL_SID}/topology.yaml
242
243 # Download the topology file from VIRL session
244 scp ${SSH_OPTIONS} \
245     ${VIRL_USERNAME}@${VIRL_SERVER}:/scratch/${VIRL_SID}/topology.yaml \
246     topologies/enabled/topology_VIRL.yaml
247
248 retval=$?
249 if [ ${retval} -ne "0" ]; then
250     echo "Failed to copy topology file from VIRL simulation"
251     exit ${retval}
252 fi
253
254 set +x
255 echo "****************************************************************************************************************************************"
256 echo "3rd step: Start the simulation on the VIRL server                                                                               FINISHED"
257 echo "****************************************************************************************************************************************"
258 set -x
259
260
261 # 4th step: Run functional test suites
262
263 RC=0
264 MORE_FAILS=0
265
266 echo Running functional tests on the VIRL system...
267
268 # There are used three iterations of functional tests there
269 # to check the stability and reliability of the results.
270 for test_set in 1 2 3
271 do
272     echo
273     echo Functional test loop: ${test_set}
274     echo
275
276     pybot -L TRACE -W 136\
277         -v TOPOLOGY_PATH:${SCRIPT_DIR}/topologies/enabled/topology_VIRL.yaml \
278         --suite "tests.func" \
279         --include vm_envAND3_node_single_link_topo \
280         --include vm_envAND3_node_double_link_topo \
281         --exclude PERFTEST \
282         --noncritical EXPECTED_FAILING \
283         --output log_func_test_set${test_set} \
284         tests/
285     PARTIAL_RC=$(echo $?)
286     if [ ${PARTIAL_RC} -eq 250 ]; then
287         MORE_FAILS=1
288     fi
289     RC=$((RC+PARTIAL_RC))
290 done
291
292 set +x
293 echo "****************************************************************************************************************************************"
294 echo "4th step: Run functional tests                                                                                                  FINISHED"
295 echo "****************************************************************************************************************************************"
296 set -x
297
298 # Set RETURN_STATUS=1 if some critical test failed
299 if [ ! ${RC} -eq 0 ]; then
300         RETURN_STATUS=1
301 fi
302
303 # Log the final result
304 if [ ${RC} -eq 0 ]; then
305     set +x
306     echo
307     echo "========================================================================================================================================"
308     echo "Final result of all test loops:                                                                                                 | PASS |"
309     echo "All critical tests have passed."
310     echo "========================================================================================================================================"
311     echo
312     set -x
313 elif [ ${MORE_FAILS} -eq 0 ]; then
314     if [ ${RC} -eq 1 ]; then
315         HLP_STR="test has"
316     else
317         HLP_STR="tests have"
318     fi
319     set +x
320     echo
321     echo "========================================================================================================================================"
322     echo "Final result of all test loops:                                                                                                 | FAIL |"
323     echo "${RC} critical ${HLP_STR} failed."
324     echo "========================================================================================================================================"
325     echo
326     set -x
327 else
328     set +x
329     echo
330     echo "========================================================================================================================================"
331     echo "Final result of all test loops:                                                                                                 | FAIL |"
332     echo "More then 250 critical tests have failed in one test loop."
333     echo "========================================================================================================================================"
334     echo
335     set -x
336 fi
337
338 # 7th step: Post-processing test data
339 echo Post-processing test data...
340
341 # Rebot output post-processing
342 rebot --noncritical EXPECTED_FAILING \
343       --output output.xml \
344       ./log_func_test_set1.xml ./log_func_test_set2.xml ./log_func_test_set3.xml
345
346 # Remove unnecessary files
347 rm -f ./log_test_set1.xml ./log_test_set2.xml ./log_test_set3.xml
348
349 # Archive artifacts
350 mkdir archive
351 for i in ${ARCHIVE_ARTIFACTS[@]}; do
352     cp $( readlink -f ${i} | tr '\n' ' ' ) archive/
353 done
354
355 echo Post-processing finished.
356
357 exit ${RETURN_STATUS}