forked from dnschneid/crouton
-
Notifications
You must be signed in to change notification settings - Fork 0
/
run.sh
executable file
·601 lines (549 loc) · 17.8 KB
/
run.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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
#!/bin/sh -e
# Copyright (c) 2016 The crouton Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
# Provides common functions and variables, then runs all of the tests in tests/
# Tests numbering is categorical in 10's by the following guide:
# 0*: meta-tests, e.g. tester
# 1*: core tests, e.g. basic, background, upgrade
# 3*: small-target/tech tests, e.g. cli-extra, audio
# 5*: DE tests, e.g. xfce, xbmc
# 9*: misc application tests, e.g. chrome
# Alphabetic tests are long, and not run by default:
# w*: Start all DE/wm, and take snapshots
# x*: Install test all targets that do not have tests
# Numbering within a category is arbitrary and can have overlaps.
# Tests are always run in alphanumeric order unless specified by parameters.
set -e
APPLICATION="${0##*/}"
SCRIPTDIR="`readlink -f -- "\`dirname "$0"\`/.."`"
# List of all supported (non-*'d) releases
SUPPORTED_RELEASES="`awk -F'|' '
($1 ~ /[a-z]$/ && $2 !~ /(^|,)notest($|,)/) || $2 ~ /(^|,)test($|,)/ \
{ sub(/[^a-z]*$/, "", $1); printf $1 " " }' \
"$SCRIPTDIR/installer/"*"/releases"`"
SUPPORTED_RELEASES="${SUPPORTED_RELEASES%" "}"
SUPPORTED_RELEASES_SET=''
# System info
SYSTEM="`awk -F= '/_RELEASE_DESCRIPTION=/ {print $2}' /etc/lsb-release`"
TESTDIR="$SCRIPTDIR/test/run"
TESTNAME="`sh -e "$SCRIPTDIR/build/genversion.sh" test`"
TESTDIR="$TESTDIR/$TESTNAME"
# PREFIX intentionally includes a space. Run in /usr/local to avoid encryption
PREFIXROOT="/usr/local/$TESTNAME prefix"
RELEASE=''
MAXTRIES=3
# Default: run 3 jobs in parallel
JOBS=3
USAGE="$APPLICATION [options] [test [...]]
Runs tests of the crouton infrastructure. Omitting specific tests will run all
of the numbered tests in sequence (unnumbered tests are skipped).
Alternatively, you can specify one or more test name prefixes that are matched
against the test names and run.
Tests are run out of a unique subdirectory in /usr/local, and the results are
stored in a unique subdirectory of $SCRIPTDIR/test/run
Options:
-j JOBS Number of tests to run in parallel. Default: $JOBS
-l LOGDIR Put test logs in the specified directory.
Default: $TESTDIR
-r RELEASE Specify a release to use whenever it shouldn't matter.
Default is a random supported release, considering -R.
-R RELEASES Limit the 'all supported releases' testing to a comma-separated
list of releases. Default: all supported releases are tested.
-T MAXTRIES Number of times to repeat a failed test (default: $MAXTRIES)"
# Common functions
. "$SCRIPTDIR/installer/functions"
# Process arguments
while getopts 'j:l:r:R:T:' f; do
case "$f" in
j) JOBS="$OPTARG";;
l) TESTDIR="${OPTARG%/}";;
r) RELEASE="$OPTARG";;
R) SUPPORTED_RELEASES="`echo "$OPTARG" | tr ',' ' '`";
SUPPORTED_RELEASES_SET='y';;
T) MAXTRIES="$OPTARG";;
\?) error 2 "$USAGE";;
esac
done
shift "$((OPTIND-1))"
# We need to run as root
if [ "$USER" != root -a "$UID" != 0 ]; then
error 2 "${0##*/} must be run as root."
fi
# Choose a random release to test when the release (shouldn't) matter
# This is a list: when a test fail on a given release, the next one is picked
if [ -z "$RELEASE" ]; then
RELEASE="`echo "$SUPPORTED_RELEASES" | tr ' ' "\n" | sort -R | tr "\n" ' '`"
fi
echo "Running tests in $PREFIXROOT" 1>&2
echo "Logging to $TESTDIR" 1>&2
echo "System: $SYSTEM" 1>&2
echo "Supported releases: $SUPPORTED_RELEASES" 1>&2
echo "Default release for this run: ${RELEASE%% *}" 1>&2
# Logs all output to the specified file with the date and time prefixed.
# File is always appended. Use "log" to output a line with a [t] prefix.
# $1: log file or directory
# $2: script to source, run, and log
# $3: release to run the test on
# $4: number of attempts so far
logto() {
local file="$1" line='{print strftime("%F %T: ") $0}'
shift
if [ -d "$file" ]; then
file="$file/log"
fi
local testlog="$file-test"
date "+%F %T: BEGIN TEST ${1##*/}.$2.$3" | tee -a "$file" "$testlog" 1>&2
local start="`date '+%s'`"
local retpreamble="${1##*/}.$2.$3 finished with exit code"
local AWK='mawk -W interactive'
# srand() uses system time as seed but returns previous seed. Call it twice.
((((ret=0; TRAP=''
(
PREFIX="`mktemp -d --tmpdir="$PREFIXROOT" "$tname.XXX"`"
# Remount noexec/etc to make the environment as harsh as possible
mount --bind "$PREFIX" "$PREFIX"
mount -i -o remount,nosuid,nodev,noexec "$PREFIX"
# Get subshell pid
pid="`sh -c 'echo $PPID'`"
# Clean up on exit
settrap "
set -x
echo Running trap...
if [ -d '$PREFIX/chroots' ]; then
sh -e '$SCRIPTDIR/host-bin/unmount-chroot' \
-a -f -y -c '$PREFIX/chroots'
fi
# Kill any leftover subprocess
pkill -9 -P '$pid'
umount -l '$PREFIX'
rm -rf --one-file-system '$PREFIX'
"
release="$2" . "$1"
) </dev/null 3>&- || ret=$?
sleep 1
if [ "$ret" = 0 ]; then
log "TEST PASSED: $retpreamble $ret"
else
log "TEST FAILED: $retpreamble $ret"
fi
) | $AWK '{srand(); print (srand()-'"$start"') " [i] " $0}' 1>&3
) 2>&1 | $AWK '{srand(); print (srand()-'"$start"') " [e] " $0}' 1>&3
) 9>&1 | $AWK '{srand(); print (srand()-'"$start"') " [t] " $0}' \
| tee -a "$testlog" 1>&3
) 3>> "$file"
# Output the return and relay success
tail -n1 "$testlog" | tee /dev/stderr | grep -q "$retpreamble 0\$"
}
# Outputs a line to the log with a [t] prefix.
# Either specify the text as a parameter, or stdin if no parameters are given.
log() {
if [ "$#" != 0 ]; then
echo "$*" 1>&9
else
cat 1>&9
fi
}
# Tests and outputs success or failure. Parameters are the same as "test".
# Returns 1 on failure
test() {
if [ "$@" ]; then
log "PASS: [ $* ]"
return 0
else
log "FAIL: [ $* ]"
return 1
fi
}
# Returns a temporary file in the prefix, so you don't have to clean it up
# $1 (optional): specify a prefix
tmpfile() {
mktemp --tmpdir="$PREFIX" "${1:-tmp}.XXXXXX"
}
# Launches the installer with the specified parameters; auto-includes -p
# If -T is the first parameter, passes stdin into /prepare.sh
# -T auto-depends on core if -U or -u is not specified.
crouton() {
local ret='0' tfile=''
if [ "$1" = '-T' ]; then
shift
local param='' requires='core'
for param in "$@"; do
if [ "$param" = '-U' -o "$param" = '-u' ]; then
requires=''
break
fi
done
tfile="`mktemp --tmpdir="$PREFIX" target.XXXXXX`"
{
echo "REQUIRES='$requires'"'
. "${TARGETSDIR:="$PWD"}/common"
### Append to prepare.sh:
set -x'
cat
echo '
set +x'
} > "$tfile"
fi
log "LAUNCHING: crouton${tfile:+" -T "}$tfile $*"
if [ -n "$tfile" ]; then
log "BEGIN $tfile CONTENTS"
cat "$tfile" | log
log "END $tfile CONTENTS"
sh -e "$SCRIPTDIR/installer/main.sh" -T "$tfile" -p "$PREFIX" "$@" \
|| ret="$?"
else
sh -e "$SCRIPTDIR/installer/main.sh" -p "$PREFIX" "$@" || ret="$?"
fi
if [ -n "$tfile" ]; then
rm -f "$tfile"
fi
if [ "$ret" = 0 ]; then
log "PASS: crouton $*"
else
log "FAIL with code $ret: crouton $*"
fi
return "$ret"
}
# Downloads a bootstrap if not done already and returns the tarball.
# Safe to run in parallel.
# $1: the release to bootstrap
# returns the path on stdout.
bootstrap() {
local file="$PREFIXROOT/$1-bootstrap.tar.gz"
echo "$file"
# Use flock so that bootstrap can be called in parallel
if ! flock -n 4; then
log "Waiting for bootstrap for $1 to complete..."
flock 4
elif [ ! -s "$file" ]; then
crouton -r "$1" -f "$file" -d 1>&2
fi 4>>"$file"
if [ ! -s "$file" ]; then
log "FAIL due to incomplete bootstrap for $1"
return 1
fi
}
# Downloads and installs a basic chroot with the specified targets, then backs
# it up for quicker test starts. Safe to run in parallel; takes advantage of
# bootstraps as well.
# $1: the release to install
# $2: comma-separated list of targets. defaults to 'core'
# $3: name of the chroot to extract to; default is the release name
snapshot() {
local targets="${2:-core}"
local file="$PREFIXROOT/$1-$targets-snapshot.tar.gz"
local name="${3:-"$1"}"
# Use flock so that snapshot can be called in parallel
if ! flock -n 4; then
log "Waiting for snapshot for $1-$targets to complete..."
flock 4
elif [ ! -s "$file" ]; then
crouton -f "`bootstrap "$1"`" -t "$targets" -n "$name" 1>&2
host edit-chroot -y -b -f "$file" "$name"
return 0
fi 4>>"$file"
# Restore the snapshot into place
crouton -f "$file" -n "$name"
}
# Runs a host command with the specified parameters
# $1 command to run (enter-chroot, etc)
# $2+ parameters
host() {
local cmd="$1" ret='0'
shift
log "LAUNCHING: $cmd $*"
sh -e "$PREFIX/bin/$cmd" "$@" || ret="$?"
if [ "$ret" = 0 ]; then
log "PASS: $cmd $*"
else
log "FAIL with code $ret: $cmd $*"
fi
return "$ret"
}
# Returns success if command exits with code X within Y seconds
# If the command takes longer than Y seconds, kills it with SIGTERM
# $1 exit code to expect
# $2 number of seconds within which the command should exit
# $3+ command to run
exitswithin() {
local code="$1" seconds="$2" ret=0
shift 2
log "Expecting '$*' to exit with code $code within $seconds seconds"
"$@" &
local pid="$!"
(sleep "$seconds" && exec kill -TERM "$pid") &
local sleepid="$!"
wait "$pid" || ret="$?"
sleep .1
if kill "$sleepid" 2>/dev/null; then
if [ "$ret" = "$code" ]; then
log "PASS: '$*' exited with code $ret within $seconds seconds"
else
log "FAIL: '$*' exited with code $ret instead of $code"
return 1
fi
else
log "FAIL: '$*' took more than $seconds seconds to exit"
return 2
fi
return 0
}
# Returns success if command runs longer than X seconds; exit code is ignored
# If the command survives longer than X seconds, kills it with SIGINT
# $1 number of seconds the command should survive
# $2+ command to run
runslongerthan() {
local seconds="$1" ret=0
shift
log "Expecting '$*' to survive longer than $seconds seconds"
"$@" &
local pid="$!"
(sleep "$seconds" && exec kill -INT "$pid") &
local sleepid="$!"
wait "$pid" || ret="$?"
sleep .1
if kill "$sleepid" 2>/dev/null; then
log "FAIL: '$*' did not survive at least $seconds seconds (returned $ret)"
return 2
else
log "PASS: '$*' survived for $seconds seconds (returned $ret)"
fi
return 0
}
# Expects a successful return code from the provided command.
passes() {
log "Expecting '$*' to succeed"
local ret=0
"$@" || ret=$?
if [ "$ret" = 0 ]; then
log "PASS: '$*' succeeded"
else
log "FAIL: '$*' returned $ret"
return "$ret"
fi
return 0
}
# Expects a failure return code from the provided command.
fails() {
log "Expecting '$*' to fail"
local ret=0
"$@" || ret=$?
if [ "$ret" != 0 ]; then
log "PASS: '$*' returned $ret"
else
log "FAIL: '$*' succeeded"
return 1
fi
return 0
}
# Sources a function from a script for unit testing.
# Note that the function may need global variables defined when run.
# Usage:
# from scriptfile import functionA[[,] functionB]*
# scriptfile should be tarball-relative, i.e., host-bin/mount-chroot
from() {
local scriptpath="$SCRIPTDIR/$1" scriptfile="$1" name script
if [ "$2" != 'import' -o -z "$3" ]; then
echo " $*
SyntaxError: invalid syntax" 1>&2
return 2
fi
if [ ! -f "$scriptpath" ]; then
echo "ImportError: No module named $scriptfile" 1>&2
return 2
fi
shift 2
for name in "$@"; do
name="${name%,}"
script="`awk '
/^'"$name"'[(][)] {$/ {x=1}
x;
x && /^}$/ {exit}
' "$scriptpath"`"
if [ -z "$script" ]; then
echo "ImportError: cannot import name $name" 1>&2
return 2
fi
log "Importing $name from $scriptfile"
eval "$script"
done
return 0
}
# Ensures only one test can play with graphics at one time
# Run it without parameters, in a subshell. The lock will be released when
# the subshell exits
vtlock() {
local vtlockfile='/var/lock/croutonvt'
exec 4>>"$vtlockfile"
if ! flock -n 4; then
log 'Waiting for VT lock...'
flock 4
fi
}
# Runs the provided command under vtlock
vtlockrun() {
(
vtlock
"$@" || return $?
)
}
# Default responses to questions
export CROUTON_USERNAME='test'
export CROUTON_PASSPHRASE='hunter2'
export CROUTON_NEW_PASSPHRASE="$CROUTON_PASSPHRASE"
export CROUTON_EDIT_RESPONSE='y'
export CROUTON_MOUNT_RESPONSE='y'
export CROUTON_UNMOUNT_RESPONSE='y'
# Test machines lack entropy: Use /dev/urandom instead of /dev/random
export CROUTON_WEAK_RANDOM='y'
# HACK: restart debugd when running tests to avoid namespace issues.
# This will go away when we start using mount namespaces.
export CROUTON_UNMOUNT_RESTART_DEBUGD='y'
# Prevent powerd from sleeping the system
sh -e "$SCRIPTDIR/chroot-bin/croutonpowerd" -i &
croutonpowerd="$!"
# Run all the tests
mkdir -p "$TESTDIR" "$PREFIXROOT"
addtrap "echo 'Cleaning up...' 1>&2
pkill debootstrap 2>/dev/null
kill \$jobpids 2>/dev/null
for pid in \$jobpids; do
wait \$pid 2>/dev/null
done
for m in '$PREFIXROOT/'*; do
if [ -d \"\$m/chroots\" ]; then
sh -e '$SCRIPTDIR/host-bin/unmount-chroot' -a -y -c \"\$m/chroots\"
fi
if mountpoint -q \"\$m\"; then
umount -l \"\$m\" 2>/dev/null
fi
done
rm -rf --one-file-system '$PREFIXROOT'
kill '$croutonpowerd' 2>/dev/null"
# If no arguments were passed, match all numbered tests
if [ "$#" = 0 ]; then
set -- 0 1 2 3 4 5 6 7 8 9
fi
jobpids=''
fail=0
# Waits for there to be fewer than $1 jobs running. Reads and updates $jobpids.
# If $1 is omitted, uses $JOBS
# If 0 is specified, assumes 1
waitjobs() {
local j=0
while [ -n "$jobpids" -a "$j" -le 0 ]; do
j="${1:-"$JOBS"}"
if [ "$j" -lt 1 ]; then
j=1
fi
local newjobpids='' pid
for pid in $jobpids; do
if kill -0 "$pid" 2>/dev/null; then
j="$((j-1))"
newjobpids="$newjobpids $pid"
else
# Grab the return code
if ! wait "$pid"; then
fail="$((fail+1))"
fi
fi
done
jobpids="${newjobpids# }"
sleep 1
done
}
# Queue format: "test file|release|number of tries
# Make sure QUEUELOCK is held when modifying QUEUEFILE
QUEUEFILE="`tmpfile queue`"
QUEUEFILETMP="`tmpfile queuetmp`"
QUEUELOCK="`tmpfile queuelock`"
# Add all tests matching the supplied prefixes to the queue (random order)
tname=''
for p in "$@"; do
for t in "$SCRIPTDIR/test/tests/$p"*; do
if [ ! -s "$t" -o "${t%~}" != "$t" ]; then
continue
fi
# When $release is blank, the tests output a list of supported releases,
# that is intersected with $SUPPORTED_RELEASES. Also, "all" indicates
# that all releases are supported, and "default" indicates that only a
# default release should be tested
testrel=""
for rel in `release="" . "$t"`; do
for sup in $SUPPORTED_RELEASES; do
if [ "$rel" = "all" -o "$rel" = "$sup" ]; then
echo "$t|$sup|0"
fi
done
# default is translated later
if [ "$rel" = "default" ]; then
echo "$t|default|0"
fi
done
done
done | sort -u | sort -R > "$QUEUEFILE"
if [ ! -s "$QUEUEFILE" ]; then
echo "No tests found matching $*" 1>&2
exit 2
fi
# Start jobs from the queue
while true; do
# Wait for a free slot (max $JOBS at a time)
waitjobs
if [ ! -s "$QUEUEFILE" ]; then
if [ -z "$jobpids" ]; then
break
fi
# Queue empty, but jobs are still running, check again in a while.
sleep 10
continue
fi
job="`(
flock 3
head -n 1 "$QUEUEFILE"
tail -n +2 "$QUEUEFILE" > "$QUEUEFILETMP"
mv "$QUEUEFILETMP" "$QUEUEFILE"
) 3>"$QUEUELOCK"`"
if [ -z "$job" ]; then
continue
fi
# Split job line
t="${job%%|*}"
job="${job#$t|}"
jobrel="${job%%|*}"
job="${job#$jobrel|}"
try="${job%%|*}"
# jobrel is the release indicated in the job line (can be default)
# rel is an actual release
if [ "$jobrel" = "default" ]; then
# Select element $try in $RELEASE (wrap around)
rel="`echo "$RELEASE" | awk '{x=('"$try"'%NF)+1; print $x; exit}'`"
else
rel="$jobrel"
fi
tname="${t##*/}.$rel.$try"
# Run the test
(
if ! logto "$TESTDIR/$tname" "$t" "$rel" "$try"; then
if [ "$((try+1))" -lt "$MAXTRIES" ]; then
# Test failed, try again...
(
flock 3
echo "$t|$jobrel|$((try+1))" >> "$QUEUEFILE"
) 3>"$QUEUELOCK"
else
exit 1
fi
fi
) &
jobpids="$jobpids${jobpids:+" "}$!"
done
# Clean up /var/run/crouton
rm -rf --one-file-system /var/run/crouton || true
if [ "$fail" -gt 0 ]; then
echo "$fail test(s) failed." 1>&2
exit 1
else
echo "All tests passed." 1>&2
fi