1 # Copyright (c) 2023 Cisco and/or its affiliates.
2 # Copyright (c) 2023 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.15.1 || {
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.gz 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}/generated_tests.tar.gz - Archive of generated tests.
150 pushd "${ARCHIVE_DIR}" || die
151 tar czf "generated_tests.tar.gz" "${GENERATED_DIR}/tests" || true
156 function check_download_dir () {
158 # Fail if there are no files visible in ${DOWNLOAD_DIR}.
161 # - DOWNLOAD_DIR - Path to directory pybot takes the build to test from.
163 # - ${DOWNLOAD_DIR} - Has to be non-empty to proceed.
165 # - die - Print to stderr and exit.
169 if [[ ! "$(ls -A "${DOWNLOAD_DIR}")" ]]; then
170 die "No artifacts downloaded!"
175 function check_prerequisites () {
177 # Fail if prerequisites are not met.
180 # - installed - Check if application is installed/present in system.
181 # - die - Print to stderr and exit.
185 if ! installed sshpass; then
186 die "Please install sshpass before continue!"
191 function common_dirs () {
193 # Set global variables, create some directories (without touching content).
196 # - BASH_FUNCTION_DIR - Path to existing directory this file is located in.
197 # - CSIT_DIR - Path to existing root of local CSIT git repository.
198 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
199 # - JOB_SPECS_DIR - Path to existing directory with job test specifications.
200 # - RESOURCES_DIR - Path to existing CSIT subdirectory "resources".
201 # - TOOLS_DIR - Path to existing resources subdirectory "tools".
202 # - PYTHON_SCRIPTS_DIR - Path to existing tools subdirectory "scripts".
203 # - ARCHIVE_DIR - Path to created CSIT subdirectory "archives".
204 # The name is chosen to match what ci-management expects.
205 # - DOWNLOAD_DIR - Path to created CSIT subdirectory "download_dir".
206 # - GENERATED_DIR - Path to created CSIT subdirectory "generated".
207 # Directories created if not present:
208 # ARCHIVE_DIR, DOWNLOAD_DIR, GENERATED_DIR.
210 # - die - Print to stderr and exit.
214 this_file=$(readlink -e "${BASH_SOURCE[0]}") || {
215 die "Some error during locating of this source file."
217 BASH_FUNCTION_DIR=$(dirname "${this_file}") || {
218 die "Some error during dirname call."
220 # Current working directory could be in a different repo, e.g. VPP.
221 pushd "${BASH_FUNCTION_DIR}" || die "Pushd failed"
222 relative_csit_dir=$(git rev-parse --show-toplevel) || {
223 die "Git rev-parse failed."
225 CSIT_DIR=$(readlink -e "${relative_csit_dir}") || die "Readlink failed."
226 popd || die "Popd failed."
227 TOPOLOGIES_DIR=$(readlink -e "${CSIT_DIR}/topologies/available") || {
228 die "Readlink failed."
230 JOB_SPECS_DIR=$(readlink -e "${CSIT_DIR}/docs/job_specs") || {
231 die "Readlink failed."
233 RESOURCES_DIR=$(readlink -e "${CSIT_DIR}/resources") || {
234 die "Readlink failed."
236 TOOLS_DIR=$(readlink -e "${RESOURCES_DIR}/tools") || {
237 die "Readlink failed."
239 DOC_GEN_DIR=$(readlink -e "${TOOLS_DIR}/doc_gen") || {
240 die "Readlink failed."
242 PYTHON_SCRIPTS_DIR=$(readlink -e "${TOOLS_DIR}/scripts") || {
243 die "Readlink failed."
246 ARCHIVE_DIR=$(readlink -f "${CSIT_DIR}/archives") || {
247 die "Readlink failed."
249 mkdir -p "${ARCHIVE_DIR}" || die "Mkdir failed."
250 DOWNLOAD_DIR=$(readlink -f "${CSIT_DIR}/download_dir") || {
251 die "Readlink failed."
253 mkdir -p "${DOWNLOAD_DIR}" || die "Mkdir failed."
254 GENERATED_DIR=$(readlink -f "${CSIT_DIR}/generated") || {
255 die "Readlink failed."
257 mkdir -p "${GENERATED_DIR}" || die "Mkdir failed."
261 function compose_pybot_arguments () {
264 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
265 # - DUT - CSIT test/ subdirectory, set while processing tags.
266 # - TAGS - Array variable holding selected tag boolean expressions.
267 # - TOPOLOGIES_TAGS - Tag boolean expression filtering tests for topology.
268 # - TEST_CODE - The test selection string from environment or argument.
269 # - SELECTION_MODE - Selection criteria [test, suite, include, exclude].
271 # - PYBOT_ARGS - String holding part of all arguments for pybot.
272 # - EXPANDED_TAGS - Array of strings pybot arguments compiled from tags.
276 # No explicit check needed with "set -u".
277 PYBOT_ARGS=("--loglevel" "TRACE")
278 PYBOT_ARGS+=("--variable" "TOPOLOGY_PATH:${WORKING_TOPOLOGY}")
280 case "${TEST_CODE}" in
282 PYBOT_ARGS+=("--suite" "tests.${DUT}.device")
285 PYBOT_ARGS+=("--suite" "tests.${DUT}.perf")
288 die "Unknown specification: ${TEST_CODE}"
292 for tag in "${TAGS[@]}"; do
293 if [[ ${tag} == "!"* ]]; then
294 EXPANDED_TAGS+=("--exclude" "${tag#$"!"}")
296 if [[ ${SELECTION_MODE} == "--test" ]]; then
297 EXPANDED_TAGS+=("--test" "${tag}")
299 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}AND${tag}")
304 if [[ ${SELECTION_MODE} == "--test" ]]; then
305 EXPANDED_TAGS+=("--include" "${TOPOLOGIES_TAGS}")
310 function deactivate_docker_topology () {
312 # Deactivate virtual vpp-device topology by removing containers.
315 # - NODENESS - Node multiplicity of desired testbed.
316 # - FLAVOR - Node flavor string, usually describing the processor.
320 case_text="${NODENESS}_${FLAVOR}"
321 case "${case_text}" in
323 ssh="ssh root@172.17.0.1 -p 6022"
324 env_vars=$(env | grep CSIT_ | tr '\n' ' ' ) || die
325 # The "declare -f" output is long and boring.
327 ${ssh} "$(declare -f); deactivate_wrapper ${env_vars}" || {
328 die "Topology cleanup via shim-dcr failed!"
334 clean_environment || {
335 die "Topology cleanup locally failed!"
340 die "Unknown specification: ${case_text}!"
347 # Print the message to standard error end exit with error code specified
348 # by the second argument.
351 # - The default error message.
353 # - ${1} - The whole error message, be sure to quote. Optional
354 # - ${2} - the code to exit with, default: 1.
358 warn "${1:-Unspecified run-time error occurred!}"
363 function die_on_pybot_error () {
365 # Source this fragment if you want to abort on any failed test case.
368 # - PYBOT_EXIT_STATUS - Set by a pybot running fragment.
370 # - die - Print to stderr and exit.
374 if [[ "${PYBOT_EXIT_STATUS}" != "0" ]]; then
375 die "Test failures are present!" "${PYBOT_EXIT_STATUS}"
380 function generate_tests () {
382 # Populate ${GENERATED_DIR}/tests based on ${CSIT_DIR}/tests/.
383 # Any previously existing content of ${GENERATED_DIR}/tests is wiped before.
384 # The generation is done by executing any *.py executable
385 # within any subdirectory after copying.
387 # This is a separate function, because this code is called
388 # both by autogen checker and entries calling run_pybot.
391 # - ${CSIT_DIR}/tests - Used as templates for the generated tests.
392 # Directories replaced:
393 # - ${GENERATED_DIR}/tests - Overwritten by the generated tests.
397 rm -rf "${GENERATED_DIR}/tests" || die
398 cp -r "${CSIT_DIR}/tests" "${GENERATED_DIR}/tests" || die
399 cmd_line=("find" "${GENERATED_DIR}/tests" "-type" "f")
400 cmd_line+=("-executable" "-name" "*.py")
401 # We sort the directories, so log output can be compared between runs.
402 file_list=$("${cmd_line[@]}" | sort) || die
404 for gen in ${file_list}; do
405 directory="$(dirname "${gen}")" || die
406 filename="$(basename "${gen}")" || die
407 pushd "${directory}" || die
408 ./"${filename}" || die
414 function get_test_code () {
417 # - ${1} - Optional, argument of entry script (or empty as unset).
418 # Test code value to override job name from environment.
420 # - JOB_NAME - String affecting test selection, default if not argument.
422 # - TEST_CODE - The test selection string from environment or argument.
423 # - NODENESS - Node multiplicity of desired testbed.
424 # - FLAVOR - Node flavor string, usually describing the processor.
428 TEST_CODE="${1-}" || die "Reading optional argument failed, somehow."
429 if [[ -z "${TEST_CODE}" ]]; then
430 TEST_CODE="${JOB_NAME-}" || die "Reading job name failed, somehow."
433 case "${TEST_CODE}" in
494 function get_test_tag_string () {
497 # - GERRIT_EVENT_TYPE - Event type set by gerrit, can be unset.
498 # - GERRIT_EVENT_COMMENT_TEXT - Comment text, read for "comment-added" type.
499 # - TEST_CODE - The test selection string from environment or argument.
501 # - TEST_TAG_STRING - The string following trigger word in gerrit comment.
502 # May be empty, or even not set on event types not adding comment.
504 # TODO: ci-management scripts no longer need to perform this.
508 if [[ "${GERRIT_EVENT_TYPE-}" == "comment-added" ]]; then
509 case "${TEST_CODE}" in
517 die "Unknown specification: ${TEST_CODE}"
519 # Ignore lines not containing the trigger word.
520 comment=$(fgrep "${trigger}" <<< "${GERRIT_EVENT_COMMENT_TEXT}" || true)
521 # The vpp-csit triggers trail stuff we are not interested in.
522 # Removing them and trigger word: https://unix.stackexchange.com/a/13472
523 # (except relying on \s whitespace, \S non-whitespace and . both).
524 # The last string is concatenated, only the middle part is expanded.
525 cmd=("grep" "-oP" '\S*'"${trigger}"'\S*\s\K.+$') || die "Unset trigger?"
526 # On parsing error, TEST_TAG_STRING probably stays empty.
527 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
528 if [[ -z "${TEST_TAG_STRING-}" ]]; then
529 # Probably we got a base64 encoded comment.
530 comment="${GERRIT_EVENT_COMMENT_TEXT}"
531 comment=$(base64 --decode <<< "${comment}" || true)
532 comment=$(fgrep "${trigger}" <<< "${comment}" || true)
533 TEST_TAG_STRING=$("${cmd[@]}" <<< "${comment}" || true)
535 if [[ -n "${TEST_TAG_STRING-}" ]]; then
536 test_tag_array=(${TEST_TAG_STRING})
537 if [[ "${test_tag_array[0]}" == "icl" ]]; then
538 export GRAPH_NODE_VARIANT="icl"
539 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
540 elif [[ "${test_tag_array[0]}" == "skx" ]]; then
541 export GRAPH_NODE_VARIANT="skx"
542 TEST_TAG_STRING="${test_tag_array[@]:1}" || true
549 function installed () {
551 # Check if the given utility is installed. Fail if not installed.
553 # Duplicate of common.sh function, as this file is also used standalone.
556 # - ${1} - Utility to check.
558 # - 0 - If command is installed.
559 # - 1 - If command is not installed.
567 function move_archives () {
569 # Move archive directory to top of workspace, if not already there.
571 # ARCHIVE_DIR is positioned relative to CSIT_DIR,
572 # but in some jobs CSIT_DIR is not same as WORKSPACE
573 # (e.g. under VPP_DIR). To simplify ci-management settings,
574 # we want to move the data to the top. We do not want simple copy,
575 # as ci-management is eager with recursive search.
577 # As some scripts may call this function multiple times,
578 # the actual implementation use copying and deletion,
579 # so the workspace gets "union" of contents (except overwrites on conflict).
580 # The consequence is empty ARCHIVE_DIR remaining after this call.
582 # As the source directory is emptied,
583 # the check for dirs being different is essential.
586 # - WORKSPACE - Jenkins workspace, move only if the value is not empty.
587 # Can be unset, then it speeds up manual testing.
588 # - ARCHIVE_DIR - Path to directory with content to be moved.
589 # Directories updated:
590 # - ${WORKSPACE}/archives/ - Created if does not exist.
591 # Content of ${ARCHIVE_DIR}/ is moved.
593 # - die - Print to stderr and exit.
597 if [[ -n "${WORKSPACE-}" ]]; then
598 target=$(readlink -f "${WORKSPACE}/archives")
599 if [[ "${target}" != "${ARCHIVE_DIR}" ]]; then
600 mkdir -p "${target}" || die "Archives dir create failed."
601 cp -rf "${ARCHIVE_DIR}"/* "${target}" || die "Copy failed."
602 rm -rf "${ARCHIVE_DIR}"/* || die "Delete failed."
608 function post_process_robot_outputs () {
610 # Generate INFO level output_info.xml by rebot.
613 # - ARCHIVE_DIR - Path to post-processed files.
617 # Generate INFO level output_info.xml for post-processing.
618 all_options=("--loglevel" "INFO")
619 all_options+=("--log" "none")
620 all_options+=("--report" "none")
621 all_options+=("--output" "${ARCHIVE_DIR}/output_info.xml")
622 all_options+=("${ARCHIVE_DIR}/output.xml")
623 rebot "${all_options[@]}" || true
627 function prepare_topology () {
629 # Prepare virtual testbed topology if needed based on flavor.
632 # - TEST_CODE - String affecting test selection, usually jenkins job name.
633 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
634 # - FLAVOR - Node flavor string, e.g. "clx" or "skx".
636 # - die - Print to stderr and exit.
637 # - terraform_init - Terraform init topology.
638 # - terraform_apply - Terraform apply topology.
642 case_text="${NODENESS}_${FLAVOR}"
643 case "${case_text}" in
644 "1n_aws" | "2n_aws" | "3n_aws")
645 export TF_VAR_testbed_name="${TEST_CODE}"
646 terraform_init || die "Failed to call terraform init."
647 terraform_apply || die "Failed to call terraform apply."
653 function reserve_and_cleanup_testbed () {
655 # Reserve physical testbed, perform cleanup, register trap to unreserve.
656 # When cleanup fails, remove from topologies and keep retrying
657 # until all topologies are removed.
660 # - TOPOLOGIES - Array of paths to topology yaml to attempt reservation on.
661 # - PYTHON_SCRIPTS_DIR - Path to directory holding the reservation script.
662 # - BUILD_TAG - Any string suitable as filename, identifying
663 # test run executing this function. May be unset.
665 # - TOPOLOGIES - Array of paths to topologies, with failed cleanups removed.
666 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
668 # - die - Print to stderr and exit.
669 # - ansible_playbook - Perform an action using ansible, see ansible.sh
671 # - EXIT - Calls cancel_all for ${WORKING_TOPOLOGY}.
676 for topo in "${TOPOLOGIES[@]}"; do
678 scrpt="${PYTHON_SCRIPTS_DIR}/topo_reservation.py"
679 opts=("-t" "${topo}" "-r" "${BUILD_TAG:-Unknown}")
680 python3 "${scrpt}" "${opts[@]}"
683 if [[ "${result}" == "0" ]]; then
684 # Trap unreservation before cleanup check,
685 # so multiple jobs showing failed cleanup improve chances
686 # of humans to notice and fix.
687 WORKING_TOPOLOGY="${topo}"
688 echo "Reserved: ${WORKING_TOPOLOGY}"
689 trap "untrap_and_unreserve_testbed" EXIT || {
690 message="TRAP ATTEMPT AND UNRESERVE FAILED, FIX MANUALLY."
691 untrap_and_unreserve_testbed "${message}" || {
692 die "Teardown should have died, not failed."
694 die "Trap attempt failed, unreserve succeeded. Aborting."
696 # Cleanup + calibration checks
698 ansible_playbook "cleanup, calibration"
701 if [[ "${result}" == "0" ]]; then
704 warn "Testbed cleanup failed: ${topo}"
705 untrap_and_unreserve_testbed "Fail of unreserve after cleanup."
707 # Else testbed is accessible but currently reserved, moving on.
710 if [[ -n "${WORKING_TOPOLOGY-}" ]]; then
711 # Exit the infinite while loop if we made a reservation.
712 warn "Reservation and cleanup successful."
716 if [[ "${#TOPOLOGIES[@]}" == "0" ]]; then
717 die "Run out of operational testbeds!"
720 # Wait ~3minutes before next try.
721 sleep_time="$[ ( ${RANDOM} % 20 ) + 180 ]s" || {
722 die "Sleep time calculation failed."
724 echo "Sleeping ${sleep_time}"
725 sleep "${sleep_time}" || die "Sleep failed."
730 function run_pybot () {
732 # Run pybot with options based on input variables.
733 # Generate INFO level output_info.xml by rebot.
736 # - CSIT_DIR - Path to existing root of local CSIT git repository.
737 # - ARCHIVE_DIR - Path to store robot result files in.
738 # - PYBOT_ARGS, EXPANDED_TAGS - See compose_pybot_arguments.sh
739 # - GENERATED_DIR - Tests are assumed to be generated under there.
741 # - PYBOT_EXIT_STATUS - Exit status of most recent pybot invocation.
743 # - die - Print to stderr and exit.
747 all_options=("--outputdir" "${ARCHIVE_DIR}" "${PYBOT_ARGS[@]}")
748 all_options+=("${EXPANDED_TAGS[@]}")
750 pushd "${CSIT_DIR}" || die "Change directory operation failed."
752 robot "${all_options[@]}" "${GENERATED_DIR}/tests/"
753 PYBOT_EXIT_STATUS="$?"
756 post_process_robot_outputs || die
758 popd || die "Change directory operation failed."
762 function select_arch_os () {
764 # Set variables affected by local CPU architecture and operating system.
767 # - VPP_VER_FILE - Name of file in CSIT dir containing vpp stable version.
768 # - IMAGE_VER_FILE - Name of file in CSIT dir containing the image name.
769 # - PKG_SUFFIX - Suffix of OS package file name, "rpm" or "deb."
773 source /etc/os-release || die "Get OS release failed."
778 *"LTS (Jammy Jellyfish)"*)
779 IMAGE_VER_FILE="VPP_DEVICE_IMAGE_UBUNTU_JAMMY"
780 VPP_VER_FILE="VPP_STABLE_VER_UBUNTU_JAMMY"
784 die "Unsupported Ubuntu version!"
789 die "Unsupported distro or OS!"
793 arch=$(uname -m) || {
794 die "Get CPU architecture failed."
799 IMAGE_VER_FILE="${IMAGE_VER_FILE}_ARM"
807 function select_tags () {
810 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
811 # - TEST_CODE - String affecting test selection, usually jenkins job name.
812 # - DUT - CSIT test/ subdirectory, set while processing tags.
813 # - TEST_TAG_STRING - String selecting tags, from gerrit comment.
815 # - TOPOLOGIES_DIR - Path to existing directory with available tpologies.
816 # - BASH_FUNCTION_DIR - Directory with input files to process.
818 # - TAGS - Array of processed tag boolean expressions.
819 # - SELECTION_MODE - Selection criteria [test, suite, include, exclude].
824 case "${TEST_CODE}" in
826 start_pattern='^ SUT:'
829 start_pattern='^ TG:'
832 end_pattern='^ \? \?[A-Za-z0-9]\+:'
833 # Remove the sections from topology file
834 sed_command="/${start_pattern}/,/${end_pattern}/d"
835 # All topologies NICs
836 available=$(sed "${sed_command}" "${TOPOLOGIES_DIR}"/* \
837 | grep -hoP "model: \K.*" | sort -u)
838 # Selected topology NICs
839 reserved=$(sed "${sed_command}" "${WORKING_TOPOLOGY}" \
840 | grep -hoP "model: \K.*" | sort -u)
841 # All topologies NICs - Selected topology NICs
842 exclude_nics=($(comm -13 <(echo "${reserved}") <(echo "${available}"))) || {
843 die "Computation of excluded NICs failed."
846 # Select default NIC tag.
847 case "${TEST_CODE}" in
849 default_nic="nic_intel-e822cq"
852 default_nic="nic_intel-x520-da2"
854 *"3n-icx"* | *"2n-icx"*)
855 default_nic="nic_intel-xxv710"
857 *"2n-clx"* | *"2n-zn2"*)
858 default_nic="nic_intel-xxv710"
860 *"2n-tx2"* | *"3n-alt"* | *"mrr-daily-master")
861 default_nic="nic_intel-xl710"
863 *"1n-aws"* | *"2n-aws"* | *"3n-aws"*)
864 default_nic="nic_amazon-nitro-50g"
867 default_nic="nic_intel-x710"
871 sed_nic_sub_cmd="sed s/\${default_nic}/${default_nic}/"
873 awk_nics_sub_cmd+='gsub("xxv710","25ge2p1xxv710");'
874 awk_nics_sub_cmd+='gsub("x710","10ge2p1x710");'
875 awk_nics_sub_cmd+='gsub("xl710","40ge2p1xl710");'
876 awk_nics_sub_cmd+='gsub("x520-da2","10ge2p1x520");'
877 awk_nics_sub_cmd+='gsub("cx556a","100ge2p1cx556a");'
878 awk_nics_sub_cmd+='gsub("e810cq","100ge2p1e810cq");'
879 awk_nics_sub_cmd+='gsub("vic1227","10ge2p1vic1227");'
880 awk_nics_sub_cmd+='gsub("vic1385","40ge2p1vic1385");'
881 awk_nics_sub_cmd+='gsub("nitro-50g","50ge1p1ENA");'
882 awk_nics_sub_cmd+='if ($9 =="drv_avf") drv="avf-";'
883 awk_nics_sub_cmd+='else if ($9 =="drv_rdma_core") drv ="rdma-";'
884 awk_nics_sub_cmd+='else if ($9 =="drv_af_xdp") drv ="af-xdp-";'
885 awk_nics_sub_cmd+='else drv="";'
886 awk_nics_sub_cmd+='if ($1 =="-") cores="";'
887 awk_nics_sub_cmd+='else cores=$1;'
888 awk_nics_sub_cmd+='print "*"$7"-" drv $11"-"$5"."$3"-" cores "-" drv $11"-"$5'
890 # Tag file directory shorthand.
891 tfd="${JOB_SPECS_DIR}"
892 case "${TEST_CODE}" in
893 # Select specific performance tests based on jenkins job type variable.
895 readarray -t test_tag_array <<< $(grep -v "#" \
896 ${tfd}/vpp_device/${DUT}-${NODENESS}-${FLAVOR}.md |
897 awk {"$awk_nics_sub_cmd"} || echo "devicetest") || die
898 SELECTION_MODE="--test"
901 readarray -t test_tag_array <<< $(grep -v "#" \
902 ${tfd}/mlr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
903 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
904 SELECTION_MODE="--test"
907 readarray -t test_tag_array <<< $(grep -v "#" \
908 ${tfd}/mrr_daily/${DUT}-${NODENESS}-${FLAVOR}.md |
909 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
910 SELECTION_MODE="--test"
913 readarray -t test_tag_array <<< $(grep -v "#" \
914 ${tfd}/mrr_weekly/${DUT}-${NODENESS}-${FLAVOR}.md |
915 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
916 SELECTION_MODE="--test"
918 *"report-iterative"* )
919 test_sets=(${TEST_TAG_STRING//:/ })
920 # Run only one test set per run
921 report_file=${test_sets[0]}.md
922 readarray -t test_tag_array <<< $(grep -v "#" \
923 ${tfd}/report_iterative/${NODENESS}-${FLAVOR}/${report_file} |
924 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
925 SELECTION_MODE="--test"
927 *"report-coverage"* )
928 test_sets=(${TEST_TAG_STRING//:/ })
929 # Run only one test set per run
930 report_file=${test_sets[0]}.md
931 readarray -t test_tag_array <<< $(grep -v "#" \
932 ${tfd}/report_coverage/${NODENESS}-${FLAVOR}/${report_file} |
933 awk {"$awk_nics_sub_cmd"} || echo "perftest") || die
934 SELECTION_MODE="--test"
937 if [[ -z "${TEST_TAG_STRING-}" ]]; then
938 # If nothing is specified, we will run pre-selected tests by
940 test_tag_array=("mrrAND${default_nic}AND1cAND64bANDethip4-ip4base"
941 "mrrAND${default_nic}AND1cAND78bANDethip6-ip6base"
942 "mrrAND${default_nic}AND1cAND64bANDeth-l2bdbasemaclrn"
943 "mrrAND${default_nic}AND1cAND64bANDeth-l2xcbase"
944 "!drv_af_xdp" "!drv_avf")
946 # If trigger contains tags, split them into array.
947 test_tag_array=(${TEST_TAG_STRING//:/ })
949 SELECTION_MODE="--include"
953 # Blacklisting certain tags per topology.
955 # Reasons for blacklisting:
956 # - ipsechw - Blacklisted on testbeds without crypto hardware accelerator.
957 case "${TEST_CODE}" in
959 test_tag_array+=("!avf")
960 test_tag_array+=("!vhost")
961 test_tag_array+=("!flow")
964 test_tag_array+=("!flow")
967 test_tag_array+=("!ipsechw")
970 test_tag_array+=("!ipsechw")
973 test_tag_array+=("!ipsechw")
974 # Not enough nic_intel-xxv710 to support double link tests.
975 test_tag_array+=("!3_node_double_link_topoANDnic_intel-xxv710")
978 test_tag_array+=("!ipsechw")
980 *"2n-tx2"* | *"3n-alt"*)
981 test_tag_array+=("!ipsechw")
986 # 3n-tsh only has x520 NICs which don't work with AVF
987 test_tag_array+=("!drv_avf")
988 test_tag_array+=("!ipsechw")
990 *"1n-aws"* | *"2n-aws"* | *"3n-aws"*)
991 test_tag_array+=("!ipsechw")
995 # We will add excluded NICs.
996 test_tag_array+=("${exclude_nics[@]/#/!NIC_}")
1002 if [[ "${TEST_CODE}" == "vpp-"* ]]; then
1003 if [[ "${TEST_CODE}" != *"device"* ]]; then
1004 # Automatic prefixing for VPP perf jobs to limit the NIC used and
1005 # traffic evaluation to MRR.
1006 if [[ "${TEST_TAG_STRING-}" == *"nic_"* ]]; then
1007 prefix="${prefix}mrrAND"
1009 prefix="${prefix}mrrAND${default_nic}AND"
1013 for tag in "${test_tag_array[@]}"; do
1014 if [[ "${tag}" == "!"* ]]; then
1015 # Exclude tags are not prefixed.
1017 elif [[ "${tag}" == " "* || "${tag}" == *"perftest"* ]]; then
1018 # Badly formed tag expressions can trigger way too much tests.
1020 warn "The following tag expression hints at bad trigger: ${tag}"
1021 warn "Possible cause: Multiple triggers in a single comment."
1022 die "Aborting to avoid triggering too many tests."
1023 elif [[ "${tag}" == *"OR"* ]]; then
1024 # If OR had higher precedence than AND, it would be useful here.
1025 # Some people think it does, thus triggering way too much tests.
1027 warn "The following tag expression hints at bad trigger: ${tag}"
1028 warn "Operator OR has lower precedence than AND. Use space instead."
1029 die "Aborting to avoid triggering too many tests."
1030 elif [[ "${tag}" != "" && "${tag}" != "#"* ]]; then
1031 # Empty and comment lines are skipped.
1032 # Other lines are normal tags, they are to be prefixed.
1033 TAGS+=("${prefix}${tag}")
1040 function select_topology () {
1043 # - NODENESS - Node multiplicity of testbed, either "2n" or "3n".
1044 # - FLAVOR - Node flavor string, e.g. "clx" or "skx".
1045 # - CSIT_DIR - Path to existing root of local CSIT git repository.
1046 # - TOPOLOGIES_DIR - Path to existing directory with available topologies.
1048 # - TOPOLOGIES - Array of paths to suitable topology yaml files.
1049 # - TOPOLOGIES_TAGS - Tag expression selecting tests for the topology.
1051 # - die - Print to stderr and exit.
1055 case_text="${NODENESS}_${FLAVOR}"
1056 case "${case_text}" in
1058 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
1059 TOPOLOGIES_TAGS="2_node_single_link_topo"
1061 "1n_skx" | "1n_tx2")
1062 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*vpp_device*.template )
1063 TOPOLOGIES_TAGS="2_node_single_link_topo"
1066 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_skx*.yaml )
1067 TOPOLOGIES_TAGS="2_node_*_link_topo"
1070 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_zn2*.yaml )
1071 TOPOLOGIES_TAGS="2_node_*_link_topo"
1074 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_skx*.yaml )
1075 TOPOLOGIES_TAGS="3_node_*_link_topo"
1078 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_icx*.yaml )
1079 TOPOLOGIES_TAGS="3_node_*_link_topo"
1082 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_clx*.yaml )
1083 TOPOLOGIES_TAGS="2_node_*_link_topo"
1086 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_icx*.yaml )
1087 TOPOLOGIES_TAGS="2_node_*_link_topo"
1090 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_snr*.yaml )
1091 TOPOLOGIES_TAGS="3_node_single_link_topo"
1094 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_tsh*.yaml )
1095 TOPOLOGIES_TAGS="3_node_single_link_topo"
1098 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n_tx2*.yaml )
1099 TOPOLOGIES_TAGS="2_node_single_link_topo"
1102 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n_alt*.yaml )
1103 TOPOLOGIES_TAGS="3_node_single_link_topo"
1106 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*1n-aws*.yaml )
1107 TOPOLOGIES_TAGS="1_node_single_link_topo"
1110 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*2n-aws*.yaml )
1111 TOPOLOGIES_TAGS="2_node_single_link_topo"
1114 TOPOLOGIES=( "${TOPOLOGIES_DIR}"/*3n-aws*.yaml )
1115 TOPOLOGIES_TAGS="3_node_single_link_topo"
1118 # No falling back to default, that should have been done
1119 # by the function which has set NODENESS and FLAVOR.
1120 die "Unknown specification: ${case_text}"
1123 if [[ -z "${TOPOLOGIES-}" ]]; then
1124 die "No applicable topology found!"
1129 function set_environment_variables () {
1131 # Depending on testbed topology, overwrite defaults set in the
1132 # resources/libraries/python/Constants.py file
1135 # - TEST_CODE - String affecting test selection, usually jenkins job name.
1137 # See specific cases
1141 case "${TEST_CODE}" in
1142 *"1n-aws"* | *"2n-aws"* | *"3n-aws"*)
1143 # T-Rex 2.88+ workaround for ENA NICs.
1144 export TREX_RX_DESCRIPTORS_COUNT=1024
1145 export TREX_EXTRA_CMDLINE="--mbuf-factor 19"
1146 export TREX_CORE_COUNT=6
1147 # Settings to prevent duration stretching.
1148 export PERF_TRIAL_STL_DELAY=0.1
1151 # Maciek's workaround for Zen2 with lower amount of cores.
1152 export TREX_CORE_COUNT=14
1157 function untrap_and_unreserve_testbed () {
1159 # Use this as a trap function to ensure testbed does not remain reserved.
1160 # Perhaps call directly before script exit, to free testbed for other jobs.
1161 # This function is smart enough to avoid multiple unreservations (so safe).
1162 # Topo cleanup is executed (call it best practice), ignoring failures.
1165 # - default message to die with if testbed might remain reserved.
1167 # - ${1} - Message to die with if unreservation fails. Default hardcoded.
1168 # Variables read (by inner function):
1169 # - WORKING_TOPOLOGY - Path to topology yaml file of the reserved testbed.
1170 # - PYTHON_SCRIPTS_DIR - Path to directory holding Python scripts.
1171 # Variables written:
1172 # - WORKING_TOPOLOGY - Set to empty string on successful unreservation.
1173 # Trap unregistered:
1174 # - EXIT - Failure to untrap is reported, but ignored otherwise.
1176 # - die - Print to stderr and exit.
1177 # - ansible_playbook - Perform an action using ansible, see ansible.sh
1180 set +eu # We do not want to exit early in a "teardown" function.
1181 trap - EXIT || echo "Trap deactivation failed, continuing anyway."
1182 wt="${WORKING_TOPOLOGY}" # Just to avoid too long lines.
1183 if [[ -z "${wt-}" ]]; then
1185 warn "Testbed looks unreserved already. Trap removal failed before?"
1187 ansible_playbook "cleanup" || true
1188 python3 "${PYTHON_SCRIPTS_DIR}/topo_reservation.py" -c -t "${wt}" || {
1189 die "${1:-FAILED TO UNRESERVE, FIX MANUALLY.}" 2
1191 case "${TEST_CODE}" in
1192 *"1n-aws"* | *"2n-aws"* | *"3n-aws"*)
1193 terraform_destroy || die "Failed to call terraform destroy."
1206 # Print the message to standard error.
1209 # - ${@} - The text of the message.