1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
# 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:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
set -exuo pipefail
# 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.
function archive_test_results () {
# Arguments:
# - ${1}: Directory to archive to. Required. Parent has to exist.
# Variable set:
# - TARGET - Target directory.
# 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
set -exuo pipefail
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 "Attempt to move '${filename}' failed."
}
done
}
function build_vpp_ubuntu_amd64 () {
# 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.
# Functions called:
# - die - Print to stderr and exit, defined in common.sh
set -exuo pipefail
cd "${VPP_DIR}" || die "Change directory command 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=y pkg-verify || die "VPP build with make pkg-verify failed."
echo "* VPP ${1-} BUILD SUCCESSFULLY COMPLETED" || {
die "Argument not found."
}
}
function compare_test_results () {
# 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.
# - PYTHON_SCRIPTS_DIR - Path to directory holding comparison utility.
# Directories recreated:
# - csit_parent - Sibling to csit directory, for holding results
# of parent build.
# Functions called:
# - die - Print to stderr and exit, defined in common.sh
# 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.
python3 "${TOOLS_DIR}/integrated/compare_perpatch.py"
# The exit code determines the vote result.
}
function initialize_csit_dirs () {
set -exuo pipefail
# Variables read:
# - VPP_DIR - Path to WORKSPACE, parent of created directories.
# Directories created:
# - csit_current - 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
set -exuo pipefail
cd "${VPP_DIR}" || die "Change directory operation failed."
rm -rf "csit_current" "csit_parent" || {
die "Directory deletion failed."
}
mkdir -p "csit_current" "csit_parent" || {
die "Directory creation failed."
}
}
function select_build () {
# Arguments:
# - ${1} - Path to directory to copy VPP artifacts from. Required.
# Variables read:
# - DOWNLOAD_DIR - Path to directory where Robot takes builds to test from.
# - VPP_DIR - Path to existing directory, root for relative paths.
# Directories read:
# - ${1} - Existing directory with built new VPP artifacts (and DPDK).
# Directories updated:
# - ${DOWNLOAD_DIR} - Old content removed, .deb files from ${1} 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."
source_dir="$(readlink -e "$1")"
rm -rf "${DOWNLOAD_DIR}"/* || die "Cleanup of download dir failed."
cp "${source_dir}"/*".deb" "${DOWNLOAD_DIR}" || die "Copy operation failed."
# TODO: Is there a nice way to create symlinks,
# so that if job fails on robot, results can be archived?
}
function set_aside_commit_build_artifacts () {
# Function is copying VPP built artifacts from actual checkout commit for
# further use and clean git.
# 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_current - 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."
rm -rf "build_current" || die "Remove operation failed."
mkdir -p "build_current" || die "Directory creation failed."
mv "build-root"/*".deb" "build_current"/ || 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 set_aside_parent_build_artifacts () {
# Function is copying VPP built artifacts from parent checkout commit for
# further use. Checkout to parent is not part of this function.
# 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
set -exuo pipefail
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."
}
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 () {
# Variables read:
# - CSIT_DIR - Path to existing root of local CSIT git repository.
# Variables set:
# - VPP_DIR - Path to existing root of local VPP git repository.
# 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."
}
|
