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 DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
243 die "Readlink failed."
245 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
246 die "Readlink failed."
249 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archive") || {
250 die "Readlink failed."
252 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
253 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
254 die "Readlink failed."
256 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
257 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
258 die "Readlink failed."
260 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
264 function compose_pybot_arguments () {
267 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
268 # - DUT - CSIT test/ subdirectory, set while processing tags.
269 # - TAGS - Array variable holding selected tag boolean expressions.
270 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
271 # - TEST_CODE - The test selection string from environment or argument.
273 # - PYBOT_ARGS - String holding part of all arguments for pybot.
274 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
278 # No explicit check needed with "set -u".
279 PYBOT_ARGS=("--loglevel" "TRACE")
280 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
282 case "${TEST_CODE}" in
284 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
287 PYBOT_ARGS+=("--suite" "tests.${DUT}.func")
290 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
293 die "Unknown specification: ${TEST_CODE}"
297 for tag in "${TAGS[@]}"; do
298 if [[ ${tag} == "!"* ]]; then
299 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
301 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
307 function copy_archives () {
309 # Create additional archive if workspace variable is set.
310 # This way if script is running in jenkins all will be
311 # automatically archived to logs.fd.io.
314 # - WORKSPACE - Jenkins workspace, copy only if the value is not empty.
315 # Can be unset, then it speeds up manual testing.
316 # - ARCHIVE_DIR - Path to directory with content to be copied.
317 # Directories updated:
318 # - ${WORKSPACE}/archives/ - Created if does not exist.
319 # Content of ${ARCHIVE_DIR}/ is copied here.
321 # - die - Print to stderr and exit.
325 if [[ -n "${WORKSPACE-}" ]]; then
326 mkdir -p "${WORKSPACE}/archives/" || die "Archives dir create failed."
327 cp -rf "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
332 function deactivate_docker_topology () {
334 # Deactivate virtual vpp-device topology by removing containers.
337 # - NODENESS - Node multiplicity of desired testbed.
338 # - FLAVOR - Node flavor string, usually describing the processor.
342 case_text="${NODENESS}_${FLAVOR}"
343 case "${case_text}" in
345 hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
346 ssh="ssh root@${hostname} -p 6022"
347 env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
348 ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
349 die "Topology cleanup via shim-dcr failed!"
354 clean_environment || {
355 die "Topology cleanup locally failed!"
360 die "Unknown specification: ${case_text}!"
367 # Print the message to standard error end exit with error code specified
368 # by the second argument.
371 # - The default error message.
373 # - ${1} - The whole error message, be sure to quote. Optional
374 # - ${2} - the code to exit with, default: 1.
378 warn "${1:-Unspecified run-time error occurred!}"
383 function die_on_pybot_error () {
385 # Source this fragment if you want to abort on any failed test case.
388 # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
390 # - die - Print to stderr and exit.
394 if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
395 die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
400 function generate_tests () {
402 # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
403 # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
404 # The generation is done by executing any *.py executable
405 # within any subdirectory after copying.
407 # This is a separate function, because this code is called
408 # both by autogen checker and entries calling run_pybot.
411 # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
412 # Directories replaced:
413 # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
417 rm -rf "${GENERATED_DIR}/tests" || die
418 cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
419 cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
420 cmd_line+=("-executable" "-name" "*.py")
421 file_list=$("${cmd_line[@]}") || die
423 for gen in ${file_list}; do
424 directory="$(dirname "${gen}")" || die
425 filename="$(basename "${gen}")" || die
426 pushd "${directory}" || die
427 ./"${filename}" || die
433 function get_test_code () {
436 # - ${1} - Optional, argument of entry script (or empty as unset).
437 # Test code value to override job name from environment.
439 # - JOB_NAME - String affecting test selection, default if not argument.
441 # - TEST_CODE - The test selection string from environment or argument.
442 # - NODENESS - Node multiplicity of desired testbed.
443 # - FLAVOR - Node flavor string, usually describing the processor.
447 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
448 if [[ -z "${TEST_CODE}" ]]; then
449 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
452 case "${TEST_CODE}" in
486 # Fallback to 3-node Haswell by default (backward compatibility)
494 function get_test_tag_string () {
497 # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
498 # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
499 # - TEST_CODE - The test selection string from environment or argument.
501 # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
502 # May be empty, not set on event types not adding comment.
504 # TODO: ci-management scripts no longer need to perform this.
509 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
510 case "${TEST_CODE}" in
512 # On parsing error, ${trigger} stays empty.
513 trigger="$(echo "${GERRIT_EVENT_COMMENT_TEXT}" \
514 | grep -oE '(devicetest$|devicetest[[:space:]].+$)')" \
516 # Set test tags as string.
517 TEST_TAG_STRING="${trigger#$"devicetest"}"
520 # On parsing error, ${trigger} stays empty.
521 comment="${GERRIT_EVENT_COMMENT_TEXT}"
522 # As "perftest" can be followed by something, we substitute it.
523 comment="${comment/perftest-2n/perftest}"
524 comment="${comment/perftest-3n/perftest}"
525 comment="${comment/perftest-hsw/perftest}"
526 comment="${comment/perftest-skx/perftest}"
527 comment="${comment/perftest-dnv/perftest}"
528 comment="${comment/perftest-tsh/perftest}"
529 tag_string="$(echo "${comment}" \
530 | grep -oE '(perftest$|perftest[[:space:]].+$)' || true)"
531 # Set test tags as string.
532 TEST_TAG_STRING="${tag_string#$"perftest"}"
535 die "Unknown specification: ${TEST_CODE}"
541 function installed () {
543 # Check if the given utility is installed. Fail if not installed.
545 # Duplicate of common.sh function, as this file is also used standalone.
548 # - ${1} - Utility to check.
550 # - 0 - If command is installed.
551 # - 1 - If command is not installed.
559 function reserve_and_cleanup_testbed () {
561 # Reserve physical testbed, perform cleanup, register trap to unreserve.
562 # When cleanup fails, remove from topologies and keep retrying
563 # until all topologies are removed.
566 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
567 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
568 # - BUILD_TAG - Any string suitable as filename, identifying
569 # test run executing this function. May be unset.
571 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
572 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
574 # - die - Print to stderr and exit.
576 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
581 for topo in "${TOPOLOGIES[@]}"; do
583 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
584 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
585 python "${scrpt}" "${opts[@]}"
588 if [[ "${result}" == "0" ]]; then
589 # Trap unreservation before cleanup check,
590 # so multiple jobs showing failed cleanup improve chances
591 # of humans to notice and fix.
592 WORKING_TOPOLOGY="${topo}"
593 echo "Reserved: ${WORKING_TOPOLOGY}"
594 trap "untrap_and_unreserve_testbed" EXIT || {
595 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
596 untrap_and_unreserve_testbed "${message}" || {
597 die "Teardown should have died, not failed."
599 die "Trap attempt failed, unreserve succeeded. Aborting."
606 if [[ "${result}" == "0" ]]; then
609 warn "Testbed cleanup failed: ${topo}"
610 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
612 # Else testbed is accessible but currently reserved, moving on.
615 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
616 # Exit the infinite while loop if we made a reservation.
617 warn "Reservation and cleanup successful."
621 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
622 die "Run out of operational testbeds!"
625 # Wait ~3minutes before next try.
626 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
627 die "Sleep time calculation failed."
629 echo "Sleeping ${sleep_time}"
630 sleep "${sleep_time}" || die "Sleep failed."
635 function run_pybot () {
637 # Run pybot with options based on input variables. Create output_info.xml
640 # - CSIT_DIR - Path to existing root of local CSIT git repository.
641 # - ARCHIVE_DIR - Path to store robot result files in.
642 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
643 # - GENERATED_DIR - Tests are assumed to be generated under there.
645 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
647 # - die - Print to stderr and exit.
651 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
652 all_options+=("--noncritical" "EXPECTED_FAILING")
653 all_options+=("${EXPANDED_TAGS[@]}")
655 pushd "${CSIT_DIR}" || die "Change directory operation failed."
657 pybot "${all_options[@]}" "${GENERATED_DIR}/tests/"
658 PYBOT_EXIT_STATUS="$?"
661 # Generate INFO level output_info.xml for post-processing.
662 all_options=("--loglevel" "INFO")
663 all_options+=("--log" "none")
664 all_options+=("--report" "none")
665 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
666 all_options+=("${ARCHIVE_DIR}/output.xml")
667 rebot "${all_options[@]}" || true
668 popd || die "Change directory operation failed."
672 function select_arch_os () {
674 # Set variables affected by local CPU architecture and operating system.
677 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
678 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
679 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
683 os_id=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') || {
684 die "Get OS release failed."
689 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
690 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_BIONIC"
694 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_CENTOS"
695 VPP_VER_FILE="VPP_STABLE_VER_CENTOS"
699 die "Unable to identify distro or os from ${os_id}"
703 arch=$(uname -m) || {
704 die "Get CPU architecture failed."
709 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
717 function select_tags () {
720 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
721 # - TEST_CODE - String affecting test selection, usually jenkins job name.
722 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
724 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
725 # - BASH_FUNCTION_DIR - Directory with input files to process.
727 # - TAGS - Array of processed tag boolean expressions.
732 start_pattern='^ TG:'
733 end_pattern='^ \? \?[A-Za-z0-9]\+:'
734 # Remove the TG section from topology file
735 sed_command="/${start_pattern}/,/${end_pattern}/d"
736 # All topologies DUT NICs
737 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
738 | grep -hoP "model: \K.*" | sort -u)
739 # Selected topology DUT NICs
740 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
741 | grep -hoP "model: \K.*" | sort -u)
742 # All topologies DUT NICs - Selected topology DUT NICs
743 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
744 die "Computation of excluded NICs failed."
747 # Select default NIC tag.
748 case "${TEST_CODE}" in
749 *"3n-dnv"* | *"2n-dnv"*)
750 default_nic="nic_intel-x553"
753 default_nic="nic_intel-x520-da2"
756 default_nic="nic_intel-x710"
760 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
761 # Tag file directory shorthand.
762 tfd="${BASH_FUNCTION_DIR}"
763 case "${TEST_CODE}" in
764 # Select specific performance tests based on jenkins job type variable.
766 readarray -t test_tag_array < "${tfd}/mlr-weekly.txt" || die
769 readarray -t test_tag_array <<< $(${sed_nic_sub_cmd} \
770 ${tfd}/mrr-daily-${FLAVOR}.txt) || die
773 readarray -t test_tag_array < "${tfd}/mrr-weekly.txt" || die
776 if [[ -z "${TEST_TAG_STRING-}" ]]; then
777 # If nothing is specified, we will run pre-selected tests by
779 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDip4base"
780 "mrrAND${default_nic}AND1cAND78bANDip6base"
781 "mrrAND${default_nic}AND1cAND64bANDl2bdbase"
782 "mrrAND${default_nic}AND1cAND64bANDl2xcbase"
785 # If trigger contains tags, split them into array.
786 test_tag_array=(${TEST_TAG_STRING//:/ })
791 # Blacklisting certain tags per topology.
793 # Reasons for blacklisting:
794 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
795 # TODO: Add missing reasons here (if general) or where used (if specific).
796 case "${TEST_CODE}" in
798 test_tag_array+=("!ipsechw")
801 test_tag_array+=("!ipsechw")
802 # Not enough nic_intel-xxv710 to support double link tests.
803 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
806 test_tag_array+=("!ipsechw")
807 test_tag_array+=("!memif")
808 test_tag_array+=("!srv6_proxy")
809 test_tag_array+=("!vhost")
810 test_tag_array+=("!vts")
811 test_tag_array+=("!drv_avf")
814 test_tag_array+=("!memif")
815 test_tag_array+=("!srv6_proxy")
816 test_tag_array+=("!vhost")
817 test_tag_array+=("!vts")
818 test_tag_array+=("!drv_avf")
821 # 3n-tsh only has x520 NICs which don't work with AVF
822 test_tag_array+=("!drv_avf")
823 test_tag_array+=("!ipsechw")
826 # TODO: Introduce NOIOMMU version of AVF tests.
827 # TODO: Make (both) AVF tests work on Haswell,
828 # or document why (some of) it is not possible.
829 # https://github.com/FDio/vpp/blob/master/src/plugins/avf/README.md
830 test_tag_array+=("!drv_avf")
831 # All cards have access to QAT. But only one card (xl710)
832 # resides in same NUMA as QAT. Other cards must go over QPI
833 # which we do not want to even run.
834 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
837 # Default to 3n-hsw due to compatibility.
838 test_tag_array+=("!drv_avf")
839 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
843 # We will add excluded NICs.
844 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
848 # We will prefix with perftest to prevent running other tests
852 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
853 # Automatic prefixing for VPP jobs to limit the NIC used and
854 # traffic evaluation to MRR.
855 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
856 prefix="${prefix}mrrAND"
858 prefix="${prefix}mrrAND${default_nic}AND"
861 for tag in "${test_tag_array[@]}"; do
862 if [[ "${tag}" == "!"* ]]; then
863 # Exclude tags are not prefixed.
865 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
866 # Empty and comment lines are skipped.
867 # Other lines are normal tags, they are to be prefixed.
868 TAGS+=("${prefix}${tag}")
875 function select_topology () {
878 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
879 # - FLAVOR - Node flavor string, currently either "hsw" or "skx".
880 # - CSIT_DIR - Path to existing root of local CSIT git repository.
881 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
883 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
884 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
886 # - die - Print to stderr and exit.
890 case_text="${NODENESS}_${FLAVOR}"
891 case "${case_text}" in
892 # TODO: Move tags to "# Blacklisting certain tags per topology" section.
893 # TODO: Double link availability depends on NIC used.
895 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
896 TOPOLOGIES_TAGS="2_node_single_link_topo"
899 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
900 TOPOLOGIES_TAGS="2_node_single_link_topo"
903 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
904 TOPOLOGIES_TAGS="2_node_*_link_topo"
907 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
908 TOPOLOGIES_TAGS="3_node_*_link_topo"
911 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
912 TOPOLOGIES_TAGS="2_node_single_link_topo"
915 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
916 TOPOLOGIES_TAGS="3_node_single_link_topo"
919 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
920 TOPOLOGIES_TAGS="3_node_single_link_topo"
923 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
924 TOPOLOGIES_TAGS="3_node_single_link_topo"
927 # No falling back to 3n_hsw default, that should have been done
928 # by the function which has set NODENESS and FLAVOR.
929 die "Unknown specification: ${case_text}"
932 if [[ -z "${TOPOLOGIES-}" ]]; then
933 die "No applicable topology found!"
938 function select_vpp_device_tags () {
941 # - TEST_CODE - String affecting test selection, usually jenkins job name.
942 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
945 # - TAGS - Array of processed tag boolean expressions.
949 case "${TEST_CODE}" in
950 # Select specific device tests based on jenkins job type variable.
952 if [[ -z "${TEST_TAG_STRING-}" ]]; then
953 # If nothing is specified, we will run pre-selected tests by
954 # following tags. Items of array will be concatenated by OR
955 # in Robot Framework.
958 # If trigger contains tags, split them into array.
959 test_tag_array=(${TEST_TAG_STRING//:/ })
964 # Blacklisting certain tags per topology.
966 # Reasons for blacklisting:
967 # - avf - AVF is not possible to run on enic driver of VirtualBox.
968 # - vhost - VirtualBox does not support nesting virtualization on Intel CPU.
969 case "${TEST_CODE}" in
971 test_tag_array+=("!avf")
972 test_tag_array+=("!vhost")
980 # We will prefix with devicetest to prevent running other tests
982 prefix="devicetestAND"
983 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
984 # Automatic prefixing for VPP jobs to limit testing.
987 for tag in "${test_tag_array[@]}"; do
988 if [[ ${tag} == "!"* ]]; then
989 # Exclude tags are not prefixed.
992 TAGS+=("${prefix}${tag}")
997 function untrap_and_unreserve_testbed () {
999 # Use this as a trap function to ensure testbed does not remain reserved.
1000 # Perhaps call directly before script exit, to free testbed for other jobs.
1001 # This function is smart enough to avoid multiple unreservations (so safe).
1002 # Topo cleanup is executed (call it best practice), ignoring failures.
1005 # - default message to die with if testbed might remain reserved.
1007 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1008 # Variables read (by inner function):
1009 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1010 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1011 # Variables written:
1012 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1013 # Trap unregistered:
1014 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1016 # - die - Print to stderr and exit.
1019 set +eu # We do not want to exit early in a "teardown" function.
1020 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1021 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1022 if [[ -z "${wt-}" ]]; then
1024 warn "Testbed looks unreserved already. Trap removal failed before?"
1026 cleanup_topo || true
1027 python "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1028 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1038 # Print the message to standard error.
1041 # - ${@} - The text of the message.