X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fbash%2Ffunction%2Fper_patch.sh;h=b9680a1560f64bfe49b541f38cded17e8be01888;hb=8e06304165ccf50418027f65605b237eaf14aca7;hp=854392eca6b11de884d5cc8470b1652636ec93ae;hpb=f3e74e6b21a5d5568f4bd1357222e8a014d8397c;p=csit.git diff --git a/resources/libraries/bash/function/per_patch.sh b/resources/libraries/bash/function/per_patch.sh index 854392eca6..b9680a1560 100644 --- a/resources/libraries/bash/function/per_patch.sh +++ b/resources/libraries/bash/function/per_patch.sh @@ -1,4 +1,5 @@ -# Copyright (c) 2018 Cisco and/or its affiliates. +# Copyright (c) 2023 Cisco and/or its affiliates. +# Copyright (c) 2023 PANTHEON.tech s.r.o. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -13,99 +14,52 @@ set -exuo pipefail -# This library defines functions used mainly by "per_patch_perf.sh" entry script. +# This library defines functions used mainly by per patch entry scripts. # Generally, the functions assume "common.sh" library has been sourced already. - # Keep functions ordered alphabetically, please. -# TODO: Add a link to bash style guide. - - -function archive_parse_test_results () { - - set -exuo pipefail - - # Arguments: - # - ${1}: Directory to archive to. Required. Parent has to exist. - # Variables read: - # - ARCHIVE_DIR - Path to where robot result files are created in. - # - VPP_DIR - Path to existing directory, root for to relative paths. - # Directories updated: - # - ${1} - Created, and robot and parsing files are moved/created there. - # Functions called: - # - die - Print to stderr and exit, defined in common.sh - # - parse_bmrr_results - See definition in this file. - - cd "${VPP_DIR}" || die "Change directory command failed." - target="$(readlink -f "$1")" - mkdir -p "${target}" || die "Directory creation failed." - for filename in "output.xml" "log.html" "report.html"; do - mv "${ARCHIVE_DIR}/${filename}" "${target}/${filename}" || { - die "Attempt to move '${filename}' failed." - } - done - parse_bmrr_results "${target}" || { - die "The function should have died on error." - } -} - - -function build_vpp_ubuntu_amd64 () { - - set -exuo pipefail - # TODO: Make sure whether this works on other distros/archs too. +function build_vpp_ubuntu () { + # This function is using make pkg-verify to build VPP with all dependencies + # that is ARCH/OS aware. VPP repo is SSOT for building mechanics and CSIT + # is consuming artifacts. This way if VPP will introduce change in building + # mechanics they will not be blocked by CSIT repo. + # # Arguments: # - ${1} - String identifier for echo, can be unset. # Variables read: + # - MAKE_PARALLEL_FLAGS - Make flags when building VPP. + # - MAKE_PARALLEL_JOBS - Number of cores to use when building VPP. # - VPP_DIR - Path to existing directory, parent to accessed directories. # Directories updated: # - ${VPP_DIR} - Whole subtree, many files (re)created by the build process. - # - ${VPP_DIR}/build-root - Final build artifacts for CSIT end up here. - # - ${VPP_DIR}/dpdk - The dpdk artifact is built, but moved to build-root/. # Functions called: # - die - Print to stderr and exit, defined in common.sh + set -exuo pipefail + cd "${VPP_DIR}" || die "Change directory command failed." - echo 'Building using "make build-root/vagrant/build.sh"' - # TODO: Do we want to support "${DRYRUN}" == "True"? - make UNATTENDED=yes install-dep || die "Make install-dep failed." - # The per_patch script calls this function twice, first for the new commit, - # then for its parent commit. On Jenkins, no dpdk is installed at first, - # locally it might have been installed. New dpdk is installed second call. - # If make detects installed vpp-ext-deps with matching version, - # it skips building vpp-ext-deps entirely. - # On the other hand, if parent uses different dpdk version, - # the new vpp-ext-deps is built, but the old one is not removed - # from the build directory if present. (Further functions move both, - # and during test dpkg would decide randomly which version gets installed.) - # As per_patch is too dumb (yet) to detect any of that, - # the only safe solution is to clean build directory and force rebuild. - # TODO: Make this function smarter and skip DPDK rebuilds if possible. - cmd=("dpkg-query" "--showformat='$${Version}'" "--show" "vpp-ext-deps") - installed_deb_ver="$(sudo "${cmd[@]}" || true)" - if [[ -n "${installed_deb_ver}" ]]; then - sudo dpkg --purge "vpp-ext-deps" || { - die "DPDK package uninstalation failed." - } + if [ -n "${MAKE_PARALLEL_FLAGS-}" ]; then + echo "Building VPP. Number of cores for build set with" \ + "MAKE_PARALLEL_FLAGS='${MAKE_PARALLEL_FLAGS}'." + elif [ -n "${MAKE_PARALLEL_JOBS-}" ]; then + echo "Building VPP. Number of cores for build set with" \ + "MAKE_PARALLEL_JOBS='${MAKE_PARALLEL_JOBS}'." + else + echo "Building VPP. Number of cores not set, " \ + "using build default ($(grep -c ^processor /proc/cpuinfo))." fi - make UNATTENDED=yes install-ext-deps || { - die "Make install-ext-deps failed." - } - build-root/vagrant/"build.sh" || die "Vagrant VPP build script failed." - echo "*******************************************************************" + + make UNATTENDED=y pkg-verify || die "VPP build with make pkg-verify failed." echo "* VPP ${1-} BUILD SUCCESSFULLY COMPLETED" || { die "Argument not found." } - echo "*******************************************************************" } function compare_test_results () { - set -exuo pipefail - # Variables read: # - VPP_DIR - Path to directory with VPP git repo (at least built parts). # - ARCHIVE_DIR - Path to where robot result files are created in. @@ -115,156 +69,75 @@ function compare_test_results () { # of parent build. # Functions called: # - die - Print to stderr and exit, defined in common.sh - # - parse_bmrr_results - See definition in this file. # Exit code: # - 0 - If the comparison utility sees no regression (nor data error). # - 1 - If the comparison utility sees a regression (or data error). + set -exuo pipefail + cd "${VPP_DIR}" || die "Change directory operation failed." # Reusing CSIT main virtualenv. - pip install -r "${PYTHON_SCRIPTS_DIR}/perpatch_requirements.txt" || { - die "Perpatch Python requirements installation failed." - } - python "${PYTHON_SCRIPTS_DIR}/compare_perpatch.py" + python3 "${TOOLS_DIR}/integrated/compare_perpatch.py" # The exit code determines the vote result. } -function download_builds () { +function initialize_csit_dirs () { set -exuo pipefail - # This is mostly useful only for Sandbox testing, to avoid recompilation. - # - # Arguments: - # - ${1} - URL to download VPP builds from. # Variables read: # - VPP_DIR - Path to WORKSPACE, parent of created directories. # Directories created: - # - archive - Ends up empty, not to be confused with ${ARCHIVE_DIR}. - # - build_new - Holding built artifacts of the patch under test (PUT). - # - built_parent - Holding built artifacts of parent of PUT. + # - csit_{part} - See the caller what it is used for. # Functions called: # - die - Print to stderr and exit, defined in common.sh - cd "${VPP_DIR}" || die "Change directory operation failed." - rm -rf "build-root" "build_parent" "build_new" "archive" "csit_new" || { - die "Directory removal failed." - } - wget -N --progress=dot:giga "${1}" || die "Wget download failed." - unzip "archive.zip" || die "Archive extraction failed." - mv "archive/build_parent" ./ || die "Move operation failed." - mv "archive/build_new" ./ || die "Move operation failed." -} - - -function initialize_csit_dirs () { - set -exuo pipefail - # This could be in prepare_test, but download_builds also needs this. - # - # Variables read: - # - VPP_DIR - Path to WORKSPACE, parent of created directories. - # Directories created: - # - csit_new - Holding test results of the patch under test (PUT). - # - csit_parent - Holding test results of parent of PUT. - # Functions called: - # - die - Print to stderr and exit, defined in common.sh - cd "${VPP_DIR}" || die "Change directory operation failed." - rm -rf "csit_new" "csit_parent" || { - die "Directory deletion failed." - } - mkdir -p "csit_new" "csit_parent" || { - die "Directory creation failed." - } + while true; do + if [[ ${#} < 1 ]]; then + # All directories created. + break + fi + name_part="${1}" || die + shift || die + dir_name="csit_${name_part}" || die + rm -rf "${dir_name}" || die "Directory deletion failed." + mkdir -p "${dir_name}" || die "Directory creation failed." + done } -function parse_bmrr_results () { - - set -exuo pipefail +function move_test_results () { - # Currently "parsing" is just two greps. - # TODO: Re-use PAL parsing code, make parsing more general and centralized. - # # Arguments: - # - ${1} - Path to (existing) directory holding robot output.xml result. - # Files read: - # - output.xml - From argument location. - # Files updated: - # - results.txt - (Re)created, in argument location. - # Functions called: - # - die - Print to stderr and exit, defined in common.sh - - rel_dir="$(readlink -e "${1}")" || die "Readlink failed." - in_file="${rel_dir}/output.xml" - out_file="${rel_dir}/results.txt" - # TODO: Do we need to check echo exit code explicitly? - echo "Parsing ${in_file} putting results into ${out_file}" - echo "TODO: Re-use parts of PAL when they support subsample test parsing." - pattern='Maximum Receive Rate trial results in packets' - pattern+=' per second: .*\]' - grep -o "${pattern}" "${in_file}" | grep -o '\[.*\]' > "${out_file}" || { - die "Some parsing grep command has failed." - } -} - - -function prepare_build_parent () { - - set -exuo pipefail - + # - ${1}: Directory to archive to. Required. Parent has to exist. + # Variable set: + # - TARGET - Target archival directory, equivalent to the argument. # Variables read: - # - VPP_DIR - Path to existing directory, parent to accessed directories. - # Directories read: - # - build-root - Existing directory with built VPP artifacts (also DPDK). + # - ARCHIVE_DIR - Path to where robot result files are created in. + # - VPP_DIR - Path to existing directory, root for to relative paths. # Directories updated: - # - ${VPP_DIR} - A local git repository, parent commit gets checked out. - # - build_new - Old contents removed, content of build-root copied here. + # - ${1} - Created, and robot and parsing files are moved/created there. # Functions called: # - die - Print to stderr and exit, defined in common.sh - cd "${VPP_DIR}" || die "Change directory operation failed." - rm -rf "build_new" || die "Remove operation failed." - mkdir -p "build_new" || die "Directory creation failed." - mv "build-root"/*".deb" "build_new"/ || die "Move operation failed." - # The previous build could have left some incompatible leftovers, - # e.g. DPDK artifacts of different version (in build/external). - # Also, there usually is a copy of dpdk artifact in build-root. - git clean -dffx "build"/ "build-root"/ || die "Git clean operation failed." - # Finally, check out the parent commit. - git checkout HEAD~ || die "Git checkout operation failed." - # Display any other leftovers. - git status || die "Git status operation failed." -} - - -function prepare_test () { - set -exuo pipefail - # Variables read: - # - VPP_DIR - Path to existing directory, parent of accessed directories. - # Directories read: - # - build-root - Existing directory with built VPP artifacts (also DPDK). - # Directories updated: - # - build_parent - Old directory removed, build-root debs moved here. - # Functions called: - # - die - Print to stderr and exit, defined in common.sh - - cd "${VPP_DIR}" || die "Change directory operation failed." - rm -rf "build_parent" || die "Remove failed." - mkdir -p "build_parent" || die "Directory creation operation failed." - mv "build-root"/*".deb" "build_parent"/ || die "Move operation failed." + cd "${VPP_DIR}" || die "Change directory command failed." + TARGET="$(readlink -f "$1")" + mkdir -p "${TARGET}" || die "Directory creation failed." + file_list=("output.xml" "log.html" "report.html" "tests") + for filename in "${file_list[@]}"; do + mv "${ARCHIVE_DIR}/${filename}" "${TARGET}/${filename}" || die + done } function select_build () { - set -exuo pipefail - # Arguments: # - ${1} - Path to directory to copy VPP artifacts from. Required. # Variables read: @@ -277,6 +150,8 @@ function select_build () { # Functions called: # - die - Print to stderr and exit, defined in common.sh + set -exuo pipefail + cd "${VPP_DIR}" || die "Change directory operation failed." source_dir="$(readlink -e "$1")" rm -rf "${DOWNLOAD_DIR}"/* || die "Cleanup of download dir failed." @@ -286,23 +161,55 @@ function select_build () { } -function set_perpatch_dut () { +function set_aside_build_artifacts () { + + # Function used to save VPP .deb artifacts from currently finished build. + # + # After the artifacts are copied to the target directory, + # the main git tree is cleaned up to not interfere with next build. + # + # Arguments: + # - ${1} - String to derive the target directory name from. Required. + # Variables read: + # - VPP_DIR - Path to existing directory, parent to accessed directories. + # Directories read: + # - build-root - Existing directory with built VPP artifacts (also DPDK). + # Directories updated: + # - ${VPP_DIR} - A local git repository, parent commit gets checked out. + # - build_${1} - Old contents removed, content of build-root copied here. + # Functions called: + # - die - Print to stderr and exit, defined in common.sh set -exuo pipefail + cd "${VPP_DIR}" || die "Change directory operation failed." + dir_name="build_${1}" || die + rm -rf "${dir_name}" || die "Remove operation failed." + mkdir -p "${dir_name}" || die "Directory creation failed." + mv "build-root"/*".deb" "${dir_name}"/ || die "Move operation failed." + # The previous build could have left some incompatible leftovers, + # e.g. DPDK artifacts of different version (in build/external). + # Also, there usually is a copy of dpdk artifact in build-root. + git clean -dffx "build"/ "build-root"/ || die "Git clean operation failed." + git status || die +} + + +function set_perpatch_dut () { + # Variables set: # - DUT - CSIT test/ subdirectory containing suites to execute. # TODO: Detect DUT from job name, when we have more than just VPP perpatch. + set -exuo pipefail + DUT="vpp" } function set_perpatch_vpp_dir () { - set -exuo pipefail - # Variables read: # - CSIT_DIR - Path to existing root of local CSIT git repository. # Variables set: @@ -310,6 +217,8 @@ function set_perpatch_vpp_dir () { # Functions called: # - die - Print to stderr and exit, defined in common.sh + set -exuo pipefail + # In perpatch, CSIT is cloned inside VPP clone. VPP_DIR="$(readlink -e "${CSIT_DIR}/..")" || die "Readlink failed." }