1 # Copyright (c) 2021 Cisco and/or its affiliates.
2 # Copyright (c) 2021 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 parse_env_variables || die "Parse of environment variables failed!"
84 # Replace all variables in template with those in environment.
85 source <(echo 'cat <<EOF >topo.yml'; cat ${TOPOLOGIES[0]}; echo EOF;) || {
86 die "Topology file create failed!"
89 WORKING_TOPOLOGY="${CSIT_DIR}/topologies/available/vpp_device.yaml"
90 mv topo.yml "${WORKING_TOPOLOGY}" || {
91 die "Topology move failed!"
93 cat ${WORKING_TOPOLOGY} | grep -v password || {
94 die "Topology read failed!"
99 function activate_virtualenv () {
101 # Update virtualenv pip package, delete and create virtualenv directory,
102 # activate the virtualenv, install requirements, set PYTHONPATH.
105 # - ${1} - Path to existing directory for creating virtualenv in.
106 # If missing or empty, ${CSIT_DIR} is used.
107 # - ${2} - Path to requirements file, ${CSIT_DIR}/requirements.txt if empty.
109 # - CSIT_DIR - Path to existing root of local CSIT git repository.
110 # Variables exported:
111 # - PYTHONPATH - CSIT_DIR, as CSIT Python scripts usually need this.
113 # - die - Print to stderr and exit.
117 root_path="${1-$CSIT_DIR}"
118 env_dir="${root_path}/env"
119 req_path=${2-$CSIT_DIR/requirements.txt}
120 rm -rf "${env_dir}" || die "Failed to clean previous virtualenv."
121 pip3 install virtualenv==20.0.20 || {
122 die "Virtualenv package install failed."
124 virtualenv --no-download --python=$(which python3) "${env_dir}" || {
125 die "Virtualenv creation for $(which python3) failed."
128 source "${env_dir}/bin/activate" || die "Virtualenv activation failed."
130 pip3 install -r "${req_path}" || {
131 die "Requirements installation failed."
133 # Most CSIT Python scripts assume PYTHONPATH is set and exported.
134 export PYTHONPATH="${CSIT_DIR}" || die "Export failed."
138 function archive_tests () {
140 # Create .tar.xz of generated/tests for archiving.
141 # To be run after generate_tests, kept separate to offer more flexibility.
144 # - ${GENERATED_DIR}/tests - Tree of executed suites to archive.
146 # - ${ARCHIVE_DIR}/tests.tar.xz - Archive of generated tests.
150 filename="generated_robot_files.tar.xz"
151 tar c "${GENERATED_DIR}/tests" | xz -3 > "${ARCHIVE_DIR}/${filename}" || {
152 die "Error creating archive of generated tests."
157 function check_download_dir () {
159 # Fail if there are no files visible in ${DOWNLOAD_DIR}.
162 # - DOWNLOAD_DIR - Path to directory pybot takes the build to test from.
164 # - ${DOWNLOAD_DIR} - Has to be non-empty to proceed.
166 # - die - Print to stderr and exit.
170 if [[ ! "$(ls -A "${DOWNLOAD_DIR}")" ]]; then
171 die "No artifacts downloaded!"
176 function check_prerequisites () {
178 # Fail if prerequisites are not met.
181 # - installed - Check if application is installed/present in system.
182 # - die - Print to stderr and exit.
186 if ! installed sshpass; then
187 die "Please install sshpass before continue!"
192 function common_dirs () {
194 # Set global variables, create some directories (without touching content).
197 # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
198 # - CSIT_DIR - Path to existing root of local CSIT git repository.
199 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
200 # - JOB_SPECS_DIR - Path to existing directory with job test specifications.
201 # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
202 # - TOOLS_DIR - Path to existing resources subdirectory "tools".
203 # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
204 # - ARCHIVE_DIR - Path to created CSIT subdirectory "archives".
205 # The name is chosen to match what ci-management expects.
206 # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
207 # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
208 # Directories created if not present:
209 # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
211 # - die - Print to stderr and exit.
215 this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
216 die "Some error during locating of this source file."
218 BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
219 die "Some error during dirname call."
221 # Current working directory could be in a different repo, e.g. VPP.
222 pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
223 relative_csit_dir=$(git rev-parse --show-toplevel) || {
224 die "Git rev-parse failed."
226 CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
227 popd || die "Popd failed."
228 TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
229 die "Readlink failed."
231 JOB_SPECS_DIR=$(readlink -e "${CSIT_DIR}/docs/job_specs") || {
232 die "Readlink failed."
234 RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
235 die "Readlink failed."
237 TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
238 die "Readlink failed."
240 DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
241 die "Readlink failed."
243 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
244 die "Readlink failed."
247 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archives") || {
248 die "Readlink failed."
250 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
251 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
252 die "Readlink failed."
254 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
255 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
256 die "Readlink failed."
258 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
262 function compose_pybot_arguments () {
265 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
266 # - DUT - CSIT test/ subdirectory, set while processing tags.
267 # - TAGS - Array variable holding selected tag boolean expressions.
268 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
269 # - TEST_CODE - The test selection string from environment or argument.
270 # - SELECTION_MODE - Selection criteria [test, suite, include, exclude].
272 # - PYBOT_ARGS - String holding part of all arguments for pybot.
273 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
277 # No explicit check needed with "set -u".
278 PYBOT_ARGS=("--loglevel" "TRACE")
279 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
281 case "${TEST_CODE}" in
283 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
286 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
289 die "Unknown specification: ${TEST_CODE}"
293 for tag in "${TAGS[@]}"; do
294 if [[ ${tag} == "!"* ]]; then
295 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
297 if [[ ${SELECTION_MODE} == "--test" ]]; then
298 EXPANDED_TAGS+=("--test" "${tag}")
300 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
305 if [[ ${SELECTION_MODE} == "--test" ]]; then
306 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}")
311 function deactivate_docker_topology () {
313 # Deactivate virtual vpp-device topology by removing containers.
316 # - NODENESS - Node multiplicity of desired testbed.
317 # - FLAVOR - Node flavor string, usually describing the processor.
321 case_text="${NODENESS}_${FLAVOR}"
322 case "${case_text}" in
324 ssh="ssh root@172.17.0.1 -p 6022"
325 env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
326 # The "declare -f" output is long and boring.
328 ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
329 die "Topology cleanup via shim-dcr failed!"
335 clean_environment || {
336 die "Topology cleanup locally failed!"
341 die "Unknown specification: ${case_text}!"
348 # Print the message to standard error end exit with error code specified
349 # by the second argument.
352 # - The default error message.
354 # - ${1} - The whole error message, be sure to quote. Optional
355 # - ${2} - the code to exit with, default: 1.
359 warn "${1:-Unspecified run-time error occurred!}"
364 function die_on_pybot_error () {
366 # Source this fragment if you want to abort on any failed test case.
369 # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
371 # - die - Print to stderr and exit.
375 if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
376 die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
381 function generate_tests () {
383 # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
384 # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
385 # The generation is done by executing any *.py executable
386 # within any subdirectory after copying.
388 # This is a separate function, because this code is called
389 # both by autogen checker and entries calling run_pybot.
392 # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
393 # Directories replaced:
394 # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
398 rm -rf "${GENERATED_DIR}/tests" || die
399 cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
400 cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
401 cmd_line+=("-executable" "-name" "*.py")
402 # We sort the directories, so log output can be compared between runs.
403 file_list=$("${cmd_line[@]}" | sort) || die
405 for gen in ${file_list}; do
406 directory="$(dirname "${gen}")" || die
407 filename="$(basename "${gen}")" || die
408 pushd "${directory}" || die
409 ./"${filename}" || die
415 function get_test_code () {
418 # - ${1} - Optional, argument of entry script (or empty as unset).
419 # Test code value to override job name from environment.
421 # - JOB_NAME - String affecting test selection, default if not argument.
423 # - TEST_CODE - The test selection string from environment or argument.
424 # - NODENESS - Node multiplicity of desired testbed.
425 # - FLAVOR - Node flavor string, usually describing the processor.
429 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
430 if [[ -z "${TEST_CODE}" ]]; then
431 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
434 case "${TEST_CODE}" in
491 function get_test_tag_string () {
494 # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
495 # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
496 # - TEST_CODE - The test selection string from environment or argument.
498 # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
499 # May be empty, or even not set on event types not adding comment.
501 # TODO: ci-management scripts no longer need to perform this.
505 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
506 case "${TEST_CODE}" in
514 die "Unknown specification: ${TEST_CODE}"
516 # Ignore lines not containing the trigger word.
517 comment=$(fgrep "${trigger}" <<< "${GERRIT_EVENT_COMMENT_TEXT}" || true)
518 # The vpp-csit triggers trail stuff we are not interested in.
519 # Removing them and trigger word: https://unix.stackexchange.com/a/13472
520 # (except relying on \s whitespace, \S non-whitespace and . both).
521 # The last string is concatenated, only the middle part is expanded.
522 cmd=("grep" "-oP" '\S*'"${trigger}"'\S*\s\K.+$') || die "Unset trigger?"
523 # On parsing error, TEST_TAG_STRING probably stays empty.
524 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
525 if [[ -z "${TEST_TAG_STRING-}" ]]; then
526 # Probably we got a base64 encoded comment.
527 comment="${GERRIT_EVENT_COMMENT_TEXT}"
528 comment=$(base64 --decode <<< "${comment}" || true)
529 comment=$(fgrep "${trigger}" <<< "${comment}" || true)
530 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
532 if [[ -n "${TEST_TAG_STRING-}" ]]; then
533 test_tag_array=(${TEST_TAG_STRING})
534 if [[ "${test_tag_array[0]}" == "icl" ]]; then
535 export GRAPH_NODE_VARIANT="icl"
536 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
537 elif [[ "${test_tag_array[0]}" == "skx" ]]; then
538 export GRAPH_NODE_VARIANT="skx"
539 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
546 function installed () {
548 # Check if the given utility is installed. Fail if not installed.
550 # Duplicate of common.sh function, as this file is also used standalone.
553 # - ${1} - Utility to check.
555 # - 0 - If command is installed.
556 # - 1 - If command is not installed.
564 function move_archives () {
566 # Move archive directory to top of workspace, if not already there.
568 # ARCHIVE_DIR is positioned relative to CSIT_DIR,
569 # but in some jobs CSIT_DIR is not same as WORKSPACE
570 # (e.g. under VPP_DIR). To simplify ci-management settings,
571 # we want to move the data to the top. We do not want simple copy,
572 # as ci-management is eager with recursive search.
574 # As some scripts may call this function multiple times,
575 # the actual implementation use copying and deletion,
576 # so the workspace gets "union" of contents (except overwrites on conflict).
577 # The consequence is empty ARCHIVE_DIR remaining after this call.
579 # As the source directory is emptied,
580 # the check for dirs being different is essential.
583 # - WORKSPACE - Jenkins workspace, move only if the value is not empty.
584 # Can be unset, then it speeds up manual testing.
585 # - ARCHIVE_DIR - Path to directory with content to be moved.
586 # Directories updated:
587 # - ${WORKSPACE}/archives/ - Created if does not exist.
588 # Content of ${ARCHIVE_DIR}/ is moved.
590 # - die - Print to stderr and exit.
594 if [[ -n "${WORKSPACE-}" ]]; then
595 target=$(readlink -f "${WORKSPACE}/archives")
596 if [[ "${target}" != "${ARCHIVE_DIR}" ]]; then
597 mkdir -p "${target}" || die "Archives dir create failed."
598 cp -rf "${ARCHIVE_DIR}"/* "${target}" || die "Copy failed."
599 rm -rf "${ARCHIVE_DIR}"/* || die "Delete failed."
605 function prepare_topology () {
607 # Prepare virtual testbed topology if needed based on flavor.
610 # - TEST_CODE - String affecting test selection, usually jenkins job name.
611 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
612 # - FLAVOR - Node flavor string, e.g. "clx" or "skx".
614 # - die - Print to stderr and exit.
615 # - terraform_init - Terraform init topology.
616 # - terraform_apply - Terraform apply topology.
620 case_text="${NODENESS}_${FLAVOR}"
621 case "${case_text}" in
623 export TF_VAR_testbed_name="${TEST_CODE}"
624 terraform_init || die "Failed to call terraform init."
625 terraform_apply || die "Failed to call terraform apply."
628 export TF_VAR_testbed_name="${TEST_CODE}"
629 terraform_init || die "Failed to call terraform init."
630 terraform_apply || die "Failed to call terraform apply."
636 function reserve_and_cleanup_testbed () {
638 # Reserve physical testbed, perform cleanup, register trap to unreserve.
639 # When cleanup fails, remove from topologies and keep retrying
640 # until all topologies are removed.
643 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
644 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
645 # - BUILD_TAG - Any string suitable as filename, identifying
646 # test run executing this function. May be unset.
648 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
649 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
651 # - die - Print to stderr and exit.
652 # - ansible_playbook - Perform an action using ansible, see ansible.sh
654 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
659 for topo in "${TOPOLOGIES[@]}"; do
661 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
662 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
663 python3 "${scrpt}" "${opts[@]}"
666 if [[ "${result}" == "0" ]]; then
667 # Trap unreservation before cleanup check,
668 # so multiple jobs showing failed cleanup improve chances
669 # of humans to notice and fix.
670 WORKING_TOPOLOGY="${topo}"
671 echo "Reserved: ${WORKING_TOPOLOGY}"
672 trap "untrap_and_unreserve_testbed" EXIT || {
673 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
674 untrap_and_unreserve_testbed "${message}" || {
675 die "Teardown should have died, not failed."
677 die "Trap attempt failed, unreserve succeeded. Aborting."
679 # Cleanup + calibration checks
681 ansible_playbook "cleanup, calibration"
684 if [[ "${result}" == "0" ]]; then
687 warn "Testbed cleanup failed: ${topo}"
688 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
690 # Else testbed is accessible but currently reserved, moving on.
693 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
694 # Exit the infinite while loop if we made a reservation.
695 warn "Reservation and cleanup successful."
699 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
700 die "Run out of operational testbeds!"
703 # Wait ~3minutes before next try.
704 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
705 die "Sleep time calculation failed."
707 echo "Sleeping ${sleep_time}"
708 sleep "${sleep_time}" || die "Sleep failed."
713 function run_pybot () {
715 # Run pybot with options based on input variables. Create output_info.xml
717 # Also, .info.json files are moved into an archive to speed up PAL.
720 # - CSIT_DIR - Path to existing root of local CSIT git repository.
721 # - ARCHIVE_DIR - Path to store robot result files in.
722 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
723 # - GENERATED_DIR - Tests are assumed to be generated under there.
725 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
727 # - die - Print to stderr and exit.
731 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
732 all_options+=("--noncritical" "EXPECTED_FAILING")
733 all_options+=("${EXPANDED_TAGS[@]}")
735 pushd "${CSIT_DIR}" || die "Change directory operation failed."
737 robot "${all_options[@]}" "${GENERATED_DIR}/tests/"
738 PYBOT_EXIT_STATUS="$?"
741 # Compress raw json outputs, if any.
742 pushd "${ARCHIVE_DIR}" || die
743 if [ -d "tests" ]; then
744 # Use deterministic order.
745 options+=("--sort=name")
746 # We are keeping info outputs where they are.
747 # Assuming we want to move anything but info files (and dirs).
748 options+=("--exclude=*.info.json")
749 # There may be other unforeseen errors,
750 # we still want to execute subsequent commands, so disable set -e.
752 tar cvf "tests_output_raw.tar" "${options[@]}" "tests"
753 # If compression fails, it leaves an uncompressed .tar,
754 # we still want to archive that to investigate why compression failed.
755 time xz -9e "tests_output_raw.tar"
756 # Tar can remove when archiving, but chokes (not deterministically)
757 # on attempting to remove dirs (not empty as info files are there).
758 # So we need to delete the raw files manually.
759 find "tests" -type f -name "*.raw.json" -delete
764 # Generate INFO level output_info.xml for post-processing.
765 # This comes last, as it is slowest, and sometimes users abort here.
766 all_options=("--loglevel" "INFO")
767 all_options+=("--log" "none")
768 all_options+=("--report" "none")
769 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
770 all_options+=("${ARCHIVE_DIR}/output.xml")
771 rebot "${all_options[@]}" || true
772 popd || die "Change directory operation failed."
776 function select_arch_os () {
778 # Set variables affected by local CPU architecture and operating system.
781 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
782 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
783 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
787 source /etc/os-release || die "Get OS release failed."
792 *"LTS (Focal Fossa)"*)
793 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU"
794 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_FOCAL"
798 die "Unsupported Ubuntu version!"
803 die "Unsupported distro or OS!"
807 arch=$(uname -m) || {
808 die "Get CPU architecture failed."
813 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
821 function select_tags () {
824 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
825 # - TEST_CODE - String affecting test selection, usually jenkins job name.
826 # - DUT - CSIT test/ subdirectory, set while processing tags.
827 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
829 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
830 # - BASH_FUNCTION_DIR - Directory with input files to process.
832 # - TAGS - Array of processed tag boolean expressions.
833 # - SELECTION_MODE - Selection criteria [test, suite, include, exclude].
838 start_pattern='^ TG:'
839 end_pattern='^ \? \?[A-Za-z0-9]\+:'
840 # Remove the TG section from topology file
841 sed_command="/${start_pattern}/,/${end_pattern}/d"
842 # All topologies DUT NICs
843 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
844 | grep -hoP "model: \K.*" | sort -u)
845 # Selected topology DUT NICs
846 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
847 | grep -hoP "model: \K.*" | sort -u)
848 # All topologies DUT NICs - Selected topology DUT NICs
849 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
850 die "Computation of excluded NICs failed."
853 # Select default NIC tag.
854 case "${TEST_CODE}" in
855 *"3n-dnv"* | *"2n-dnv"*)
856 default_nic="nic_intel-x553"
859 default_nic="nic_intel-x520-da2"
861 *"3n-skx"* | *"2n-skx"* | *"2n-clx"* | *"2n-zn2"*)
862 default_nic="nic_intel-xxv710"
864 *"2n-tx2"* | *"mrr-daily-master")
865 default_nic="nic_intel-xl710"
867 *"2n-aws"* | *"3n-aws"*)
868 default_nic="nic_amazon-nitro-50g"
871 default_nic="nic_intel-x710"
875 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
877 awk_nics_sub_cmd+='gsub("xxv710","25ge2p1xxv710");'
878 awk_nics_sub_cmd+='gsub("x710","10ge2p1x710");'
879 awk_nics_sub_cmd+='gsub("xl710","40ge2p1xl710");'
880 awk_nics_sub_cmd+='gsub("x520-da2","10ge2p1x520");'
881 awk_nics_sub_cmd+='gsub("x553","10ge2p1x553");'
882 awk_nics_sub_cmd+='gsub("cx556a","100ge2p1cx556a");'
883 awk_nics_sub_cmd+='gsub("e810cq","100ge2p1e810cq");'
884 awk_nics_sub_cmd+='gsub("vic1227","10ge2p1vic1227");'
885 awk_nics_sub_cmd+='gsub("vic1385","40ge2p1vic1385");'
886 awk_nics_sub_cmd+='gsub("nitro-50g","50ge1p1ENA");'
887 awk_nics_sub_cmd+='if ($9 =="drv_avf") drv="avf-";'
888 awk_nics_sub_cmd+='else if ($9 =="drv_rdma_core") drv ="rdma-";'
889 awk_nics_sub_cmd+='else if ($9 =="drv_af_xdp") drv ="af-xdp-";'
890 awk_nics_sub_cmd+='else drv="";'
891 awk_nics_sub_cmd+='if ($1 =="-") cores="";'
892 awk_nics_sub_cmd+='else cores=$1;'
893 awk_nics_sub_cmd+='print "*"$7"-" drv $11"-"$5"."$3"-" cores "-" drv $11"-"$5'
895 # Tag file directory shorthand.
896 tfd="${JOB_SPECS_DIR}"
897 case "${TEST_CODE}" in
898 # Select specific performance tests based on jenkins job type variable.
900 readarray -t test_tag_array <<< $(grep -v "#" \
901 ${tfd}/vpp_device/${DUT}-${NODENESS}-${FLAVOR}.md |
902 awk {"$awk_nics_sub_cmd"} || echo "devicetest") || die
903 SELECTION_MODE="--test"
906 readarray -t test_tag_array <<< $(grep -v "#" \
907 ${tfd}/mlr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
908 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
909 SELECTION_MODE="--test"
912 readarray -t test_tag_array <<< $(grep -v "#" \
913 ${tfd}/mrr_daily/${DUT}-${NODENESS}-${FLAVOR}.md |
914 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
915 SELECTION_MODE="--test"
918 readarray -t test_tag_array <<< $(grep -v "#" \
919 ${tfd}/mrr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
920 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
921 SELECTION_MODE="--test"
923 *"report-iterative"* )
924 test_sets=(${TEST_TAG_STRING//:/ })
925 # Run only one test set per run
926 report_file=${test_sets[0]}.md
927 readarray -t test_tag_array <<< $(grep -v "#" \
928 ${tfd}/report_iterative/${NODENESS}-${FLAVOR}/${report_file} |
929 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
930 SELECTION_MODE="--test"
932 *"report-coverage"* )
933 test_sets=(${TEST_TAG_STRING//:/ })
934 # Run only one test set per run
935 report_file=${test_sets[0]}.md
936 readarray -t test_tag_array <<< $(grep -v "#" \
937 ${tfd}/report_coverage/${NODENESS}-${FLAVOR}/${report_file} |
938 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
939 SELECTION_MODE="--test"
942 if [[ -z "${TEST_TAG_STRING-}" ]]; then
943 # If nothing is specified, we will run pre-selected tests by
945 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDethip4-ip4base"
946 "mrrAND${default_nic}AND1cAND78bANDethip6-ip6base"
947 "mrrAND${default_nic}AND1cAND64bANDeth-l2bdbasemaclrn"
948 "mrrAND${default_nic}AND1cAND64bANDeth-l2xcbase"
949 "!drv_af_xdp" "!drv_avf")
951 # If trigger contains tags, split them into array.
952 test_tag_array=(${TEST_TAG_STRING//:/ })
954 SELECTION_MODE="--include"
958 # Blacklisting certain tags per topology.
960 # Reasons for blacklisting:
961 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
962 case "${TEST_CODE}" in
964 test_tag_array+=("!avf")
965 test_tag_array+=("!vhost")
966 test_tag_array+=("!flow")
969 test_tag_array+=("!flow")
972 test_tag_array+=("!ipsechw")
975 test_tag_array+=("!ipsechw")
976 # Not enough nic_intel-xxv710 to support double link tests.
977 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
980 test_tag_array+=("!ipsechw")
983 test_tag_array+=("!ipsechw")
986 test_tag_array+=("!memif")
987 test_tag_array+=("!srv6_proxy")
988 test_tag_array+=("!vhost")
989 test_tag_array+=("!vts")
990 test_tag_array+=("!drv_avf")
993 test_tag_array+=("!ipsechw")
996 test_tag_array+=("!memif")
997 test_tag_array+=("!srv6_proxy")
998 test_tag_array+=("!vhost")
999 test_tag_array+=("!vts")
1000 test_tag_array+=("!drv_avf")
1003 # 3n-tsh only has x520 NICs which don't work with AVF
1004 test_tag_array+=("!drv_avf")
1005 test_tag_array+=("!ipsechw")
1007 *"2n-aws"* | *"3n-aws"*)
1008 test_tag_array+=("!ipsechw")
1012 # We will add excluded NICs.
1013 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
1019 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
1020 if [[ "${TEST_CODE}" != *"device"* ]]; then
1021 # Automatic prefixing for VPP perf jobs to limit the NIC used and
1022 # traffic evaluation to MRR.
1023 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
1024 prefix="${prefix}mrrAND"
1026 prefix="${prefix}mrrAND${default_nic}AND"
1030 for tag in "${test_tag_array[@]}"; do
1031 if [[ "${tag}" == "!"* ]]; then
1032 # Exclude tags are not prefixed.
1034 elif [[ "${tag}" == " "* || "${tag}" == *"perftest"* ]]; then
1035 # Badly formed tag expressions can trigger way too much tests.
1037 warn "The following tag expression hints at bad trigger: ${tag}"
1038 warn "Possible cause: Multiple triggers in a single comment."
1039 die "Aborting to avoid triggering too many tests."
1040 elif [[ "${tag}" == *"OR"* ]]; then
1041 # If OR had higher precedence than AND, it would be useful here.
1042 # Some people think it does, thus triggering way too much tests.
1044 warn "The following tag expression hints at bad trigger: ${tag}"
1045 warn "Operator OR has lower precedence than AND. Use space instead."
1046 die "Aborting to avoid triggering too many tests."
1047 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
1048 # Empty and comment lines are skipped.
1049 # Other lines are normal tags, they are to be prefixed.
1050 TAGS+=("${prefix}${tag}")
1057 function select_topology () {
1060 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
1061 # - FLAVOR - Node flavor string, e.g. "clx" or "skx".
1062 # - CSIT_DIR - Path to existing root of local CSIT git repository.
1063 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
1065 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
1066 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
1068 # - die - Print to stderr and exit.
1072 case_text="${NODENESS}_${FLAVOR}"
1073 case "${case_text}" in
1075 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
1076 TOPOLOGIES_TAGS="2_node_single_link_topo"
1078 "1n_skx" | "1n_tx2")
1079 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
1080 TOPOLOGIES_TAGS="2_node_single_link_topo"
1083 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
1084 TOPOLOGIES_TAGS="2_node_*_link_topo"
1087 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_zn2*.yaml )
1088 TOPOLOGIES_TAGS="2_node_*_link_topo"
1091 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
1092 TOPOLOGIES_TAGS="3_node_*_link_topo"
1095 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_clx*.yaml )
1096 TOPOLOGIES_TAGS="2_node_*_link_topo"
1099 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_dnv*.yaml )
1100 TOPOLOGIES_TAGS="2_node_single_link_topo"
1103 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_dnv*.yaml )
1104 TOPOLOGIES_TAGS="3_node_single_link_topo"
1107 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
1108 TOPOLOGIES_TAGS="3_node_single_link_topo"
1111 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_tx2*.yaml )
1112 TOPOLOGIES_TAGS="2_node_single_link_topo"
1115 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_aws*.yaml )
1116 TOPOLOGIES_TAGS="2_node_single_link_topo"
1119 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_aws*.yaml )
1120 TOPOLOGIES_TAGS="3_node_single_link_topo"
1123 # No falling back to default, that should have been done
1124 # by the function which has set NODENESS and FLAVOR.
1125 die "Unknown specification: ${case_text}"
1128 if [[ -z "${TOPOLOGIES-}" ]]; then
1129 die "No applicable topology found!"
1134 function set_environment_variables () {
1136 # Depending on testbed topology, overwrite defaults set in the
1137 # resources/libraries/python/Constants.py file
1140 # - TEST_CODE - String affecting test selection, usually jenkins job name.
1142 # See specific cases
1146 case "${TEST_CODE}" in
1147 *"2n-aws"* | *"3n-aws"*)
1148 # T-Rex 2.88 workaround for ENA NICs
1149 export TREX_RX_DESCRIPTORS_COUNT=1024
1150 export TREX_EXTRA_CMDLINE="--mbuf-factor 19"
1151 export TREX_CORE_COUNT=6
1152 # Settings to prevent duration stretching
1153 export PERF_TRIAL_STL_DELAY=0.1
1159 function untrap_and_unreserve_testbed () {
1161 # Use this as a trap function to ensure testbed does not remain reserved.
1162 # Perhaps call directly before script exit, to free testbed for other jobs.
1163 # This function is smart enough to avoid multiple unreservations (so safe).
1164 # Topo cleanup is executed (call it best practice), ignoring failures.
1167 # - default message to die with if testbed might remain reserved.
1169 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1170 # Variables read (by inner function):
1171 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1172 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1173 # Variables written:
1174 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1175 # Trap unregistered:
1176 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1178 # - die - Print to stderr and exit.
1179 # - ansible_playbook - Perform an action using ansible, see ansible.sh
1182 set +eu # We do not want to exit early in a "teardown" function.
1183 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1184 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1185 if [[ -z "${wt-}" ]]; then
1187 warn "Testbed looks unreserved already. Trap removal failed before?"
1189 ansible_playbook "cleanup" || true
1190 python3 "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1191 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1193 case "${TEST_CODE}" in
1194 *"2n-aws"* | *"3n-aws"*)
1195 terraform_destroy || die "Failed to call terraform destroy."
1208 # Print the message to standard error.
1211 # - ${@} - The text of the message.