Add comments for some tag exclusions
[csit.git] / resources / libraries / bash / function / common.sh
index 7da8020..810500e 100644 (file)
@@ -23,6 +23,8 @@ set -exuo pipefail
 
 
 function activate_docker_topology () {
+    set -exuo pipefail
+
     # Create virtual vpp-device topology. Output of the function is topology
     # file describing created environment saved to a file.
     #
@@ -31,16 +33,15 @@ function activate_docker_topology () {
     # - TOPOLOGIES - Available topologies.
     # - NODENESS - Node multiplicity of desired testbed.
     # - FLAVOR - Node flavor string, usually describing the processor.
+    # - IMAGE_VER_FILE - Name of file that contains the image version.
     # Variables set:
     # - WORKING_TOPOLOGY - Path to topology file.
 
-    set -exuo pipefail
-
     source "${BASH_FUNCTION_DIR}/device.sh" || {
         die "Source failed!"
     }
 
-    device_image="$(< ${CSIT_DIR}/VPP_DEVICE_IMAGE)"
+    device_image="$(< ${CSIT_DIR}/${IMAGE_VER_FILE})"
     case_text="${NODENESS}_${FLAVOR}"
     case "${case_text}" in
         "1n_skx")
@@ -50,7 +51,8 @@ function activate_docker_topology () {
             hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3)
             ssh="ssh root@${hostname} -p 6022"
             run="activate_wrapper ${NODENESS} ${FLAVOR} ${device_image}"
-            env_vars=$(${ssh} "$(declare -f); ${run}") || {
+            # backtics to avoid https://midnight-commander.org/ticket/2142
+            env_vars=`${ssh} "$(declare -f); ${run}"` || {
                 die "Topology reservation via shim-dcr failed!"
             }
             set -a
@@ -131,6 +133,24 @@ function activate_virtualenv () {
 }
 
 
+function archive_tests () {
+
+    set -exuo pipefail
+
+    # Create .tar.xz of generated/tests for archiving.
+    # To be run after generate_tests, kept separate to offer more flexibility.
+
+    # Directory read:
+    # - ${GENERATED_DIR}/tests - Tree of executed suites to archive.
+    # File rewriten:
+    # - ${ARCHIVE_DIR}/tests.tar.xz - Archive of generated tests.
+
+    tar c "${GENERATED_DIR}/tests" | xz -9e > "${ARCHIVE_DIR}/tests.tar.xz" || {
+        die "Error creating archive of generated tests."
+    }
+}
+
+
 function check_download_dir () {
 
     set -exuo pipefail
@@ -169,6 +189,8 @@ function common_dirs () {
 
     set -exuo pipefail
 
+    # Set global variables, create some directories (without touching content).
+
     # Variables set:
     # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
     # - CSIT_DIR - Path to existing root of local CSIT git repository.
@@ -178,6 +200,9 @@ function common_dirs () {
     # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
     # - ARCHIVE_DIR - Path to created CSIT subdirectory "archive".
     # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
+    # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
+    # Directories created if not present:
+    # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
     # Functions called:
     # - die - Print to stderr and exit.
 
@@ -211,6 +236,10 @@ function common_dirs () {
         die "Readlink failed."
     }
     mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
+    GENERATED_DIR="$(readlink -f "${CSIT_DIR}/generated")" || {
+        die "Readlink failed."
+    }
+    mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
 }
 
 
@@ -342,11 +371,44 @@ function die_on_pybot_error () {
     # - die - Print to stderr and exit.
 
     if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
-        die "${PYBOT_EXIT_STATUS}" "Test failures are present!"
+        die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
     fi
 }
 
 
+function generate_tests () {
+
+    set -exuo pipefail
+
+    # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
+    # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
+    # The generation is done by executing any *.py executable
+    # within any subdirectory after copying.
+
+    # This is a separate function, because this code is called
+    # both by autogen checker and entries calling run_pybot.
+
+    # Directories read:
+    # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
+    # Directories replaced:
+    # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
+
+    rm -rf "${GENERATED_DIR}/tests"
+    cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests"
+    cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
+    cmd_line+=("-executable" "-name" "*.py")
+    file_list=$("${cmd_line[@]}") || die
+
+    for gen in ${file_list}; do
+        directory="$(dirname "${gen}")" || die
+        filename="$(basename "${gen}")" || die
+        pushd "${directory}" || die
+        ./"${filename}" || die
+        popd || die
+    done
+}
+
+
 function get_test_code () {
 
     set -exuo pipefail
@@ -500,45 +562,34 @@ function run_pybot () {
 
     set -exuo pipefail
 
-    # Currently, VPP-1361 causes occasional test failures.
-    # If real result is more important than time, we can retry few times.
-    # TODO: We should be retrying on test case level instead.
-
-    # Arguments:
-    # - ${1} - Optional number of pybot invocations to try to avoid failures.
-    #   Default: 1.
     # Variables read:
     # - CSIT_DIR - Path to existing root of local CSIT git repository.
     # - ARCHIVE_DIR - Path to store robot result files in.
     # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
+    # - GENERATED_DIR - Tests are assumed to be generated under there.
     # Variables set:
     # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
     # Functions called:
     # - die - Print to stderr and exit.
 
-    # Set ${tries} as an integer variable, to fail on non-numeric input.
-    local -i "tries" || die "Setting type of variable failed."
-    tries="${1:-1}" || die "Argument evaluation failed."
     all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
     all_options+=("${EXPANDED_TAGS[@]}")
 
-    while true; do
-        if [[ "${tries}" -le 0 ]]; then
-            break
-        else
-            tries="$((${tries} - 1))"
-        fi
-        pushd "${CSIT_DIR}" || die "Change directory operation failed."
-        set +e
-        # TODO: Make robot tests not require "$(pwd)" == "${CSIT_DIR}".
-        pybot "${all_options[@]}" "${CSIT_DIR}/tests/"
-        PYBOT_EXIT_STATUS="$?"
-        set -e
-        popd || die "Change directory operation failed."
-        if [[ "${PYBOT_EXIT_STATUS}" == "0" ]]; then
-            break
-        fi
-    done
+    pushd "${CSIT_DIR}" || die "Change directory operation failed."
+    set +e
+    # TODO: Make robot tests not require "$(pwd)" == "${CSIT_DIR}".
+    pybot "${all_options[@]}" "${GENERATED_DIR}/tests/"
+    PYBOT_EXIT_STATUS="$?"
+    set -e
+
+    # Generate INFO level output_info.xml for post-processing.
+    all_options=("--loglevel" "INFO")
+    all_options+=("--log" "none")
+    all_options+=("--report" "none")
+    all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
+    all_options+=("${ARCHIVE_DIR}/output.xml")
+    rebot "${all_options[@]}"
+    popd || die "Change directory operation failed."
 }
 
 
@@ -556,17 +607,23 @@ function select_tags () {
     # - TAGS - Array of processed tag boolean expressions.
 
     # NIC SELECTION
-    # All topologies NICs
-    available=$(grep -hoPR "model: \K.*" "${TOPOLOGIES_DIR}"/* | sort -u)
-    # Selected topology NICs
-    reserved=$(grep -hoPR "model: \K.*" "${WORKING_TOPOLOGY}" | sort -u)
-    # All topologies NICs - Selected topology NICs
+    start_pattern='^  TG:'
+    end_pattern='^ \? \?[A-Za-z0-9]\+:'
+    # Remove the TG section from topology file
+    sed_command="/${start_pattern}/,/${end_pattern}/d"
+    # All topologies DUT NICs
+    available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
+                | grep -hoP "model: \K.*" | sort -u)
+    # Selected topology DUT NICs
+    reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
+               | grep -hoP "model: \K.*" | sort -u)
+    # All topologies DUT NICs - Selected topology DUT NICs
     exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}")))
 
     # Select default NIC
     case "${TEST_CODE}" in
         *"3n-tsh"*)
-            DEFAULT_NIC='nic_intel-82599es'
+            DEFAULT_NIC='nic_intel-x520-da2'
             ;;
         *)
             DEFAULT_NIC='nic_intel-x710'
@@ -576,107 +633,13 @@ function select_tags () {
     case "${TEST_CODE}" in
         # Select specific performance tests based on jenkins job type variable.
         *"ndrpdr-weekly"* )
-            test_tag_array=("ndrpdrAND64bAND1c"
-                            "ndrpdrAND78bAND1c")
+            readarray -t test_tag_array < "${BASH_FUNCTION_DIR}/mlr-weekly.txt"
             ;;
         *"mrr-daily"* )
-            test_tag_array=(# vic
-                            "mrrANDnic_cisco-vic-1227AND64b"
-                            "mrrANDnic_cisco-vic-1385AND64b"
-                            # memif
-                            "mrrANDmemifANDethAND64b"
-                            "mrrANDmemifANDethANDimix"
-                            # crypto
-                            "mrrANDipsecAND64b"
-                            # ip4 base
-                            "mrrANDip4baseAND64b"
-                            # ip4 scale FIB 2M
-                            "mrrANDip4fwdANDfib_2mAND64b"
-                            # ip4 scale FIB 200k
-                            "mrrANDip4fwdANDfib_200kANDnic_intel-*710AND64b"
-                            # ip4 scale FIB 20k
-                            "mrrANDip4fwdANDfib_20kANDnic_intel-*710AND64b"
-                            # ip4 scale ACL
-                            "mrrANDip4fwdANDacl1AND10k_flowsAND64b"
-                            "mrrANDip4fwdANDacl50AND10k_flowsAND64b"
-                            # ip4 scale NAT44
-                            "mrrANDip4fwdANDnat44ANDbaseAND64b"
-                            "mrrANDip4fwdANDnat44ANDsrc_user_4000AND64b"
-                            # ip4 features
-                            "mrrANDip4fwdANDfeatureANDnic_intel-*710AND64b"
-                            # TODO: Remove when tags in
-                            # tests/vpp/perf/ip4/*-ipolicemarkbase-*.robot
-                            # are fixed
-                            "mrrANDip4fwdANDpolice_markANDnic_intel-*710AND64b"
-                            # ip4 tunnels
-                            "mrrANDip4fwdANDencapANDip6unrlayANDip4ovrlayANDnic_intel-x520-da2AND64b"
-                            "mrrANDip4fwdANDencapANDnic_intel-*710AND64b"
-                            "mrrANDl2ovrlayANDencapANDnic_intel-*710AND64b"
-                            # ip6 base
-                            "mrrANDip6baseANDethAND78b"
-                            # ip6 features
-                            "mrrANDip6fwdANDfeatureANDnic_intel-*710AND78b"
-                            # ip6 scale FIB 2M
-                            "mrrANDip6fwdANDfib_2mANDnic_intel-*710AND78b"
-                            # ip6 scale FIB 200k
-                            "mrrANDip6fwdANDfib_200kANDnic_intel-*710AND78b"
-                            # ip6 scale FIB 20k
-                            "mrrANDip6fwdANDfib_20kANDnic_intel-*710AND78b"
-                            # ip6 tunnels
-                            "mrrANDip6fwdANDencapANDnic_intel-x520-da2AND78b"
-                            # l2xc base
-                            "mrrANDl2xcfwdANDbaseAND64b"
-                            # l2xc scale ACL
-                            "mrrANDl2xcANDacl1AND10k_flowsAND64b"
-                            "mrrANDl2xcANDacl50AND10k_flowsAND64b"
-                            # l2xc scale FIB 2M
-                            "mrrANDl2xcANDfib_2mAND64b"
-                            # l2xc scale FIB 200k
-                            "mrrANDl2xcANDfib_200kANDnic_intel-*710AND64b"
-                            # l2xc scale FIB 20k
-                            "mrrANDl2xcANDfib_20kANDnic_intel-*710AND64b"
-                            # l2bd base
-                            "mrrANDl2bdmaclrnANDbaseAND64b"
-                            # l2bd scale ACL
-                            "mrrANDl2bdmaclrnANDacl1AND10k_flowsAND64b"
-                            "mrrANDl2bdmaclrnANDacl50AND10k_flowsAND64b"
-                            # l2bd scale FIB 2M
-                            "mrrANDl2bdmaclrnANDfib_1mAND64b"
-                            # l2bd scale FIB 200k
-                            "mrrANDl2bdmaclrnANDfib_100kANDnic_intel-*710AND64b"
-                            # l2bd scale FIB 20k
-                            "mrrANDl2bdmaclrnANDfib_10kANDnic_intel-*710AND64b"
-                            # l2 patch base
-                            "mrrANDl2patchAND64b"
-                            # srv6
-                            "mrrANDsrv6ANDnic_intel-x520-da2AND78b"
-                            # vts
-                            "mrrANDvtsANDnic_intel-x520-da2AND114b"
-                            # vm vhost l2xc base
-                            "mrrANDvhostANDl2xcfwdANDbaseAND64b"
-                            "mrrANDvhostANDl2xcfwdANDbaseANDimix"
-                            # vm vhost l2bd base
-                            "mrrANDvhostANDl2bdmaclrnANDbaseAND64b"
-                            "mrrANDvhostANDl2bdmaclrnANDbaseANDimix"
-                            # vm vhost ip4 base
-                            "mrrANDvhostANDip4fwdANDbaseAND64b"
-                            "mrrANDvhostANDip4fwdANDbaseANDimix"
-                            # DPDK
-                            "mrrANDdpdkAND64b"
-                            # Exclude
-                            "!mrrANDip6baseANDdot1qAND78b"
-                            "!vhost_256ANDnic_intel-x520-da2"
-                            "!vhostANDnic_intel-xl710"
-                            "!cfs_opt"
-                            "!lbond_dpdk"
-                            "!nf_density")
+            readarray -t test_tag_array < "${BASH_FUNCTION_DIR}/mrr-daily.txt"
             ;;
         *"mrr-weekly"* )
-            test_tag_array=(# NF Density tests
-                            "mrrANDnf_densityAND64b"
-                            "mrrANDnf_densityANDimix"
-                            # DPDK
-                            "mrrANDdpdkAND64b")
+            readarray -t test_tag_array < "${BASH_FUNCTION_DIR}/mrr-weekly.txt"
             ;;
         * )
             if [[ -z "${TEST_TAG_STRING-}" ]]; then
@@ -686,7 +649,7 @@ function select_tags () {
                                 "mrrAND${DEFAULT_NIC}AND1cAND78bANDip6base"
                                 "mrrAND${DEFAULT_NIC}AND1cAND64bANDl2bdbase"
                                 "mrrAND${DEFAULT_NIC}AND1cAND64bANDl2xcbase"
-                                "!dot1q")
+                                "!dot1q" "!drv_avf")
             else
                 # If trigger contains tags, split them into array.
                 test_tag_array=(${TEST_TAG_STRING//:/ })
@@ -696,21 +659,36 @@ function select_tags () {
 
     # Blacklisting certain tags per topology.
     case "${TEST_CODE}" in
-        *"3n-hsw"*)
-            test_tag_array+=("!drv_avf")
-            ;;
         *"2n-skx"*)
             test_tag_array+=("!ipsechw")
             ;;
         *"3n-skx"*)
             test_tag_array+=("!ipsechw")
+            # Not enough nic_intel-xxv710 to support double link tests.
+            test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
             ;;
         *"3n-tsh"*)
             test_tag_array+=("!ipsechw")
+            test_tag_array+=("!memif")
+            test_tag_array+=("!srv6_proxy")
+            test_tag_array+=("!vhost")
+            test_tag_array+=("!vts")
+            ;;
+        *"3n-hsw"*)
+            # TODO: Introduce NOIOMMU version of AVF tests.
+            # TODO: Make (both) AVF tests work on Haswell,
+            # or document why (some of) it is not possible.
+            # https://github.com/FDio/vpp/blob/master/src/plugins/avf/README.md
+            test_tag_array+=("!drv_avf")
+            # All cards have access to QAT. But only one card (xl710)
+            # resides in same NUMA as QAT. Other cards must go over QPI
+            # which we do not want to even run.
+            test_tag_array+=("!ipsechwNOTnic_intel-xl710")
             ;;
         *)
             # Default to 3n-hsw due to compatibility.
             test_tag_array+=("!drv_avf")
+            test_tag_array+=("!ipsechwNOTnic_intel-xl710")
             ;;
     esac
 
@@ -722,19 +700,27 @@ function select_tags () {
     # We will prefix with perftest to prevent running other tests
     # (e.g. Functional).
     prefix="perftestAND"
+    set +x
     if [[ "${TEST_CODE}" == "vpp-"* ]]; then
         # Automatic prefixing for VPP jobs to limit the NIC used and
         # traffic evaluation to MRR.
-        prefix="${prefix}mrrAND${DEFAULT_NIC}AND"
+        if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
+            prefix="${prefix}mrrAND"
+        else
+            prefix="${prefix}mrrAND${DEFAULT_NIC}AND"
+        fi
     fi
     for tag in "${test_tag_array[@]}"; do
-        if [[ ${tag} == "!"* ]]; then
+        if [[ "${tag}" == "!"* ]]; then
             # Exclude tags are not prefixed.
             TAGS+=("${tag}")
-        else
+        elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
+            # Empty and comment lines are skipped.
+            # Other lines are normal tags, they are to be prefixed.
             TAGS+=("${prefix}${tag}")
         fi
     done
+    set -x
 }
 
 
@@ -783,6 +769,36 @@ function select_vpp_device_tags () {
     done
 }
 
+function select_os () {
+
+    set -exuo pipefail
+
+    # Variables set:
+    # - VPP_VER_FILE - Name of File in CSIT dir containing vpp stable version.
+    # - IMAGE_VER_FILE - Name of File in CSIT dir containing the image name.
+    # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
+
+    os_id=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') || {
+        die "Get OS release failed."
+    }
+
+    case "${os_id}" in
+        "ubuntu"*)
+            IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
+            VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_BIONIC"
+            PKG_SUFFIX="deb"
+            ;;
+        "centos"*)
+            IMAGE_VER_FILE="VPP_DEVICE_IMAGE_CENTOS"
+            VPP_VER_FILE="VPP_STABLE_VER_CENTOS"
+            PKG_SUFFIX="rpm"
+            ;;
+        *)
+            die "Unable to identify distro or os from ${OS}"
+            ;;
+    esac
+}
+
 
 function select_topology () {
 
@@ -801,46 +817,29 @@ function select_topology () {
 
     case_text="${NODENESS}_${FLAVOR}"
     case "${case_text}" in
+        # TODO: Move tags to "# Blacklisting certain tags per topology" section.
         "1n_vbox")
-            TOPOLOGIES=(
-                        "${TOPOLOGIES_DIR}/vpp_device.template"
-                       )
+            TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
             TOPOLOGIES_TAGS="2_node_single_link_topo"
             ;;
         "1n_skx")
-            TOPOLOGIES=(
-                        "${TOPOLOGIES_DIR}/vpp_device.template"
-                       )
+            TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
             TOPOLOGIES_TAGS="2_node_single_link_topo"
             ;;
         "2n_skx")
-            TOPOLOGIES=(
-                        "${TOPOLOGIES_DIR}/lf_2n_skx_testbed21.yaml"
-                        #"${TOPOLOGIES_DIR}/lf_2n_skx_testbed22.yaml"
-                        "${TOPOLOGIES_DIR}/lf_2n_skx_testbed23.yaml"
-                        "${TOPOLOGIES_DIR}/lf_2n_skx_testbed24.yaml"
-                       )
+            TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
             TOPOLOGIES_TAGS="2_node_*_link_topo"
             ;;
         "3n_skx")
-            TOPOLOGIES=(
-                        "${TOPOLOGIES_DIR}/lf_3n_skx_testbed31.yaml"
-                        "${TOPOLOGIES_DIR}/lf_3n_skx_testbed32.yaml"
-                       )
+            TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
             TOPOLOGIES_TAGS="3_node_*_link_topo"
             ;;
         "3n_hsw")
-            TOPOLOGIES=(
-                        "${TOPOLOGIES_DIR}/lf_3n_hsw_testbed1.yaml"
-                        "${TOPOLOGIES_DIR}/lf_3n_hsw_testbed2.yaml"
-                        "${TOPOLOGIES_DIR}/lf_3n_hsw_testbed3.yaml"
-                       )
+            TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
             TOPOLOGIES_TAGS="3_node_single_link_topo"
             ;;
         "3n_tsh")
-            TOPOLOGIES=(
-                        "${TOPOLOGIES_DIR}/lf_3n_tsh_testbed33.yaml"
-                       )
+            TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
             TOPOLOGIES_TAGS="3_node_*_link_topo"
             ;;
         *)