INFO: Update PTL
[vswitchperf.git] / ci / build-vsperf.sh
index a02de00..b60a7fa 100755 (executable)
@@ -1,6 +1,6 @@
 #!/bin/bash
 #
-# Copyright 2015-2016 Intel Corporation.
+# Copyright 2015-2017 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 
 EXIT=0
 EXIT_TC_FAILED=1
-EXIT_NO_RESULTS=10
-EXIT_NO_TEST_REPORT_LOG_DIR=11
+EXIT_SANITY_TC_FAILED=2
+EXIT_PYLINT_FAILED=4
+EXIT_NO_RESULTS=128
+EXIT_NO_TEST_REPORT_LOG_DIR=256
 
 #
 # configuration
@@ -37,17 +39,27 @@ VSPERF_BIN='./vsperf'
 LOG_FILE_PREFIX="/tmp/vsperf_build"
 DATE=$(date -u +"%Y-%m-%d_%H-%M-%S")
 BRANCH=${GIT_BRANCH##*/}
+VSPERFENV_DIR="$HOME/vsperfenv"
+RESULTS_ARCHIVE="$HOME/ci_results_archive"
 
 # CI job specific configuration
 # VERIFY - run basic set of TCs with default settings
-TESTCASES_VERIFY="phy2phy_tput pvp_tput"
-TESTPARAM_VERIFY=""
+TESTCASES_VERIFY="vswitch_add_del_bridge vswitch_add_del_bridges vswitch_add_del_vport vswitch_add_del_vports vswitch_vports_add_del_flow"
+TESTPARAM_VERIFY="--integration"
+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"
+TESTPARAM_VERIFY_VPP=$TESTPARAM_VERIFY
 # MERGE - run selected TCs with default settings
-TESTCASES_MERGE="phy2phy_tput back2back phy2phy_cont pvp_tput pvvp_tput"
-TESTPARAM_MERGE=""
+TESTCASES_MERGE=$TESTCASES_VERIFY
+TESTPARAM_MERGE=$TESTPARAM_VERIFY
+TESTCASES_MERGE_VPP=$TESTCASES_VERIFY_VPP
+TESTPARAM_MERGE_VPP=$TESTPARAM_VERIFY_VPP
 # DAILY - run selected TCs for defined packet sizes
 TESTCASES_DAILY='phy2phy_tput back2back phy2phy_tput_mod_vlan phy2phy_scalability pvp_tput pvp_back2back pvvp_tput pvvp_back2back'
-TESTPARAM_DAILY='--test-params pkt_sizes=64,128,512,1024,1518'
+TESTCASES_DAILY_VPP='phy2phy_tput_vpp phy2phy_back2back_vpp pvp_tput_vpp pvp_back2back_vpp pvvp_tput_vpp pvvp_back2back_vpp'
+TESTPARAM_DAILY='--test-params TRAFFICGEN_PKT_SIZES=(64,128,512,1024,1518)'
+TESTPARAM_DAILY_VPP=$TESTPARAM_DAILY
+TESTCASES_SRIOV='pvp_tput'
+TESTPARAM_SRIOV='--test-params TRAFFICGEN_PKT_SIZES=(64,128,512,1024,1518)'
 # check if user config file exists if not then we will use default settings
 if [ -f $HOME/vsperf-${BRANCH}.conf ] ; then
     # branch specific config was found
@@ -59,13 +71,19 @@ else
         CONF_FILE=""
     fi
 fi
+# check if sriov specific config file exists if not then use default configuration
+if [ -f $HOME/vsperf-${BRANCH}.conf.sriov ] ; then
+    CONF_FILE_SRIOV="${CONF_FILE}.sriov"
+else
+    CONF_FILE_SRIOV=$CONF_FILE
+fi
 
 # Test report related configuration
 TEST_REPORT_PARTIAL="*_test_report.rst"
-TEST_REPORT_DIR="${WORKSPACE}/docs/results"
+TEST_REPORT_DIR="${WORKSPACE}/docs/testing/developer/devguide/results"
 TEST_REPORT_INDEX="${TEST_REPORT_DIR}/index.rst"
 TEST_REPORT_LINK_OLD="https://wiki.opnfv.org/wiki/vsperf_results"
-TEST_REPORT_FILE="${WORKSPACE}/docs_output/results/results.pdf"
+TEST_REPORT_FILE="${WORKSPACE}/docs_output/testing_developer_devguide_results/index.html"
 TEST_REPORT_TARBALL="vswitchperf_logs_${DATE}.tar.gz"
 
 if [[ "x${BRANCH}" == "xmaster" ]]; then
@@ -109,20 +127,23 @@ function terminate_vsperf() {
 #   $1 - directory with results
 function print_results() {
     for i in $TESTCASES ; do
-        if [[ $i == *"pvp"* ]]; then
-            DEPLOYMENT="pvp"
-        elif [[ $i == *"pvvp"* ]]; then
-            DEPLOYMENT="pvvp"
-        else
-            DEPLOYMENT="p2p"
-        fi
-        RES_FILE="result_${i}_${DEPLOYMENT}.csv"
-
-        if [ -e "${1}/${RES_FILE}" ]; then
-            printf "    %-70s %-6s\n" $RES_FILE "OK"
-        else
-            printf "    %-70s %-6s\n" $RES_FILE "FAILED"
+        if [ ! -e $1 ] ; then
+            printf "    %-70s %-6s\n" "result_${i}" "FAILED"
             EXIT=$EXIT_TC_FAILED
+        else
+            RES_FILE=`ls -1 $1 | egrep "result_${i}_[0-9a-zA-Z\-]+.csv"`
+
+            if [ "x$RES_FILE" != "x" -a -e "${1}/${RES_FILE}" ]; then
+                if grep ^FAILED "${1}/${RES_FILE}" &> /dev/null ; then
+                    printf "    %-70s %-6s\n" "result_${i}" "FAILED"
+                    EXIT=$EXIT_TC_FAILED
+                else
+                    printf "    %-70s %-6s\n" "result_${i}" "OK"
+                fi
+            else
+                printf "    %-70s %-6s\n" "result_${i}" "FAILED"
+                EXIT=$EXIT_TC_FAILED
+            fi
         fi
     done
 }
@@ -132,20 +153,40 @@ function print_results() {
 #   $1 - vswitch and vnf combination, one of OVS_vanilla, OVS_with_DPDK_and_vHost_User
 #   $2 - CI job type, one of verify, merge, daily
 function execute_vsperf() {
+    OPNFVPOD=""
     # figure out list of TCs and execution parameters
     case $2 in
         "verify")
-            TESTPARAM=$TESTPARAM_VERIFY
-            TESTCASES=$TESTCASES_VERIFY
+            if [ "$1" == "VPP" ] ; then
+                TESTPARAM=$TESTPARAM_VERIFY_VPP
+                TESTCASES=$TESTCASES_VERIFY_VPP
+            else
+                TESTPARAM=$TESTPARAM_VERIFY
+                TESTCASES=$TESTCASES_VERIFY
+            fi
             ;;
         "merge")
-            TESTPARAM=$TESTPARAM_MERGE
-            TESTCASES=$TESTCASES_MERGE
+            if [ "$1" == "VPP" ] ; then
+                TESTPARAM=$TESTPARAM_MERGE_VPP
+                TESTCASES=$TESTCASES_MERGE_VPP
+            else
+                TESTPARAM=$TESTPARAM_MERGE
+                TESTCASES=$TESTCASES_MERGE
+            fi
             ;;
         *)
-            # by default use daily build
-            TESTPARAM=$TESTPARAM_DAILY
-            TESTCASES=$TESTCASES_DAILY
+            # by default use daily build and upload results to the OPNFV databse
+            if [ "$1" == "VPP" ] ; then
+                TESTPARAM=$TESTPARAM_DAILY_VPP
+                TESTCASES=$TESTCASES_DAILY_VPP
+                # don't report VPP results into testresults DB, until TC name mapping
+                # for VPP tests will be defined
+                #OPNFVPOD="--opnfvpod=$NODE_NAME"
+            else
+                TESTPARAM=$TESTPARAM_DAILY
+                TESTCASES=$TESTCASES_DAILY
+                OPNFVPOD="--opnfvpod=$NODE_NAME"
+            fi
             ;;
     esac
 
@@ -155,21 +196,44 @@ function execute_vsperf() {
     DATE_SUFFIX=$(date -u +"%Y-%m-%d_%H-%M-%S")
 
     case $1 in
+        "SRIOV")
+            # use SRIOV specific TCs and configuration
+            TESTPARAM=$TESTPARAM_SRIOV
+            TESTCASES=$TESTCASES_SRIOV
+            # figure out log file name
+            LOG_SUBDIR="SRIOV"
+            LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
+
+            echo "    $VSPERF_BIN --vswitch none --vnf QemuPciPassthrough $CONF_FILE_SRIOV $TESTPARAM $TESTCASES &> $LOG_FILE"
+            $VSPERF_BIN --vswitch none --vnf QemuPciPassthrough $CONF_FILE_SRIOV $TESTPARAM $TESTCASES &> $LOG_FILE
+            ;;
+        "VPP")
+            # figure out log file name
+            LOG_SUBDIR="VppDpdkVhost"
+            LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
+
+            hugepages_info > $LOG_FILE
+            echo "    $VSPERF_BIN $OPNFVPOD --vswitch VppDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES > $LOG_FILE"
+            $VSPERF_BIN $OPNFVPOD --vswitch VppDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES &>> $LOG_FILE
+            hugepages_info >> $LOG_FILE
+            ;;
         "OVS_vanilla")
             # figure out log file name
             LOG_SUBDIR="OvsVanilla"
             LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
 
-            echo "$VSPERF_BIN --opnfvpod="$NODE_NAME" --vswitch OvsVanilla --vnf QemuVirtioNet $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE"
-            $VSPERF_BIN --opnfvpod="$NODE_NAME" --vswitch OvsVanilla --vnf QemuVirtioNet $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE
+            echo "    $VSPERF_BIN $OPNFVPOD --vswitch OvsVanilla --vnf QemuVirtioNet $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE"
+            $VSPERF_BIN $OPNFVPOD --vswitch OvsVanilla --vnf QemuVirtioNet $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE
             ;;
         *)
             # figure out log file name
             LOG_SUBDIR="OvsDpdkVhost"
             LOG_FILE="${LOG_FILE_PREFIX}_${LOG_SUBDIR}_${DATE_SUFFIX}.log"
 
-            echo "$VSPERF_BIN --opnfvpod="$NODE_NAME" --vswitch OvsDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES > $LOG_FILE"
-            $VSPERF_BIN --opnfvpod="$NODE_NAME" --vswitch OvsDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES &> $LOG_FILE
+            hugepages_info > $LOG_FILE
+            echo "    $VSPERF_BIN $OPNFVPOD --vswitch OvsDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES > $LOG_FILE"
+            $VSPERF_BIN $OPNFVPOD --vswitch OvsDpdkVhost --vnf QemuDpdkVhostUser $CONF_FILE $TESTPARAM $TESTCASES &>> $LOG_FILE
+            hugepages_info >> $LOG_FILE
             ;;
     esac
 
@@ -178,9 +242,17 @@ function execute_vsperf() {
     RES_DIR="/$(grep "Creating result directory" $LOG_FILE | cut -d'/' -f2-)"
     if [[ "/" == "${RES_DIR}" ]] ; then
         echo "FAILURE: Results are not available."
+        echo "-------------------------------------------------------------------"
+        cat $LOG_FILE
+        echo "-------------------------------------------------------------------"
         exit $EXIT_NO_RESULTS
     else
         print_results "${RES_DIR}"
+        if [ $(($EXIT & $EXIT_TC_FAILED)) -gt 0 ] ; then
+            echo "-------------------------------------------------------------------"
+            cat $LOG_FILE
+            echo "-------------------------------------------------------------------"
+        fi
     fi
 
     # show detailed result figures
@@ -216,7 +288,9 @@ function generate_report() {
 
     # prepare final tarball with all logs...
     tar --exclude "${TEST_REPORT_TARBALL}" -czf "${TEST_REPORT_LOG_DIR}/${TEST_REPORT_TARBALL}" $(find "${TEST_REPORT_LOG_DIR}" -mindepth 1 -maxdepth 1 -type d)
-    # ...and remove original log files
+    # ...and move original log files to the archive directory...
+    find "${TEST_REPORT_LOG_DIR}" -maxdepth 2 -name "results_*" -type d -exec mv \{\} ${RESULTS_ARCHIVE} \;
+    # ...and remove the rest
     find "${TEST_REPORT_LOG_DIR}" -mindepth 1 -maxdepth 1 -type d -exec rm -rf \{\} \;
 
     # clone opnfvdocs repository
@@ -229,15 +303,28 @@ function generate_report() {
     sed -ie 's,python ,python2 ,g' ./opnfvdocs/scripts/docs-build.sh
     OPNFVDOCS_DIR='./opnfvdocs' ./opnfvdocs/scripts/docs-build.sh &> /dev/null
 
-    # store PDF with test results into dedicated directory
+    # store HTML report with test results into dedicated directory
     if [ -f $TEST_REPORT_FILE ] ; then
-        cp -a $TEST_REPORT_FILE $TEST_REPORT_LOG_DIR
+        cp -ar $TEST_REPORT_FILE $(dirname $TEST_REPORT_FILE)/_static $TEST_REPORT_LOG_DIR
         echo "Final test report has been created."
     else
         echo "FAILURE: Generation of final test report has failed."
     fi
 }
 
+# generates graphs from recent test results
+function generate_and_push_graphs() {
+    # create graphs from results in archive directory
+    ./ci/plot-results.sh "$1" "$2" "$RESULTS_ARCHIVE"
+
+    # push graphs into artifactory
+    if ls *png &> /dev/null ; then
+        gsutil cp *png gs://artifacts.opnfv.org/logs/vswitchperf/intel-pod12/graphs/
+    else
+        echo "Graphs were not created."
+    fi
+}
+
 # pushes test report and logs collected during test execution into artifactory
 function push_results_to_artifactory() {
     # clone releng repository
@@ -277,35 +364,171 @@ function initialize_logdir() {
     fi
 }
 
+# verify basic vsperf functionality
+function execute_vsperf_sanity() {
+    DATE_SUFFIX=$(date -u +"%Y-%m-%d_%H-%M-%S")
+    LOG_FILE="${LOG_FILE_PREFIX}_sanity_${DATE_SUFFIX}.log"
+    echo "Execution of VSPERF sanity checks:"
+    for PARAM in '--version' '--help' '--list-trafficgens' '--list-collectors' '--list-vswitches' '--list-fwdapps' '--list-vnfs' '--list-settings' '--list' '--integration --list'; do
+        echo -e "-------------------------------------------------------------------" >> $LOG_FILE
+        echo "$VSPERF_BIN $PARAM $CONF_FILE" >> $LOG_FILE
+        echo -e "-------------------------------------------------------------------" >> $LOG_FILE
+        $VSPERF_BIN $PARAM $CONF_FILE &>> $LOG_FILE
+        if $VSPERF_BIN $PARAM $CONF_FILE &>> $LOG_FILE ; then
+            printf "    %-70s %-6s\n" "$VSPERF_BIN $PARAM" "OK"
+        else
+            printf "    %-70s %-6s\n" "$VSPERF_BIN $PARAM" "FAILED"
+            EXIT=$EXIT_SANITY_TC_FAILED
+        fi
+        echo >> $LOG_FILE
+    done
+    echo "Sanity log file $LOG_FILE"
+    if [ $(($EXIT & $EXIT_SANITY_TC_FAILED)) -gt 0 ] ; then
+        echo "-------------------------------------------------------------------"
+        cat $LOG_FILE
+        echo "-------------------------------------------------------------------"
+    fi
+}
+
+# execute pylint to check code quality
+function execute_vsperf_pylint_check() {
+    if ! ./check -b ; then
+        EXIT=$EXIT_PYLINT_FAILED
+    fi
+}
+
+# check and install required packages at nodes running VERIFY and MERGE jobs
+function dependencies_check() {
+    . /etc/os-release
+    if [ $ID == "ubuntu" ] ; then
+        echo "Dependencies check"
+        echo "=================="
+        # install system packages
+        for PACKAGE in "python3-tk" "sysstat" "bc" ; do
+            if dpkg -s $PACKAGE &> /dev/null ; then
+                printf "    %-70s %-6s\n" $PACKAGE "OK"
+            else
+                printf "    %-70s %-6s\n" $PACKAGE "missing"
+                sudo apt-get install -y $PACKAGE
+            fi
+        done
+        # install additional python packages into python environment
+        for PACKAGE in "pylint" ; do
+            if pip show $PACKAGE &> /dev/null ; then
+                printf "    %-70s %-6s\n" $PACKAGE "OK"
+            else
+                printf "    %-70s %-6s\n" $PACKAGE "missing"
+                pip install $PACKAGE
+            fi
+        done
+        echo
+    fi
+}
+
+# configure hugepages
+function configure_hugepages() {
+    HP_MAX=8192
+    HP_REQUESTED=3072
+    HP_NR=`cat /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages`
+    HP_FREE=`cat /sys/devices/system/node/node0/hugepages/hugepages-2048kB/free_hugepages`
+    # check if HP must be (re)configured
+    if [ $HP_FREE -lt $HP_REQUESTED ] ; then
+        HP_NR_NEW=$(($HP_NR+($HP_REQUESTED-$HP_FREE)))
+        if [ $HP_NR_NEW -gt $HP_MAX ] ; then
+            HP_NR_NEW=$HP_MAX
+        fi
+        sudo bash -c "echo $HP_NR_NEW > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages"
+    fi
+
+    if [ -f /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages ] ; then
+        sudo bash -c "echo 0 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages"
+    fi
+}
+
+# dump hugepages configuration
+function hugepages_info() {
+    echo "-------------------------------------------------------------------"
+    head /sys/devices/system/node/node*/hugepages/hugepages*/*
+    echo "-------------------------------------------------------------------"
+}
+
 #
 # main
 #
 
+echo
+
 # enter workspace dir
 cd $WORKSPACE
 
+# create virtualenv if needed
+if [ ! -e $VSPERFENV_DIR ] ; then
+    echo "Create VSPERF environment"
+    echo "========================="
+    virtualenv --python=python3 "$VSPERFENV_DIR"
+    echo
+fi
+
+# acivate and update virtualenv
+echo "Update VSPERF environment"
+echo "========================="
+source "$VSPERFENV_DIR"/bin/activate
+pip install -r ./requirements.txt
+echo
+
+# VERFIY&MERGE job specific - check if required packages are installed
+dependencies_check
+
 # initialization
 initialize_logdir
 
+# configure hugepages
+echo "Configure hugepages"
+echo "==================="
+configure_hugepages
+hugepages_info | grep -v '^--'
+echo
+
 # execute job based on passed parameter
 case $1 in
     "verify")
+        echo "================="
         echo "VSPERF verify job"
         echo "================="
 
-        #execute_vsperf OVS_with_DPDK_and_vHost_User $1
+        execute_vsperf_pylint_check
+        terminate_vsperf
+        execute_vsperf_sanity
+        terminate_vsperf
+        execute_vsperf OVS_with_DPDK_and_vHost_User $1
+        terminate_vsperf
+        execute_vsperf OVS_vanilla $1
+        terminate_vsperf
+        execute_vsperf VPP $1
+        terminate_vsperf
 
         exit $EXIT
         ;;
     "merge")
+        echo "================"
         echo "VSPERF merge job"
         echo "================"
 
-        #execute_vsperf OVS_with_DPDK_and_vHost_User $1
+        execute_pylint_check
+        terminate_vsperf
+        execute_vsperf_sanity
+        terminate_vsperf
+        execute_vsperf OVS_with_DPDK_and_vHost_User $1
+        terminate_vsperf
+        execute_vsperf OVS_vanilla $1
+        terminate_vsperf
+        execute_vsperf VPP $1
+        terminate_vsperf
 
         exit $EXIT
         ;;
     *)
+        echo "================"
         echo "VSPERF daily job"
         echo "================"
 
@@ -314,11 +537,20 @@ case $1 in
         terminate_vsperf
         execute_vsperf OVS_vanilla $1
         terminate_vsperf
+        execute_vsperf VPP $1
+        terminate_vsperf
+        execute_vsperf SRIOV $1
+        terminate_vsperf
 
         generate_report
 
         push_results_to_artifactory
 
+        generate_and_push_graphs "$TESTCASES_DAILY" ",OvsDpdkVhost,"
+        generate_and_push_graphs "$TESTCASES_DAILY" ",OvsVanilla,"
+        generate_and_push_graphs "$TESTCASES_DAILY_VPP" ",VppDpdkVhost,"
+        generate_and_push_graphs "$TESTCASES_SRIOV" ",none,"
+
         cleanup
 
         exit $EXIT