resources/libraries/bash/function/common.sh

   1 # Copyright (c) 2021 Cisco and/or its affiliates.
   2 # Copyright (c) 2021 PANTHEON.tech and/or its affiliates.
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at:
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 set -exuo pipefail
  16
  17 # This library defines functions used by multiple entry scripts.
  18 # Keep functions ordered alphabetically, please.
  19
  20 # TODO: Add a link to bash style guide.
  21 # TODO: Consider putting every die into a {} block,
  22 #   the code might become more readable (but longer).
  23
  24
  25 function activate_docker_topology () {
  26
  27     # Create virtual vpp-device topology. Output of the function is topology
  28     # file describing created environment saved to a file.
  29     #
  30     # Variables read:
  31     # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
  32     # - TOPOLOGIES - Available topologies.
  33     # - NODENESS - Node multiplicity of desired testbed.
  34     # - FLAVOR - Node flavor string, usually describing the processor.
  35     # - IMAGE_VER_FILE - Name of file that contains the image version.
  36     # - CSIT_DIR - Directory where ${IMAGE_VER_FILE} is located.
  37     # Variables set:
  38     # - WORKING_TOPOLOGY - Path to topology file.
  39
  40     set -exuo pipefail
  41
  42     source "${BASH_FUNCTION_DIR}/device.sh" || {
  43         die "Source failed!"
  44     }
  45     device_image="$(< ${CSIT_DIR}/${IMAGE_VER_FILE})"
  46     case_text="${NODENESS}_${FLAVOR}"
  47     case "${case_text}" in
  48         "1n_skx" | "1n_tx2")
  49             # We execute reservation over csit-shim-dcr (ssh) which runs sourced
  50             # script's functions. Env variables are read from ssh output
  51             # back to localhost for further processing.
  52             # Shim and Jenkins executor are in the same network on the same host
  53             # Connect to docker's default gateway IP and shim's exposed port
  54             ssh="ssh root@172.17.0.1 -p 6022"
  55             run="activate_wrapper ${NODENESS} ${FLAVOR} ${device_image}"
  56             # The "declare -f" output is long and boring.
  57             set +x
  58             # backtics to avoid https://midnight-commander.org/ticket/2142
  59             env_vars=`${ssh} "$(declare -f); ${run}"` || {
  60                 die "Topology reservation via shim-dcr failed!"
  61             }
  62             set -x
  63             set -a
  64             source <(echo "$env_vars" | grep -v /usr/bin/docker) || {
  65                 die "Source failed!"
  66             }
  67             set +a
  68             ;;
  69         "1n_vbox")
  70             # We execute reservation on localhost. Sourced script automatially
  71             # sets environment variables for further processing.
  72             activate_wrapper "${NODENESS}" "${FLAVOR}" "${device_image}" || die
  73             ;;
  74         *)
  75             die "Unknown specification: ${case_text}!"
  76     esac
  77
  78     trap 'deactivate_docker_topology' EXIT || {
  79          die "Trap attempt failed, please cleanup manually. Aborting!"
  80     }
  81
  82     # Replace all variables in template with those in environment.
  83     source <(echo 'cat <<EOF >topo.yml'; cat ${TOPOLOGIES[0]}; echo EOF;) || {
  84         die "Topology file create failed!"
  85     }
  86
  87     WORKING_TOPOLOGY="/tmp/topology.yaml"
  88     mv topo.yml "${WORKING_TOPOLOGY}" || {
  89         die "Topology move failed!"
  90     }
  91     cat ${WORKING_TOPOLOGY} | grep -v password || {
  92         die "Topology read failed!"
  93     }
  94 }
  95
  96
  97 function activate_virtualenv () {
  98
  99     # Update virtualenv pip package, delete and create virtualenv directory,
 100     # activate the virtualenv, install requirements, set PYTHONPATH.
 101
 102     # Arguments:
 103     # - ${1} - Path to existing directory for creating virtualenv in.
 104     #          If missing or empty, ${CSIT_DIR} is used.
 105     # - ${2} - Path to requirements file, ${CSIT_DIR}/requirements.txt if empty.
 106     # Variables read:
 107     # - CSIT_DIR - Path to existing root of local CSIT git repository.
 108     # Variables exported:
 109     # - PYTHONPATH - CSIT_DIR, as CSIT Python scripts usually need this.
 110     # Functions called:
 111     # - die - Print to stderr and exit.
 112
 113     set -exuo pipefail
 114
 115     root_path="${1-$CSIT_DIR}"
 116     env_dir="${root_path}/env"
 117     req_path=${2-$CSIT_DIR/requirements.txt}
 118     rm -rf "${env_dir}" || die "Failed to clean previous virtualenv."
 119     pip3 install virtualenv==20.0.20 || {
 120         die "Virtualenv package install failed."
 121     }
 122     virtualenv --no-download --python=$(which python3) "${env_dir}" || {
 123         die "Virtualenv creation for $(which python3) failed."
 124     }
 125     set +u
 126     source "${env_dir}/bin/activate" || die "Virtualenv activation failed."
 127     set -u
 128     pip3 install -r "${req_path}" || {
 129         die "Requirements installation failed."
 130     }
 131     # Most CSIT Python scripts assume PYTHONPATH is set and exported.
 132     export PYTHONPATH="${CSIT_DIR}" || die "Export failed."
 133 }
 134
 135
 136 function archive_tests () {
 137
 138     # Create .tar.xz of generated/tests for archiving.
 139     # To be run after generate_tests, kept separate to offer more flexibility.
 140
 141     # Directory read:
 142     # - ${GENERATED_DIR}/tests - Tree of executed suites to archive.
 143     # File rewriten:
 144     # - ${ARCHIVE_DIR}/tests.tar.xz - Archive of generated tests.
 145
 146     set -exuo pipefail
 147
 148     tar c "${GENERATED_DIR}/tests" | xz -3 > "${ARCHIVE_DIR}/tests.tar.xz" || {
 149         die "Error creating archive of generated tests."
 150     }
 151 }
 152
 153
 154 function check_download_dir () {
 155
 156     # Fail if there are no files visible in ${DOWNLOAD_DIR}.
 157     #
 158     # Variables read:
 159     # - DOWNLOAD_DIR - Path to directory pybot takes the build to test from.
 160     # Directories read:
 161     # - ${DOWNLOAD_DIR} - Has to be non-empty to proceed.
 162     # Functions called:
 163     # - die - Print to stderr and exit.
 164
 165     set -exuo pipefail
 166
 167     if [[ ! "$(ls -A "${DOWNLOAD_DIR}")" ]]; then
 168         die "No artifacts downloaded!"
 169     fi
 170 }
 171
 172
 173 function check_prerequisites () {
 174
 175     # Fail if prerequisites are not met.
 176     #
 177     # Functions called:
 178     # - installed - Check if application is installed/present in system.
 179     # - die - Print to stderr and exit.
 180
 181     set -exuo pipefail
 182
 183     if ! installed sshpass; then
 184         die "Please install sshpass before continue!"
 185     fi
 186 }
 187
 188
 189 function common_dirs () {
 190
 191     # Set global variables, create some directories (without touching content).
 192
 193     # Variables set:
 194     # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
 195     # - CSIT_DIR - Path to existing root of local CSIT git repository.
 196     # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
 197     # - JOB_SPECS_DIR - Path to existing directory with job test specifications.
 198     # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
 199     # - TOOLS_DIR - Path to existing resources subdirectory "tools".
 200     # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
 201     # - ARCHIVE_DIR - Path to created CSIT subdirectory "archives".
 202     #   The name is chosen to match what ci-management expects.
 203     # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
 204     # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
 205     # Directories created if not present:
 206     # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
 207     # Functions called:
 208     # - die - Print to stderr and exit.
 209
 210     set -exuo pipefail
 211
 212     this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
 213         die "Some error during locating of this source file."
 214     }
 215     BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
 216         die "Some error during dirname call."
 217     }
 218     # Current working directory could be in a different repo, e.g. VPP.
 219     pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
 220     relative_csit_dir=$(git rev-parse --show-toplevel) || {
 221         die "Git rev-parse failed."
 222     }
 223     CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
 224     popd || die "Popd failed."
 225     TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
 226         die "Readlink failed."
 227     }
 228     JOB_SPECS_DIR=$(readlink -e "${CSIT_DIR}/docs/job_specs") || {
 229         die "Readlink failed."
 230     }
 231     RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
 232         die "Readlink failed."
 233     }
 234     TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
 235         die "Readlink failed."
 236     }
 237     DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
 238         die "Readlink failed."
 239     }
 240     PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
 241         die "Readlink failed."
 242     }
 243
 244     ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archives") || {
 245         die "Readlink failed."
 246     }
 247     mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
 248     DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
 249         die "Readlink failed."
 250     }
 251     mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
 252     GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
 253         die "Readlink failed."
 254     }
 255     mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
 256 }
 257
 258
 259 function compose_pybot_arguments () {
 260
 261     # Variables read:
 262     # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
 263     # - DUT - CSIT test/ subdirectory, set while processing tags.
 264     # - TAGS - Array variable holding selected tag boolean expressions.
 265     # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
 266     # - TEST_CODE - The test selection string from environment or argument.
 267     # - SELECTION_MODE - Selection criteria [test, suite, include, exclude].
 268     # Variables set:
 269     # - PYBOT_ARGS - String holding part of all arguments for pybot.
 270     # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
 271
 272     set -exuo pipefail
 273
 274     # No explicit check needed with "set -u".
 275     PYBOT_ARGS=("--loglevel" "TRACE")
 276     PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
 277
 278     case "${TEST_CODE}" in
 279         *"device"*)
 280             PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
 281             ;;
 282         *"perf"*)
 283             PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
 284             ;;
 285         *)
 286             die "Unknown specification: ${TEST_CODE}"
 287     esac
 288
 289     EXPANDED_TAGS=()
 290     for tag in "${TAGS[@]}"; do
 291         if [[ ${tag} == "!"* ]]; then
 292             EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
 293         else
 294             if [[ ${SELECTION_MODE} == "--test" ]]; then
 295                 EXPANDED_TAGS+=("--test" "${tag}")
 296             else
 297                 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
 298             fi
 299         fi
 300     done
 301
 302     if [[ ${SELECTION_MODE} == "--test" ]]; then
 303         EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}")
 304     fi
 305 }
 306
 307
 308 function deactivate_docker_topology () {
 309
 310     # Deactivate virtual vpp-device topology by removing containers.
 311     #
 312     # Variables read:
 313     # - NODENESS - Node multiplicity of desired testbed.
 314     # - FLAVOR - Node flavor string, usually describing the processor.
 315
 316     set -exuo pipefail
 317
 318     case_text="${NODENESS}_${FLAVOR}"
 319     case "${case_text}" in
 320         "1n_skx" | "1n_tx2")
 321             ssh="ssh root@172.17.0.1 -p 6022"
 322             env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
 323             # The "declare -f" output is long and boring.
 324             set +x
 325             ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
 326                 die "Topology cleanup via shim-dcr failed!"
 327             }
 328             set -x
 329             ;;
 330         "1n_vbox")
 331             enter_mutex || die
 332             clean_environment || {
 333                 die "Topology cleanup locally failed!"
 334             }
 335             exit_mutex || die
 336             ;;
 337         *)
 338             die "Unknown specification: ${case_text}!"
 339     esac
 340 }
 341
 342
 343 function die () {
 344
 345     # Print the message to standard error end exit with error code specified
 346     # by the second argument.
 347     #
 348     # Hardcoded values:
 349     # - The default error message.
 350     # Arguments:
 351     # - ${1} - The whole error message, be sure to quote. Optional
 352     # - ${2} - the code to exit with, default: 1.
 353
 354     set -x
 355     set +eu
 356     warn "${1:-Unspecified run-time error occurred!}"
 357     exit "${2:-1}"
 358 }
 359
 360
 361 function die_on_pybot_error () {
 362
 363     # Source this fragment if you want to abort on any failed test case.
 364     #
 365     # Variables read:
 366     # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
 367     # Functions called:
 368     # - die - Print to stderr and exit.
 369
 370     set -exuo pipefail
 371
 372     if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
 373         die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
 374     fi
 375 }
 376
 377
 378 function generate_tests () {
 379
 380     # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
 381     # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
 382     # The generation is done by executing any *.py executable
 383     # within any subdirectory after copying.
 384
 385     # This is a separate function, because this code is called
 386     # both by autogen checker and entries calling run_pybot.
 387
 388     # Directories read:
 389     # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
 390     # Directories replaced:
 391     # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
 392
 393     set -exuo pipefail
 394
 395     rm -rf "${GENERATED_DIR}/tests" || die
 396     cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
 397     cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
 398     cmd_line+=("-executable" "-name" "*.py")
 399     # We sort the directories, so log output can be compared between runs.
 400     file_list=$("${cmd_line[@]}" | sort) || die
 401
 402     for gen in ${file_list}; do
 403         directory="$(dirname "${gen}")" || die
 404         filename="$(basename "${gen}")" || die
 405         pushd "${directory}" || die
 406         ./"${filename}" || die
 407         popd || die
 408     done
 409 }
 410
 411
 412 function get_test_code () {
 413
 414     # Arguments:
 415     # - ${1} - Optional, argument of entry script (or empty as unset).
 416     #   Test code value to override job name from environment.
 417     # Variables read:
 418     # - JOB_NAME - String affecting test selection, default if not argument.
 419     # Variables set:
 420     # - TEST_CODE - The test selection string from environment or argument.
 421     # - NODENESS - Node multiplicity of desired testbed.
 422     # - FLAVOR - Node flavor string, usually describing the processor.
 423
 424     set -exuo pipefail
 425
 426     TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
 427     if [[ -z "${TEST_CODE}" ]]; then
 428         TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
 429     fi
 430
 431     case "${TEST_CODE}" in
 432         *"1n-vbox"*)
 433             NODENESS="1n"
 434             FLAVOR="vbox"
 435             ;;
 436         *"1n-skx"*)
 437             NODENESS="1n"
 438             FLAVOR="skx"
 439             ;;
 440        *"1n-tx2"*)
 441             NODENESS="1n"
 442             FLAVOR="tx2"
 443             ;;
 444         *"2n-aws"*)
 445             NODENESS="2n"
 446             FLAVOR="aws"
 447             ;;
 448         *"3n-aws"*)
 449             NODENESS="3n"
 450             FLAVOR="aws"
 451             ;;
 452         *"2n-skx"*)
 453             NODENESS="2n"
 454             FLAVOR="skx"
 455             ;;
 456         *"2n-zn2"*)
 457             NODENESS="2n"
 458             FLAVOR="zn2"
 459             ;;
 460         *"3n-skx"*)
 461             NODENESS="3n"
 462             FLAVOR="skx"
 463             ;;
 464         *"2n-clx"*)
 465             NODENESS="2n"
 466             FLAVOR="clx"
 467             ;;
 468         *"2n-dnv"*)
 469             NODENESS="2n"
 470             FLAVOR="dnv"
 471             ;;
 472         *"3n-dnv"*)
 473             NODENESS="3n"
 474             FLAVOR="dnv"
 475             ;;
 476         *"2n-tx2"*)
 477             NODENESS="2n"
 478             FLAVOR="tx2"
 479             ;;
 480         *"3n-tsh"*)
 481             NODENESS="3n"
 482             FLAVOR="tsh"
 483             ;;
 484         *)
 485             # Fallback to 3-node Haswell by default (backward compatibility)
 486             NODENESS="3n"
 487             FLAVOR="hsw"
 488             ;;
 489     esac
 490 }
 491
 492
 493 function get_test_tag_string () {
 494
 495     # Variables read:
 496     # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
 497     # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
 498     # - TEST_CODE - The test selection string from environment or argument.
 499     # Variables set:
 500     # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
 501     #   May be empty, or even not set on event types not adding comment.
 502
 503     # TODO: ci-management scripts no longer need to perform this.
 504
 505     set -exuo pipefail
 506
 507     if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
 508         case "${TEST_CODE}" in
 509             *"device"*)
 510                 trigger="devicetest"
 511                 ;;
 512             *"perf"*)
 513                 trigger="perftest"
 514                 ;;
 515             *)
 516                 die "Unknown specification: ${TEST_CODE}"
 517         esac
 518         # Ignore lines not containing the trigger word.
 519         comment=$(fgrep "${trigger}" <<< "${GERRIT_EVENT_COMMENT_TEXT}" || true)
 520         # The vpp-csit triggers trail stuff we are not interested in.
 521         # Removing them and trigger word: https://unix.stackexchange.com/a/13472
 522         # (except relying on \s whitespace, \S non-whitespace and . both).
 523         # The last string is concatenated, only the middle part is expanded.
 524         cmd=("grep" "-oP" '\S*'"${trigger}"'\S*\s\K.+$') || die "Unset trigger?"
 525         # On parsing error, TEST_TAG_STRING probably stays empty.
 526         TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
 527         if [[ -z "${TEST_TAG_STRING-}" ]]; then
 528             # Probably we got a base64 encoded comment.
 529             comment=$(base64 --decode <<< "${GERRIT_EVENT_COMMENT_TEXT}" || true)
 530             comment=$(fgrep "${trigger}" <<< "${comment}" || true)
 531             TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
 532         fi
 533         if [[ -n "${TEST_TAG_STRING-}" ]]; then
 534             test_tag_array=(${TEST_TAG_STRING})
 535             if [[ "${test_tag_array[0]}" == "icl" ]]; then
 536                 export GRAPH_NODE_VARIANT="icl"
 537                 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
 538             elif [[ "${test_tag_array[0]}" == "skx" ]]; then
 539                 export GRAPH_NODE_VARIANT="skx"
 540                 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
 541             elif [[ "${test_tag_array[0]}" == "hsw" ]]; then
 542                 export GRAPH_NODE_VARIANT="hsw"
 543                 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
 544             fi
 545         fi
 546     fi
 547 }
 548
 549
 550 function installed () {
 551
 552     # Check if the given utility is installed. Fail if not installed.
 553     #
 554     # Duplicate of common.sh function, as this file is also used standalone.
 555     #
 556     # Arguments:
 557     # - ${1} - Utility to check.
 558     # Returns:
 559     # - 0 - If command is installed.
 560     # - 1 - If command is not installed.
 561
 562     set -exuo pipefail
 563
 564     command -v "${1}"
 565 }
 566
 567
 568 function move_archives () {
 569
 570     # Move archive directory to top of workspace, if not already there.
 571     #
 572     # ARCHIVE_DIR is positioned relative to CSIT_DIR,
 573     # but in some jobs CSIT_DIR is not same as WORKSPACE
 574     # (e.g. under VPP_DIR). To simplify ci-management settings,
 575     # we want to move the data to the top. We do not want simple copy,
 576     # as ci-management is eager with recursive search.
 577     #
 578     # As some scripts may call this function multiple times,
 579     # the actual implementation use copying and deletion,
 580     # so the workspace gets "union" of contents (except overwrites on conflict).
 581     # The consequence is empty ARCHIVE_DIR remaining after this call.
 582     #
 583     # As the source directory is emptied,
 584     # the check for dirs being different is essential.
 585     #
 586     # Variables read:
 587     # - WORKSPACE - Jenkins workspace, move only if the value is not empty.
 588     #   Can be unset, then it speeds up manual testing.
 589     # - ARCHIVE_DIR - Path to directory with content to be moved.
 590     # Directories updated:
 591     # - ${WORKSPACE}/archives/ - Created if does not exist.
 592     #   Content of ${ARCHIVE_DIR}/ is moved.
 593     # Functions called:
 594     # - die - Print to stderr and exit.
 595
 596     set -exuo pipefail
 597
 598     if [[ -n "${WORKSPACE-}" ]]; then
 599         target=$(readlink -f "${WORKSPACE}/archives")
 600         if [[ "${target}" != "${ARCHIVE_DIR}" ]]; then
 601             mkdir -p "${target}" || die "Archives dir create failed."
 602             cp -rf "${ARCHIVE_DIR}"/* "${target}" || die "Copy failed."
 603             rm -rf "${ARCHIVE_DIR}"/* || die "Delete failed."
 604         fi
 605     fi
 606 }
 607
 608
 609 function reserve_and_cleanup_testbed () {
 610
 611     # Reserve physical testbed, perform cleanup, register trap to unreserve.
 612     # When cleanup fails, remove from topologies and keep retrying
 613     # until all topologies are removed.
 614     #
 615     # Variables read:
 616     # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
 617     # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
 618     # - BUILD_TAG - Any string suitable as filename, identifying
 619     #   test run executing this function. May be unset.
 620     # Variables set:
 621     # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
 622     # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
 623     # Functions called:
 624     # - die - Print to stderr and exit.
 625     # - ansible_playbook - Perform an action using ansible, see ansible.sh
 626     # Traps registered:
 627     # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
 628
 629     set -exuo pipefail
 630
 631     while true; do
 632         for topo in "${TOPOLOGIES[@]}"; do
 633             set +e
 634             scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
 635             opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
 636             python3 "${scrpt}" "${opts[@]}"
 637             result="$?"
 638             set -e
 639             if [[ "${result}" == "0" ]]; then
 640                 # Trap unreservation before cleanup check,
 641                 # so multiple jobs showing failed cleanup improve chances
 642                 # of humans to notice and fix.
 643                 WORKING_TOPOLOGY="${topo}"
 644                 echo "Reserved: ${WORKING_TOPOLOGY}"
 645                 trap "untrap_and_unreserve_testbed" EXIT || {
 646                     message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
 647                     untrap_and_unreserve_testbed "${message}" || {
 648                         die "Teardown should have died, not failed."
 649                     }
 650                     die "Trap attempt failed, unreserve succeeded. Aborting."
 651                 }
 652                 # Cleanup + calibration checks
 653                 set +e
 654                 ansible_playbook "cleanup, calibration"
 655                 result="$?"
 656                 set -e
 657                 if [[ "${result}" == "0" ]]; then
 658                     break
 659                 fi
 660                 warn "Testbed cleanup failed: ${topo}"
 661                 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
 662             fi
 663             # Else testbed is accessible but currently reserved, moving on.
 664         done
 665
 666         if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
 667             # Exit the infinite while loop if we made a reservation.
 668             warn "Reservation and cleanup successful."
 669             break
 670         fi
 671
 672         if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
 673             die "Run out of operational testbeds!"
 674         fi
 675
 676         # Wait ~3minutes before next try.
 677         sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
 678             die "Sleep time calculation failed."
 679         }
 680         echo "Sleeping ${sleep_time}"
 681         sleep "${sleep_time}" || die "Sleep failed."
 682     done
 683 }
 684
 685
 686 function run_pybot () {
 687
 688     # Run pybot with options based on input variables. Create output_info.xml
 689     #
 690     # Variables read:
 691     # - CSIT_DIR - Path to existing root of local CSIT git repository.
 692     # - ARCHIVE_DIR - Path to store robot result files in.
 693     # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
 694     # - GENERATED_DIR - Tests are assumed to be generated under there.
 695     # Variables set:
 696     # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
 697     # Functions called:
 698     # - die - Print to stderr and exit.
 699
 700     set -exuo pipefail
 701
 702     all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
 703     all_options+=("--noncritical" "EXPECTED_FAILING")
 704     all_options+=("${EXPANDED_TAGS[@]}")
 705
 706     pushd "${CSIT_DIR}" || die "Change directory operation failed."
 707     set +e
 708     robot "${all_options[@]}" "${GENERATED_DIR}/tests/"
 709     PYBOT_EXIT_STATUS="$?"
 710     set -e
 711
 712     # Generate INFO level output_info.xml for post-processing.
 713     all_options=("--loglevel" "INFO")
 714     all_options+=("--log" "none")
 715     all_options+=("--report" "none")
 716     all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
 717     all_options+=("${ARCHIVE_DIR}/output.xml")
 718     rebot "${all_options[@]}" || true
 719     popd || die "Change directory operation failed."
 720 }
 721
 722
 723 function select_arch_os () {
 724
 725     # Set variables affected by local CPU architecture and operating system.
 726     #
 727     # Variables set:
 728     # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
 729     # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
 730     # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
 731
 732     set -exuo pipefail
 733
 734     source /etc/os-release || die "Get OS release failed."
 735
 736     case "${ID}" in
 737         "ubuntu"*)
 738             case "${VERSION}" in
 739                 *"LTS (Focal Fossa)"*)
 740                     IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
 741                     VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_FOCAL"
 742                     PKG_SUFFIX="deb"
 743                     ;;
 744                 *)
 745                     die "Unsupported Ubuntu version!"
 746                     ;;
 747             esac
 748             ;;
 749         *)
 750             die "Unsupported distro or OS!"
 751             ;;
 752     esac
 753
 754     arch=$(uname -m) || {
 755         die "Get CPU architecture failed."
 756     }
 757
 758     case "${arch}" in
 759         "aarch64")
 760             IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
 761             ;;
 762         *)
 763             ;;
 764     esac
 765 }
 766
 767
 768 function select_tags () {
 769
 770     # Variables read:
 771     # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
 772     # - TEST_CODE - String affecting test selection, usually jenkins job name.
 773     # - DUT - CSIT test/ subdirectory, set while processing tags.
 774     # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
 775     #   Can be unset.
 776     # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
 777     # - BASH_FUNCTION_DIR - Directory with input files to process.
 778     # Variables set:
 779     # - TAGS - Array of processed tag boolean expressions.
 780     # - SELECTION_MODE - Selection criteria [test, suite, include, exclude].
 781
 782     set -exuo pipefail
 783
 784     # NIC SELECTION
 785     start_pattern='^  TG:'
 786     end_pattern='^ \? \?[A-Za-z0-9]\+:'
 787     # Remove the TG section from topology file
 788     sed_command="/${start_pattern}/,/${end_pattern}/d"
 789     # All topologies DUT NICs
 790     available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
 791                 | grep -hoP "model: \K.*" | sort -u)
 792     # Selected topology DUT NICs
 793     reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
 794                | grep -hoP "model: \K.*" | sort -u)
 795     # All topologies DUT NICs - Selected topology DUT NICs
 796     exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
 797         die "Computation of excluded NICs failed."
 798     }
 799
 800     # Select default NIC tag.
 801     case "${TEST_CODE}" in
 802         *"3n-dnv"* | *"2n-dnv"*)
 803             default_nic="nic_intel-x553"
 804             ;;
 805         *"3n-tsh"*)
 806             default_nic="nic_intel-x520-da2"
 807             ;;
 808         *"3n-skx"* | *"2n-skx"* | *"2n-clx"* | *"2n-zn2"*)
 809             default_nic="nic_intel-xxv710"
 810             ;;
 811         *"3n-hsw"* | *"2n-tx2"* | *"mrr-daily-master")
 812             default_nic="nic_intel-xl710"
 813             ;;
 814         *"2n-aws"* | *"3n-aws"*)
 815             default_nic="nic_amazon-nitro-50g"
 816             ;;
 817         *)
 818             default_nic="nic_intel-x710"
 819             ;;
 820     esac
 821
 822     sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
 823     awk_nics_sub_cmd=""
 824     awk_nics_sub_cmd+='gsub("xxv710","25ge2p1xxv710");'
 825     awk_nics_sub_cmd+='gsub("x710","10ge2p1x710");'
 826     awk_nics_sub_cmd+='gsub("xl710","40ge2p1xl710");'
 827     awk_nics_sub_cmd+='gsub("x520-da2","10ge2p1x520");'
 828     awk_nics_sub_cmd+='gsub("x553","10ge2p1x553");'
 829     awk_nics_sub_cmd+='gsub("cx556a","100ge2p1cx556a");'
 830     awk_nics_sub_cmd+='gsub("vic1227","10ge2p1vic1227");'
 831     awk_nics_sub_cmd+='gsub("vic1385","40ge2p1vic1385");'
 832     awk_nics_sub_cmd+='gsub("nitro-50g","50ge1p1ENA");'
 833     awk_nics_sub_cmd+='if ($9 =="drv_avf") drv="avf-";'
 834     awk_nics_sub_cmd+='else if ($9 =="drv_rdma_core") drv ="rdma-";'
 835     awk_nics_sub_cmd+='else drv="";'
 836     awk_nics_sub_cmd+='print "*"$7"-" drv $11"-"$5"."$3"-"$1"-" drv $11"-"$5'
 837
 838     # Tag file directory shorthand.
 839     tfd="${JOB_SPECS_DIR}"
 840     case "${TEST_CODE}" in
 841         # Select specific performance tests based on jenkins job type variable.
 842         *"ndrpdr-weekly"* )
 843             readarray -t test_tag_array <<< $(grep -v "#" \
 844                 ${tfd}/mlr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
 845                 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
 846             SELECTION_MODE="--test"
 847             ;;
 848         *"mrr-daily"* )
 849             readarray -t test_tag_array <<< $(grep -v "#" \
 850                 ${tfd}/mrr_daily/${DUT}-${NODENESS}-${FLAVOR}.md |
 851                 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
 852             SELECTION_MODE="--test"
 853             ;;
 854         *"mrr-weekly"* )
 855             readarray -t test_tag_array <<< $(grep -v "#" \
 856                 ${tfd}/mrr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
 857                 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
 858             SELECTION_MODE="--test"
 859             ;;
 860         *"report-iterative"* )
 861             test_sets=(${TEST_TAG_STRING//:/ })
 862             # Run only one test set per run
 863             report_file=${test_sets[0]}.md
 864             readarray -t test_tag_array <<< $(grep -v "#" \
 865                 ${tfd}/report_iterative/${NODENESS}-${FLAVOR}/${report_file} |
 866                 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
 867             SELECTION_MODE="--test"
 868             ;;
 869         *"report-coverage"* )
 870             test_sets=(${TEST_TAG_STRING//:/ })
 871             # Run only one test set per run
 872             report_file=${test_sets[0]}.md
 873             readarray -t test_tag_array <<< $(grep -v "#" \
 874                 ${tfd}/report_coverage/${NODENESS}-${FLAVOR}/${report_file} |
 875                 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
 876             SELECTION_MODE="--test"
 877             ;;
 878         * )
 879             if [[ -z "${TEST_TAG_STRING-}" ]]; then
 880                 # If nothing is specified, we will run pre-selected tests by
 881                 # following tags.
 882                 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDip4base"
 883                                 "mrrAND${default_nic}AND1cAND78bANDip6base"
 884                                 "mrrAND${default_nic}AND1cAND64bANDl2bdbase"
 885                                 "mrrAND${default_nic}AND1cAND64bANDl2xcbase"
 886                                 "!dot1q" "!drv_avf")
 887             else
 888                 # If trigger contains tags, split them into array.
 889                 test_tag_array=(${TEST_TAG_STRING//:/ })
 890             fi
 891             SELECTION_MODE="--include"
 892             ;;
 893     esac
 894
 895     # Blacklisting certain tags per topology.
 896     #
 897     # Reasons for blacklisting:
 898     # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
 899     # TODO: Add missing reasons here (if general) or where used (if specific).
 900     case "${TEST_CODE}" in
 901         *"2n-skx"*)
 902             test_tag_array+=("!ipsechw")
 903             ;;
 904         *"3n-skx"*)
 905             test_tag_array+=("!ipsechw")
 906             # Not enough nic_intel-xxv710 to support double link tests.
 907             test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
 908             ;;
 909         *"2n-clx"*)
 910             test_tag_array+=("!ipsechw")
 911             ;;
 912         *"2n-zn2"*)
 913             test_tag_array+=("!ipsechw")
 914             ;;
 915         *"2n-dnv"*)
 916             test_tag_array+=("!ipsechw")
 917             test_tag_array+=("!memif")
 918             test_tag_array+=("!srv6_proxy")
 919             test_tag_array+=("!vhost")
 920             test_tag_array+=("!vts")
 921             test_tag_array+=("!drv_avf")
 922             ;;
 923         *"2n-tx2"*)
 924             test_tag_array+=("!ipsechw")
 925             ;;
 926         *"3n-dnv"*)
 927             test_tag_array+=("!memif")
 928             test_tag_array+=("!srv6_proxy")
 929             test_tag_array+=("!vhost")
 930             test_tag_array+=("!vts")
 931             test_tag_array+=("!drv_avf")
 932             ;;
 933         *"3n-tsh"*)
 934             # 3n-tsh only has x520 NICs which don't work with AVF
 935             test_tag_array+=("!drv_avf")
 936             test_tag_array+=("!ipsechw")
 937             ;;
 938         *"3n-hsw"*)
 939             test_tag_array+=("!drv_avf")
 940             # All cards have access to QAT. But only one card (xl710)
 941             # resides in same NUMA as QAT. Other cards must go over QPI
 942             # which we do not want to even run.
 943             test_tag_array+=("!ipsechwNOTnic_intel-xl710")
 944             ;;
 945         *"2n-aws"* | *"3n-aws"*)
 946             test_tag_array+=("!ipsechw")
 947             ;;
 948         *)
 949             # Default to 3n-hsw due to compatibility.
 950             test_tag_array+=("!drv_avf")
 951             test_tag_array+=("!ipsechwNOTnic_intel-xl710")
 952             ;;
 953     esac
 954
 955     # We will add excluded NICs.
 956     test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
 957
 958     TAGS=()
 959     prefix=""
 960
 961     set +x
 962     if [[ "${TEST_CODE}" == "vpp-"* ]]; then
 963         # Automatic prefixing for VPP jobs to limit the NIC used and
 964         # traffic evaluation to MRR.
 965         if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
 966             prefix="${prefix}mrrAND"
 967         else
 968             prefix="${prefix}mrrAND${default_nic}AND"
 969         fi
 970     fi
 971     for tag in "${test_tag_array[@]}"; do
 972         if [[ "${tag}" == "!"* ]]; then
 973             # Exclude tags are not prefixed.
 974             TAGS+=("${tag}")
 975         elif [[ "${tag}" == " "* || "${tag}" == *"perftest"* ]]; then
 976             # Badly formed tag expressions can trigger way too much tests.
 977             set -x
 978             warn "The following tag expression hints at bad trigger: ${tag}"
 979             warn "Possible cause: Multiple triggers in a single comment."
 980             die "Aborting to avoid triggering too many tests."
 981         elif [[ "${tag}" == *"OR"* ]]; then
 982             # If OR had higher precedence than AND, it would be useful here.
 983             # Some people think it does, thus triggering way too much tests.
 984             set -x
 985             warn "The following tag expression hints at bad trigger: ${tag}"
 986             warn "Operator OR has lower precedence than AND. Use space instead."
 987             die "Aborting to avoid triggering too many tests."
 988         elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
 989             # Empty and comment lines are skipped.
 990             # Other lines are normal tags, they are to be prefixed.
 991             TAGS+=("${prefix}${tag}")
 992         fi
 993     done
 994     set -x
 995 }
 996
 997
 998 function select_topology () {
 999
1000     # Variables read:
1001     # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
1002     # - FLAVOR - Node flavor string, currently either "hsw" or "skx".
1003     # - CSIT_DIR - Path to existing root of local CSIT git repository.
1004     # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
1005     # Variables set:
1006     # - TOPOLOGIES - Array of paths to suitable topology yaml files.
1007     # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
1008     # Functions called:
1009     # - die - Print to stderr and exit.
1010
1011     set -exuo pipefail
1012
1013     case_text="${NODENESS}_${FLAVOR}"
1014     case "${case_text}" in
1015         # TODO: Move tags to "# Blacklisting certain tags per topology" section.
1016         # TODO: Double link availability depends on NIC used.
1017         "1n_vbox")
1018             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
1019             TOPOLOGIES_TAGS="2_node_single_link_topo"
1020             ;;
1021         "1n_skx" | "1n_tx2")
1022             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
1023             TOPOLOGIES_TAGS="2_node_single_link_topo"
1024             ;;
1025         "2n_skx")
1026             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
1027             TOPOLOGIES_TAGS="2_node_*_link_topo"
1028             ;;
1029         "2n_zn2")
1030             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_zn2*.yaml )
1031             TOPOLOGIES_TAGS="2_node_*_link_topo"
1032             ;;
1033         "3n_skx")
1034             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
1035             TOPOLOGIES_TAGS="3_node_*_link_topo"
1036             ;;
1037         "2n_clx")
1038             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_clx*.yaml )
1039             TOPOLOGIES_TAGS="2_node_*_link_topo"
1040             ;;
1041         "2n_dnv")
1042             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
1043             TOPOLOGIES_TAGS="2_node_single_link_topo"
1044             ;;
1045         "3n_dnv")
1046             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
1047             TOPOLOGIES_TAGS="3_node_single_link_topo"
1048             ;;
1049         "3n_hsw")
1050             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
1051             TOPOLOGIES_TAGS="3_node_single_link_topo"
1052             ;;
1053         "3n_tsh")
1054             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
1055             TOPOLOGIES_TAGS="3_node_single_link_topo"
1056             ;;
1057         "2n_tx2")
1058             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_tx2*.yaml )
1059             TOPOLOGIES_TAGS="2_node_single_link_topo"
1060             ;;
1061         "2n_aws")
1062             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_aws*.yaml )
1063             TOPOLOGIES_TAGS="2_node_single_link_topo"
1064             ;;
1065         "3n_aws")
1066             TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_aws*.yaml )
1067             TOPOLOGIES_TAGS="3_node_single_link_topo"
1068             ;;
1069         *)
1070             # No falling back to 3n_hsw default, that should have been done
1071             # by the function which has set NODENESS and FLAVOR.
1072             die "Unknown specification: ${case_text}"
1073     esac
1074
1075     if [[ -z "${TOPOLOGIES-}" ]]; then
1076         die "No applicable topology found!"
1077     fi
1078 }
1079
1080
1081 function select_vpp_device_tags () {
1082
1083     # Variables read:
1084     # - TEST_CODE - String affecting test selection, usually jenkins job name.
1085     # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
1086     #   Can be unset.
1087     # Variables set:
1088     # - TAGS - Array of processed tag boolean expressions.
1089
1090     set -exuo pipefail
1091
1092     case "${TEST_CODE}" in
1093         # Select specific device tests based on jenkins job type variable.
1094         * )
1095             if [[ -z "${TEST_TAG_STRING-}" ]]; then
1096                 # If nothing is specified, we will run pre-selected tests by
1097                 # following tags. Items of array will be concatenated by OR
1098                 # in Robot Framework.
1099                 test_tag_array=()
1100             else
1101                 # If trigger contains tags, split them into array.
1102                 test_tag_array=(${TEST_TAG_STRING//:/ })
1103             fi
1104             SELECTION_MODE="--include"
1105             ;;
1106     esac
1107
1108     # Blacklisting certain tags per topology.
1109     #
1110     # Reasons for blacklisting:
1111     # - avf - AVF is not possible to run on enic driver of VirtualBox.
1112     # - vhost - VirtualBox does not support nesting virtualization on Intel CPU.
1113     case "${TEST_CODE}" in
1114         *"1n-vbox"*)
1115             test_tag_array+=("!avf")
1116             test_tag_array+=("!vhost")
1117             ;;
1118         *)
1119             ;;
1120     esac
1121
1122     TAGS=()
1123
1124     # We will prefix with devicetest to prevent running other tests
1125     # (e.g. Functional).
1126     prefix="devicetestAND"
1127     if [[ "${TEST_CODE}" == "vpp-"* ]]; then
1128         # Automatic prefixing for VPP jobs to limit testing.
1129         prefix="${prefix}"
1130     fi
1131     for tag in "${test_tag_array[@]}"; do
1132         if [[ ${tag} == "!"* ]]; then
1133             # Exclude tags are not prefixed.
1134             TAGS+=("${tag}")
1135         else
1136             TAGS+=("${prefix}${tag}")
1137         fi
1138     done
1139 }
1140
1141
1142 function set_environment_variables () {
1143
1144     # Depending on testbed topology, overwrite defaults set in the
1145     # resources/libraries/python/Constants.py file
1146     #
1147     # Variables read:
1148     # - TEST_CODE - String affecting test selection, usually jenkins job name.
1149     # Variables set:
1150     # See specific cases
1151
1152     set -exuo pipefail
1153
1154     case "${TEST_CODE}" in
1155         *"2n-aws"* | *"3n-aws"*)
1156             # T-Rex 2.88 workaround for ENA NICs
1157             export TREX_RX_DESCRIPTORS_COUNT=1024
1158             export TREX_EXTRA_CMDLINE="--mbuf-factor 19"
1159             # Settings to prevent duration stretching
1160             export PERF_TRIAL_STL_DELAY=0.1
1161             ;;
1162     esac
1163 }
1164
1165
1166 function untrap_and_unreserve_testbed () {
1167
1168     # Use this as a trap function to ensure testbed does not remain reserved.
1169     # Perhaps call directly before script exit, to free testbed for other jobs.
1170     # This function is smart enough to avoid multiple unreservations (so safe).
1171     # Topo cleanup is executed (call it best practice), ignoring failures.
1172     #
1173     # Hardcoded values:
1174     # - default message to die with if testbed might remain reserved.
1175     # Arguments:
1176     # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1177     # Variables read (by inner function):
1178     # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1179     # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1180     # Variables written:
1181     # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1182     # Trap unregistered:
1183     # - EXIT - Failure to untrap is reported, but ignored otherwise.
1184     # Functions called:
1185     # - die - Print to stderr and exit.
1186     # - ansible_playbook - Perform an action using ansible, see ansible.sh
1187
1188     set -xo pipefail
1189     set +eu  # We do not want to exit early in a "teardown" function.
1190     trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1191     wt="${WORKING_TOPOLOGY}"  # Just to avoid too long lines.
1192     if [[ -z "${wt-}" ]]; then
1193         set -eu
1194         warn "Testbed looks unreserved already. Trap removal failed before?"
1195     else
1196         ansible_playbook "cleanup" || true
1197         python3 "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1198             die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1199         }
1200         WORKING_TOPOLOGY=""
1201         set -eu
1202     fi
1203 }
1204
1205
1206 function warn () {
1207
1208     # Print the message to standard error.
1209     #
1210     # Arguments:
1211     # - ${@} - The text of the message.
1212
1213     set -exuo pipefail
1214
1215     echo "$@" >&2
1216 }