-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pipeline.sh
executable file
·492 lines (409 loc) · 13.9 KB
/
pipeline.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
#!/usr/bin/env bash
# -------------------------------------------------------------------------------- #
# Description #
# -------------------------------------------------------------------------------- #
# This script will locate and process all relevant files within the given git #
# repository. Errors will be stored and a final exit status used to show if a #
# failure occurred during the processing. #
# -------------------------------------------------------------------------------- #
# -------------------------------------------------------------------------------- #
# Configure the shell. #
# -------------------------------------------------------------------------------- #
set -Eeuo pipefail
# -------------------------------------------------------------------------------- #
# Global Variables #
# -------------------------------------------------------------------------------- #
# Are you using a perl based tool?
PERL_BASED_TOOL=false
# Are you using a python based tool?
PYTHON_BASED_TOOL=false
INSTALL_REQUIREMENTS=false
# Are you using a ruby gem based tool?
RUBY_GEM_BASED_TOOL=false
RUBY_GEM_NAME=''
# Are you using a docker based tool?
DOCKER_BASED_TOOL=true
DOCKER_CONTAINER='koalaman/shellcheck:stable'
DOCKER_CONTAINER_SHORT='shellcheck'
# How to install the require tool - eg gem install or pip install
INSTALL_COMMAND=('docker' 'pull' '--quiet' "${DOCKER_CONTAINER}")
# The specific command to run when running a test
TEST_COMMAND=('docker' 'run' '--rm' '-v' "${PWD}:/mnt" "${DOCKER_CONTAINER}")
# Version Banner - What to show on the version banned
BANNER_NAME="${DOCKER_CONTAINER_SHORT}"
# File type to match (comes from file -b) [Regex based]
FILE_TYPE_SEARCH_PATTERN='(shell|dash) script'
# File name to match [Regex based]
FILE_NAME_SEARCH_PATTERN='\.(sh|bash|dash|ksh)$'
# Set where to look for files.
SCAN_ROOT='.'
# -------------------------------------------------------------------------------- #
# Script Specific Global Variables #
# -------------------------------------------------------------------------------- #
#
# Add anything specific to this tool here
#
# -------------------------------------------------------------------------------- #
# Tool Specific Functions #
# -------------------------------------------------------------------------------- #
function handle_non_standard_parameters()
{
local parameters=false
local retval=0
if [[ "${parameters}" != true ]]; then
retval=1
fi
return "${retval}"
}
function check_file()
{
local filename=$1
local errors
file_count=$((file_count + 1))
# shellcheck disable=SC2310
if ! errors=$(run_command "${TEST_COMMAND[@]}" "${filename}"); then
fail "${filename}" "${errors}"
fail_count=$((fail_count + 1))
else
success "${filename}"
ok_count=$((ok_count + 1))
fi
}
# -------------------------------------------------------------------------------- #
# Stop Here #
# #
# Everything below here is standard and designed to work with all of the tools #
# that have been built and released as part of the CICDToolbox. #
# -------------------------------------------------------------------------------- #
EXIT_VALUE=0
CURRENT_STAGE=0
# -------------------------------------------------------------------------------- #
# Utility Functions #
# -------------------------------------------------------------------------------- #
function run_command()
{
local command=("$@")
if ! output=$("${command[@]}" 2>&1); then
echo "${output}"
return 1
fi
echo "${output}"
return 0
}
function stage()
{
local message=${1:-}
CURRENT_STAGE=$((CURRENT_STAGE + 1))
align_right "${bold_text}${cyan_text}Stage ${CURRENT_STAGE}: ${message}${reset}"
}
function success()
{
local message=${1:-}
echo " [ ${bold_text}${green_text}OK${reset} ] ${message}"
}
function fail()
{
local message=${1:-}
local errors=${2:-}
local override=${3:-false}
echo " [ ${bold_text}${red_text}FAIL${reset} ] ${message}"
if [[ "${SHOW_ERRORS}" == true || "${override}" == true ]]; then
if [[ -n "${errors}" ]]; then
echo
echo "${errors}" | while IFS= read -r err; do
echo " ${err}"
done
echo
fi
fi
EXIT_VALUE=1
}
function skip()
{
local message=${1:-}
if [[ "${SHOW_SKIPPED}" == true ]]; then
skip_count=$((skip_count + 1))
echo " [ ${bold_text}${yellow_text}Skip${reset} ] ${message}"
fi
}
function is_excluded()
{
local needle=$1
for pattern in "${exclude_list[@]}"; do
if [[ "${needle}" =~ ${pattern} ]]; then
return 0
fi
done
return 1
}
function is_included()
{
local needle=$1
for pattern in "${include_list[@]}"; do
if [[ "${needle}" =~ ${pattern} ]]; then
return 0
fi
done
return 1
}
function align_right()
{
local message=${1:-}
local offset=${2:-2}
local width=${screen_width}
local clean
clean=$(strip_colours "${message}")
local textsize=${#clean}
local left_line='-' left_width=$((width - (textsize + offset + 2)))
local right_line='-' right_width=${offset}
while ((${#left_line} < left_width)); do left_line+="${left_line}"; done
while ((${#right_line} < right_width)); do right_line+="${right_line}"; done
printf '%s %s %s\n' "${left_line:0:left_width}" "${message}" "${right_line:0:right_width}"
}
function strip_colours()
{
local orig=${1:-}
if ! shopt -q extglob; then
shopt -s extglob
local on=true
fi
local clean="${orig//$'\e'[\[(]*([0-9;])[@-n]/}"
[[ "${on}" == true ]] && shopt -u extglob
echo "${clean}"
}
# -------------------------------------------------------------------------------- #
# Core Functions #
# -------------------------------------------------------------------------------- #
function install_prerequisites()
{
local pip_update=('python' '-m' 'pip' 'install' '--quiet' '--upgrade' 'pip')
stage 'Install Prerequisites'
if [[ "${PYTHON_BASED_TOOL}" = true ]] ; then
# shellcheck disable=SC2310
if ! errors=$(run_command "${pip_update[@]}"); then
fail "${pip_update[*]}" "${errors}" true
exit "${EXIT_VALUE}"
else
success "${pip_update[*]}"
fi
fi
if [[ "${DOCKER_BASED_TOOL}" = true ]] ; then
# shellcheck disable=SC2310
if ! errors=$(run_command "${INSTALL_COMMAND[@]}"); then
fail "${INSTALL_COMMAND[*]}" "${errors}" true
exit "${EXIT_VALUE}"
else
success "${INSTALL_COMMAND[*]}"
fi
else
if ! "${TEST_COMMAND[@]}" --help &> /dev/null; then
# shellcheck disable=SC2310
if ! errors=$(run_command "${INSTALL_COMMAND[@]}"); then
fail "${INSTALL_COMMAND[*]}" "${errors}" true
exit "${EXIT_VALUE}"
else
success "${INSTALL_COMMAND[*]}"
fi
else
success "${TEST_COMMAND[*]} is already installed"
fi
fi
if [[ "${INSTALL_REQUIREMENTS}" = true ]] ; then
while IFS= read -r filename
do
CMD=("pip" "install" "-r" "${filename}")
# shellcheck disable=SC2310
if errors=$(run_command "${CMD[@]}" ); then
success "${CMD[*]}"
else
fail "${CMD[*]}" "${errors}" true
exit "${EXIT_VALUE}"
fi
done < <(find . -name 'requirements*.txt' -type f -not -path "./.git/*" | sed 's|^./||' | sort -Vf || true)
fi
}
function get_version_information()
{
local output
if [[ "${RUBY_GEM_BASED_TOOL}" = true ]] ; then
output=$(run_command gem list | grep "^${RUBY_GEM_NAME} " | sed 's/[^0-9.]*\([0-9.]*\).*/\1/')
elif [[ "${PYTHON_BASED_TOOL}" = true ]] ; then
output=$(run_command "${TEST_COMMAND[@]}" --version)
output=$(echo "${output}" | tr -d '\n' | head -n 1 | sed 's/[^0-9.]*\([0-9.]*\).*/\1/')
elif [[ "${DOCKER_BASED_TOOL}" = true ]] ; then
output=$(run_command docker run "${DOCKER_CONTAINER}" "${DOCKER_CONTAINER_SHORT}" --version)
output=$(echo "${output}" | tr -d '\n' | head -n 1 | sed 's/[^0-9.]*\([0-9.]*\).*/\1/')
elif [[ "${PERL_BASED_TOOL}" = true ]] ; then
output=$(run_command "${TEST_COMMAND[@]}" -e 'print substr($^V, 1)')
else
output=$(run_command "${TEST_COMMAND[@]}" --version)
output=$(echo "${output}" | tr -d '\n' | head -n 1 | sed 's/[^0-9.]*\([0-9.]*\).*/\1/')
fi
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
echo "Failed to get version information."
return 1
fi
VERSION="${output}"
BANNER="Run ${BANNER_NAME} (v${VERSION})"
}
function check()
{
local filename=$1
# shellcheck disable=SC2310
if is_included "${filename}"; then
check_file "${filename}"
return
fi
# shellcheck disable=SC2310
if is_excluded "${filename}"; then
skip "${filename}"
return
fi
if [[ "${#include_list[@]}" -ne 0 ]]; then
return
fi
check_file "${filename}"
}
function scan_files()
{
while IFS= read -r filename; do
if file -b "${filename}" | grep -qE "${FILE_TYPE_SEARCH_PATTERN}"; then
check "${filename}"
elif [[ "${filename}" =~ ${FILE_NAME_SEARCH_PATTERN} ]]; then
check "${filename}"
fi
done < <(find "${SCAN_ROOT}" -type f -not -path "./.git/*" | sed 's|^./||' | sort -Vf || true)
}
function handle_parameters()
{
stage "Parameters"
if [[ -n "${REPORT_ONLY-}" ]] && [[ "${REPORT_ONLY}" = true ]]; then
REPORT_ONLY=true
echo " Report Only: ${cyan_text}true${reset}"
parameters=true
else
REPORT_ONLY=false
fi
if [[ -n "${SHOW_ERRORS-}" ]] && [[ "${SHOW_ERRORS}" = false ]]; then
SHOW_ERRORS=false
echo " Show Errors: ${cyan_text}true${reset}"
parameters=true
else
SHOW_ERRORS=true
fi
if [[ -n "${SHOW_SKIPPED-}" ]] && [[ "${SHOW_SKIPPED}" == true ]]; then
SHOW_SKIPPED=true
echo " Show Skipped: ${cyan_text}true${reset}"
parameters=true
else
SHOW_SKIPPED=false
fi
if [[ -n "${INCLUDE_FILES-}" ]]; then
IFS=',' read -r -a include_list <<< "${INCLUDE_FILES}"
echo " Included Files: ${cyan_text}${INCLUDE_FILES}${reset}"
parameters=true
else
include_list=()
fi
if [[ -n "${EXCLUDE_FILES-}" ]] && [[ "${#include_list[@]}" -eq 0 ]]; then
IFS=',' read -r -a exclude_list <<< "${EXCLUDE_FILES}"
echo " Excluded Files: ${cyan_text}${EXCLUDE_FILES}${reset}"
parameters=true
else
exclude_list=()
fi
# shellcheck disable=SC2310
if handle_non_standard_parameters; then
parameters=true
fi
if [[ "${parameters}" != true ]]; then
echo " No parameters given"
fi
}
function handle_color_parameters()
{
if [[ -n "${NO_COLOR-}" ]]; then
if [[ "${NO_COLOR}" == true ]]; then
NO_COLOR=true
else
NO_COLOR=false
fi
else
NO_COLOR=false
fi
}
function footer()
{
stage 'Report'
echo " ${bold_text}Total${reset}: ${file_count}, ${bold_text}${green_text}OK${reset}: ${ok_count}, ${bold_text}${red_text}Failed${reset}: ${fail_count}, ${bold_text}${yellow_text}Skipped${reset}: ${skip_count}"
stage 'Complete'
}
function setup()
{
export TERM=xterm
handle_color_parameters
screen_width=0
# shellcheck disable=SC2034
bold_text=''
# shellcheck disable=SC2034
reset=''
# shellcheck disable=SC2034
black_text=''
# shellcheck disable=SC2034
red_text=''
# shellcheck disable=SC2034
green_text=''
# shellcheck disable=SC2034
yellow_text=''
# shellcheck disable=SC2034
blue_text=''
# shellcheck disable=SC2034
magenta_text=''
# shellcheck disable=SC2034
cyan_text=''
# shellcheck disable=SC2034
white_text=''
if [[ "${NO_COLOR}" == false ]]; then
screen_width=$(tput cols)
screen_width=$((screen_width - 2))
# shellcheck disable=SC2034
bold_text=$(tput bold)
# shellcheck disable=SC2034
reset=$(tput sgr0)
# shellcheck disable=SC2034
black_text=$(tput setaf 0)
# shellcheck disable=SC2034
red_text=$(tput setaf 1)
# shellcheck disable=SC2034
green_text=$(tput setaf 2)
# shellcheck disable=SC2034
yellow_text=$(tput setaf 3)
# shellcheck disable=SC2034
blue_text=$(tput setaf 4)
# shellcheck disable=SC2034
magenta_text=$(tput setaf 5)
# shellcheck disable=SC2034
cyan_text=$(tput setaf 6)
# shellcheck disable=SC2034
white_text=$(tput setaf 7)
fi
(( screen_width < 140 )) && screen_width=140
file_count=0
ok_count=0
fail_count=0
skip_count=0
parameters=false
}
# -------------------------------------------------------------------------------- #
# Main #
# -------------------------------------------------------------------------------- #
setup
handle_parameters
install_prerequisites
get_version_information
stage "${BANNER}"
scan_files
footer
[[ "${REPORT_ONLY}" == true ]] && EXIT_VALUE=0
exit "${EXIT_VALUE}"