forked from canonical/snapd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
run-checks
executable file
·446 lines (392 loc) · 14.6 KB
/
run-checks
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
#!/bin/bash -eu
export LANG=C.UTF-8
export LANGUAGE=en
if command -v goctest >/dev/null; then
goctest="goctest"
else
goctest="go test"
fi
COVERMODE=${COVERMODE:-atomic}
COVERAGE_SUFFIX=${GO_BUILD_TAGS:-notags}
COVERAGE_OUT=${COVERAGE_OUT:-.coverage/coverage-$COVERAGE_SUFFIX.cov}
CHANGED_FILES=${CHANGED_FILES:-""}
if [ -z "${GITHUB_WORKFLOW:-}" ]; then
# when *not* running inside github, ensure we use go-1.18 by default
export PATH=/usr/lib/go-1.18/bin:"${PATH}"
fi
# add workaround for https://github.com/golang/go/issues/24449
if [ "$(uname -m)" = "s390x" ]; then
if go version | grep -q go1.10; then
echo "covermode 'atomic' crashes on s390x with go1.10, reseting "
echo "to 'set'. see https://github.com/golang/go/issues/24449"
COVERMODE="set"
fi
fi
# If GOPATH is set in the shell environment, the path will be reflected
# in $(go env GOPATH). If no shell path was set, Go will default the internal
# GOPATH to $HOME/go. Note that GOPATH may contain a colon delimited set
# of paths, so in order to run any binary from any of the installed GOPATHs
# we must add all the possible bin locations.
GOBINS=$(go env GOPATH | sed 's|:|/bin:|g' | sed 's|.*|\0/bin|g')
export PATH="$PATH:$GOBINS"
short=
STATIC=
UNIT=
case "${1:-all}" in
all)
STATIC=1
UNIT=1
;;
--static)
STATIC=1
;;
--unit)
UNIT=1
;;
--short-unit)
UNIT=1
short=1
;;
*)
echo "Wrong flag ${1}. To run a single suite use --static, --unit."
exit 1
esac
CURRENTTRAP="true"
EXIT_CODE=99
store_exit_code() {
EXIT_CODE=$?
}
exit_with_exit_code() {
exit $EXIT_CODE
}
addtrap() {
CURRENTTRAP="$CURRENTTRAP ; $1"
# shellcheck disable=SC2064
trap "store_exit_code; $CURRENTTRAP ; exit_with_exit_code" EXIT
}
goinstall() {
pkg="$1"
version="${2:-}"
# go1.18+ will no longer build/install packages. Here "go install"
# must be used but it will only fetch remote packages if the @latest
# (or similar syntax is used). Instead of checking the version we
# check if the "go install" help mentions this new feature.
if go help install | grep -q @latest; then
go install "${pkg}"@"${version:=latest}"
else
go get -u "${pkg}"@"${version:=latest}"
fi
}
endmsg() {
if [ $EXIT_CODE -eq 0 ]; then
p="success.txt"
m="All good, what could possibly go wrong."
else
p="failure.txt"
m="Crushing failure and despair."
fi
echo
if [ -t 1 ] && [ -z "$STATIC" ]; then
cat "data/$p"
else
echo "$m"
fi
}
addtrap endmsg
missing_interface_spread_test() {
snap_yaml="tests/lib/snaps/test-snapd-policy-app-consumer/meta/snap.yaml"
core_snap_yaml="tests/main/interfaces-many-snap-provided/test-snapd-policy-app-provider-core/meta/snap.yaml"
classic_snap_yaml="tests/main/interfaces-many-snap-provided/test-snapd-policy-app-provider-classic/meta/snap.yaml"
for iface in $(go run ./tests/lib/list-interfaces.go) ; do
search="plugs: \\[ $iface \\]"
case "$iface" in
bool-file|gpio|pwm|dsp|netlink-driver|hidraw|i2c|iio|serial-port|spi)
# skip gadget provided interfaces for now
continue
;;
dbus|content)
search="interface: $iface"
;;
autopilot)
search='plugs: \[ autopilot-introspection \]'
;;
esac
if ! grep -q "$search" "$snap_yaml" ; then
echo "Missing high-level test for interface '$iface'. Please add to:"
echo "* $snap_yaml"
echo "* $core_snap_yaml (if needed)"
echo "* $classic_snap_yaml (if needed)"
exit 1
fi
done
}
if [ "$STATIC" = 1 ]; then
./get-deps.sh
# Run static tests.
echo Checking docs
./mdlint.py ./*.md ./**/*.md
# XXX: remove once we can use an action, see workflows/test.yaml for
# details why we still use this script
if [ -n "${GITHUB_PULL_REQUEST:-}" ] && [ "${GITHUB_PULL_REQUEST:-}" != "false" ]; then
echo Checking pull request summary
./check-pr-title.py "$GITHUB_PULL_REQUEST"
fi
# check commit author/committer name for unicode
./check-commit-email.py
if [ -z "${SKIP_GOFMT:-}" ]; then
echo Checking formatting
fmt=""
for dir in $(go list -f '{{.Dir}}' ./... | grep -v '/\(c-\)\?vendor/' ); do
# skip vendor packages
s="$(${GOFMT:-gofmt} -s -d "$dir" || true)"
if [ -n "$s" ]; then
fmt="$s\\n$fmt"
fi
done
if [ -n "$fmt" ]; then
echo "Formatting wrong in following files:"
# shellcheck disable=SC2001
echo "$fmt" | sed -e 's/\\n/\n/g'
exit 1
fi
fi
# go vet
echo Running vet
go list ./... | grep -v '/vendor/' | xargs go vet
echo 'Checking for usages of http.Status*'
got=""
for dir in $(go list -f '{{.Dir}}' ./... | grep -v '/vendor/' ); do
s="$(grep -nP 'http\.Status(?!Text)' "$dir"/*.go || true)"
if [ -n "$s" ]; then
got="$s\\n$got"
fi
done
if [ -n "$got" ]; then
echo 'Usages of http.Status*, we prefer the numeric values directly:'
echo "$got"
exit 1
fi
echo "Checking for direct usages of math/rand"
got=""
for dir in $(go list -f '{{.Dir}}' ./... | grep -v '/vendor/' ); do
# shellcheck disable=SC2063
s="$(grep -nP --exclude '*_test.go' --exclude 'randutil/*.go' math/rand "$dir"/*.go || true)"
if [ -n "$s" ]; then
got="$s\\n$got"
fi
done
if [ -n "$got" ]; then
echo 'Direct usages of math/rand, we prefer randutil:'
echo "$got"
exit 1
fi
echo "Checking for usages of deprecated io/ioutil"
got=""
for dir in $(go list -f '{{.Dir}}' ./... | grep -v '/vendor/' ); do
# shellcheck disable=SC2063
s="$(grep -nP io/ioutil "$dir"/*.go || true)"
if [ -n "$s" ]; then
got="$s\\n$got"
fi
done
if [ -n "$got" ]; then
echo 'Found usages of deprecated io/ioutil, please use "io" or "os" equivalents'
echo "$got"
exit 1
fi
if command -v shellcheck >/dev/null; then
exclude_tools_path=tests/lib/external/snapd-testing-tools
echo "Checking shell scripts..."
if [ -n "$CHANGED_FILES" ]; then
echo "Checking just the changed bash files"
echo "Changed files: $CHANGED_FILES"
# shellcheck disable=SC2086
INITIAL_FILES="$( file -N $CHANGED_FILES | awk -F": " '$2~/shell.script/{print $1}' )"
else
echo "Checking all the bash files"
INITIAL_FILES="$( ( git ls-files -z 2>/dev/null || find . \( -name .git -o -name vendor -o -name c-vendor \) -prune -o -print0) | xargs -0 file -N | awk -F": " '$2~/shell.script/{print $1}' )"
fi
echo "Filtering files"
FILTERED_FILES=
for file in $INITIAL_FILES; do
if ! echo "$file" | grep -q "$exclude_tools_path"; then
FILTERED_FILES="$FILTERED_FILES $file"
fi
done
if [ -n "$FILTERED_FILES" ]; then
echo "Running shellcheck for files: $FILTERED_FILES"
# shellcheck disable=SC2086
shellcheck -x $FILTERED_FILES
else
echo "Skipping shellcheck, no files to check"
fi
regexp='GOPATH(?!%%:\*)(?!:)[^= ]*/'
if grep -qPr --exclude HACKING.md --exclude 'Makefile.*' --exclude-dir .git --exclude-dir vendor "$regexp"; then
echo "Using GOPATH as if it were a single entry and not a list:"
grep -PHrn -C1 --color=auto --exclude HACKING.md --exclude 'Makefile.*' --exclude-dir .git --exclude-dir vendor "$regexp"
echo "Use GOHOME, or {GOPATH%%:*}, instead."
exit 1
fi
unset regexp
# also run spread-shellcheck
FILTERED_FILES="spread.yaml"
if [ -n "$CHANGED_FILES" ]; then
# shellcheck disable=SC2086
for changed_file in $CHANGED_FILES; do
if [[ $changed_file == */task.yaml ]]; then
FILTERED_FILES="$FILTERED_FILES $(pwd)/$changed_file"
fi
done
else
FILTERED_FILES="$FILTERED_FILES tests"
fi
# XXX: exclude core20-preseed test as its environment block confuses shellcheck, and it's not possible to disable shellcheck there.
# shellcheck disable=SC2086
./tests/lib/external/snapd-testing-tools/utils/spread-shellcheck $FILTERED_FILES --exclude "$exclude_tools_path" --exclude "tests/nested/manual/core20-preseed"
fi
if [ -z "${SKIP_MISSPELL-}" ]; then
echo "Checking spelling errors"
if ! command -v misspell >/dev/null; then
goinstall github.com/client9/misspell/cmd/misspell
fi
# FIXME: auter is only misspelled in the changelog so we should fix there
# PROCES is used in the seccomp tests (PRIO_PROCES{,S,SS})
# exportfs is used in the nfs-support test
# becuase because of misspell in upstream steam rules (PR#12657)
MISSPELL_IGNORE="auther,PROCES,PROCESSS,proces,processs,exportfs,becuase"
git ls-files -z -- . ':!:./po' ':!:./vendor' ':!:./c-vendor' ':!:./cmd/libsnap-confine-private/bpf/vendor' |
xargs -0 misspell -error -i "$MISSPELL_IGNORE"
fi
if [ -z "${SKIP_INEFFASSIGN-}" ]; then
if dpkg --compare-versions "$(go version | awk '$3 ~ /^go[0-9]/ {print substr($3, 3)}')" ge 1.12; then
echo "Checking for ineffective assignments"
if ! command -v ineffassign >/dev/null; then
goinstall github.com/gordonklaus/ineffassign
fi
# ineffassign knows about ignoring vendor/ \o/
ineffassign ./...
fi
fi
echo "Checking for naked returns"
if ! command -v nakedret >/dev/null; then
goinstall github.com/alexkohler/nakedret v1.0.1
fi
got=$(go list ./... | grep -v '/osutil/udev/' | grep -v '/vendor/' | xargs nakedret 2>&1)
if [ -n "$got" ]; then
echo "$got"
if [ -z "${SKIP_NAKEDRET:-}" ]; then
exit 1
else
echo "Ignoring nakedret errors as requested"
fi
fi
echo "Checking all interfaces have minimal spread test"
missing_interface_spread_test
echo "Checking for incorrect multiline strings in spread tests"
badmultiline=$(find tests -name 'task.yaml' -print0 -o -name 'spread.yaml' -print0 | \
xargs -0 grep -R -n -E '(restore*|prepare*|execute|debug):\s*$' || true)
if [ -n "$badmultiline" ]; then
echo "Incorrect multiline strings at the following locations:"
echo "$badmultiline"
exit 1
fi
echo "Checking for potentially incorrect use of MATCH -v"
badMATCH=$(find tests -name 'task.yaml' -print0 -o -name 'spread.yaml' -print0 | \
xargs -0 grep -R -n -E 'MATCH +-v' || true)
if [ -n "$badMATCH" ]; then
echo "Potentially incorrect use of MATCH -v at the following locations:"
echo "$badMATCH"
exit 1
fi
# FIXME: re-add staticcheck with a matching version for the used go-version
if [ -z "${SKIP_TESTS_FORMAT_CHECK-}" ] || [ "$SKIP_TESTS_FORMAT_CHECK" = 0 ]; then
CHANGED_TESTS=""
FILTERED_TESTS=""
EXCLUDE_PATH=tests/lib/external/snapd-testing-tools
if [ -n "$CHANGED_FILES" ]; then
# shellcheck disable=SC2086
for changed_file in $CHANGED_FILES; do
if [[ $changed_file == */task.yaml ]]; then
CHANGED_TESTS="$CHANGED_TESTS $changed_file"
fi
done
fi
# shellcheck disable=SC2086
for test in $CHANGED_TESTS; do
if ! echo "$test" | grep -q "$EXCLUDE_PATH"; then
if [ -z "$FILTERED_TESTS" ]; then
FILTERED_TESTS="$test"
else
FILTERED_TESTS="$FILTERED_TESTS $test"
fi
fi
done
echo "Checking tests formatting"
if [ -n "$FILTERED_TESTS" ]; then
# shellcheck disable=SC2086
./tests/lib/external/snapd-testing-tools/utils/check-test-format --tests $FILTERED_TESTS
fi
fi
echo "Checking for usages of !=, == or Equals with ErrNoState"
if got=$(grep -n -R -E "(\!=|==|Equals,) (state\.)?ErrNoState" --include=*.go) ; then
echo "Don't use equality checks with ErrNoState, use errors.Is() instead"
echo "$got"
exit 1
fi
fi
if [ "$UNIT" = 1 ]; then
./get-deps.sh
echo "Show go version"
command -v go
go version
tags=
if [ -n "${GO_BUILD_TAGS-}" ]; then
echo "Using build tags: $GO_BUILD_TAGS"
tags="-tags $GO_BUILD_TAGS"
fi
echo Building
# shellcheck disable=SC2086
go build -v $tags github.com/snapcore/snapd/...
# tests
echo Running tests from "$PWD"
if [ "$short" = 1 ]; then
# shellcheck disable=SC2046,SC2086
GOTRACEBACK=1 $goctest $tags -short -timeout 5m $(go list ./... | grep -v '/vendor/' )
else
coverage=""
if [ -z "${SKIP_COVERAGE-}" ]; then
coverage="-coverprofile=$COVERAGE_OUT -covermode=$COVERMODE"
# Prepare the coverage output profile.
mkdir -p "$(dirname "$COVERAGE_OUT")"
echo "mode: $COVERMODE" > "$COVERAGE_OUT"
else
echo "Skipping test coverage"
fi
# shellcheck disable=SC2046,SC2086
GOTRACEBACK=1 $goctest $tags -timeout 5m $coverage $(go list ./... | grep -v '/vendor/' )
fi
# python unit test for mountinfo.query and version-compare
command -v python2 && python2 ./tests/lib/tools/mountinfo.query --run-unit-tests
command -v python3 && python3 ./tests/lib/tools/mountinfo.query --run-unit-tests
command -v python2 && python2 ./tests/lib/tools/version-compare --run-unit-tests
command -v python3 && python3 ./tests/lib/tools/version-compare --run-unit-tests
command -v pytest-3 && PYTHONDONTWRITEBYTECODE=1 pytest-3 ./release-tools
fi
UNCLEAN="$(git status -s|grep '^??')" || true
SKIP_UNCLEAN=${SKIP_UNCLEAN=}
if [ -n "$UNCLEAN" ] && [ -z "$SKIP_UNCLEAN" ]; then
cat <<EOF
There are files left in the git tree after the tests:
$UNCLEAN
EOF
exit 1
fi
if [ -n "${SKIP_DIRTY_CHECK-}" ]; then
exit 0
fi
# XXX: re-enable after vendor/vendor.json is removed
# if git describe --always --dirty | grep -q dirty; then
# echo "Build tree is dirty"
# git diff
# exit 1
# fi