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!"
186 function common_dirs () {
188 # Set global variables, create some directories (without touching content).
191 # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
192 # - CSIT_DIR - Path to existing root of local CSIT git repository.
193 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
194 # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
195 # - TOOLS_DIR - Path to existing resources subdirectory "tools".
196 # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
197 # - ARCHIVE_DIR - Path to created CSIT subdirectory "archive".
198 # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
199 # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
200 # Directories created if not present:
201 # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
203 # - die - Print to stderr and exit.
207 this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
208 die "Some error during locating of this source file."
210 BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
211 die "Some error during dirname call."
213 # Current working directory could be in a different repo, e.g. VPP.
214 pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
215 relative_csit_dir=$(git rev-parse --show-toplevel) || {
216 die "Git rev-parse failed."
218 CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
219 popd || die "Popd failed."
220 TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
221 die "Readlink failed."
223 RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
224 die "Readlink failed."
226 TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
227 die "Readlink failed."
229 DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
230 die "Readlink failed."
232 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
233 die "Readlink failed."
236 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archive") || {
237 die "Readlink failed."
239 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
240 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
241 die "Readlink failed."
243 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
244 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
245 die "Readlink failed."
247 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
251 function compose_pybot_arguments () {
254 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
255 # - DUT - CSIT test/ subdirectory, set while processing tags.
256 # - TAGS - Array variable holding selected tag boolean expressions.
257 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
258 # - TEST_CODE - The test selection string from environment or argument.
260 # - PYBOT_ARGS - String holding part of all arguments for pybot.
261 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
265 # No explicit check needed with "set -u".
266 PYBOT_ARGS=("--loglevel" "TRACE")
267 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
269 case "${TEST_CODE}" in
271 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
274 PYBOT_ARGS+=("--suite" "tests.${DUT}.func")
277 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
280 die "Unknown specification: ${TEST_CODE}"
284 for tag in "${TAGS[@]}"; do
285 if [[ ${tag} == "!"* ]]; then
286 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
288 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
294 function copy_archives () {
296 # Create additional archive if workspace variable is set.
297 # This way if script is running in jenkins all will be
298 # automatically archived to logs.fd.io.
301 # - WORKSPACE - Jenkins workspace, copy only if the value is not empty.
302 # Can be unset, then it speeds up manual testing.
303 # - ARCHIVE_DIR - Path to directory with content to be copied.
304 # Directories updated:
305 # - ${WORKSPACE}/archives/ - Created if does not exist.
306 # Content of ${ARCHIVE_DIR}/ is copied here.
308 # - die - Print to stderr and exit.
312 if [[ -n "${WORKSPACE-}" ]]; then
313 mkdir -p "${WORKSPACE}/archives/" || die "Archives dir create failed."
314 cp -rf "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
319 function deactivate_docker_topology () {
321 # Deactivate virtual vpp-device topology by removing containers.
324 # - NODENESS - Node multiplicity of desired testbed.
325 # - FLAVOR - Node flavor string, usually describing the processor.
329 case_text="${NODENESS}_${FLAVOR}"
330 case "${case_text}" in
332 hostname=$(grep search /etc/resolv.conf | cut -d' ' -f3) || die
333 ssh="ssh root@${hostname} -p 6022"
334 env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
335 ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
336 die "Topology cleanup via shim-dcr failed!"
341 clean_environment || {
342 die "Topology cleanup locally failed!"
347 die "Unknown specification: ${case_text}!"
354 # Print the message to standard error end exit with error code specified
355 # by the second argument.
358 # - The default error message.
360 # - ${1} - The whole error message, be sure to quote. Optional
361 # - ${2} - the code to exit with, default: 1.
365 warn "${1:-Unspecified run-time error occurred!}"
370 function die_on_pybot_error () {
372 # Source this fragment if you want to abort on any failed test case.
375 # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
377 # - die - Print to stderr and exit.
381 if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
382 die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
387 function generate_tests () {
389 # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
390 # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
391 # The generation is done by executing any *.py executable
392 # within any subdirectory after copying.
394 # This is a separate function, because this code is called
395 # both by autogen checker and entries calling run_pybot.
398 # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
399 # Directories replaced:
400 # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
404 rm -rf "${GENERATED_DIR}/tests" || die
405 cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
406 cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
407 cmd_line+=("-executable" "-name" "*.py")
408 file_list=$("${cmd_line[@]}") || die
410 for gen in ${file_list}; do
411 directory="$(dirname "${gen}")" || die
412 filename="$(basename "${gen}")" || die
413 pushd "${directory}" || die
414 ./"${filename}" || die
420 function get_test_code () {
423 # - ${1} - Optional, argument of entry script (or empty as unset).
424 # Test code value to override job name from environment.
426 # - JOB_NAME - String affecting test selection, default if not argument.
428 # - TEST_CODE - The test selection string from environment or argument.
429 # - NODENESS - Node multiplicity of desired testbed.
430 # - FLAVOR - Node flavor string, usually describing the processor.
434 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
435 if [[ -z "${TEST_CODE}" ]]; then
436 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
439 case "${TEST_CODE}" in
477 # Fallback to 3-node Haswell by default (backward compatibility)
485 function get_test_tag_string () {
488 # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
489 # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
490 # - TEST_CODE - The test selection string from environment or argument.
492 # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
493 # May be empty, not set on event types not adding comment.
495 # TODO: ci-management scripts no longer need to perform this.
500 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
501 case "${TEST_CODE}" in
503 # On parsing error, ${trigger} stays empty.
504 trigger="$(echo "${GERRIT_EVENT_COMMENT_TEXT}" \
505 | grep -oE '(devicetest$|devicetest[[:space:]].+$)' \
507 # Set test tags as string.
508 TEST_TAG_STRING="${trigger#$"devicetest"}"
511 # On parsing error, ${trigger} stays empty.
512 comment="${GERRIT_EVENT_COMMENT_TEXT}"
513 # As "perftest" can be followed by something, we substitute it.
514 comment="${comment/perftest-2n/perftest}"
515 comment="${comment/perftest-3n/perftest}"
516 comment="${comment/perftest-hsw/perftest}"
517 comment="${comment/perftest-skx/perftest}"
518 comment="${comment/perftest-dnv/perftest}"
519 comment="${comment/perftest-tsh/perftest}"
520 tag_string="$(echo "${comment}" \
521 | grep -oE '(perftest$|perftest[[:space:]].+$)' || true)"
522 # Set test tags as string.
523 TEST_TAG_STRING="${tag_string#$"perftest"}"
526 die "Unknown specification: ${TEST_CODE}"
532 function installed () {
534 # Check if the given utility is installed. Fail if not installed.
536 # Duplicate of common.sh function, as this file is also used standalone.
539 # - ${1} - Utility to check.
541 # - 0 - If command is installed.
542 # - 1 - If command is not installed.
550 function reserve_and_cleanup_testbed () {
552 # Reserve physical testbed, perform cleanup, register trap to unreserve.
553 # When cleanup fails, remove from topologies and keep retrying
554 # until all topologies are removed.
557 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
558 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
559 # - BUILD_TAG - Any string suitable as filename, identifying
560 # test run executing this function. May be unset.
562 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
563 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
565 # - die - Print to stderr and exit.
566 # - ansible_hosts - Perform an action using ansible, see ansible.sh
568 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
573 for topo in "${TOPOLOGIES[@]}"; do
575 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
576 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
577 python "${scrpt}" "${opts[@]}"
580 if [[ "${result}" == "0" ]]; then
581 # Trap unreservation before cleanup check,
582 # so multiple jobs showing failed cleanup improve chances
583 # of humans to notice and fix.
584 WORKING_TOPOLOGY="${topo}"
585 echo "Reserved: ${WORKING_TOPOLOGY}"
586 trap "untrap_and_unreserve_testbed" EXIT || {
587 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
588 untrap_and_unreserve_testbed "${message}" || {
589 die "Teardown should have died, not failed."
591 die "Trap attempt failed, unreserve succeeded. Aborting."
595 ansible_hosts "cleanup"
598 if [[ "${result}" == "0" ]]; then
601 warn "Testbed cleanup failed: ${topo}"
602 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
604 # Else testbed is accessible but currently reserved, moving on.
607 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
608 # Exit the infinite while loop if we made a reservation.
609 warn "Reservation and cleanup successful."
613 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
614 die "Run out of operational testbeds!"
617 # Wait ~3minutes before next try.
618 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
619 die "Sleep time calculation failed."
621 echo "Sleeping ${sleep_time}"
622 sleep "${sleep_time}" || die "Sleep failed."
627 function run_pybot () {
629 # Run pybot with options based on input variables. Create output_info.xml
632 # - CSIT_DIR - Path to existing root of local CSIT git repository.
633 # - ARCHIVE_DIR - Path to store robot result files in.
634 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
635 # - GENERATED_DIR - Tests are assumed to be generated under there.
637 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
639 # - die - Print to stderr and exit.
643 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
644 all_options+=("--noncritical" "EXPECTED_FAILING")
645 all_options+=("${EXPANDED_TAGS[@]}")
647 pushd "${CSIT_DIR}" || die "Change directory operation failed."
649 pybot "${all_options[@]}" "${GENERATED_DIR}/tests/"
650 PYBOT_EXIT_STATUS="$?"
653 # Generate INFO level output_info.xml for post-processing.
654 all_options=("--loglevel" "INFO")
655 all_options+=("--log" "none")
656 all_options+=("--report" "none")
657 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
658 all_options+=("${ARCHIVE_DIR}/output.xml")
659 rebot "${all_options[@]}" || true
660 popd || die "Change directory operation failed."
664 function select_arch_os () {
666 # Set variables affected by local CPU architecture and operating system.
669 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
670 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
671 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
675 os_id=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') || {
676 die "Get OS release failed."
681 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
682 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_BIONIC"
686 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_CENTOS"
687 VPP_VER_FILE="VPP_STABLE_VER_CENTOS"
691 die "Unable to identify distro or os from ${os_id}"
695 arch=$(uname -m) || {
696 die "Get CPU architecture failed."
701 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
709 function select_tags () {
712 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
713 # - TEST_CODE - String affecting test selection, usually jenkins job name.
714 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
716 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
717 # - BASH_FUNCTION_DIR - Directory with input files to process.
719 # - TAGS - Array of processed tag boolean expressions.
724 start_pattern='^ TG:'
725 end_pattern='^ \? \?[A-Za-z0-9]\+:'
726 # Remove the TG section from topology file
727 sed_command="/${start_pattern}/,/${end_pattern}/d"
728 # All topologies DUT NICs
729 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
730 | grep -hoP "model: \K.*" | sort -u)
731 # Selected topology DUT NICs
732 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
733 | grep -hoP "model: \K.*" | sort -u)
734 # All topologies DUT NICs - Selected topology DUT NICs
735 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
736 die "Computation of excluded NICs failed."
739 # Select default NIC tag.
740 case "${TEST_CODE}" in
741 *"3n-dnv"* | *"2n-dnv"*)
742 default_nic="nic_intel-x553"
745 default_nic="nic_intel-x520-da2"
747 *"3n-skx"* | *"2n-skx"* | *"2n-clx"*)
748 default_nic="nic_intel-xxv710"
750 *"3n-hsw"* | *"mrr-daily-master")
751 default_nic="nic_intel-xl710"
754 default_nic="nic_intel-x710"
758 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
759 # Tag file directory shorthand.
760 tfd="${BASH_FUNCTION_DIR}"
761 case "${TEST_CODE}" in
762 # Select specific performance tests based on jenkins job type variable.
764 readarray -t test_tag_array < "${tfd}/mlr-weekly.txt" || die
767 readarray -t test_tag_array <<< $(${sed_nic_sub_cmd} \
768 ${tfd}/mrr-daily-${FLAVOR}.txt) || die
771 readarray -t test_tag_array <<< $(${sed_nic_sub_cmd} \
772 ${tfd}/mrr-weekly.txt) || die
775 if [[ -z "${TEST_TAG_STRING-}" ]]; then
776 # If nothing is specified, we will run pre-selected tests by
778 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDip4base"
779 "mrrAND${default_nic}AND1cAND78bANDip6base"
780 "mrrAND${default_nic}AND1cAND64bANDl2bdbase"
781 "mrrAND${default_nic}AND1cAND64bANDl2xcbase"
784 # If trigger contains tags, split them into array.
785 test_tag_array=(${TEST_TAG_STRING//:/ })
790 # Blacklisting certain tags per topology.
792 # Reasons for blacklisting:
793 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
794 # TODO: Add missing reasons here (if general) or where used (if specific).
795 case "${TEST_CODE}" in
797 test_tag_array+=("!ipsechw")
800 test_tag_array+=("!ipsechw")
801 # Not enough nic_intel-xxv710 to support double link tests.
802 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
805 test_tag_array+=("!ipsechw")
808 test_tag_array+=("!ipsechw")
809 test_tag_array+=("!memif")
810 test_tag_array+=("!srv6_proxy")
811 test_tag_array+=("!vhost")
812 test_tag_array+=("!vts")
813 test_tag_array+=("!drv_avf")
816 test_tag_array+=("!memif")
817 test_tag_array+=("!srv6_proxy")
818 test_tag_array+=("!vhost")
819 test_tag_array+=("!vts")
820 test_tag_array+=("!drv_avf")
823 # 3n-tsh only has x520 NICs which don't work with AVF
824 test_tag_array+=("!drv_avf")
825 test_tag_array+=("!ipsechw")
828 # TODO: Introduce NOIOMMU version of AVF tests.
829 # TODO: Make (both) AVF tests work on Haswell,
830 # or document why (some of) it is not possible.
831 # https://github.com/FDio/vpp/blob/master/src/plugins/avf/README.md
832 test_tag_array+=("!drv_avf")
833 # All cards have access to QAT. But only one card (xl710)
834 # resides in same NUMA as QAT. Other cards must go over QPI
835 # which we do not want to even run.
836 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
839 # Default to 3n-hsw due to compatibility.
840 test_tag_array+=("!drv_avf")
841 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
845 # We will add excluded NICs.
846 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
850 # We will prefix with perftest to prevent running other tests
854 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
855 # Automatic prefixing for VPP jobs to limit the NIC used and
856 # traffic evaluation to MRR.
857 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
858 prefix="${prefix}mrrAND"
860 prefix="${prefix}mrrAND${default_nic}AND"
863 for tag in "${test_tag_array[@]}"; do
864 if [[ "${tag}" == "!"* ]]; then
865 # Exclude tags are not prefixed.
867 elif [[ "${tag}" == " "* || "${tag}" == *"perftest"* ]]; then
868 # Badly formed tag expressions can trigger way too much tests.
870 warn "The following tag expression hints at bad trigger: ${tag}"
871 warn "Possible cause: Multiple triggers in a single comment."
872 die "Aborting to avoid triggering too many tests."
873 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
874 # Empty and comment lines are skipped.
875 # Other lines are normal tags, they are to be prefixed.
876 TAGS+=("${prefix}${tag}")
883 function select_topology () {
886 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
887 # - FLAVOR - Node flavor string, currently either "hsw" or "skx".
888 # - CSIT_DIR - Path to existing root of local CSIT git repository.
889 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
891 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
892 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
894 # - die - Print to stderr and exit.
898 case_text="${NODENESS}_${FLAVOR}"
899 case "${case_text}" in
900 # TODO: Move tags to "# Blacklisting certain tags per topology" section.
901 # TODO: Double link availability depends on NIC used.
903 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
904 TOPOLOGIES_TAGS="2_node_single_link_topo"
907 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
908 TOPOLOGIES_TAGS="2_node_single_link_topo"
911 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
912 TOPOLOGIES_TAGS="2_node_*_link_topo"
915 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
916 TOPOLOGIES_TAGS="3_node_*_link_topo"
919 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_clx*.yaml )
920 TOPOLOGIES_TAGS="2_node_*_link_topo"
923 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
924 TOPOLOGIES_TAGS="2_node_single_link_topo"
927 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
928 TOPOLOGIES_TAGS="3_node_single_link_topo"
931 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
932 TOPOLOGIES_TAGS="3_node_single_link_topo"
935 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
936 TOPOLOGIES_TAGS="3_node_single_link_topo"
939 # No falling back to 3n_hsw default, that should have been done
940 # by the function which has set NODENESS and FLAVOR.
941 die "Unknown specification: ${case_text}"
944 if [[ -z "${TOPOLOGIES-}" ]]; then
945 die "No applicable topology found!"
950 function select_vpp_device_tags () {
953 # - TEST_CODE - String affecting test selection, usually jenkins job name.
954 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
957 # - TAGS - Array of processed tag boolean expressions.
961 case "${TEST_CODE}" in
962 # Select specific device tests based on jenkins job type variable.
964 if [[ -z "${TEST_TAG_STRING-}" ]]; then
965 # If nothing is specified, we will run pre-selected tests by
966 # following tags. Items of array will be concatenated by OR
967 # in Robot Framework.
970 # If trigger contains tags, split them into array.
971 test_tag_array=(${TEST_TAG_STRING//:/ })
976 # Blacklisting certain tags per topology.
978 # Reasons for blacklisting:
979 # - avf - AVF is not possible to run on enic driver of VirtualBox.
980 # - vhost - VirtualBox does not support nesting virtualization on Intel CPU.
981 case "${TEST_CODE}" in
983 test_tag_array+=("!avf")
984 test_tag_array+=("!vhost")
992 # We will prefix with devicetest to prevent running other tests
994 prefix="devicetestAND"
995 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
996 # Automatic prefixing for VPP jobs to limit testing.
999 for tag in "${test_tag_array[@]}"; do
1000 if [[ ${tag} == "!"* ]]; then
1001 # Exclude tags are not prefixed.
1004 TAGS+=("${prefix}${tag}")
1009 function untrap_and_unreserve_testbed () {
1011 # Use this as a trap function to ensure testbed does not remain reserved.
1012 # Perhaps call directly before script exit, to free testbed for other jobs.
1013 # This function is smart enough to avoid multiple unreservations (so safe).
1014 # Topo cleanup is executed (call it best practice), ignoring failures.
1017 # - default message to die with if testbed might remain reserved.
1019 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1020 # Variables read (by inner function):
1021 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1022 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1023 # Variables written:
1024 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1025 # Trap unregistered:
1026 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1028 # - die - Print to stderr and exit.
1029 # - ansible_hosts - Perform an action using ansible, see ansible.sh
1032 set +eu # We do not want to exit early in a "teardown" function.
1033 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1034 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1035 if [[ -z "${wt-}" ]]; then
1037 warn "Testbed looks unreserved already. Trap removal failed before?"
1039 ansible_hosts "cleanup" || true
1040 python "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1041 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1051 # Print the message to standard error.
1054 # - ${@} - The text of the message.