1 # Copyright (c) 2019 Cisco and/or its affiliates.
2 # Copyright (c) 2019 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:
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 # This library defines functions used by multiple entry scripts.
18 # Keep functions ordered alphabetically, please.
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).
25 function activate_docker_topology () {
27 # Create virtual vpp-device topology. Output of the function is topology
28 # file describing created environment saved to a file.
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.
38 # - WORKING_TOPOLOGY - Path to topology file.
42 source "${BASH_FUNCTION_DIR}/device.sh" || {
46 device_image="$(< ${CSIT_DIR}/${IMAGE_VER_FILE})"
47 case_text="${NODENESS}_${FLAVOR}"
48 case "${case_text}" in
50 # We execute reservation over csit-shim-dcr (ssh) which runs sourced
51 # script's functions. Env variables are read from ssh output
52 # back to localhost for further processing.
53 hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
54 ssh="ssh root@${hostname} -p 6022"
55 run="activate_wrapper ${NODENESS} ${FLAVOR} ${device_image}"
56 # The "declare -f" output is long and boring.
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!"
64 source <(echo "$env_vars" | grep -v /usr/bin/docker) || {
70 # We execute reservation on localhost. Sourced script automatially
71 # sets environment variables for further processing.
72 activate_wrapper "${NODENESS}" "${FLAVOR}" "${device_image}" || die
75 die "Unknown specification: ${case_text}!"
78 trap 'deactivate_docker_topology' EXIT || {
79 die "Trap attempt failed, please cleanup manually. Aborting!"
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!"
87 WORKING_TOPOLOGY="/tmp/topology.yaml"
88 mv topo.yml "${WORKING_TOPOLOGY}" || {
89 die "Topology move failed!"
91 cat ${WORKING_TOPOLOGY} | grep -v password || {
92 die "Topology read failed!"
97 function activate_virtualenv () {
99 # Update virtualenv pip package, delete and create virtualenv directory,
100 # activate the virtualenv, install requirements, set PYTHONPATH.
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.
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.
111 # - die - Print to stderr and exit.
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 --upgrade virtualenv || {
120 die "Virtualenv package install failed."
122 virtualenv --python=$(which python3) "${env_dir}" || {
123 die "Virtualenv creation for $(which python3) failed."
126 source "${env_dir}/bin/activate" || die "Virtualenv activation failed."
128 pip3 install --upgrade -r "${req_path}" || {
129 die "Requirements installation failed."
131 # Most CSIT Python scripts assume PYTHONPATH is set and exported.
132 export PYTHONPATH="${CSIT_DIR}" || die "Export failed."
136 function archive_tests () {
138 # Create .tar.xz of generated/tests for archiving.
139 # To be run after generate_tests, kept separate to offer more flexibility.
142 # - ${GENERATED_DIR}/tests - Tree of executed suites to archive.
144 # - ${ARCHIVE_DIR}/tests.tar.xz - Archive of generated tests.
148 tar c "${GENERATED_DIR}/tests" | xz -9e > "${ARCHIVE_DIR}/tests.tar.xz" || {
149 die "Error creating archive of generated tests."
154 function check_download_dir () {
156 # Fail if there are no files visible in ${DOWNLOAD_DIR}.
159 # - DOWNLOAD_DIR - Path to directory pybot takes the build to test from.
161 # - ${DOWNLOAD_DIR} - Has to be non-empty to proceed.
163 # - die - Print to stderr and exit.
167 if [[ ! "$(ls -A "${DOWNLOAD_DIR}")" ]]; then
168 die "No artifacts downloaded!"
173 function check_prerequisites () {
175 # Fail if prerequisites are not met.
178 # - installed - Check if application is installed/present in system.
179 # - die - Print to stderr and exit.
183 if ! installed sshpass; then
184 die "Please install sshpass before continue!"
189 function common_dirs () {
191 # Set global variables, create some directories (without touching content).
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 tpologies.
197 # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
198 # - TOOLS_DIR - Path to existing resources subdirectory "tools".
199 # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
200 # - ARCHIVE_DIR - Path to created CSIT subdirectory "archive".
201 # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
202 # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
203 # Directories created if not present:
204 # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
206 # - die - Print to stderr and exit.
210 this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
211 die "Some error during locating of this source file."
213 BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
214 die "Some error during dirname call."
216 # Current working directory could be in a different repo, e.g. VPP.
217 pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
218 relative_csit_dir=$(git rev-parse --show-toplevel) || {
219 die "Git rev-parse failed."
221 CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
222 popd || die "Popd failed."
223 TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
224 die "Readlink failed."
226 RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
227 die "Readlink failed."
229 TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
230 die "Readlink failed."
232 DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
233 die "Readlink failed."
235 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
236 die "Readlink failed."
239 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archive") || {
240 die "Readlink failed."
242 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
243 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
244 die "Readlink failed."
246 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
247 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
248 die "Readlink failed."
250 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
254 function compose_pybot_arguments () {
257 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
258 # - DUT - CSIT test/ subdirectory, set while processing tags.
259 # - TAGS - Array variable holding selected tag boolean expressions.
260 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
261 # - TEST_CODE - The test selection string from environment or argument.
263 # - PYBOT_ARGS - String holding part of all arguments for pybot.
264 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
268 # No explicit check needed with "set -u".
269 PYBOT_ARGS=("--loglevel" "TRACE")
270 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
272 case "${TEST_CODE}" in
274 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
277 PYBOT_ARGS+=("--suite" "tests.${DUT}.func")
280 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
283 die "Unknown specification: ${TEST_CODE}"
287 for tag in "${TAGS[@]}"; do
288 if [[ ${tag} == "!"* ]]; then
289 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
291 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
297 function copy_archives () {
299 # Create additional archive if workspace variable is set.
300 # This way if script is running in jenkins all will be
301 # automatically archived to logs.fd.io.
304 # - WORKSPACE - Jenkins workspace, copy only if the value is not empty.
305 # Can be unset, then it speeds up manual testing.
306 # - ARCHIVE_DIR - Path to directory with content to be copied.
307 # Directories updated:
308 # - ${WORKSPACE}/archives/ - Created if does not exist.
309 # Content of ${ARCHIVE_DIR}/ is copied here.
311 # - die - Print to stderr and exit.
315 if [[ -n "${WORKSPACE-}" ]]; then
316 mkdir -p "${WORKSPACE}/archives/" || die "Archives dir create failed."
317 cp -rf "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
322 function deactivate_docker_topology () {
324 # Deactivate virtual vpp-device topology by removing containers.
327 # - NODENESS - Node multiplicity of desired testbed.
328 # - FLAVOR - Node flavor string, usually describing the processor.
332 case_text="${NODENESS}_${FLAVOR}"
333 case "${case_text}" in
335 hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
336 ssh="ssh root@${hostname} -p 6022"
337 env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
338 # The "declare -f" output is long and boring.
340 ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
341 die "Topology cleanup via shim-dcr failed!"
347 clean_environment || {
348 die "Topology cleanup locally failed!"
353 die "Unknown specification: ${case_text}!"
360 # Print the message to standard error end exit with error code specified
361 # by the second argument.
364 # - The default error message.
366 # - ${1} - The whole error message, be sure to quote. Optional
367 # - ${2} - the code to exit with, default: 1.
371 warn "${1:-Unspecified run-time error occurred!}"
376 function die_on_pybot_error () {
378 # Source this fragment if you want to abort on any failed test case.
381 # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
383 # - die - Print to stderr and exit.
387 if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
388 die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
393 function generate_tests () {
395 # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
396 # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
397 # The generation is done by executing any *.py executable
398 # within any subdirectory after copying.
400 # This is a separate function, because this code is called
401 # both by autogen checker and entries calling run_pybot.
404 # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
405 # Directories replaced:
406 # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
410 rm -rf "${GENERATED_DIR}/tests" || die
411 cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
412 cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
413 cmd_line+=("-executable" "-name" "*.py")
414 file_list=$("${cmd_line[@]}") || die
416 for gen in ${file_list}; do
417 directory="$(dirname "${gen}")" || die
418 filename="$(basename "${gen}")" || die
419 pushd "${directory}" || die
420 ./"${filename}" || die
426 function get_test_code () {
429 # - ${1} - Optional, argument of entry script (or empty as unset).
430 # Test code value to override job name from environment.
432 # - JOB_NAME - String affecting test selection, default if not argument.
434 # - TEST_CODE - The test selection string from environment or argument.
435 # - NODENESS - Node multiplicity of desired testbed.
436 # - FLAVOR - Node flavor string, usually describing the processor.
440 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
441 if [[ -z "${TEST_CODE}" ]]; then
442 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
445 case "${TEST_CODE}" in
483 # Fallback to 3-node Haswell by default (backward compatibility)
491 function get_test_tag_string () {
494 # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
495 # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
496 # - TEST_CODE - The test selection string from environment or argument.
498 # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
499 # May be empty, or even not set on event types not adding comment.
501 # TODO: ci-management scripts no longer need to perform this.
505 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
506 case "${TEST_CODE}" in
514 die "Unknown specification: ${TEST_CODE}"
516 # Ignore lines not containing the trigger word.
517 comment=$(fgrep "${trigger}" <<< "${GERRIT_EVENT_COMMENT_TEXT}") || true
518 # The vpp-csit triggers trail stuff we are not interested in.
519 # Removing them and trigger word: https://unix.stackexchange.com/a/13472
520 # (except relying on \s whitespace, \S non-whitespace and . both).
521 # The last string is concatenated, only the middle part is expanded.
522 cmd=("grep" "-oP" '\S*'"${trigger}"'\S*\s\K.+$') || die "Unset trigger?"
523 # On parsing error, TEST_TAG_STRING probably stays empty.
524 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}") || true
529 function installed () {
531 # Check if the given utility is installed. Fail if not installed.
533 # Duplicate of common.sh function, as this file is also used standalone.
536 # - ${1} - Utility to check.
538 # - 0 - If command is installed.
539 # - 1 - If command is not installed.
547 function reserve_and_cleanup_testbed () {
549 # Reserve physical testbed, perform cleanup, register trap to unreserve.
550 # When cleanup fails, remove from topologies and keep retrying
551 # until all topologies are removed.
554 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
555 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
556 # - BUILD_TAG - Any string suitable as filename, identifying
557 # test run executing this function. May be unset.
559 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
560 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
562 # - die - Print to stderr and exit.
563 # - ansible_hosts - Perform an action using ansible, see ansible.sh
565 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
570 for topo in "${TOPOLOGIES[@]}"; do
572 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
573 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
574 python3 "${scrpt}" "${opts[@]}"
577 if [[ "${result}" == "0" ]]; then
578 # Trap unreservation before cleanup check,
579 # so multiple jobs showing failed cleanup improve chances
580 # of humans to notice and fix.
581 WORKING_TOPOLOGY="${topo}"
582 echo "Reserved: ${WORKING_TOPOLOGY}"
583 trap "untrap_and_unreserve_testbed" EXIT || {
584 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
585 untrap_and_unreserve_testbed "${message}" || {
586 die "Teardown should have died, not failed."
588 die "Trap attempt failed, unreserve succeeded. Aborting."
592 ansible_hosts "cleanup"
595 if [[ "${result}" == "0" ]]; then
598 warn "Testbed cleanup failed: ${topo}"
599 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
601 # Else testbed is accessible but currently reserved, moving on.
604 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
605 # Exit the infinite while loop if we made a reservation.
606 warn "Reservation and cleanup successful."
610 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
611 die "Run out of operational testbeds!"
614 # Wait ~3minutes before next try.
615 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
616 die "Sleep time calculation failed."
618 echo "Sleeping ${sleep_time}"
619 sleep "${sleep_time}" || die "Sleep failed."
624 function run_pybot () {
626 # Run pybot with options based on input variables. Create output_info.xml
629 # - CSIT_DIR - Path to existing root of local CSIT git repository.
630 # - ARCHIVE_DIR - Path to store robot result files in.
631 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
632 # - GENERATED_DIR - Tests are assumed to be generated under there.
634 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
636 # - die - Print to stderr and exit.
640 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
641 all_options+=("--noncritical" "EXPECTED_FAILING")
642 all_options+=("${EXPANDED_TAGS[@]}")
644 pushd "${CSIT_DIR}" || die "Change directory operation failed."
646 robot "${all_options[@]}" "${GENERATED_DIR}/tests/"
647 PYBOT_EXIT_STATUS="$?"
650 # Generate INFO level output_info.xml for post-processing.
651 all_options=("--loglevel" "INFO")
652 all_options+=("--log" "none")
653 all_options+=("--report" "none")
654 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
655 all_options+=("${ARCHIVE_DIR}/output.xml")
656 rebot "${all_options[@]}" || true
657 popd || die "Change directory operation failed."
661 function select_arch_os () {
663 # Set variables affected by local CPU architecture and operating system.
666 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
667 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
668 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
672 os_id=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') || {
673 die "Get OS release failed."
678 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
679 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_BIONIC"
683 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_CENTOS"
684 VPP_VER_FILE="VPP_STABLE_VER_CENTOS"
688 die "Unable to identify distro or os from ${os_id}"
692 arch=$(uname -m) || {
693 die "Get CPU architecture failed."
698 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
706 function select_tags () {
709 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
710 # - TEST_CODE - String affecting test selection, usually jenkins job name.
711 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
713 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
714 # - BASH_FUNCTION_DIR - Directory with input files to process.
716 # - TAGS - Array of processed tag boolean expressions.
721 start_pattern='^ TG:'
722 end_pattern='^ \? \?[A-Za-z0-9]\+:'
723 # Remove the TG section from topology file
724 sed_command="/${start_pattern}/,/${end_pattern}/d"
725 # All topologies DUT NICs
726 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
727 | grep -hoP "model: \K.*" | sort -u)
728 # Selected topology DUT NICs
729 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
730 | grep -hoP "model: \K.*" | sort -u)
731 # All topologies DUT NICs - Selected topology DUT NICs
732 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
733 die "Computation of excluded NICs failed."
736 # Select default NIC tag.
737 case "${TEST_CODE}" in
738 *"3n-dnv"* | *"2n-dnv"*)
739 default_nic="nic_intel-x553"
742 default_nic="nic_intel-x520-da2"
744 *"3n-skx"* | *"2n-skx"* | *"2n-clx"*)
745 default_nic="nic_intel-xxv710"
747 *"3n-hsw"* | *"mrr-daily-master")
748 default_nic="nic_intel-xl710"
751 default_nic="nic_intel-x710"
755 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
756 # Tag file directory shorthand.
757 tfd="${BASH_FUNCTION_DIR}"
758 case "${TEST_CODE}" in
759 # Select specific performance tests based on jenkins job type variable.
761 readarray -t test_tag_array < "${tfd}/mlr-weekly.txt" || die
764 readarray -t test_tag_array <<< $(${sed_nic_sub_cmd} \
765 ${tfd}/mrr-daily-${FLAVOR}.txt) || die
768 readarray -t test_tag_array <<< $(${sed_nic_sub_cmd} \
769 ${tfd}/mrr-weekly.txt) || die
772 if [[ -z "${TEST_TAG_STRING-}" ]]; then
773 # If nothing is specified, we will run pre-selected tests by
775 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDip4base"
776 "mrrAND${default_nic}AND1cAND78bANDip6base"
777 "mrrAND${default_nic}AND1cAND64bANDl2bdbase"
778 "mrrAND${default_nic}AND1cAND64bANDl2xcbase"
781 # If trigger contains tags, split them into array.
782 test_tag_array=(${TEST_TAG_STRING//:/ })
787 # Blacklisting certain tags per topology.
789 # Reasons for blacklisting:
790 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
791 # TODO: Add missing reasons here (if general) or where used (if specific).
792 case "${TEST_CODE}" in
794 test_tag_array+=("!ipsechw")
797 test_tag_array+=("!ipsechw")
798 # Not enough nic_intel-xxv710 to support double link tests.
799 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
802 test_tag_array+=("!ipsechw")
805 test_tag_array+=("!ipsechw")
806 test_tag_array+=("!memif")
807 test_tag_array+=("!srv6_proxy")
808 test_tag_array+=("!vhost")
809 test_tag_array+=("!vts")
810 test_tag_array+=("!drv_avf")
813 test_tag_array+=("!memif")
814 test_tag_array+=("!srv6_proxy")
815 test_tag_array+=("!vhost")
816 test_tag_array+=("!vts")
817 test_tag_array+=("!drv_avf")
820 # 3n-tsh only has x520 NICs which don't work with AVF
821 test_tag_array+=("!drv_avf")
822 test_tag_array+=("!ipsechw")
825 # TODO: Introduce NOIOMMU version of AVF tests.
826 # TODO: Make (both) AVF tests work on Haswell,
827 # or document why (some of) it is not possible.
828 # https://github.com/FDio/vpp/blob/master/src/plugins/avf/README.md
829 test_tag_array+=("!drv_avf")
830 # All cards have access to QAT. But only one card (xl710)
831 # resides in same NUMA as QAT. Other cards must go over QPI
832 # which we do not want to even run.
833 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
836 # Default to 3n-hsw due to compatibility.
837 test_tag_array+=("!drv_avf")
838 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
842 # We will add excluded NICs.
843 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
847 # We will prefix with perftest to prevent running other tests
851 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
852 # Automatic prefixing for VPP jobs to limit the NIC used and
853 # traffic evaluation to MRR.
854 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
855 prefix="${prefix}mrrAND"
857 prefix="${prefix}mrrAND${default_nic}AND"
860 for tag in "${test_tag_array[@]}"; do
861 if [[ "${tag}" == "!"* ]]; then
862 # Exclude tags are not prefixed.
864 elif [[ "${tag}" == " "* || "${tag}" == *"perftest"* ]]; then
865 # Badly formed tag expressions can trigger way too much tests.
867 warn "The following tag expression hints at bad trigger: ${tag}"
868 warn "Possible cause: Multiple triggers in a single comment."
869 die "Aborting to avoid triggering too many tests."
870 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
871 # Empty and comment lines are skipped.
872 # Other lines are normal tags, they are to be prefixed.
873 TAGS+=("${prefix}${tag}")
880 function select_topology () {
883 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
884 # - FLAVOR - Node flavor string, currently either "hsw" or "skx".
885 # - CSIT_DIR - Path to existing root of local CSIT git repository.
886 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
888 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
889 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
891 # - die - Print to stderr and exit.
895 case_text="${NODENESS}_${FLAVOR}"
896 case "${case_text}" in
897 # TODO: Move tags to "# Blacklisting certain tags per topology" section.
898 # TODO: Double link availability depends on NIC used.
900 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
901 TOPOLOGIES_TAGS="2_node_single_link_topo"
904 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
905 TOPOLOGIES_TAGS="2_node_single_link_topo"
908 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
909 TOPOLOGIES_TAGS="2_node_*_link_topo"
912 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
913 TOPOLOGIES_TAGS="3_node_*_link_topo"
916 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_clx*.yaml )
917 TOPOLOGIES_TAGS="2_node_*_link_topo"
920 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
921 TOPOLOGIES_TAGS="2_node_single_link_topo"
924 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
925 TOPOLOGIES_TAGS="3_node_single_link_topo"
928 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
929 TOPOLOGIES_TAGS="3_node_single_link_topo"
932 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
933 TOPOLOGIES_TAGS="3_node_single_link_topo"
936 # No falling back to 3n_hsw default, that should have been done
937 # by the function which has set NODENESS and FLAVOR.
938 die "Unknown specification: ${case_text}"
941 if [[ -z "${TOPOLOGIES-}" ]]; then
942 die "No applicable topology found!"
947 function select_vpp_device_tags () {
950 # - TEST_CODE - String affecting test selection, usually jenkins job name.
951 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
954 # - TAGS - Array of processed tag boolean expressions.
958 case "${TEST_CODE}" in
959 # Select specific device tests based on jenkins job type variable.
961 if [[ -z "${TEST_TAG_STRING-}" ]]; then
962 # If nothing is specified, we will run pre-selected tests by
963 # following tags. Items of array will be concatenated by OR
964 # in Robot Framework.
967 # If trigger contains tags, split them into array.
968 test_tag_array=(${TEST_TAG_STRING//:/ })
973 # Blacklisting certain tags per topology.
975 # Reasons for blacklisting:
976 # - avf - AVF is not possible to run on enic driver of VirtualBox.
977 # - vhost - VirtualBox does not support nesting virtualization on Intel CPU.
978 case "${TEST_CODE}" in
980 test_tag_array+=("!avf")
981 test_tag_array+=("!vhost")
989 # We will prefix with devicetest to prevent running other tests
991 prefix="devicetestAND"
992 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
993 # Automatic prefixing for VPP jobs to limit testing.
996 for tag in "${test_tag_array[@]}"; do
997 if [[ ${tag} == "!"* ]]; then
998 # Exclude tags are not prefixed.
1001 TAGS+=("${prefix}${tag}")
1006 function untrap_and_unreserve_testbed () {
1008 # Use this as a trap function to ensure testbed does not remain reserved.
1009 # Perhaps call directly before script exit, to free testbed for other jobs.
1010 # This function is smart enough to avoid multiple unreservations (so safe).
1011 # Topo cleanup is executed (call it best practice), ignoring failures.
1014 # - default message to die with if testbed might remain reserved.
1016 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1017 # Variables read (by inner function):
1018 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1019 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1020 # Variables written:
1021 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1022 # Trap unregistered:
1023 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1025 # - die - Print to stderr and exit.
1026 # - ansible_hosts - Perform an action using ansible, see ansible.sh
1029 set +eu # We do not want to exit early in a "teardown" function.
1030 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1031 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1032 if [[ -z "${wt-}" ]]; then
1034 warn "Testbed looks unreserved already. Trap removal failed before?"
1036 ansible_hosts "cleanup" || true
1037 python3 "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1038 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1048 # Print the message to standard error.
1051 # - ${@} - The text of the message.