3 # Copyright 2015-2017 Intel Corporation.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 # VSPERF nightly build execution script
20 # build-vsperf.sh job_type
21 # where job_type is one of "verify", "merge", "daily"
29 EXIT_SANITY_TC_FAILED=2
32 EXIT_NO_TEST_REPORT_LOG_DIR=256
39 LOG_FILE_PREFIX="/tmp/vsperf_build"
40 DATE=$(date -u +"%Y-%m-%d_%H-%M-%S")
41 BRANCH=${GIT_BRANCH##*/}
42 VSPERFENV_DIR="$HOME/vsperfenv"
43 RESULTS_ARCHIVE="$HOME/ci_results_archive"
45 # CI job specific configuration
46 # VERIFY - run basic set of TCs with default settings
47 TESTCASES_VERIFY="vswitch_add_del_bridge vswitch_add_del_bridges vswitch_add_del_vport vswitch_add_del_vports vswitch_vports_add_del_flow"
48 TESTPARAM_VERIFY="--integration"
49 TESTCASES_VERIFY_VPP="vswitch_add_del_bridge vswitch_add_del_bridges vswitch_add_del_vport vswitch_add_del_vports vswitch_vports_add_del_connection_vpp"
50 TESTPARAM_VERIFY_VPP=$TESTPARAM_VERIFY
51 # MERGE - run selected TCs with default settings
52 TESTCASES_MERGE=$TESTCASES_VERIFY
53 TESTPARAM_MERGE=$TESTPARAM_VERIFY
54 TESTCASES_MERGE_VPP=$TESTCASES_VERIFY_VPP
55 TESTPARAM_MERGE_VPP=$TESTPARAM_VERIFY_VPP
56 # DAILY - run selected TCs for defined packet sizes
57 TESTCASES_DAILY='phy2phy_tput back2back phy2phy_tput_mod_vlan phy2phy_scalability pvp_tput pvp_back2back pvvp_tput pvvp_back2back'
58 TESTCASES_DAILY_VPP='phy2phy_tput_vpp phy2phy_back2back_vpp pvp_tput_vpp pvp_back2back_vpp pvvp_tput_vpp pvvp_back2back_vpp'
59 TESTPARAM_DAILY='--test-params TRAFFICGEN_PKT_SIZES=(64,128,512,1024,1518)'
60 TESTPARAM_DAILY_VPP=$TESTPARAM_DAILY
61 TESTCASES_SRIOV='pvp_tput'
62 TESTPARAM_SRIOV='--test-params TRAFFICGEN_PKT_SIZES=(64,128,512,1024,1518)'
63 # check if user config file exists if not then we will use default settings
64 if [ -f $HOME/vsperf-${BRANCH}.conf ] ; then
65 # branch specific config was found
66 CONF_FILE="--conf-file ${HOME}/vsperf-${BRANCH}.conf"
68 if [ -f $HOME/vsperf.conf ] ; then
69 CONF_FILE="--conf-file ${HOME}/vsperf.conf"
74 # check if sriov specific config file exists if not then use default configuration
75 if [ -f $HOME/vsperf-${BRANCH}.conf.sriov ] ; then
76 CONF_FILE_SRIOV="${CONF_FILE}.sriov"
78 CONF_FILE_SRIOV=$CONF_FILE
81 # Test report related configuration
82 TEST_REPORT_PARTIAL="*_test_report.rst"
83 TEST_REPORT_DIR="${WORKSPACE}/docs/testing/developer/devguide/results"
84 TEST_REPORT_INDEX="${TEST_REPORT_DIR}/index.rst"
85 TEST_REPORT_LINK_OLD="https://wiki.opnfv.org/wiki/vsperf_results"
86 TEST_REPORT_FILE="${WORKSPACE}/docs_output/testing_developer_devguide_results/index.html"
87 TEST_REPORT_TARBALL="vswitchperf_logs_${DATE}.tar.gz"
89 if [[ "x${BRANCH}" == "xmaster" ]]; then
90 TEST_REPORT_LINK_NEW="https://artifacts.opnfv.org/logs/$PROJECT/$NODE_NAME/$DATE/${TEST_REPORT_TARBALL}"
92 TEST_REPORT_LINK_NEW="https://artifacts.opnfv.org/logs/$PROJECT/$NODE_NAME/$BRANCH/$DATE/${TEST_REPORT_TARBALL}"
95 TEST_REPORT_LOG_DIR="${HOME}/opnfv/$PROJECT/results/$BRANCH"
101 # terminate vsperf and all its utilities
102 # it is expected that vsperf is the only python3 app
103 # and no other ovs or qemu instances are running
107 function terminate_vsperf() {
108 sudo pkill stress &> /dev/null
109 sudo pkill python3 &> /dev/null
110 sudo killall -9 qemu-system-x86_64 &> /dev/null
112 # sometimes qemu resists to terminate, so wait a bit and kill it again
113 if pgrep qemu-system-x86_64 &> /dev/null ; then
115 sudo killall -9 qemu-system-x86_64 &> /dev/null
119 sudo pkill ovs-vswitchd &> /dev/null
121 sudo pkill ovsdb-server &> /dev/null
125 # check and print testcase execution status
127 # $1 - directory with results
128 function print_results() {
129 for i in $TESTCASES ; do
130 RES_FILE=`ls -1 $1 | egrep "result_${i}_[0-9a-zA-Z\-]+.csv"`
132 if [ "x$RES_FILE" != "x" -a -e "${1}/${RES_FILE}" ]; then
133 if grep ^FAILED "${1}/${RES_FILE}" &> /dev/null ; then
134 printf " %-70s %-6s\n" "result_${i}" "FAILED"
137 printf " %-70s %-6s\n" "result_${i}" "OK"
140 printf " %-70s %-6s\n" "result_${i}" "FAILED"
146 # execute tests and display results
148 # $1 - vswitch and vnf combination, one of OVS_vanilla, OVS_with_DPDK_and_vHost_User
149 # $2 - CI job type, one of verify, merge, daily
150 function execute_vsperf() {
152 # figure out list of TCs and execution parameters
155 if [ "$1" == "VPP" ] ; then
156 TESTPARAM=$TESTPARAM_VERIFY_VPP
157 TESTCASES=$TESTCASES_VERIFY_VPP
159 TESTPARAM=$TESTPARAM_VERIFY
160 TESTCASES=$TESTCASES_VERIFY
164 if [ "$1" == "VPP" ] ; then
165 TESTPARAM=$TESTPARAM_MERGE_VPP
166 TESTCASES=$TESTCASES_MERGE_VPP
168 TESTPARAM=$TESTPARAM_MERGE
169 TESTCASES=$TESTCASES_MERGE
173 # by default use daily build and upload results to the OPNFV databse
174 if [ "$1" == "VPP" ] ; then
175 TESTPARAM=$TESTPARAM_DAILY_VPP
176 TESTCASES=$TESTCASES_DAILY_VPP
177 # don't report VPP results into testresults DB, until TC name mapping
178 # for VPP tests will be defined
179 #OPNFVPOD="--opnfvpod=$NODE_NAME"
181 TESTPARAM=$TESTPARAM_DAILY
182 TESTCASES=$TESTCASES_DAILY
183 OPNFVPOD="--opnfvpod=$NODE_NAME"
189 echo -e "\nExecution of VSPERF for $1"
191 DATE_SUFFIX=$(date -u +"%Y-%m-%d_%H-%M-%S")
195 # use SRIOV specific TCs and configuration
196 TESTPARAM=$TESTPARAM_SRIOV
197 TESTCASES=$TESTCASES_SRIOV
198 # figure out log file name
200 LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
202 echo " $VSPERF_BIN --vswitch none --vnf QemuPciPassthrough $CONF_FILE_SRIOV $TESTPARAM $TESTCASES &> $LOG_FILE"
203 $VSPERF_BIN --vswitch none --vnf QemuPciPassthrough $CONF_FILE_SRIOV $TESTPARAM $TESTCASES &> $LOG_FILE
206 # figure out log file name
207 LOG_SUBDIR="VppDpdkVhost"
208 LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
210 hugepages_info > $LOG_FILE
211 echo " $VSPERF_BIN $OPNFVPOD --vswitch VppDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES > $LOG_FILE"
212 $VSPERF_BIN $OPNFVPOD --vswitch VppDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES &>> $LOG_FILE
213 hugepages_info >> $LOG_FILE
216 # figure out log file name
217 LOG_SUBDIR="OvsVanilla"
218 LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
220 echo " $VSPERF_BIN $OPNFVPOD --vswitch OvsVanilla --vnf QemuVirtioNet $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE"
221 $VSPERF_BIN $OPNFVPOD --vswitch OvsVanilla --vnf QemuVirtioNet $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE
224 # figure out log file name
225 LOG_SUBDIR="OvsDpdkVhost"
226 LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
228 hugepages_info > $LOG_FILE
229 echo " $VSPERF_BIN $OPNFVPOD --vswitch OvsDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES > $LOG_FILE"
230 $VSPERF_BIN $OPNFVPOD --vswitch OvsDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES &>> $LOG_FILE
231 hugepages_info >> $LOG_FILE
235 # evaluation of results
236 echo -e "\nResults for $1"
237 RES_DIR="/$(grep "Creating result directory" $LOG_FILE | cut -d'/' -f2-)"
238 if [[ "/" == "${RES_DIR}" ]] ; then
239 echo "FAILURE: Results are not available."
240 echo "-------------------------------------------------------------------"
242 echo "-------------------------------------------------------------------"
243 exit $EXIT_NO_RESULTS
245 print_results "${RES_DIR}"
246 if [ $(($EXIT & $EXIT_TC_FAILED)) -gt 0 ] ; then
247 echo "-------------------------------------------------------------------"
249 echo "-------------------------------------------------------------------"
253 # show detailed result figures
254 for md_file in $(grep '\.md"$' $LOG_FILE | cut -d'"' -f2); do
255 # TC resut file header
256 echo -e "\n-------------------------------------------------------------------"
258 echo -e "-------------------------------------------------------------------\n"
260 sed -n '/^- Test ID/,/Bidirectional/{/Packet size/b;p;/Bidirectional/q};/Results\/Metrics Collected/,/Statistics collected/{/^$/p;/^|/p}' $md_file
262 sed -n '/Results\/Metrics Collected/,/Statistics collected/{/^$/p;/^|/p}' $md_file | grep -v "Unknown" | cat -s
265 # add test results into the final doc template
266 for report in ${RES_DIR}/${TEST_REPORT_PARTIAL} ; do
267 # modify link to the artifactory with test report and logs
268 if [ -f $report ] ; then
269 sed -i -e "s,$TEST_REPORT_LINK_OLD,$TEST_REPORT_LINK_NEW," "$report"
270 cp $report $TEST_REPORT_DIR
271 echo " $(basename $report)" >> $TEST_REPORT_INDEX
275 # copy logs into dedicated directory
276 mkdir ${TEST_REPORT_LOG_DIR}/${LOG_SUBDIR}
277 [ -f "$LOG_FILE" ] && cp -a "${LOG_FILE}" "${TEST_REPORT_LOG_DIR}/${LOG_SUBDIR}" &> /dev/null
278 [ -d "$RES_DIR" ] && cp -ar "$RES_DIR" "${TEST_REPORT_LOG_DIR}/${LOG_SUBDIR}" &> /dev/null
281 # generates final test_report in PDF and HTML formats
282 function generate_report() {
284 # prepare final tarball with all logs...
285 tar --exclude "${TEST_REPORT_TARBALL}" -czf "${TEST_REPORT_LOG_DIR}/${TEST_REPORT_TARBALL}" $(find "${TEST_REPORT_LOG_DIR}" -mindepth 1 -maxdepth 1 -type d)
286 # ...and move original log files to the archive directory...
287 find "${TEST_REPORT_LOG_DIR}" -maxdepth 2 -name "results_*" -type d -exec mv \{\} ${RESULTS_ARCHIVE} \;
288 # ...and remove the rest
289 find "${TEST_REPORT_LOG_DIR}" -mindepth 1 -maxdepth 1 -type d -exec rm -rf \{\} \;
291 # clone opnfvdocs repository
292 echo "Cloning opnfvdocs repository..."
293 [ -d opnfvdocs ] && rm -rf opnfvdocs
294 git clone https://gerrit.opnfv.org/gerrit/opnfvdocs &> /dev/null
296 # generate final docs with test results
297 echo "Generating test report..."
298 sed -ie 's,python ,python2 ,g' ./opnfvdocs/scripts/docs-build.sh
299 OPNFVDOCS_DIR='./opnfvdocs' ./opnfvdocs/scripts/docs-build.sh &> /dev/null
301 # store HTML report with test results into dedicated directory
302 if [ -f $TEST_REPORT_FILE ] ; then
303 cp -ar $TEST_REPORT_FILE $(dirname $TEST_REPORT_FILE)/_static $TEST_REPORT_LOG_DIR
304 echo "Final test report has been created."
306 echo "FAILURE: Generation of final test report has failed."
310 # generates graphs from recent test results
311 function generate_and_push_graphs() {
312 # create graphs from results in archive directory
313 ./ci/plot-results.sh "$1" "$2" "$RESULTS_ARCHIVE"
315 # push graphs into artifactory
316 if ls *png &> /dev/null ; then
317 gsutil cp *png gs://artifacts.opnfv.org/logs/vswitchperf/intel-pod12/graphs/
319 echo "Graphs were not created."
323 # pushes test report and logs collected during test execution into artifactory
324 function push_results_to_artifactory() {
325 # clone releng repository
326 echo "Cloning releng repository..."
327 [ -d releng ] && rm -rf releng
328 git clone https://gerrit.opnfv.org/gerrit/releng &> /dev/null
330 echo "Pushing results and logs into artifactory..."
331 . ./releng/utils/push-test-logs.sh "$DATE"
333 # enter workspace as it could be modified by 3rd party script
337 # removes any local changes of repository
339 echo "Cleaning up..."
343 # prepares directory for logs collection and removes old logs
344 function initialize_logdir() {
345 if [[ "x$TEST_REPORT_LOG_DIR" == "x" ]] ; then
346 echo "FAILURE: Logging directory is not defined. Logs and report cannot be published!"
347 exit $EXIT_NO_TEST_REPORT_LOG_DIR
349 # remove TEST_REPORT_LOG_DIR if it exists
350 if [ -e $TEST_REPORT_LOG_DIR ] ; then
351 if [ -f $TEST_REPORT_LOG_DIR ] ; then
352 rm $TEST_REPORT_LOG_DIR
354 rm -rf ${TEST_REPORT_LOG_DIR}
357 # create TEST_REPORT_LOG_DIR
358 mkdir -p $TEST_REPORT_LOG_DIR
362 # verify basic vsperf functionality
363 function execute_vsperf_sanity() {
364 DATE_SUFFIX=$(date -u +"%Y-%m-%d_%H-%M-%S")
365 LOG_FILE="${LOG_FILE_PREFIX}_sanity_${DATE_SUFFIX}.log"
366 echo "Execution of VSPERF sanity checks:"
367 for PARAM in '--version' '--help' '--list-trafficgens' '--list-collectors' '--list-vswitches' '--list-fwdapps' '--list-vnfs' '--list-settings' '--list' '--integration --list'; do
368 echo -e "-------------------------------------------------------------------" >> $LOG_FILE
369 echo "$VSPERF_BIN $PARAM $CONF_FILE" >> $LOG_FILE
370 echo -e "-------------------------------------------------------------------" >> $LOG_FILE
371 $VSPERF_BIN $PARAM $CONF_FILE &>> $LOG_FILE
372 if $VSPERF_BIN $PARAM $CONF_FILE &>> $LOG_FILE ; then
373 printf " %-70s %-6s\n" "$VSPERF_BIN $PARAM" "OK"
375 printf " %-70s %-6s\n" "$VSPERF_BIN $PARAM" "FAILED"
376 EXIT=$EXIT_SANITY_TC_FAILED
380 echo "Sanity log file $LOG_FILE"
381 if [ $(($EXIT & $EXIT_SANITY_TC_FAILED)) -gt 0 ] ; then
382 echo "-------------------------------------------------------------------"
384 echo "-------------------------------------------------------------------"
388 # execute pylint to check code quality
389 function execute_vsperf_pylint_check() {
390 if ! ./check -b ; then
391 EXIT=$EXIT_PYLINT_FAILED
395 # check and install required packages at nodes running VERIFY and MERGE jobs
396 function dependencies_check() {
398 if [ $ID == "ubuntu" ] ; then
399 echo "Dependencies check"
400 echo "=================="
401 # install system packages
402 for PACKAGE in "python3-tk" "sysstat" "bc" ; do
403 if dpkg -s $PACKAGE &> /dev/null ; then
404 printf " %-70s %-6s\n" $PACKAGE "OK"
406 printf " %-70s %-6s\n" $PACKAGE "missing"
407 sudo apt-get install -y $PACKAGE
410 # install additional python packages into python environment
411 for PACKAGE in "pylint" ; do
412 if pip show $PACKAGE &> /dev/null ; then
413 printf " %-70s %-6s\n" $PACKAGE "OK"
415 printf " %-70s %-6s\n" $PACKAGE "missing"
423 # configure hugepages
424 function configure_hugepages() {
425 sudo bash -c "echo 2048 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages"
426 sudo bash -c "echo 0 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages"
429 # dump hugepages configuration
430 function hugepages_info() {
431 echo "-------------------------------------------------------------------"
432 head /sys/devices/system/node/node*/hugepages/hugepages*/*
433 echo "-------------------------------------------------------------------"
442 # enter workspace dir
445 # create virtualenv if needed
446 if [ ! -e $VSPERFENV_DIR ] ; then
447 echo "Create VSPERF environment"
448 echo "========================="
449 virtualenv --python=python3 "$VSPERFENV_DIR"
453 # acivate and update virtualenv
454 echo "Update VSPERF environment"
455 echo "========================="
456 source "$VSPERFENV_DIR"/bin/activate
457 pip install -r ./requirements.txt
460 # VERFIY&MERGE job specific - check if required packages are installed
466 # configure hugepages
469 # execute job based on passed parameter
472 echo "================="
473 echo "VSPERF verify job"
474 echo "================="
476 execute_vsperf_pylint_check
478 execute_vsperf_sanity
480 execute_vsperf OVS_with_DPDK_and_vHost_User $1
482 execute_vsperf OVS_vanilla $1
484 execute_vsperf VPP $1
490 echo "================"
491 echo "VSPERF merge job"
492 echo "================"
496 execute_vsperf_sanity
498 execute_vsperf OVS_with_DPDK_and_vHost_User $1
500 execute_vsperf OVS_vanilla $1
502 execute_vsperf VPP $1
508 echo "================"
509 echo "VSPERF daily job"
510 echo "================"
513 execute_vsperf OVS_with_DPDK_and_vHost_User $1
515 execute_vsperf OVS_vanilla $1
517 execute_vsperf VPP $1
519 execute_vsperf SRIOV $1
524 push_results_to_artifactory
526 generate_and_push_graphs "$TESTCASES_DAILY" ",OvsDpdkVhost,"
527 generate_and_push_graphs "$TESTCASES_DAILY" ",OvsVanilla,"
528 generate_and_push_graphs "$TESTCASES_DAILY_VPP" ",VppDpdkVhost,"
529 generate_and_push_graphs "$TESTCASES_SRIOV" ",none,"