-# 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:
# the code might become more readable (but longer).
-function activate_virtualenv () {
+function activate_docker_topology () {
+
+ # Create virtual vpp-device topology. Output of the function is topology
+ # file describing created environment saved to a file.
+ #
+ # Variables read:
+ # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
+ # - 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.
+ # - CSIT_DIR - Directory where ${IMAGE_VER_FILE} is located.
+ # Variables set:
+ # - WORKING_TOPOLOGY - Path to topology file.
set -exuo pipefail
+ source "${BASH_FUNCTION_DIR}/device.sh" || {
+ die "Source failed!"
+ }
+
+ device_image="$(< ${CSIT_DIR}/${IMAGE_VER_FILE})"
+ case_text="${NODENESS}_${FLAVOR}"
+ case "${case_text}" in
+ "1n_skx" | "1n_tx2")
+ # We execute reservation over csit-shim-dcr (ssh) which runs sourced
+ # script's functions. Env variables are read from ssh output
+ # back to localhost for further processing.
+ hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
+ ssh="ssh root@${hostname} -p 6022"
+ run="activate_wrapper ${NODENESS} ${FLAVOR} ${device_image}"
+ # backtics to avoid https://midnight-commander.org/ticket/2142
+ env_vars=`${ssh} "$(declare -f); ${run}"` || {
+ die "Topology reservation via shim-dcr failed!"
+ }
+ set -a
+ source <(echo "$env_vars" | grep -v /usr/bin/docker) || {
+ die "Source failed!"
+ }
+ set +a
+ ;;
+ "1n_vbox")
+ # We execute reservation on localhost. Sourced script automatially
+ # sets environment variables for further processing.
+ activate_wrapper "${NODENESS}" "${FLAVOR}" "${device_image}" || die
+ ;;
+ *)
+ die "Unknown specification: ${case_text}!"
+ esac
+
+ trap 'deactivate_docker_topology' EXIT || {
+ die "Trap attempt failed, please cleanup manually. Aborting!"
+ }
+
+ # Replace all variables in template with those in environment.
+ source <(echo 'cat <<EOF >topo.yml'; cat ${TOPOLOGIES[0]}; echo EOF;) || {
+ die "Topology file create failed!"
+ }
+
+ WORKING_TOPOLOGY="/tmp/topology.yaml"
+ mv topo.yml "${WORKING_TOPOLOGY}" || {
+ die "Topology move failed!"
+ }
+ cat ${WORKING_TOPOLOGY} | grep -v password || {
+ die "Topology read failed!"
+ }
+}
+
+
+function activate_virtualenv () {
+
+ # 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."
+ set -exuo pipefail
+ 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 --system-site-packages "${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 check_download_dir () {
+function archive_tests () {
+
+ # 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.
set -exuo pipefail
+ tar c "${GENERATED_DIR}/tests" | xz -9e > "${ARCHIVE_DIR}/tests.tar.xz" || {
+ die "Error creating archive of generated tests."
+ }
+}
+
+
+function check_download_dir () {
+
# Fail if there are no files visible in ${DOWNLOAD_DIR}.
- # TODO: Do we need this as a function, if it is (almost) a one-liner?
#
# Variables read:
# - DOWNLOAD_DIR - Path to directory pybot takes the build to test from.
# Functions called:
# - die - Print to stderr and exit.
+ set -exuo pipefail
+
if [[ ! "$(ls -A "${DOWNLOAD_DIR}")" ]]; then
die "No artifacts downloaded!"
fi
}
-function common_dirs () {
+function cleanup_topo () {
+
+ # Variables read:
+ # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
+ # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
set -exuo pipefail
+ python "${PYTHON_SCRIPTS_DIR}/topo_cleanup.py" -t "${WORKING_TOPOLOGY}"
+ # Not using "|| die" as some callers might want to ignore errors,
+ # e.g. in teardowns, such as unreserve.
+}
+
+
+function common_dirs () {
+
+ # 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.
# - 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.
- BASH_FUNCTION_DIR="$(dirname "$(readlink -e "${BASH_SOURCE[0]}")")" || {
- die "Some error during localizing this source directory."
+ set -exuo pipefail
+
+ this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
+ die "Some error during locating of this source file."
+ }
+ BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
+ die "Some error during dirname call."
}
# Current working directory could be in a different repo, e.g. VPP.
pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
- CSIT_DIR="$(readlink -e "$(git rev-parse --show-toplevel)")" || {
- die "Readlink or git rev-parse failed."
+ relative_csit_dir=$(git rev-parse --show-toplevel) || {
+ die "Git rev-parse failed."
}
+ CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
popd || die "Popd failed."
- TOPOLOGIES_DIR="$(readlink -e "${CSIT_DIR}/topologies/available")" || {
+ TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
die "Readlink failed."
}
- RESOURCES_DIR="$(readlink -e "${CSIT_DIR}/resources")" || {
+ RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
die "Readlink failed."
}
- TOOLS_DIR="$(readlink -e "${RESOURCES_DIR}/tools")" || {
+ TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
die "Readlink failed."
}
- PYTHON_SCRIPTS_DIR="$(readlink -e "${TOOLS_DIR}/scripts")" || {
+ PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
die "Readlink failed."
}
- ARCHIVE_DIR="$(readlink -f "${CSIT_DIR}/archive")" || {
+ ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archive") || {
die "Readlink failed."
}
mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
- DOWNLOAD_DIR="$(readlink -f "${CSIT_DIR}/download_dir")" || {
+ DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
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."
}
function compose_pybot_arguments () {
- set -exuo pipefail
-
# Variables read:
# - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
# - DUT - CSIT test/ subdirectory, set while processing tags.
# - TAGS - Array variable holding selected tag boolean expressions.
# - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
+ # - TEST_CODE - The test selection string from environment or argument.
# Variables set:
# - PYBOT_ARGS - String holding part of all arguments for pybot.
# - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
+ set -exuo pipefail
+
# No explicit check needed with "set -u".
- PYBOT_ARGS=("--loglevel" "TRACE" "--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
- PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
+ PYBOT_ARGS=("--loglevel" "TRACE")
+ PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
+
+ case "${TEST_CODE}" in
+ *"device"*)
+ PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
+ ;;
+ *"func"*)
+ PYBOT_ARGS+=("--suite" "tests.${DUT}.func")
+ ;;
+ *"perf"*)
+ PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
+ ;;
+ *)
+ die "Unknown specification: ${TEST_CODE}"
+ esac
EXPANDED_TAGS=()
for tag in "${TAGS[@]}"; do
function copy_archives () {
- set -exuo pipefail
-
+ # Create additional archive if workspace variable is set.
+ # This way if script is running in jenkins all will be
+ # automatically archived to logs.fd.io.
+ #
# Variables read:
# - WORKSPACE - Jenkins workspace, copy only if the value is not empty.
# Can be unset, then it speeds up manual testing.
# Functions called:
# - die - Print to stderr and exit.
- # We will create additional archive if workspace variable is set.
- # This way if script is running in jenkins all will be
- # automatically archived to logs.fd.io.
+ set -exuo pipefail
+
if [[ -n "${WORKSPACE-}" ]]; then
mkdir -p "${WORKSPACE}/archives/" || die "Archives dir create failed."
- cp -r "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
+ cp -rf "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
fi
}
+function deactivate_docker_topology () {
+
+ # Deactivate virtual vpp-device topology by removing containers.
+ #
+ # Variables read:
+ # - NODENESS - Node multiplicity of desired testbed.
+ # - FLAVOR - Node flavor string, usually describing the processor.
+
+ set -exuo pipefail
+
+ case_text="${NODENESS}_${FLAVOR}"
+ case "${case_text}" in
+ "1n_skx" | "1n_tx2")
+ hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
+ ssh="ssh root@${hostname} -p 6022"
+ env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
+ ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
+ die "Topology cleanup via shim-dcr failed!"
+ }
+ ;;
+ "1n_vbox")
+ enter_mutex || die
+ clean_environment || {
+ die "Topology cleanup locally failed!"
+ }
+ exit_mutex || die
+ ;;
+ *)
+ die "Unknown specification: ${case_text}!"
+ esac
+}
+
+
function die () {
+
# Print the message to standard error end exit with error code specified
# by the second argument.
#
function die_on_pybot_error () {
- set -exuo pipefail
-
# Source this fragment if you want to abort on any failed test case.
#
# Variables read:
# Functions called:
# - die - Print to stderr and exit.
+ set -exuo pipefail
+
if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
- die "${PYBOT_EXIT_STATUS}" "Test failures are present!"
+ die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
fi
}
-function get_test_code () {
+function generate_tests () {
+
+ # 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.
set -exuo pipefail
+ rm -rf "${GENERATED_DIR}/tests" || die
+ cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
+ 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 () {
+
# Arguments:
# - ${1} - Optional, argument of entry script (or empty as unset).
# Test code value to override job name from environment.
# - NODENESS - Node multiplicity of desired testbed.
# - FLAVOR - Node flavor string, usually describing the processor.
+ set -exuo pipefail
+
TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
if [[ -z "${TEST_CODE}" ]]; then
TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
fi
case "${TEST_CODE}" in
+ *"1n-vbox"*)
+ NODENESS="1n"
+ FLAVOR="vbox"
+ ;;
+ *"1n-skx"*)
+ NODENESS="1n"
+ FLAVOR="skx"
+ ;;
+ *"1n-tx2"*)
+ NODENESS="1n"
+ FLAVOR="tx2"
+ ;;
*"2n-skx"*)
NODENESS="2n"
FLAVOR="skx"
NODENESS="3n"
FLAVOR="skx"
;;
+ *"2n-dnv"*)
+ NODENESS="2n"
+ FLAVOR="dnv"
+ ;;
+ *"3n-dnv"*)
+ NODENESS="3n"
+ FLAVOR="dnv"
+ ;;
+ *"3n-tsh"*)
+ NODENESS="3n"
+ FLAVOR="tsh"
+ ;;
*)
# Fallback to 3-node Haswell by default (backward compatibility)
NODENESS="3n"
function get_test_tag_string () {
- set -exuo pipefail
-
# Variables read:
# - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
# - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
+ # - TEST_CODE - The test selection string from environment or argument.
# Variables set:
- # - TEST_TAG_STRING - The string following "perftest" in gerrit comment,
- # or empty.
+ # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
+ # May be empty, not set on event types not adding comment.
# TODO: ci-management scripts no longer need to perform this.
+ set -exuo pipefail
+
trigger=""
if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
- # On parsing error, ${trigger} stays empty.
- trigger="$(echo "${GERRIT_EVENT_COMMENT_TEXT}" \
- | grep -oE '(perftest$|perftest[[:space:]].+$)')" || true
+ case "${TEST_CODE}" in
+ *"device"*)
+ # On parsing error, ${trigger} stays empty.
+ trigger="$(echo "${GERRIT_EVENT_COMMENT_TEXT}" \
+ | grep -oE '(devicetest$|devicetest[[:space:]].+$)')" \
+ || true
+ # Set test tags as string.
+ TEST_TAG_STRING="${trigger#$"devicetest"}"
+ ;;
+ *"perf"*)
+ # On parsing error, ${trigger} stays empty.
+ 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-dnv/perftest}"
+ comment="${comment/perftest-tsh/perftest}"
+ tag_string="$(echo "${comment}" \
+ | grep -oE '(perftest$|perftest[[:space:]].+$)' || true)"
+ # Set test tags as string.
+ TEST_TAG_STRING="${tag_string#$"perftest"}"
+ ;;
+ *)
+ die "Unknown specification: ${TEST_CODE}"
+ esac
fi
- # Set test tags as string.
- TEST_TAG_STRING="${trigger#$"perftest"}"
}
-function reserve_testbed () {
-
- set -exuo pipefail
+function reserve_and_cleanup_testbed () {
# Reserve physical testbed, perform cleanup, register trap to unreserve.
+ # When cleanup fails, remove from topologies and keep retrying
+ # until all topologies are removed.
#
# Variables read:
# - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
# - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
+ # - BUILD_TAG - Any string suitable as filename, identifying
+ # test run executing this function. May be unset.
+ # - BUILD_URL - Any string suitable as URL, identifying
+ # test run executing this function. May be unset.
# Variables set:
+ # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
# - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
# Functions called:
# - die - Print to stderr and exit.
# Traps registered:
# - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
- while true; do
+ set -exuo pipefail
+
+ while [[ ${TOPOLOGIES[@]} ]]; do
for topo in "${TOPOLOGIES[@]}"; do
set +e
- python "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -t "${topo}"
+ scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
+ opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
+ opts+=("-u" "${BUILD_URL:-Unknown}")
+ python "${scrpt}" "${opts[@]}"
result="$?"
set -e
if [[ "${result}" == "0" ]]; then
+ # Trap unreservation before cleanup check,
+ # so multiple jobs showing failed cleanup improve chances
+ # of humans to notice and fix.
WORKING_TOPOLOGY="${topo}"
echo "Reserved: ${WORKING_TOPOLOGY}"
trap "untrap_and_unreserve_testbed" EXIT || {
}
die "Trap attempt failed, unreserve succeeded. Aborting."
}
- python "${PYTHON_SCRIPTS_DIR}/topo_cleanup.py" -t "${topo}" || {
- die "Testbed cleanup failed."
- }
+ # Cleanup check.
+ set +e
+ cleanup_topo
+ result="$?"
+ set -e
+ if [[ "${result}" == "0" ]]; then
+ break
+ fi
+ warn "Testbed cleanup failed: ${topo}"
+ untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
+ # WORKING_TOPOLOGY is now empty again.
+ # Build new topology array.
+ # TOPOLOGIES=("${TOPOLOGIES[@]/$topo}")
+ # does not really work, see:
+ # https://stackoverflow.com/questions/16860877/remove-an-element-from-a-bash-array
+ new_topologies=()
+ for item in "${TOPOLOGIES[@]}"; do
+ if [[ "${item}" != "${topo}" ]]; then
+ new_topologies+=("${item}")
+ fi
+ done
+ TOPOLOGIES=("${new_topologies[@]}")
break
fi
done
echo "Sleeping ${sleep_time}"
sleep "${sleep_time}" || die "Sleep failed."
done
+ if [[ ${TOPOLOGIES[@]} ]]; then
+ echo "Reservation and cleanup successful."
+ else
+ die "Run out of operational testbeds!"
+ fi
}
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.
+ # Run pybot with options based on input variables. Create output_info.xml
+ #
# 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."
+ set -exuo pipefail
+
all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
+ all_options+=("--noncritical" "EXPECTED_FAILING")
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
+ 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[@]}" || true
+ popd || die "Change directory operation failed."
}
-function select_tags () {
+function select_os () {
+
+ # Populate variables related to local operating system.
+ #
+ # Also install any missing prerequisities CSIT tests need.
+ # TODO: Move the installation to a separate function?
+ #
+ # 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."
set -exuo pipefail
+ 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_tags () {
+
# Variables read:
# - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
# - TEST_CODE - String affecting test selection, usually jenkins job name.
# - TEST_TAG_STRING - String selecting tags, from gerrit comment.
# Can be unset.
# - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
+ # - BASH_FUNCTION_DIR - Directory with input files to process.
# Variables set:
# - TAGS - Array of processed tag boolean expressions.
+ set -exuo pipefail
+
# 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
- exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}")))
+ 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}"))) || {
+ die "Computation of excluded NICs failed."
+ }
+ # Select default NIC tag.
+ case "${TEST_CODE}" in
+ *"3n-dnv"* | *"2n-dnv"*)
+ default_nic="nic_intel-x553"
+ ;;
+ *"3n-tsh"*)
+ default_nic="nic_intel-x520-da2"
+ ;;
+ *)
+ default_nic="nic_intel-x710"
+ ;;
+ esac
+
+ # Tag file directory shorthand.
+ tfd="${BASH_FUNCTION_DIR}"
case "${TEST_CODE}" in
# Select specific performance tests based on jenkins job type variable.
*"ndrpdr-weekly"* )
- test_tag_array=("ndrpdrAND64bAND1c"
- "ndrpdrAND78bAND1c")
- ;;
- *"mrr-daily"* | *"mrr-weekly"* )
- test_tag_array=("mrrAND64bAND1c"
- "mrrAND64bAND2c"
- "mrrAND64bAND4c"
- "mrrAND78bAND1c"
- "mrrAND78bAND2c"
- "mrrAND78bAND4c"
- "mrrAND114bAND1c"
- "mrrAND114bAND2c"
- "mrrAND114bAND4c"
- "mrrANDimixAND1cANDvhost"
- "mrrANDimixAND2cANDvhost"
- "mrrANDimixAND4cANDvhost"
- "mrrANDimixAND1cANDmemif"
- "mrrANDimixAND2cANDmemif"
- "mrrANDimixAND4cANDmemif")
+ readarray -t test_tag_array < "${tfd}/mlr-weekly.txt" || die
+ ;;
+ *"mrr-daily"* )
+ readarray -t test_tag_array < \
+ "${tfd}/mrr-daily-${FLAVOR}.txt" || die
+ ;;
+ *"mrr-weekly"* )
+ readarray -t test_tag_array < "${tfd}/mrr-weekly.txt" || die
;;
* )
if [[ -z "${TEST_TAG_STRING-}" ]]; then
# If nothing is specified, we will run pre-selected tests by
- # following tags. Items of array will be concatenated by OR
- # in Robot Framework.
- test_tag_array=("mrrANDnic_intel-x710AND1cAND64bANDip4base"
- "mrrANDnic_intel-x710AND1cAND78bANDip6base"
- "mrrANDnic_intel-x710AND1cAND64bANDl2bdbaseANDbase"
- "mrrANDnic_intel-x710AND1cAND64bANDl2xcbase")
+ # following tags.
+ 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//:/ })
esac
# Blacklisting certain tags per topology.
+ #
+ # Reasons for blacklisting:
+ # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
+ # TODO: Add missing reasons here (if general) or where used (if specific).
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")
+ ;;
+ *"2n-dnv"*)
+ test_tag_array+=("!ipsechw")
+ test_tag_array+=("!memif")
+ test_tag_array+=("!srv6_proxy")
+ test_tag_array+=("!vhost")
+ test_tag_array+=("!vts")
+ test_tag_array+=("!drv_avf")
+ ;;
+ *"3n-dnv"*)
+ test_tag_array+=("!memif")
+ test_tag_array+=("!srv6_proxy")
+ test_tag_array+=("!vhost")
+ test_tag_array+=("!vts")
+ test_tag_array+=("!drv_avf")
+ ;;
+ *"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
# 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}mrrANDnic_intel-x710AND"
+ 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
}
function select_topology () {
- set -exuo pipefail
-
# Variables read:
# - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
# - FLAVOR - Node flavor string, currently either "hsw" or "skx".
# - CSIT_DIR - Path to existing root of local CSIT git repository.
- # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
+ # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
# Variables set:
# - TOPOLOGIES - Array of paths to suitable topology yaml files.
# - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
# Functions called:
# - die - Print to stderr and exit.
+ set -exuo pipefail
+
case_text="${NODENESS}_${FLAVOR}"
case "${case_text}" in
- "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_TAGS="3_node_single_link_topo"
+ # TODO: Move tags to "# Blacklisting certain tags per topology" section.
+ # TODO: Double link availability depends on NIC used.
+ "1n_vbox")
+ TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
+ TOPOLOGIES_TAGS="2_node_single_link_topo"
+ ;;
+ "1n_skx" | "1n_tx2")
+ 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"
+ ;;
+ "2n_dnv")
+ TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
+ TOPOLOGIES_TAGS="2_node_single_link_topo"
+ ;;
+ "3n_dnv")
+ TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
+ TOPOLOGIES_TAGS="3_node_single_link_topo"
+ ;;
+ "3n_hsw")
+ TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
+ TOPOLOGIES_TAGS="3_node_single_link_topo"
+ ;;
+ "3n_tsh")
+ TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
TOPOLOGIES_TAGS="3_node_*_link_topo"
;;
*)
}
+function select_vpp_device_tags () {
+
+ # Variables read:
+ # - TEST_CODE - String affecting test selection, usually jenkins job name.
+ # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
+ # Can be unset.
+ # Variables set:
+ # - TAGS - Array of processed tag boolean expressions.
+
+ set -exuo pipefail
+
+ case "${TEST_CODE}" in
+ # Select specific performance tests based on jenkins job type variable.
+ * )
+ if [[ -z "${TEST_TAG_STRING-}" ]]; then
+ # If nothing is specified, we will run pre-selected tests by
+ # following tags. Items of array will be concatenated by OR
+ # in Robot Framework.
+ test_tag_array=()
+ else
+ # If trigger contains tags, split them into array.
+ test_tag_array=(${TEST_TAG_STRING//:/ })
+ fi
+ ;;
+ esac
+
+ TAGS=()
+
+ # We will prefix with devicetest to prevent running other tests
+ # (e.g. Functional).
+ prefix="devicetestAND"
+ if [[ "${TEST_CODE}" == "vpp-"* ]]; then
+ # Automatic prefixing for VPP jobs to limit testing.
+ prefix="${prefix}"
+ fi
+ for tag in "${test_tag_array[@]}"; do
+ if [[ ${tag} == "!"* ]]; then
+ # Exclude tags are not prefixed.
+ TAGS+=("${tag}")
+ else
+ TAGS+=("${prefix}${tag}")
+ fi
+ done
+}
+
function untrap_and_unreserve_testbed () {
+
# Use this as a trap function to ensure testbed does not remain reserved.
# Perhaps call directly before script exit, to free testbed for other jobs.
# This function is smart enough to avoid multiple unreservations (so safe).
wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
if [[ -z "${wt-}" ]]; then
set -eu
- echo "Testbed looks unreserved already. Trap removal failed before?"
+ warn "Testbed looks unreserved already. Trap removal failed before?"
else
- python "${PYTHON_SCRIPTS_DIR}/topo_cleanup.py" -t "${wt}" || true
+ cleanup_topo || true
python "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
}
function warn () {
+
# Print the message to standard error.
#
# Arguments:
# - ${@} - The text of the message.
+ set -exuo pipefail
+
echo "$@" >&2
}