Add output.xml with only INFO logging leve
[csit.git] / resources / libraries / bash / function / common.sh
index 6f57c03..eaad2ab 100644 (file)
@@ -1,4 +1,5 @@
-# Copyright (c) 2018 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2019 PANTHEON.tech and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
@@ -22,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.
     #
@@ -33,8 +36,6 @@ function activate_docker_topology () {
     # Variables set:
     # - WORKING_TOPOLOGY - Path to topology file.
 
-    set -exuo pipefail
-
     source "${BASH_FUNCTION_DIR}/device.sh" || {
         die "Source failed!"
     }
@@ -49,7 +50,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
@@ -90,43 +92,64 @@ function activate_virtualenv () {
 
     set -exuo pipefail
 
+    # Update virtualenv pip package, delete and create virtualenv directory,
+    # activate the virtualenv, install requirements, set PYTHONPATH.
+
     # Arguments:
-    # - ${1} - Non-empty path to existing directory for creating virtualenv in.
+    # - ${1} - Path to existing directory for creating virtualenv in.
+    #          If missing or empty, ${CSIT_DIR} is used.
+    # - ${2} - Path to requirements file, ${CSIT_DIR}/requirements.txt if empty.
     # Variables read:
     # - CSIT_DIR - Path to existing root of local CSIT git repository.
-    # Variables set:
-    # - ENV_DIR - Path to the created virtualenv subdirectory.
     # Variables exported:
     # - PYTHONPATH - CSIT_DIR, as CSIT Python scripts usually need this.
     # Functions called:
     # - die - Print to stderr and exit.
 
-    # TODO: Do we really need to have ENV_DIR available as a global variable?
-
-    if [[ "${1-}" == "" ]]; then
-        die "Root location of virtualenv to create is not specified."
-    fi
-    ENV_DIR="${1}/env"
-    rm -rf "${ENV_DIR}" || die "Failed to clean previous virtualenv."
+    # TODO: Do we want the callers to be able to set the env dir name?
+    # TODO: + In that case, do we want to support env switching?
+    # TODO:   + In that case we want to make env_dir global.
+    # TODO: Do we want the callers to override PYTHONPATH loaction?
 
+    root_path="${1-$CSIT_DIR}"
+    env_dir="${root_path}/env"
+    req_path=${2-$CSIT_DIR/requirements.txt}
+    rm -rf "${env_dir}" || die "Failed to clean previous virtualenv."
     pip install --upgrade virtualenv || {
         die "Virtualenv package install failed."
     }
-    virtualenv "${ENV_DIR}" || {
+    virtualenv "${env_dir}" || {
         die "Virtualenv creation failed."
     }
     set +u
-    source "${ENV_DIR}/bin/activate" || die "Virtualenv activation failed."
+    source "${env_dir}/bin/activate" || die "Virtualenv activation failed."
     set -u
-    pip install -r "${CSIT_DIR}/requirements.txt" || {
-        die "CSIT requirements installation failed."
+    pip install --upgrade -r "${req_path}" || {
+        die "Requirements installation failed."
     }
-
     # Most CSIT Python scripts assume PYTHONPATH is set and exported.
     export PYTHONPATH="${CSIT_DIR}" || die "Export failed."
 }
 
 
+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
@@ -165,6 +188,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.
@@ -174,6 +199,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.
 
@@ -207,6 +235,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."
 }
 
 
@@ -338,11 +370,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
@@ -379,6 +444,10 @@ function get_test_code () {
             NODENESS="3n"
             FLAVOR="skx"
             ;;
+        *"3n-tsh"*)
+            NODENESS="3n"
+            FLAVOR="tsh"
+            ;;
         *)
             # Fallback to 3-node Haswell by default (backward compatibility)
             NODENESS="3n"
@@ -415,11 +484,17 @@ function get_test_tag_string () {
                 ;;
             *"perf"*)
                 # On parsing error, ${trigger} stays empty.
-                trigger="$(echo "${GERRIT_EVENT_COMMENT_TEXT}" \
-                    | grep -oE '(perftest$|perftest[[:space:]].+$)')" \
-                    || true
+                comment="${GERRIT_EVENT_COMMENT_TEXT}"
+                # As "perftest" can be followed by something, we substitute it.
+                comment="${comment/perftest-2n/perftest}"
+                comment="${comment/perftest-3n/perftest}"
+                comment="${comment/perftest-hsw/perftest}"
+                comment="${comment/perftest-skx/perftest}"
+                comment="${comment/perftest-tsh/perftest}"
+                tag_string="$(echo "${comment}" \
+                    | grep -oE '(perftest$|perftest[[:space:]].+$)' || true)"
                 # Set test tags as string.
-                TEST_TAG_STRING="${trigger#$"perftest"}"
+                TEST_TAG_STRING="${tag_string#$"perftest"}"
                 ;;
             *)
                 die "Unknown specification: ${TEST_CODE}"
@@ -486,45 +561,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."
 }
 
 
@@ -542,119 +606,49 @@ 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-x520-da2'
+            ;;
+        *)
+            DEFAULT_NIC='nic_intel-x710'
+            ;;
+    esac
+
     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"* )
+            readarray -t test_tag_array < "${BASH_FUNCTION_DIR}/mrr-daily.txt"
             ;;
-        *"mrr-daily"* | *"mrr-weekly"* )
-            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")
+        *"mrr-weekly"* )
+            readarray -t test_tag_array < "${BASH_FUNCTION_DIR}/mrr-weekly.txt"
             ;;
         * )
             if [[ -z "${TEST_TAG_STRING-}" ]]; then
                 # If nothing is specified, we will run pre-selected tests by
                 # following tags.
-                test_tag_array=("mrrANDnic_intel-x710AND1cAND64bANDip4base"
-                                "mrrANDnic_intel-x710AND1cAND78bANDip6base"
-                                "mrrANDnic_intel-x710AND1cAND64bANDl2bdbase"
-                                "mrrANDnic_intel-x710AND1cAND64bANDl2xcbase"
-                                "!dot1q")
+                test_tag_array=("mrrAND${DEFAULT_NIC}AND1cAND64bANDip4base"
+                                "mrrAND${DEFAULT_NIC}AND1cAND78bANDip6base"
+                                "mrrAND${DEFAULT_NIC}AND1cAND64bANDl2bdbase"
+                                "mrrAND${DEFAULT_NIC}AND1cAND64bANDl2xcbase"
+                                "!dot1q" "!drv_avf")
             else
                 # If trigger contains tags, split them into array.
                 test_tag_array=(${TEST_TAG_STRING//:/ })
@@ -673,6 +667,13 @@ function select_tags () {
         *"3n-skx"*)
             test_tag_array+=("!ipsechw")
             ;;
+        *"3n-tsh"*)
+            test_tag_array+=("!ipsechw")
+            test_tag_array+=("!memif")
+            test_tag_array+=("!srv6_proxy")
+            test_tag_array+=("!vhost")
+            test_tag_array+=("!vts")
+            ;;
         *)
             # Default to 3n-hsw due to compatibility.
             test_tag_array+=("!drv_avf")
@@ -690,13 +691,15 @@ function select_tags () {
     if [[ "${TEST_CODE}" == "vpp-"* ]]; then
         # Automatic prefixing for VPP jobs to limit the NIC used and
         # traffic evaluation to MRR.
-        prefix="${prefix}mrrANDnic_intel-x710AND"
+        prefix="${prefix}mrrAND${DEFAULT_NIC}AND"
     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
@@ -802,6 +805,12 @@ function select_topology () {
                        )
             TOPOLOGIES_TAGS="3_node_single_link_topo"
             ;;
+        "3n_tsh")
+            TOPOLOGIES=(
+                        "${TOPOLOGIES_DIR}/lf_3n_tsh_testbed33.yaml"
+                       )
+            TOPOLOGIES_TAGS="3_node_*_link_topo"
+            ;;
         *)
             # No falling back to 3n_hsw default, that should have been done
             # by the function which has set NODENESS and FLAVOR.