1 # Copyright (c) 2020 Cisco and/or its affiliates.
2 # Copyright (c) 2020 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" || {
45 device_image="$(< ${CSIT_DIR}/${IMAGE_VER_FILE})"
46 case_text="${NODENESS}_${FLAVOR}"
47 case "${case_text}" in
49 # We execute reservation over csit-shim-dcr (ssh) which runs sourced
50 # script's functions. Env variables are read from ssh output
51 # back to localhost for further processing.
52 # Shim and Jenkins executor are in the same network on the same host
53 # Connect to docker's default gateway IP and shim's exposed port
54 ssh="ssh root@172.17.0.1 -p 6022"
55 run="activate_wrapper ${NODENESS} ${FLAVOR} ${device_image}"
56 # The "declare -f" output is long and boring.
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 virtualenv==20.0.20 || {
120 die "Virtualenv package install failed."
122 virtualenv --no-download --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 -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 -3 > "${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 topologies.
197 # - JOB_SPECS_DIR - Path to existing directory with job test specifications.
198 # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
199 # - TOOLS_DIR - Path to existing resources subdirectory "tools".
200 # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
201 # - ARCHIVE_DIR - Path to created CSIT subdirectory "archive".
202 # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
203 # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
204 # Directories created if not present:
205 # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
207 # - die - Print to stderr and exit.
211 this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
212 die "Some error during locating of this source file."
214 BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
215 die "Some error during dirname call."
217 # Current working directory could be in a different repo, e.g. VPP.
218 pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
219 relative_csit_dir=$(git rev-parse --show-toplevel) || {
220 die "Git rev-parse failed."
222 CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
223 popd || die "Popd failed."
224 TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
225 die "Readlink failed."
227 JOB_SPECS_DIR=$(readlink -e "${CSIT_DIR}/docs/job_specs") || {
228 die "Readlink failed."
230 RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
231 die "Readlink failed."
233 TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
234 die "Readlink failed."
236 DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
237 die "Readlink failed."
239 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
240 die "Readlink failed."
243 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archive") || {
244 die "Readlink failed."
246 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
247 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
248 die "Readlink failed."
250 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
251 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
252 die "Readlink failed."
254 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
258 function compose_pybot_arguments () {
261 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
262 # - DUT - CSIT test/ subdirectory, set while processing tags.
263 # - TAGS - Array variable holding selected tag boolean expressions.
264 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
265 # - TEST_CODE - The test selection string from environment or argument.
267 # - PYBOT_ARGS - String holding part of all arguments for pybot.
268 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
272 # No explicit check needed with "set -u".
273 PYBOT_ARGS=("--loglevel" "TRACE")
274 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
276 case "${TEST_CODE}" in
278 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
281 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
284 die "Unknown specification: ${TEST_CODE}"
288 for tag in "${TAGS[@]}"; do
289 if [[ ${tag} == "!"* ]]; then
290 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
292 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
298 function copy_archives () {
300 # Create additional archive if workspace variable is set.
301 # This way if script is running in jenkins all will be
302 # automatically archived to logs.fd.io.
305 # - WORKSPACE - Jenkins workspace, copy only if the value is not empty.
306 # Can be unset, then it speeds up manual testing.
307 # - ARCHIVE_DIR - Path to directory with content to be copied.
308 # Directories updated:
309 # - ${WORKSPACE}/archives/ - Created if does not exist.
310 # Content of ${ARCHIVE_DIR}/ is copied here.
312 # - die - Print to stderr and exit.
316 if [[ -n "${WORKSPACE-}" ]]; then
317 mkdir -p "${WORKSPACE}/archives/" || die "Archives dir create failed."
318 cp -rf "${ARCHIVE_DIR}"/* "${WORKSPACE}/archives" || die "Copy failed."
323 function deactivate_docker_topology () {
325 # Deactivate virtual vpp-device topology by removing containers.
328 # - NODENESS - Node multiplicity of desired testbed.
329 # - FLAVOR - Node flavor string, usually describing the processor.
333 case_text="${NODENESS}_${FLAVOR}"
334 case "${case_text}" in
336 ssh="ssh root@172.17.0.1 -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 # We sort the directories, so log output can be compared between runs.
415 file_list=$("${cmd_line[@]}" | sort) || die
417 for gen in ${file_list}; do
418 directory="$(dirname "${gen}")" || die
419 filename="$(basename "${gen}")" || die
420 pushd "${directory}" || die
421 ./"${filename}" || die
427 function get_test_code () {
430 # - ${1} - Optional, argument of entry script (or empty as unset).
431 # Test code value to override job name from environment.
433 # - JOB_NAME - String affecting test selection, default if not argument.
435 # - TEST_CODE - The test selection string from environment or argument.
436 # - NODENESS - Node multiplicity of desired testbed.
437 # - FLAVOR - Node flavor string, usually describing the processor.
441 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
442 if [[ -z "${TEST_CODE}" ]]; then
443 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
446 case "${TEST_CODE}" in
488 # Fallback to 3-node Haswell by default (backward compatibility)
496 function get_test_tag_string () {
499 # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
500 # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
501 # - TEST_CODE - The test selection string from environment or argument.
503 # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
504 # May be empty, or even not set on event types not adding comment.
506 # TODO: ci-management scripts no longer need to perform this.
510 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
511 case "${TEST_CODE}" in
519 die "Unknown specification: ${TEST_CODE}"
521 # Ignore lines not containing the trigger word.
522 comment=$(fgrep "${trigger}" <<< "${GERRIT_EVENT_COMMENT_TEXT}" || true)
523 # The vpp-csit triggers trail stuff we are not interested in.
524 # Removing them and trigger word: https://unix.stackexchange.com/a/13472
525 # (except relying on \s whitespace, \S non-whitespace and . both).
526 # The last string is concatenated, only the middle part is expanded.
527 cmd=("grep" "-oP" '\S*'"${trigger}"'\S*\s\K.+$') || die "Unset trigger?"
528 # On parsing error, TEST_TAG_STRING probably stays empty.
529 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
530 if [[ -z "${TEST_TAG_STRING-}" ]]; then
531 # Probably we got a base64 encoded comment.
532 comment=$(base64 --decode <<< "${GERRIT_EVENT_COMMENT_TEXT}" || true)
533 comment=$(fgrep "${trigger}" <<< "${comment}" || true)
534 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
536 if [[ -n "${TEST_TAG_STRING-}" ]]; then
537 test_tag_array=(${TEST_TAG_STRING})
538 if [[ "${test_tag_array[0]}" == "icl" ]]; then
539 export GRAPH_NODE_VARIANT="icl"
540 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
541 elif [[ "${test_tag_array[0]}" == "skx" ]]; then
542 export GRAPH_NODE_VARIANT="skx"
543 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
544 elif [[ "${test_tag_array[0]}" == "hsw" ]]; then
545 export GRAPH_NODE_VARIANT="hsw"
546 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
553 function installed () {
555 # Check if the given utility is installed. Fail if not installed.
557 # Duplicate of common.sh function, as this file is also used standalone.
560 # - ${1} - Utility to check.
562 # - 0 - If command is installed.
563 # - 1 - If command is not installed.
571 function reserve_and_cleanup_testbed () {
573 # Reserve physical testbed, perform cleanup, register trap to unreserve.
574 # When cleanup fails, remove from topologies and keep retrying
575 # until all topologies are removed.
578 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
579 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
580 # - BUILD_TAG - Any string suitable as filename, identifying
581 # test run executing this function. May be unset.
583 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
584 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
586 # - die - Print to stderr and exit.
587 # - ansible_playbook - Perform an action using ansible, see ansible.sh
589 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
594 for topo in "${TOPOLOGIES[@]}"; do
596 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
597 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
598 python3 "${scrpt}" "${opts[@]}"
601 if [[ "${result}" == "0" ]]; then
602 # Trap unreservation before cleanup check,
603 # so multiple jobs showing failed cleanup improve chances
604 # of humans to notice and fix.
605 WORKING_TOPOLOGY="${topo}"
606 echo "Reserved: ${WORKING_TOPOLOGY}"
607 trap "untrap_and_unreserve_testbed" EXIT || {
608 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
609 untrap_and_unreserve_testbed "${message}" || {
610 die "Teardown should have died, not failed."
612 die "Trap attempt failed, unreserve succeeded. Aborting."
614 # Cleanup + calibration checks.
616 ansible_playbook "cleanup, calibration"
619 if [[ "${result}" == "0" ]]; then
622 warn "Testbed cleanup failed: ${topo}"
623 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
625 # Else testbed is accessible but currently reserved, moving on.
628 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
629 # Exit the infinite while loop if we made a reservation.
630 warn "Reservation and cleanup successful."
634 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
635 die "Run out of operational testbeds!"
638 # Wait ~3minutes before next try.
639 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
640 die "Sleep time calculation failed."
642 echo "Sleeping ${sleep_time}"
643 sleep "${sleep_time}" || die "Sleep failed."
648 function run_pybot () {
650 # Run pybot with options based on input variables. Create output_info.xml
653 # - CSIT_DIR - Path to existing root of local CSIT git repository.
654 # - ARCHIVE_DIR - Path to store robot result files in.
655 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
656 # - GENERATED_DIR - Tests are assumed to be generated under there.
658 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
660 # - die - Print to stderr and exit.
664 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
665 all_options+=("--noncritical" "EXPECTED_FAILING")
666 all_options+=("${EXPANDED_TAGS[@]}")
668 pushd "${CSIT_DIR}" || die "Change directory operation failed."
670 robot "${all_options[@]}" "${GENERATED_DIR}/tests/"
671 PYBOT_EXIT_STATUS="$?"
674 # Generate INFO level output_info.xml for post-processing.
675 all_options=("--loglevel" "INFO")
676 all_options+=("--log" "none")
677 all_options+=("--report" "none")
678 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
679 all_options+=("${ARCHIVE_DIR}/output.xml")
680 rebot "${all_options[@]}" || true
681 popd || die "Change directory operation failed."
685 function select_arch_os () {
687 # Set variables affected by local CPU architecture and operating system.
690 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
691 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
692 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
696 os_id=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') || {
697 die "Get OS release failed."
702 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
703 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_BIONIC"
707 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_CENTOS"
708 VPP_VER_FILE="VPP_STABLE_VER_CENTOS"
712 die "Unable to identify distro or os from ${os_id}"
716 arch=$(uname -m) || {
717 die "Get CPU architecture failed."
722 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
730 function select_tags () {
733 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
734 # - TEST_CODE - String affecting test selection, usually jenkins job name.
735 # - DUT - CSIT test/ subdirectory, set while processing tags.
736 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
738 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
739 # - BASH_FUNCTION_DIR - Directory with input files to process.
741 # - TAGS - Array of processed tag boolean expressions.
746 start_pattern='^ TG:'
747 end_pattern='^ \? \?[A-Za-z0-9]\+:'
748 # Remove the TG section from topology file
749 sed_command="/${start_pattern}/,/${end_pattern}/d"
750 # All topologies DUT NICs
751 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
752 | grep -hoP "model: \K.*" | sort -u)
753 # Selected topology DUT NICs
754 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
755 | grep -hoP "model: \K.*" | sort -u)
756 # All topologies DUT NICs - Selected topology DUT NICs
757 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
758 die "Computation of excluded NICs failed."
761 # Select default NIC tag.
762 case "${TEST_CODE}" in
763 *"3n-dnv"* | *"2n-dnv"*)
764 default_nic="nic_intel-x553"
767 default_nic="nic_intel-x520-da2"
769 *"3n-skx"* | *"2n-skx"* | *"2n-clx"* | *"2n-zn2"*)
770 default_nic="nic_intel-xxv710"
772 *"3n-hsw"* | *"mrr-daily-master")
773 default_nic="nic_intel-xl710"
776 default_nic="nic_intel-x710"
780 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
781 sed_nics_sub_cmd="sed -e s/ANDxxv710/ANDnic_intel-xxv710/"
782 sed_nics_sub_cmd+=" | sed -e s/ANDx710/ANDnic_intel-x710/"
783 sed_nics_sub_cmd+=" | sed -e s/ANDxl710/ANDnic_intel-xl710/"
784 sed_nics_sub_cmd+=" | sed -e s/ANDx520-da2/ANDnic_intel-x520-da2/"
785 sed_nics_sub_cmd+=" | sed -e s/ANDx553/ANDnic_intel-x553/"
786 sed_nics_sub_cmd+=" | sed -e s/ANDcx556a/ANDnic_mellanox-cx556a/"
787 sed_nics_sub_cmd+=" | sed -e s/ANDvic1227/ANDnic_cisco-vic-1227/"
788 sed_nics_sub_cmd+=" | sed -e s/ANDvic1385/ANDnic_cisco-vic-1385/"
789 # Tag file directory shorthand.
790 tfd="${JOB_SPECS_DIR}"
791 case "${TEST_CODE}" in
792 # Select specific performance tests based on jenkins job type variable.
794 readarray -t test_tag_array <<< $(sed 's/ //g' \
795 ${tfd}/mlr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
796 eval ${sed_nics_sub_cmd} || echo "perftest") || die
799 readarray -t test_tag_array <<< $(sed 's/ //g' \
800 ${tfd}/mrr_daily/${DUT}-${NODENESS}-${FLAVOR}.md |
801 eval ${sed_nics_sub_cmd} || echo "perftest") || die
804 readarray -t test_tag_array <<< $(sed 's/ //g' \
805 ${tfd}/mrr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
806 eval ${sed_nics_sub_cmd} || echo "perftest") || die
808 *"report-iterative"* )
809 test_sets=(${TEST_TAG_STRING//:/ })
810 # Run only one test set per run
811 report_file=${test_sets[0]}.md
812 readarray -t test_tag_array <<< $(sed 's/ //g' \
813 ${tfd}/report_iterative/${NODENESS}-${FLAVOR}/${report_file} |
814 eval ${sed_nics_sub_cmd} || echo "perftest") || die
816 *"report-coverage"* )
817 test_sets=(${TEST_TAG_STRING//:/ })
818 # Run only one test set per run
819 report_file=${test_sets[0]}.md
820 readarray -t test_tag_array <<< $(sed 's/ //g' \
821 ${tfd}/report_coverage/${NODENESS}-${FLAVOR}/${report_file} |
822 eval ${sed_nics_sub_cmd} || echo "perftest") || die
825 if [[ -z "${TEST_TAG_STRING-}" ]]; then
826 # If nothing is specified, we will run pre-selected tests by
828 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDip4base"
829 "mrrAND${default_nic}AND1cAND78bANDip6base"
830 "mrrAND${default_nic}AND1cAND64bANDl2bdbase"
831 "mrrAND${default_nic}AND1cAND64bANDl2xcbase"
834 # If trigger contains tags, split them into array.
835 test_tag_array=(${TEST_TAG_STRING//:/ })
840 # Blacklisting certain tags per topology.
842 # Reasons for blacklisting:
843 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
844 # TODO: Add missing reasons here (if general) or where used (if specific).
845 case "${TEST_CODE}" in
847 test_tag_array+=("!ipsec")
850 test_tag_array+=("!ipsechw")
851 # Not enough nic_intel-xxv710 to support double link tests.
852 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
855 test_tag_array+=("!ipsec")
858 test_tag_array+=("!ipsec")
861 test_tag_array+=("!ipsechw")
862 test_tag_array+=("!memif")
863 test_tag_array+=("!srv6_proxy")
864 test_tag_array+=("!vhost")
865 test_tag_array+=("!vts")
866 test_tag_array+=("!drv_avf")
869 test_tag_array+=("!memif")
870 test_tag_array+=("!srv6_proxy")
871 test_tag_array+=("!vhost")
872 test_tag_array+=("!vts")
873 test_tag_array+=("!drv_avf")
876 # 3n-tsh only has x520 NICs which don't work with AVF
877 test_tag_array+=("!drv_avf")
878 test_tag_array+=("!ipsechw")
881 test_tag_array+=("!drv_avf")
882 # All cards have access to QAT. But only one card (xl710)
883 # resides in same NUMA as QAT. Other cards must go over QPI
884 # which we do not want to even run.
885 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
888 # Default to 3n-hsw due to compatibility.
889 test_tag_array+=("!drv_avf")
890 test_tag_array+=("!ipsechwNOTnic_intel-xl710")
894 # We will add excluded NICs.
895 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
899 # We will prefix with perftest to prevent running other tests
903 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
904 # Automatic prefixing for VPP jobs to limit the NIC used and
905 # traffic evaluation to MRR.
906 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
907 prefix="${prefix}mrrAND"
909 prefix="${prefix}mrrAND${default_nic}AND"
912 for tag in "${test_tag_array[@]}"; do
913 if [[ "${tag}" == "!"* ]]; then
914 # Exclude tags are not prefixed.
916 elif [[ "${tag}" == " "* || "${tag}" == *"perftest"* ]]; then
917 # Badly formed tag expressions can trigger way too much tests.
919 warn "The following tag expression hints at bad trigger: ${tag}"
920 warn "Possible cause: Multiple triggers in a single comment."
921 die "Aborting to avoid triggering too many tests."
922 elif [[ "${tag}" == *"OR"* ]]; then
923 # If OR had higher precedence than AND, it would be useful here.
924 # Some people think it does, thus triggering way too much tests.
926 warn "The following tag expression hints at bad trigger: ${tag}"
927 warn "Operator OR has lower precedence than AND. Use space instead."
928 die "Aborting to avoid triggering too many tests."
929 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
930 # Empty and comment lines are skipped.
931 # Other lines are normal tags, they are to be prefixed.
932 TAGS+=("${prefix}${tag}")
939 function select_topology () {
942 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
943 # - FLAVOR - Node flavor string, currently either "hsw" or "skx".
944 # - CSIT_DIR - Path to existing root of local CSIT git repository.
945 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
947 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
948 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
950 # - die - Print to stderr and exit.
954 case_text="${NODENESS}_${FLAVOR}"
955 case "${case_text}" in
956 # TODO: Move tags to "# Blacklisting certain tags per topology" section.
957 # TODO: Double link availability depends on NIC used.
959 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
960 TOPOLOGIES_TAGS="2_node_single_link_topo"
963 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
964 TOPOLOGIES_TAGS="2_node_single_link_topo"
967 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
968 TOPOLOGIES_TAGS="2_node_*_link_topo"
971 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_zn2*.yaml )
972 TOPOLOGIES_TAGS="2_node_*_link_topo"
975 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
976 TOPOLOGIES_TAGS="3_node_*_link_topo"
979 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_clx*.yaml )
980 TOPOLOGIES_TAGS="2_node_*_link_topo"
983 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
984 TOPOLOGIES_TAGS="2_node_single_link_topo"
987 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
988 TOPOLOGIES_TAGS="3_node_single_link_topo"
991 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_hsw*.yaml )
992 TOPOLOGIES_TAGS="3_node_single_link_topo"
995 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
996 TOPOLOGIES_TAGS="3_node_single_link_topo"
999 # No falling back to 3n_hsw default, that should have been done
1000 # by the function which has set NODENESS and FLAVOR.
1001 die "Unknown specification: ${case_text}"
1004 if [[ -z "${TOPOLOGIES-}" ]]; then
1005 die "No applicable topology found!"
1010 function select_vpp_device_tags () {
1013 # - TEST_CODE - String affecting test selection, usually jenkins job name.
1014 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
1017 # - TAGS - Array of processed tag boolean expressions.
1021 case "${TEST_CODE}" in
1022 # Select specific device tests based on jenkins job type variable.
1024 if [[ -z "${TEST_TAG_STRING-}" ]]; then
1025 # If nothing is specified, we will run pre-selected tests by
1026 # following tags. Items of array will be concatenated by OR
1027 # in Robot Framework.
1030 # If trigger contains tags, split them into array.
1031 test_tag_array=(${TEST_TAG_STRING//:/ })
1036 # Blacklisting certain tags per topology.
1038 # Reasons for blacklisting:
1039 # - avf - AVF is not possible to run on enic driver of VirtualBox.
1040 # - vhost - VirtualBox does not support nesting virtualization on Intel CPU.
1041 case "${TEST_CODE}" in
1043 test_tag_array+=("!avf")
1044 test_tag_array+=("!vhost")
1052 # We will prefix with devicetest to prevent running other tests
1053 # (e.g. Functional).
1054 prefix="devicetestAND"
1055 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
1056 # Automatic prefixing for VPP jobs to limit testing.
1059 for tag in "${test_tag_array[@]}"; do
1060 if [[ ${tag} == "!"* ]]; then
1061 # Exclude tags are not prefixed.
1064 TAGS+=("${prefix}${tag}")
1069 function untrap_and_unreserve_testbed () {
1071 # Use this as a trap function to ensure testbed does not remain reserved.
1072 # Perhaps call directly before script exit, to free testbed for other jobs.
1073 # This function is smart enough to avoid multiple unreservations (so safe).
1074 # Topo cleanup is executed (call it best practice), ignoring failures.
1077 # - default message to die with if testbed might remain reserved.
1079 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1080 # Variables read (by inner function):
1081 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1082 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1083 # Variables written:
1084 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1085 # Trap unregistered:
1086 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1088 # - die - Print to stderr and exit.
1089 # - ansible_playbook - Perform an action using ansible, see ansible.sh
1092 set +eu # We do not want to exit early in a "teardown" function.
1093 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1094 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1095 if [[ -z "${wt-}" ]]; then
1097 warn "Testbed looks unreserved already. Trap removal failed before?"
1099 ansible_playbook "cleanup" || true
1100 python3 "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1101 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1111 # Print the message to standard error.
1114 # - ${@} - The text of the message.