forked from quic/aimet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dobuildntest.sh
executable file
·502 lines (442 loc) · 18.7 KB
/
dobuildntest.sh
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
#!/bin/bash
# =============================================================================
# @@-COPYRIGHT-START-@@
#
# Copyright (c) 2020, Qualcomm Innovation Center, Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# @@-COPYRIGHT-END-@@
# =============================================================================
###############################################################################
## This is a script to build and run tests AIMET code.
## This script must be run from within the AIMET top-level folder
###############################################################################
# verbose mode
# set -x
# enable exit on error.
set -e
run_prep=1
run_clean=0
run_build=0
run_package_gen=0
run_unit_tests=0
run_code_violation=0
run_code_coverage=0
run_static_analysis=0
run_acceptance_tests=0
EXIT_CODE=0
# Array to store python source file paths
declare -a PYTHON_SRC_PATHS=()
# Variable to store python source file paths
PYTHON_SRC_MODULE_PATHS=""
# PYTHONPATH variable
PYTHONPATH_VALUE=""
# Array to store python source file paths for code coverage
declare -a PYCOV_SRC_PATHS=()
# Array to store python test file paths for code coverage
declare -a PYCOV_TEST_PATHS=()
workspaceFolder=`pwd`
outputFolder=
function pre_exit {
# Capture the exit code
EXIT_CODE=$?
if [ -z "$outputFolder" ]; then
outputFolder=$workspaceFolder/buildntest_results
fi
summaryFile=${outputFolder}/summary.txt
if [[ -f ${summaryFile} ]]; then
# In case there is non-zero exit code, then add a FAILED tag to the summary file.
if [ $EXIT_CODE -ne 0 ]; then
echo -e "One or more Stages \t\t FAILED " | tee -a ${outputFolder}/summary.txt
fi
echo -e "----------------------------------------------------------------------------------------------------------\n" |tee -a ${summaryFile}
echo -e "\nResults are in location:\n${outputFolder}\n" | tee -a ${summaryFile}
cat ${summaryFile}
if grep -q FAIL "${summaryFile}"; then
EXIT_CODE=3
fi
fi
# Return the exit code
exit ${EXIT_CODE}
}
trap pre_exit EXIT
function check_stage() {
RESULT=$1
STAGE=$2
if [ "$3" ]; then
EXIT_ON_FAIL=$3
fi
if [ $RESULT -eq 0 ]; then
echo -e "Stage $STAGE \t\t PASS " | tee -a ${outputFolder}/summary.txt
else
echo -e "Stage $STAGE \t\t FAILED " | tee -a ${outputFolder}/summary.txt
if [ $EXIT_ON_FAIL == "true" ]; then
echo -e "\n ABORTED " | tee -a ${outputFolder}/summary.txt
exit 3
fi
fi
}
usage() {
echo -e "\nThis is a script to build and run tests on AIMET code."
echo -e "This script must be executed from within the AIMET repo's top-level folder."
echo -e "NOTE: This script must be executed within the docker container (or in a machine with all dependencies installed). It will NOT start a docker container.\n"
echo "${0} [-o <output_folder>]"
echo " -b --> build the code"
echo " -p --> generate pip packages"
echo " -u --> run unit tests"
echo " -v --> run code violation checks (using pylint tool)"
echo " -g --> run code coverage checks (using pycov tool)"
echo " -s --> run static analysis (using clang-tidy tool)"
echo " -a --> run acceptance tests (Warning: This will take a long time to complete!)"
echo " -o --> optional output folder. Default is current directory"
echo " -w --> path to AIMET workspace. Default is current directory"
}
while getopts "o:w:abcghpsuv" opt;
do
case $opt in
a)
run_acceptance_tests=1
;;
b)
run_build=1
;;
c)
run_clean=1
;;
g)
run_code_coverage=1
;;
p)
run_package_gen=1
;;
u)
run_unit_tests=1
;;
v)
run_code_violation=1
;;
s)
run_static_analysis=1
;;
h)
usage
exit 0
;;
o)
outputFolder=$OPTARG
;;
w)
workspaceFolder=$OPTARG
;;
:)
echo "Option -$OPTARG requires an argument" >&2
exit 1;;
?)
echo "Unknown arg $opt"
usage
exit 1
;;
esac
done
# If no modes are enabled by user, then enable most modes by default
if [ $run_clean -eq 0 ] && [ $run_acceptance_tests -eq 0 ] && [ $run_build -eq 0 ] && \
[ $run_package_gen -eq 0 ] && [ $run_unit_tests -eq 0 ] && [ $run_code_violation -eq 0 ] && \
[ $run_code_coverage -eq 0 ] && [ $run_static_analysis -eq 0 ]; then
run_prep=1
run_clean=1
run_build=1
run_package_gen=1
run_unit_tests=1
run_code_violation=1
run_code_coverage=1
run_static_analysis=1
run_acceptance_tests=0
fi
if [[ -z "${workspaceFolder}" ]]; then
usage
echo -e "ERROR: Workspace directory was not specified!"
exit 3
fi
echo "Starting AIMET build and test..."
workspaceFolder=`readlink -f ${workspaceFolder}`
buildFolder=$workspaceFolder/build
artifactsFolder=$buildFolder/artifacts
AIMET_TORCH_HOME=${buildFolder}/torch_pretrain_data
# Sanity check to verify whether we're running form the correct repo location
if [[ ! -d "${workspaceFolder}/TrainingExtensions" ]] && [[ ! -d "${workspaceFolder}/aimet/TrainingExtensions" ]]; then
echo -e "ERROR: Not in AIMET directory!"
exit 3
fi
if [[ -d "${workspaceFolder}/Jenkins" ]]; then
toolsFolder=${workspaceFolder}/Jenkins
elif [[ -d "${workspaceFolder}/aimet/Jenkins" ]]; then
toolsFolder=${workspaceFolder}/aimet/Jenkins
fi
if [ $run_clean -eq 1 ]; then
echo -e "\n********** Stage: Clean **********\n"
if [ -d ${buildFolder} ]; then
rm -rf ${buildFolder}/* | true
fi
fi
if [ -z "$outputFolder" ]; then
outputFolder=$buildFolder/results
fi
mkdir -p ${outputFolder}
if [ ! -f "${outputFolder}/summary.txt" ]; then
touch ${outputFolder}/summary.txt
fi
if ! grep -q "AIMET Build and Test Summary" "${outputFolder}/summary.txt"; then
echo -e "\n----------------------------------------------------------------------------------------------------------" | tee -a ${outputFolder}/summary.txt
echo -e "\t\t AIMET Build and Test Summary " | tee -a ${outputFolder}/summary.txt
echo -e "----------------------------------------------------------------------------------------------------------" | tee -a ${outputFolder}/summary.txt
fi
if [ $run_prep -eq 1 ]; then
echo -e "\n********** Stage 1: Preparation **********\n"
cd $workspaceFolder
# Download the checkpoint files if they don't already exist
#NOTE: We needed this due to some intermittant issues downloading via torchvision
## mkdir -p ${AIMET_TORCH_HOME}/checkpoints
## wget -N https://download.pytorch.org/models/resnet18-5c106cde.pth -P ${AIMET_TORCH_HOME}/checkpoints
## wget -N https://download.pytorch.org/models/inception_v3_google-1a9a5a14.pth -P ${AIMET_TORCH_HOME}/checkpoints
# Clone the google test repo if not already present
google_test_path="${workspaceFolder}/ThirdParty/googletest/googletest-release-1.8.0"
if [ ! -e ${google_test_path} ]; then
mkdir -p $workspaceFolder/ThirdParty/googletest
pushd $workspaceFolder/ThirdParty/googletest
git clone https://github.com/google/googletest.git -b release-1.8.0 googletest-release-1.8.0
popd
check_stage $? "Preparation" "true"
fi
# Array of python src file path endings
declare -a python_src_path_endings=("TrainingExtensions/common/src/python/aimet_common")
# Array of path endings of interest for code coverage and their corresponding test folders
declare -a pycov_dir_endings=("TrainingExtensions/common/src/python:TrainingExtensions/common/test")
if [ -n "$AIMET_VARIANT" ]; then
# Add tensorflow and/or torch paths based on the variant
if [[ "$AIMET_VARIANT" == *"tf"* ]]; then
python_src_path_endings+=("TrainingExtensions/tensorflow/src/python/aimet_tensorflow")
pycov_dir_endings+=("TrainingExtensions/tensorflow/src/python:TrainingExtensions/tensorflow/test")
fi
if [[ "$AIMET_VARIANT" == *"torch"* ]]; then
python_src_path_endings+=("TrainingExtensions/torch/src/python/aimet_torch")
pycov_dir_endings+=("TrainingExtensions/torch/src/python:TrainingExtensions/torch/test")
fi
else
# For default variant, add both tensorflow and/or torch paths
python_src_path_endings+=("TrainingExtensions/tensorflow/src/python/aimet_tensorflow")
pycov_dir_endings+=("TrainingExtensions/tensorflow/src/python:TrainingExtensions/tensorflow/test")
python_src_path_endings+=("TrainingExtensions/torch/src/python/aimet_torch")
pycov_dir_endings+=("TrainingExtensions/torch/src/python:TrainingExtensions/torch/test")
fi
# Populate an array of python src paths for use in later stages
for python_src_path_ending in "${python_src_path_endings[@]}"; do
# Find all paths
PYTHON_SRC_PATHS+=($(find . -path "*$python_src_path_ending" -exec readlink -f {} \;))
done
# Populate the PYTHONPATH env variable value for use in later stages
PYTHONPATH_VALUE+=$artifactsFolder
for python_src_path in "${PYTHON_SRC_PATHS[@]}"; do
# Append the parent of each python src path to PYTHONPATH (separated by colon)
python_src_path_parent=$(readlink -f ${python_src_path}/..)
PYTHONPATH_VALUE+=":"
PYTHONPATH_VALUE+=${python_src_path_parent}
# Append the same path also to a string (separated by space)
PYTHON_SRC_MODULE_PATHS+=python_src_path_parent
PYTHON_SRC_MODULE_PATHS+=" "
done
echo "PYTHONPATH value = $PYTHONPATH_VALUE"
# Loop over the directory endings
for pycov_dir_ending in "${pycov_dir_endings[@]}"; do
pycov_src_path_ending=${pycov_dir_ending%%:*}
pycov_test_path_ending=${pycov_dir_ending#*:}
# Find all absolute src and test folders ending in the endings of interest
PYCOV_SRC_PATHS+=($(find . -path "*$pycov_src_path_ending" -exec readlink -f {} \; | grep -v build))
PYCOV_TEST_PATHS+=($(find . -path "*$pycov_test_path_ending" -exec readlink -f {} \; | grep -v build))
done
# Just display all the code coverage paths for debugging purposes
for ((index=0;index<${#PYCOV_SRC_PATHS[@]};++index)); do
pycov_src_path=${PYCOV_SRC_PATHS[index]}
pycov_test_path=${PYCOV_TEST_PATHS[index]}
echo -e "pycov_src_path = $pycov_src_path, pycov_test_path = $pycov_test_path"
done
fi
if [ $run_build -eq 1 ]; then
echo -e "\n********** Stage 2: Build **********\n"
mkdir -p $buildFolder
cd $buildFolder
extra_opts=""
if [ -n "$SW_VERSION" ]; then
extra_opts+=" -DSW_VERSION=${SW_VERSION}"
fi
# Add build options based on variant
if [ -n "$AIMET_VARIANT" ]; then
if [[ "$AIMET_VARIANT" == *"gpu"* ]]; then
extra_opts+=" -DENABLE_CUDA=ON"
fi
if [[ "$AIMET_VARIANT" == *"cpu"* ]]; then
extra_opts+=" -DENABLE_CUDA=OFF"
fi
if [[ "$AIMET_VARIANT" == *"tf"* ]]; then
extra_opts+=" -DENABLE_TENSORFLOW=ON"
fi
if [[ "$AIMET_VARIANT" == *"torch"* ]]; then
extra_opts+=" -DENABLE_TORCH=ON"
fi
if [[ "$AIMET_VARIANT" != *"tf"* ]]; then
extra_opts+=" -DENABLE_TENSORFLOW=OFF"
fi
if [[ "$AIMET_VARIANT" != *"torch"* ]]; then
extra_opts+=" -DENABLE_TORCH=OFF"
fi
fi
# Do not exit on failure by default from this point forward
set +e
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ${extra_opts} ..
make -j 8
check_stage $? "Build" "true"
echo -e "\n********** Stage 2a: Generate Docs **********\n"
make doc
check_stage $? "Generate Doc" "true"
fi
if [ $run_package_gen -eq 1 ]; then
cd $buildFolder
echo -e "\n********** Stage 2b: Install **********\n"
make install
check_stage $? "Install" "true"
echo -e "\n********** Stage 2c: Package **********\n"
make packageaimet
check_stage $? "Package" "true"
fi
if [ $run_unit_tests -eq 1 ]; then
echo -e "\n********** Stage 3: Unit tests **********\n"
cd $buildFolder
set +e
unit_test_cmd=""
if [[ -z ${DEPENDENCY_DATA_PATH} ]]; then
echo -e "DEPENDENCY_DATA_PATH was NOT set"
else
echo -e "DEPENDENCY_DATA_PATH was set to ${DEPENDENCY_DATA_PATH}"
unit_test_cmd+="export DEPENDENCY_DATA_PATH=${DEPENDENCY_DATA_PATH} && "
fi
unit_test_cmd+="export TORCH_HOME=${AIMET_TORCH_HOME} && ctest --verbose"
eval " $unit_test_cmd"
unit_test_rc=$?
python ${toolsFolder}/unittesthelper.py ${workspaceFolder}
check_stage $unit_test_rc "Unit tests" "false"
fi
if [ $run_code_violation -eq 1 ]; then
echo -e "\n********** Stage 4: Code violation checks **********\n"
cd $workspaceFolder
pylint_results_dir=$outputFolder/code_violation_result
mkdir -p ${pylint_results_dir}
for python_src_path in "${PYTHON_SRC_PATHS[@]}"; do
# Construct the pylint results file name
# Remove the top-level path from the full path for brevity
pylint_results_file_name=$(echo ${python_src_path#${workspaceFolder}/})
# Replace forward slashes with underscores
pylint_results_file_name=$(echo $pylint_results_file_name | sed -e 's/\//_/g')
# Append the suffix and extension
pylint_results_file_name+="_pylint_results.out"
LD_LIBRARY_PATH=$artifactsFolder:$LD_LIBRARY_PATH \
PYTHONPATH=$PYTHONPATH_VALUE \
PYLINTHOME=${buildFolder} \
pylint --rcfile=${workspaceFolder}/.pylintrc -r n --msg-template='{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}' ${python_src_path} 2>&1 \
| tee ${pylint_results_dir}/${pylint_results_file_name}
code_violation_result=$?
if [ $code_violation_result -eq 0 ]; then
if grep -q "error:" ${pylint_results_dir}/${pylint_results_file_name}; then
echo -e "\n********** ${python_src_path} code violation analysis results START **********\n"
cat ${pylint_results_dir}/${pylint_results_file_name}
echo -e "\n********** ${python_src_path} code violation analysis results END **********\n"
fi
fi
check_stage $code_violation_result "Code violation checks: ${python_src_path}" "false"
done
fi
if [ $run_static_analysis -eq 1 ]; then
echo -e "\n********** Stage 5: Static analysis **********\n"
static_analysis_result=0
clangtidy_results_dir=$outputFolder
mkdir -p ${clangtidy_results_dir}
#TODO: Do not fail from the static analysis command since there are many unresolved errors
set +e
cd $buildFolder; python3 /usr/bin/run-clang-tidy.py >| ${clangtidy_results_dir}/clang-tidy_results.out
static_analysis_result=$?
set -e
# Check for errors in static analysis log file and if found, display the log.
if grep -q "error:" "${clangtidy_results_dir}/clang-tidy_results.out"; then
static_analysis_result=1
echo -e "\n********** Static analysis results START **********\n"
cat ${clangtidy_results_dir}/clang-tidy_results.out
echo -e "\n********** Static analysis results END **********\n"
fi
check_stage $static_analysis_result "Static analysis" "false"
fi
if [ $run_acceptance_tests -eq 1 ]; then
echo -e "\n********** Stage 6: Acceptance tests **********\n"
cd $buildFolder
set +e
make AcceptanceTests
acceptance_test_rc=$?
python ${toolsFolder}/acceptancetesthelper.py ${workspaceFolder}
check_stage $acceptance_test_rc "Acceptance tests" "false"
fi
if [ $run_code_coverage -eq 1 ]; then
echo -e "\n********** Stage 7: Code coverage **********\n"
set +e
pycov_results_dir=$outputFolder/coverage_test_results
# Loop over the code coverage paths
for ((index=0;index<${#PYCOV_SRC_PATHS[@]};++index)); do
pycov_src_path=${PYCOV_SRC_PATHS[index]}
pycov_test_path=${PYCOV_TEST_PATHS[index]}
# Verify that the directories exist
if [ ! -d ${pycov_src_path} ] || [ ! -d ${pycov_test_path} ]; then
echo -e "\n[ERROR] Code coverage directories do not exist\n"
coverage_test_rc=1
fi
# Construct the code coverage results file name
# Remove the top-level path from the full path for brevity
pycov_results_file_name=$(echo ${pycov_src_path#${workspaceFolder}/})
# Replace forward slashes with underscores
pycov_results_file_name=$(echo $pycov_results_file_name | sed -e 's/\//_/g')
# Append the suffix and extension
pycov_results_file_name+="_code_coverage.xml"
# Run the code coverage
TORCH_HOME=${AIMET_TORCH_HOME} LD_LIBRARY_PATH=$artifactsFolder:$LD_LIBRARY_PATH PYTHONPATH=$PYTHONPATH_VALUE py.test --cov=${pycov_src_path} ${pycov_test_path} --cov-report xml:${pycov_results_dir}/${pycov_results_file_name}
coverage_test_rc=$?
cp -a ${pycov_results_dir}/${pycov_results_file_name} $outputFolder
done
check_stage $coverage_test_rc "Code coverage" "false"
fi
echo -e "\n outputFolder = ${outputFolder}"
if grep -q FAIL "${outputFolder}/summary.txt"; then
EXIT_CODE=3
fi
exit $EXIT_CODE