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 # backtics to avoid https://midnight-commander.org/ticket/2142
57 env_vars=`${ssh} "$(declare -f); ${run}"` || {
58 die "Topology reservation via shim-dcr failed!"
61 source <(echo "$env_vars" | grep -v /usr/bin/docker) || {
67 # We execute reservation on localhost. Sourced script automatially
68 # sets environment variables for further processing.
69 activate_wrapper "${NODENESS}" "${FLAVOR}" "${device_image}" || die
72 die "Unknown specification: ${case_text}!"
75 trap 'deactivate_docker_topology' EXIT || {
76 die "Trap attempt failed, please cleanup manually. Aborting!"
79 # Replace all variables in template with those in environment.
80 source <(echo 'cat <<EOF >topo.yml'; cat ${TOPOLOGIES[0]}; echo EOF;) || {
81 die "Topology file create failed!"
84 WORKING_TOPOLOGY="/tmp/topology.yaml"
85 mv topo.yml "${WORKING_TOPOLOGY}" || {
86 die "Topology move failed!"
88 cat ${WORKING_TOPOLOGY} | grep -v password || {
89 die "Topology read failed!"
94 function activate_virtualenv () {
96 # Update virtualenv pip package, delete and create virtualenv directory,
97 # activate the virtualenv, install requirements, set PYTHONPATH.
100 # - ${1} - Path to existing directory for creating virtualenv in.
101 # If missing or empty, ${CSIT_DIR} is used.
102 # - ${2} - Path to requirements file, ${CSIT_DIR}/requirements.txt if empty.
104 # - CSIT_DIR - Path to existing root of local CSIT git repository.
105 # Variables exported:
106 # - PYTHONPATH - CSIT_DIR, as CSIT Python scripts usually need this.
108 # - die - Print to stderr and exit.
112 root_path="${1-$CSIT_DIR}"
113 env_dir="${root_path}/env"
114 req_path=${2-$CSIT_DIR/requirements.txt}
115 rm -rf "${env_dir}" || die "Failed to clean previous virtualenv."
116 pip install --upgrade virtualenv || {
117 die "Virtualenv package install failed."
119 virtualenv "${env_dir}" || {
120 die "Virtualenv creation failed."
123 source "${env_dir}/bin/activate" || die "Virtualenv activation failed."
125 pip install --upgrade -r "${req_path}" || {
126 die "Requirements installation failed."
128 # Most CSIT Python scripts assume PYTHONPATH is set and exported.
129 export PYTHONPATH="${CSIT_DIR}" || die "Export failed."
133 function archive_tests () {
135 # Create .tar.xz of generated/tests for archiving.
136 # To be run after generate_tests, kept separate to offer more flexibility.
139 # - ${GENERATED_DIR}/tests - Tree of executed suites to archive.
141 # - ${ARCHIVE_DIR}/tests.tar.xz - Archive of generated tests.
145 tar c "${GENERATED_DIR}/tests" | xz -9e > "${ARCHIVE_DIR}/tests.tar.xz" || {
146 die "Error creating archive of generated tests."
151 function check_download_dir () {
153 # Fail if there are no files visible in ${DOWNLOAD_DIR}.
156 # - DOWNLOAD_DIR - Path to directory pybot takes the build to test from.
158 # - ${DOWNLOAD_DIR} - Has to be non-empty to proceed.
160 # - die - Print to stderr and exit.
164 if [[ ! "$(ls -A "${DOWNLOAD_DIR}")" ]]; then
165 die "No artifacts downloaded!"
170 function check_prerequisites () {
172 # Fail if prerequisites are not met.
175 # - installed - Check if application is installed/present in system.
176 # - die - Print to stderr and exit.
180 if ! installed sshpass; then
181 die "Please install sshpass before continue!"
185 function cleanup_topo () {
188 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
189 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
193 python "${PYTHON_SCRIPTS_DIR}/topo_cleanup.py" -t "${WORKING_TOPOLOGY}"
194 # Not using "|| die" as some callers might want to ignore errors,
195 # e.g. in teardowns, such as unreserve.
199 function common_dirs () {
201 # Set global variables, create some directories (without touching content).
204 # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
205 # - CSIT_DIR - Path to existing root of local CSIT git repository.
206 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
207 # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
208 # - TOOLS_DIR - Path to existing resources subdirectory "tools".
209 # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
210 # - ARCHIVE_DIR - Path to created CSIT subdirectory "archive".
211 # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
212 # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
213 # Directories created if not present:
214 # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
216 # - die - Print to stderr and exit.
220 this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
221 die "Some error during locating of this source file."
223 BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
224 die "Some error during dirname call."
226 # Current working directory could be in a different repo, e.g. VPP.
227 pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
228 relative_csit_dir=$(git rev-parse --show-toplevel) || {
229 die "Git rev-parse failed."
231 CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
232 popd || die "Popd failed."
233 TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
234 die "Readlink failed."
236 RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
237 die "Readlink failed."
239 TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
240 die "Readlink failed."
242 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
243 die "Readlink failed."
246 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archive") || {
247 die "Readlink failed."
249 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
250 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
251 die "Readlink failed."
253 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
254 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
255 die "Readlink failed."
257 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
261 function compose_pybot_arguments () {
264 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
265 # - DUT - CSIT test/ subdirectory, set while processing tags.
266 # - TAGS - Array variable holding selected tag boolean expressions.
267 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
268 # - TEST_CODE - The test selection string from environment or argument.
270 # - PYBOT_ARGS - String holding part of all arguments for pybot.
271 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
275 # No explicit check needed with "set -u".
276 PYBOT_ARGS=("--loglevel" "TRACE")
277 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
279 case "${TEST_CODE}" in
281 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
284 PYBOT_ARGS+=("--suite" "tests.${DUT}.func")
287 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
290 die "Unknown specification: ${TEST_CODE}"
294 for tag in "${TAGS[@]}"; do
295 if [[ ${tag} == "!"* ]]; then
296 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
298 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
304 function copy_archives () {
306 # Create additional archive if workspace variable is set.
307 # This way if script is running in jenkins all will be
308 # automatically archived to logs.fd.io.
311 # - WORKSPACE - Jenkins workspace, copy only if the value is not empty.
312 # Can be unset, then it speeds up manual testing.
313 # - ARCHIVE_DIR - Path to directory with content to be copied.
314 # Directories updated:
315 # - ${WORKSPACE}/archives/ - Created if does not exist.
316 # Content of ${ARCHIVE_DIR}/ is copied here.
318 # - die - Print to stderr and exit.
322 if [[ -n "${WORKSPACE-}" ]]; then
323 mkdir -p "${WORKSPACE}/archives/" || die "Archives dir create failed."
324 cp -rf "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
329 function deactivate_docker_topology () {
331 # Deactivate virtual vpp-device topology by removing containers.
334 # - NODENESS - Node multiplicity of desired testbed.
335 # - FLAVOR - Node flavor string, usually describing the processor.
339 case_text="${NODENESS}_${FLAVOR}"
340 case "${case_text}" in
342 hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
343 ssh="ssh root@${hostname} -p 6022"
344 env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
345 ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
346 die "Topology cleanup via shim-dcr failed!"
351 clean_environment || {
352 die "Topology cleanup locally failed!"
357 die "Unknown specification: ${case_text}!"
364 # Print the message to standard error end exit with error code specified
365 # by the second argument.
368 # - The default error message.
370 # - ${1} - The whole error message, be sure to quote. Optional
371 # - ${2} - the code to exit with, default: 1.
375 warn "${1:-Unspecified run-time error occurred!}"
380 function die_on_pybot_error () {
382 # Source this fragment if you want to abort on any failed test case.
385 # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
387 # - die - Print to stderr and exit.
391 if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
392 die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
397 function generate_tests () {
399 # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
400 # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
401 # The generation is done by executing any *.py executable
402 # within any subdirectory after copying.
404 # This is a separate function, because this code is called
405 # both by autogen checker and entries calling run_pybot.
408 # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
409 # Directories replaced:
410 # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
414 rm -rf "${GENERATED_DIR}/tests" || die
415 cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
416 cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
417 cmd_line+=("-executable" "-name" "*.py")
418 file_list=$("${cmd_line[@]}") || die
420 for gen in ${file_list}; do
421 directory="$(dirname "${gen}")" || die
422 filename="$(basename "${gen}")" || die
423 pushd "${directory}" || die
424 ./"${filename}" || die
430 function get_test_code () {
433 # - ${1} - Optional, argument of entry script (or empty as unset).
434 # Test code value to override job name from environment.
436 # - JOB_NAME - String affecting test selection, default if not argument.
438 # - TEST_CODE - The test selection string from environment or argument.
439 # - NODENESS - Node multiplicity of desired testbed.
440 # - FLAVOR - Node flavor string, usually describing the processor.
444 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
445 if [[ -z "${TEST_CODE}" ]]; then
446 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
449 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, not set on event types not adding comment.
501 # TODO: ci-management scripts no longer need to perform this.
506 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
507 case "${TEST_CODE}" in
509 # On parsing error, ${trigger} stays empty.
510 trigger="$(echo "${GERRIT_EVENT_COMMENT_TEXT}" \
511 | grep -oE '(devicetest$|devicetest[[:space:]].+$)')" \
513 # Set test tags as string.
514 TEST_TAG_STRING="${trigger#$"devicetest"}"
517 # On parsing error, ${trigger} stays empty.
518 comment="${GERRIT_EVENT_COMMENT_TEXT}"
519 # As "perftest" can be followed by something, we substitute it.
520 comment="${comment/perftest-2n/perftest}"
521 comment="${comment/perftest-3n/perftest}"
522 comment="${comment/perftest-hsw/perftest}"
523 comment="${comment/perftest-skx/perftest}"
524 comment="${comment/perftest-dnv/perftest}"
525 comment="${comment/perftest-tsh/perftest}"
526 tag_string="$(echo "${comment}" \
527 | grep -oE '(perftest$|perftest[[:space:]].+$)' || true)"
528 # Set test tags as string.
529 TEST_TAG_STRING="${tag_string#$"perftest"}"
532 die "Unknown specification: ${TEST_CODE}"
538 function installed () {
540 # Check if the given utility is installed. Fail if not installed.
542 # Duplicate of common.sh function, as this file is also used standalone.
545 # - ${1} - Utility to check.
547 # - 0 - If command is installed.
548 # - 1 - If command is not installed.
556 function remove_topo () {
558 # Remove the argument from list of available topologies.
560 # Just a de-duplicated block of code
563 # - ${1} - The topology item to remove. Required.
564 # Variable read and re-written:
565 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
569 warn "Testbed ${topo} seems unsuitable, removing from the list."
571 # Build new topology array.
572 # TOPOLOGIES=("${TOPOLOGIES[@]/$topo}")
573 # does not really work, see:
574 # https://stackoverflow.com/questions/16860877/remove-an-element-from-a-bash-array
577 for item in "${TOPOLOGIES[@]}"; do
578 if [[ "${item}" != "${1}" ]]; then
579 new_topologies+=("${item}")
582 TOPOLOGIES=("${new_topologies[@]}")
586 function reserve_and_cleanup_testbed () {
588 # Reserve physical testbed, perform cleanup, register trap to unreserve.
589 # When cleanup fails, remove from topologies and keep retrying
590 # until all topologies are removed.
593 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
594 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
595 # - BUILD_TAG - Any string suitable as filename, identifying
596 # test run executing this function. May be unset.
598 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
599 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
601 # - die - Print to stderr and exit.
603 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
608 for topo in "${TOPOLOGIES[@]}"; do
610 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
611 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
612 python "${scrpt}" "${opts[@]}"
615 if [[ "${result}" == "0" ]]; then
616 # Trap unreservation before cleanup check,
617 # so multiple jobs showing failed cleanup improve chances
618 # of humans to notice and fix.
619 WORKING_TOPOLOGY="${topo}"
620 echo "Reserved: ${WORKING_TOPOLOGY}"
621 trap "untrap_and_unreserve_testbed" EXIT || {
622 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
623 untrap_and_unreserve_testbed "${message}" || {
624 die "Teardown should have died, not failed."
626 die "Trap attempt failed, unreserve succeeded. Aborting."
633 if [[ "${result}" == "0" ]]; then
636 warn "Testbed cleanup failed: ${topo}"
637 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
638 # WORKING_TOPOLOGY is now empty again.
639 remove_topo "${topo}"
640 elif [[ "${result}" != "2" ]]; then
641 # 1 or unexpected return code, testbed is probably unusable.
642 remove_topo "${topo}"
644 # Else testbed is accessible but currently reserved, moving on.
647 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
648 # Exit the infinite while loop if we made a reservation.
649 warn "Reservation and cleanup successful."
653 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
654 die "Run out of operational testbeds!"
657 # Wait ~3minutes before next try.
658 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
659 die "Sleep time calculation failed."
661 echo "Sleeping ${sleep_time}"
662 sleep "${sleep_time}" || die "Sleep failed."
667 function run_pybot () {
669 # Run pybot with options based on input variables. Create output_info.xml
672 # - CSIT_DIR - Path to existing root of local CSIT git repository.
673 # - ARCHIVE_DIR - Path to store robot result files in.
674 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
675 # - GENERATED_DIR - Tests are assumed to be generated under there.
677 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
679 # - die - Print to stderr and exit.
683 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
684 all_options+=("--noncritical" "EXPECTED_FAILING")
685 all_options+=("${EXPANDED_TAGS[@]}")
687 pushd "${CSIT_DIR}" || die "Change directory operation failed."
689 pybot "${all_options[@]}" "${GENERATED_DIR}/tests/"
690 PYBOT_EXIT_STATUS="$?"
693 # Generate INFO level output_info.xml for post-processing.
694 all_options=("--loglevel" "INFO")
695 all_options+=("--log" "none")
696 all_options+=("--report" "none")
697 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
698 all_options+=("${ARCHIVE_DIR}/output.xml")
699 rebot "${all_options[@]}" || true
700 popd || die "Change directory operation failed."
704 function select_arch_os () {
706 # Set variables affected by local CPU architecture and operating system.
709 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
710 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
711 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
715 os_id=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') || {
716 die "Get OS release failed."
721 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
722 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_BIONIC"
726 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_CENTOS"
727 VPP_VER_FILE="VPP_STABLE_VER_CENTOS"
731 die "Unable to identify distro or os from ${os_id}"
735 arch=$(uname -m) || {
736 die "Get CPU architecture failed."
741 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
749 function select_tags () {
752 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
753 # - TEST_CODE - String affecting test selection, usually jenkins job name.
754 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
756 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
757 # - BASH_FUNCTION_DIR - Directory with input files to process.
759 # - TAGS - Array of processed tag boolean expressions.
764 start_pattern='^ TG:'
765 end_pattern='^ \? \?[A-Za-z0-9]\+:'
766 # Remove the TG section from topology file
767 sed_command="/${start_pattern}/,/${end_pattern}/d"
768 # All topologies DUT NICs
769 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
770 | grep -hoP "model: \K.*" | sort -u)
771 # Selected topology DUT NICs
772 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
773 | grep -hoP "model: \K.*" | sort -u)
774 # All topologies DUT NICs - Selected topology DUT NICs
775 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
776 die "Computation of excluded NICs failed."
779 # Select default NIC tag.
780 case "${TEST_CODE}" in
781 *"3n-dnv"* | *"2n-dnv"*)
782 default_nic="nic_intel-x553"
785 default_nic="nic_intel-x520-da2"
788 default_nic="nic_intel-x710"
792 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
793 # Tag file directory shorthand.
794 tfd="${BASH_FUNCTION_DIR}"
795 case "${TEST_CODE}" in
796 # Select specific performance tests based on jenkins job type variable.
798 readarray -t test_tag_array < "${tfd}/mlr-weekly.txt" || die
801 readarray -t test_tag_array <<< $(${sed_nic_sub_cmd} \
802 ${tfd}/mrr-daily-${FLAVOR}.txt) || die
805 readarray -t test_tag_array < "${tfd}/mrr-weekly.txt" || die
808 if [[ -z "${TEST_TAG_STRING-}" ]]; then
809 # If nothing is specified, we will run pre-selected tests by
811 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDip4base"
812 "mrrAND${default_nic}AND1cAND78bANDip6base"
813 "mrrAND${default_nic}AND1cAND64bANDl2bdbase"
814 "mrrAND${default_nic}AND1cAND64bANDl2xcbase"
817 # If trigger contains tags, split them into array.
818 test_tag_array=(${TEST_TAG_STRING//:/ })
823 # Blacklisting certain tags per topology.
825 # Reasons for blacklisting:
826 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
827 # TODO: Add missing reasons here (if general) or where used (if specific).
828 case "${TEST_CODE}" in
830 test_tag_array+=("!ipsechw")
833 test_tag_array+=("!ipsechw")
834 # Not enough nic_intel-xxv710 to support double link tests.
835 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
838 test_tag_array+=("!ipsechw")
839 test_tag_array+=("!memif")
840 test_tag_array+=("!srv6_proxy")
841 test_tag_array+=("!vhost")
842 test_tag_array+=("!vts")
843 test_tag_array+=("!drv_avf")
846 test_tag_array+=("!memif")
847 test_tag_array+=("!srv6_proxy")
848 test_tag_array+=("!vhost")
849 test_tag_array+=("!vts")
850 test_tag_array+=("!drv_avf")
853 # 3n-tsh only has x520 NICs which don't work with AVF
854 test_tag_array+=("!drv_avf")
855 test_tag_array+=("!ipsechw")
858 # TODO: Introduce NOIOMMU version of AVF tests.
859 # TODO: Make (both) AVF tests work on Haswell,
860 # or document why (some of) it is not possible.
861 # https://github.com/FDio/vpp/blob/master/src/plugins/avf/README.md
862 test_tag_array+=("!drv_avf")
863 # All cards have access to QAT. But only one card (xl710)
864 # resides in same NUMA as QAT. Other cards must go over QPI
865 # which we do not want to even run.
866 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
869 # Default to 3n-hsw due to compatibility.
870 test_tag_array+=("!drv_avf")
871 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
875 # We will add excluded NICs.
876 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
880 # We will prefix with perftest to prevent running other tests
884 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
885 # Automatic prefixing for VPP jobs to limit the NIC used and
886 # traffic evaluation to MRR.
887 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
888 prefix="${prefix}mrrAND"
890 prefix="${prefix}mrrAND${default_nic}AND"
893 for tag in "${test_tag_array[@]}"; do
894 if [[ "${tag}" == "!"* ]]; then
895 # Exclude tags are not prefixed.
897 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
898 # Empty and comment lines are skipped.
899 # Other lines are normal tags, they are to be prefixed.
900 TAGS+=("${prefix}${tag}")
907 function select_topology () {
910 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
911 # - FLAVOR - Node flavor string, currently either "hsw" or "skx".
912 # - CSIT_DIR - Path to existing root of local CSIT git repository.
913 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
915 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
916 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
918 # - die - Print to stderr and exit.
922 case_text="${NODENESS}_${FLAVOR}"
923 case "${case_text}" in
924 # TODO: Move tags to "# Blacklisting certain tags per topology" section.
925 # TODO: Double link availability depends on NIC used.
927 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
928 TOPOLOGIES_TAGS="2_node_single_link_topo"
931 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
932 TOPOLOGIES_TAGS="2_node_single_link_topo"
935 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
936 TOPOLOGIES_TAGS="2_node_*_link_topo"
939 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
940 TOPOLOGIES_TAGS="3_node_*_link_topo"
943 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
944 TOPOLOGIES_TAGS="2_node_single_link_topo"
947 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
948 TOPOLOGIES_TAGS="3_node_single_link_topo"
951 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
952 TOPOLOGIES_TAGS="3_node_single_link_topo"
955 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
956 TOPOLOGIES_TAGS="3_node_single_link_topo"
959 # No falling back to 3n_hsw default, that should have been done
960 # by the function which has set NODENESS and FLAVOR.
961 die "Unknown specification: ${case_text}"
964 if [[ -z "${TOPOLOGIES-}" ]]; then
965 die "No applicable topology found!"
970 function select_vpp_device_tags () {
973 # - TEST_CODE - String affecting test selection, usually jenkins job name.
974 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
977 # - TAGS - Array of processed tag boolean expressions.
981 case "${TEST_CODE}" in
982 # Select specific device tests based on jenkins job type variable.
984 if [[ -z "${TEST_TAG_STRING-}" ]]; then
985 # If nothing is specified, we will run pre-selected tests by
986 # following tags. Items of array will be concatenated by OR
987 # in Robot Framework.
990 # If trigger contains tags, split them into array.
991 test_tag_array=(${TEST_TAG_STRING//:/ })
996 # Blacklisting certain tags per topology.
998 # Reasons for blacklisting:
999 # - avf - AVF is not possible to run on enic driver of VirtualBox.
1000 # - vhost - VirtualBox does not support nesting virtualization on Intel CPU.
1001 case "${TEST_CODE}" in
1003 test_tag_array+=("!avf")
1004 test_tag_array+=("!vhost")
1012 # We will prefix with devicetest to prevent running other tests
1013 # (e.g. Functional).
1014 prefix="devicetestAND"
1015 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
1016 # Automatic prefixing for VPP jobs to limit testing.
1019 for tag in "${test_tag_array[@]}"; do
1020 if [[ ${tag} == "!"* ]]; then
1021 # Exclude tags are not prefixed.
1024 TAGS+=("${prefix}${tag}")
1029 function untrap_and_unreserve_testbed () {
1031 # Use this as a trap function to ensure testbed does not remain reserved.
1032 # Perhaps call directly before script exit, to free testbed for other jobs.
1033 # This function is smart enough to avoid multiple unreservations (so safe).
1034 # Topo cleanup is executed (call it best practice), ignoring failures.
1037 # - default message to die with if testbed might remain reserved.
1039 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1040 # Variables read (by inner function):
1041 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1042 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1043 # Variables written:
1044 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1045 # Trap unregistered:
1046 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1048 # - die - Print to stderr and exit.
1051 set +eu # We do not want to exit early in a "teardown" function.
1052 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1053 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1054 if [[ -z "${wt-}" ]]; then
1056 warn "Testbed looks unreserved already. Trap removal failed before?"
1058 cleanup_topo || true
1059 python "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1060 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1070 # Print the message to standard error.
1073 # - ${@} - The text of the message.