]> mj.ucw.cz Git - eval.git/blob - bin/lib
Introduced extension aliases.
[eval.git] / bin / lib
1 # The Evaluator -- Shell Function Library
2 # (c) 2001--2008 Martin Mares <mj@ucw.cz>
3
4 # General settings
5 shopt -s dotglob
6
7 # Logging functions.
8 # File handles used: fd1=log, fd2=progress
9
10 function log-init
11 {
12         exec >>$TDIR/log
13         HAVE_LOG=1
14 }
15
16 function pstart
17 {
18         echo >&2 -n "$@"
19 }
20
21 function pcont
22 {
23         echo >&2 -n "$@"
24 }
25
26 function pend
27 {
28         echo >&2 "$@"
29 }
30
31 function die
32 {
33         # Report an internal error
34         echo >&2 "$@"
35         [ -n "$HAVE_LOG" ] && echo "Fatal error: $@"
36         exit 2
37 }
38
39 function fatal
40 {
41         # Report a fatal error in the program being tested
42         echo >&2 "$@"
43         [ -n "$HAVE_LOG" ] && echo "Fatal error: $@"
44         exit 1
45 }
46
47 function try-ln
48 {
49         ln $1 $2 2>/dev/null || cp $1 $2
50 }
51
52 # Expand occurrences of `$var' in a given variable
53
54 function expand-var
55 {
56         eval echo ${!1}
57 }
58
59 # Given a <prefix>, override each variable <x> by <prefix>_<x>
60
61 function override-vars
62 {
63         local OR V W
64         declare -a OR
65         # `${!${1}_@}' does not work, so we have to use eval
66         OR=($(eval echo '${!'$1'_@}'))
67         for V in "${OR[@]}" ; do
68                 W=${V##$1_}
69                 eval $W='"$'$V'"'
70         done
71 }
72
73 # Sandbox subroutines
74
75 function box-init
76 {
77         pstart "Preparing sandbox... "
78         if [ -z "$TEST_USER" -o "$TEST_USER" == $EVAL_USER ] ; then
79                 pcont "running locally (INSECURE), "
80                 TEST_USER=$EVAL_USER
81                 BOXDIR=`pwd`/box
82                 BOXCMD=bin/box
83                 mkdir -p box
84         else
85                 pcont "used account $TEST_USER, "
86                 BOXDIR=$MO_ROOT/eval/$TEST_USER
87                 BOXCMD=bin/box-$TEST_USER
88         fi
89         [ -d $BOXDIR -a -f $BOXCMD ] || die "Sandbox set up incorrectly"
90         BOXCMD="$BOXCMD -c$BOXDIR"
91         echo "Sandbox directory: $BOXDIR"
92         echo "Sandbox command: $BOXCMD"
93         box-clean
94         pend "OK"
95 }
96
97 function box-clean
98 {
99         [ -n "$BOXCMD" ] || die "box-init not called"
100         rm -rf $BOXDIR/*
101 }
102
103 # Initialization of testing directories
104
105 function dir-init
106 {
107         pstart "Initializing... "
108         HDIR=.
109         PDIR=problems/$PROBLEM
110         SDIR=solutions/$CONTESTANT/$PROBLEM
111         TDIR=testing/$CONTESTANT/$PROBLEM
112         TMPDIR=tmp
113         [ -d $PDIR ] || die "Problem $PROBLEM not known"
114         [ -d $SDIR ] || fatal "Solution of $PROBLEM not found"
115         mkdir -p $TDIR $TMPDIR
116         rm -rf $TDIR $TMPDIR
117         mkdir -p $TDIR $TMPDIR
118         cat >$TDIR/log <<EOF
119 Testing solution of $PROBLEM by $CONTESTANT
120 Test started at `date`
121 Contestant's solution directory: $SDIR
122 Problem directory: $PDIR
123 Testing directory: $TDIR
124 EOF
125         pend "OK"
126 }
127
128 # Locate source file.
129 # If no parameter is given, locate it in SDIR and return name as SRCN and extension as SRCEXT
130 # Or a file name can be given and then SDIR, SRCN and SRCEXT are set.
131 # Beware, SDIR and SRCN can contain spaces and other strange user-supplied characters.
132
133 function locate-source
134 {
135         pstart "Finding source... "
136         local SBASE
137         if [ -n "$1" ] ; then
138                 SDIR=`dirname "$1"`
139                 local S=`basename "$1"`
140                 SBASE=$(echo "$S" | sed 's/\.\([^.]\+\)//')
141                 SRCEXT=$(echo "$S" | sed '/\./!d; s/.*\.\([^.]\+\)/\1/')
142                 if [ -n "$SRCEXT" ] ; then
143                         # Full name given, so just check the extension and existence
144                         SRCN="$S"
145                         [ -f "$SDIR/$SRCN" ] || die "Cannot find source file $SDIR/$SRCN"
146                         SRCEXT_OK=
147                         for a in $EXTENSIONS ; do
148                                 if [ $a == $SRCEXT ] ; then
149                                         pend $SDIR/$SRCN
150                                         echo "Explicitly set source file: $SDIR/$SRCN"
151                                         return 0
152                                 fi
153                         done
154                         die "Unknown extension .$SRCEXT"
155                 fi
156         else
157                 SBASE=$PROBLEM
158         fi
159         for a in $EXTENSIONS ; do
160                 if [ -f "$SDIR/$SBASE.$a" ] ; then
161                         [ -z "$SRCN" ] || die "Multiple source files found: $SDIR/$PROBLEM.$a and $SDIR/$SRCN. Please fix."
162                         SRCN="$SBASE.$a"
163                         SRCEXT=$a
164                 fi
165         done
166         [ -n "$SRCN" ] || fatal "NOT FOUND"
167         pend $SRCN
168         echo "Found source file: $SDIR/$SRCN"
169 }
170
171 # Compilation (compile SDIR/SRCN with PDIR/COMP_EXTRAS to EXE=TDIR/PROBLEM)
172
173 function compile
174 {
175         pstart "Compiling... "
176
177         a="ALIAS_EXT_$SRCEXT"
178         if [ -n "${!a}" ] ; then
179                 SRCEXT="${!a}"
180                 echo "Normalized file extension: $SRCEXT"
181         fi
182         override-vars "EXT_$SRCEXT"
183
184         # Beware, the original SRCN can be a strange user-supplied name
185         SRC=$PROBLEM.$SRCEXT
186         cp "$SDIR/$SRCN" $TDIR/$SRC
187         if [ -n "$COMP_EXTRAS" ] ; then
188                 echo "Extras: $COMP_EXTRAS"
189                 for a in $COMP_EXTRAS ; do cp $PDIR/$a $TDIR/ ; done
190         fi
191
192         box-clean
193         for a in $SRC $COMP_EXTRAS ; do cp $TDIR/$a $BOXDIR/ ; done
194         EXE=$PROBLEM
195         CCMD=$(expand-var COMP)
196         COMP_SANDBOX_OPTS=$(expand-var COMP_SANDBOX_OPTS)
197         echo "Compiler command: $CCMD"
198         echo "Compiler sandbox options: $COMP_SANDBOX_OPTS"
199         eval $COMP_SANDBOX_INIT
200
201         echo "Compiler input files:"
202         ls -Al $BOXDIR
203         echo "Compiler output:"
204         if ! $BOXCMD $COMP_SANDBOX_OPTS -- $CCMD 2>$TDIR/compile.out ; then
205                 COMPILE_MSG="`cat $TDIR/compile.out`"
206                 pend "FAILED: $COMPILE_MSG"
207                 echo "$COMPILE_MSG"
208                 return 1
209         fi
210         cat $TDIR/compile.out
211         rm $TDIR/compile.out
212         echo "Compiler output files:"
213         ls -Al $BOXDIR
214         if [ ! -f $BOXDIR/$PROBLEM ] ; then
215                 pend "FAILED: Missing executable file"
216                 echo "Missing executable file"
217                 return 1
218         fi
219         EXE=$TDIR/$PROBLEM
220         cp -a $BOXDIR/$PROBLEM $EXE
221         echo "Compiled OK, result copied to $EXE"
222         pend "OK"
223 }
224
225 # Running of test program according to current task type (returns exit code and TEST_MSG)
226
227 function test-config
228 {
229         [ -f $PDIR/$TEST.config ] && . $PDIR/$TEST.config
230         override-vars "TEST_$TEST"
231 }
232
233 function test-run
234 {
235         test-run-$TASK_TYPE
236 }
237
238 function test-result
239 {
240         P=$1
241         M=$2
242         if [ -s $TDIR/$TEST.pts ] ; then
243                 P=`cat $TDIR/$TEST.pts`
244                 rm $TDIR/$TEST.pts
245         fi
246
247         # Translate signal numbers to readable strings
248         SG=${M#Caught fatal signal }
249         SG=${SG#Committed suicide by signal }
250         if [ "$SG" != "$M" ] ; then
251                 SG=`perl -MConfig -e '@s=split / /,$Config{sig_name}; print $s[$ARGV[0]]' $SG`
252                 [ -z "$SG" ] || M="$M (SIG$SG)"
253         fi
254
255         # Translate runtime errors to readable strings
256         RE=${M#Exited with error status }
257         if [ -n "$EXIT_CODE_HOOK" -a "$RE" != "$M" ] ; then
258                 NEWMSG=`$EXIT_CODE_HOOK $RE`
259                 if [ -n "$NEWMSG" ] ; then
260                         M="Runtime error $RE: $NEWMSG"
261                 fi
262         fi
263
264         echo "Verdict: $M"
265         echo "Points: $P"
266         test-verdict $P "$M"
267 }
268
269 function test-prolog
270 {
271         pcont "<init> "
272         box-clean
273         echo "Executable file: $TDIR/$PROBLEM"
274         if [ ! -x $TDIR/$PROBLEM ] ; then
275                 test-result 0 "Compile error"
276         fi
277         cp $TDIR/$PROBLEM $BOXDIR/
278         BOX_EXTRAS=
279         IN_TYPE=${IN_TYPE:-$IO_TYPE}
280         OUT_TYPE=${OUT_TYPE:-$IO_TYPE}
281         case $IN_TYPE in
282                 file)   echo "Input file: $PROBLEM.in (from $PDIR/$TEST.in)"
283                         try-ln $PDIR/$TEST.in $TDIR/$TEST.in
284                         cp $PDIR/$TEST.in $BOXDIR/$PROBLEM.in
285                         [ $TASK_TYPE == interactive ] || BOX_EXTRAS="$BOX_EXTRAS -i/dev/null"
286                         ;;
287                 stdio)  echo "Input file: <stdin> (from $PDIR/$TEST.in)"
288                         try-ln $PDIR/$TEST.in $TDIR/$TEST.in
289                         cp $PDIR/$TEST.in $BOXDIR/.stdin
290                         BOX_EXTRAS="$BOX_EXTRAS -i.stdin"
291                         ;;
292                 none)   echo "Input file: <none>"
293                         ;;
294                 *)      die "Unknown IN_TYPE $IN_TYPE"
295                         ;;
296         esac
297         if [ -n "$EV_PEDANT" -a $IN_TYPE != none ] ; then
298                 pcont "<pedant> "
299                 if [ "$EV_PEDANT" = 1 ] ; then
300                         EV_PEDANT=" "
301                 fi
302                 bin/pedant <$TDIR/$TEST.in >$TDIR/$TEST.pedant $EV_PEDANT
303                 if [ -s $TDIR/$TEST.pedant ] ; then
304                         pend
305                         sed 's/^/\t/' <$TDIR/$TEST.pedant >&2
306                         pstart -e '\t'
307                 fi
308         fi
309         case $OUT_TYPE in
310                 file)   echo "Output file: $PROBLEM.out"
311                         [ $TASK_TYPE == interactive ] || BOX_EXTRAS="$BOX_EXTRAS -o/dev/null"
312                         ;;
313                 stdio)  echo "Output file: <stdout>"
314                         BOX_EXTRAS="$BOX_EXTRAS -o.stdout"
315                         ;;
316                 none)   echo "Output file: <none>"
317                         ;;
318                 *)      die "Unknown OUT_TYPE $OUT_TYPE"
319                         ;;
320         esac
321         echo "Timeout: $TIME_LIMIT s"
322         echo "Memory: $MEM_LIMIT KB"
323         eval $SANDBOX_INIT
324         echo "Sandbox contents before start:"
325         ls -Al $BOXDIR
326 }
327
328 function test-epilog
329 {
330         echo "Sandbox contents after exit:"
331         ls -Al $BOXDIR
332         case ${OUT_TYPE:-$IO_TYPE} in
333                 file)   [ -f $BOXDIR/$PROBLEM.out ] || test-result 0 "No output file"
334                         cp $BOXDIR/$PROBLEM.out $TDIR/$TEST.out
335                         ;;
336                 stdio)  [ -f $BOXDIR/.stdout ] || test-result 0 "No output file"
337                         cp $BOXDIR/.stdout $TDIR/$TEST.out
338                         ;;
339         esac
340
341         if [ -n "$OUTPUT_FILTER" -a "$OUT_TYPE" != none -a -z "$EV_NOFILTER" ] ; then
342                 pcont "<filter> "
343                 FILTER=$(expand-var OUTPUT_FILTER)
344                 echo "Output filter command: $FILTER"
345                 mv $TDIR/$TEST.out $TDIR/$TEST.raw
346                 if ! eval $FILTER 2>$TMPDIR/exec.out ; then
347                         cat $TMPDIR/exec.out
348                         MSG=`tail -1 $TMPDIR/exec.out`
349                         if [ -z "$MSG" ] ; then MSG="Filter failed" ; fi
350                         test-result 0 "$MSG"
351                 fi
352                 cat $TMPDIR/exec.out
353         fi
354 }
355
356 # Running of test program with file input/output
357
358 function test-run-file
359 {
360         test-prolog
361         pcont "<run> "
362         BOXOPTS=$(expand-var TEST_SANDBOX_OPTS)
363         echo "Sandbox options: $BOXOPTS"
364         if ! $BOXCMD $BOXOPTS -- ./$PROBLEM 2>$TMPDIR/exec.out ; then
365                 cat $TMPDIR/exec.out
366                 MSG=`tail -1 $TMPDIR/exec.out`
367                 test-result 0 "$MSG"
368         fi
369         cat $TMPDIR/exec.out
370         test-epilog
371 }
372
373 # Running of interactive test programs
374
375 function test-run-interactive
376 {
377         test-prolog
378         pcont "<run> "
379         BOXOPTS=$(expand-var TEST_SANDBOX_OPTS)
380         echo "Sandbox options: $BOXOPTS"
381         ICCMD=$(expand-var IA_CHECK)
382         echo "Interactive checker: $ICCMD"
383         if ! $HDIR/bin/iwrapper $BOXCMD $BOXOPTS -- ./$PROBLEM @@ $ICCMD 2>$TMPDIR/exec.out ; then
384                 cat $TMPDIR/exec.out
385                 MSG="`head -1 $TMPDIR/exec.out`"
386                 test-result 0 "$MSG"
387         fi
388         cat $TMPDIR/exec.out
389         test-epilog
390 }
391
392 # "Running" of open-data problems
393
394 function test-run-open-data
395 {
396         [ -f $SDIR/$TEST.out ] || test-result 0 "No solution"
397         ln $SDIR/$TEST.out $TDIR/$TEST.out
398 }
399
400 # Syntax checks
401
402 function syntax-check
403 {
404         [ -n "$SYNTAX_CHECK" ] || return 0
405         [ -z "$EV_NOCHECK" ] || return 0
406         pcont "<syntax> "
407         SCHECK=$(expand-var SYNTAX_CHECK)
408         echo "Syntax check command: $SCHECK"
409         if ! eval $SCHECK 2>$TMPDIR/exec.out ; then
410                 cat $TMPDIR/exec.out
411                 MSG=`tail -1 $TMPDIR/exec.out`
412                 if [ -z "$MSG" ] ; then MSG="Wrong syntax" ; fi
413                 test-result 0 "$MSG"
414         fi
415         cat $TMPDIR/exec.out
416 }
417
418 # Output checks
419
420 function output-check
421 {
422         MSG=
423         if [ -n "$OUTPUT_CHECK" -a "$OUT_TYPE" != none -a -z "$EV_NOCHECK" ] ; then
424                 pcont "<check> "
425                 [ -f $PDIR/$TEST.out ] && ln $PDIR/$TEST.out $TDIR/$TEST.ok
426                 OCHECK=$(expand-var OUTPUT_CHECK)
427                 echo "Output check command: $OCHECK"
428                 if ! eval $OCHECK 2>$TMPDIR/exec.out ; then
429                         cat $TMPDIR/exec.out
430                         MSG=`tail -1 $TMPDIR/exec.out`
431                         if [ -z "$MSG" ] ; then MSG="Wrong answer" ; fi
432                         test-result 0 "$MSG"
433                 fi
434                 cat $TMPDIR/exec.out
435                 MSG=`tail -1 $TMPDIR/exec.out`
436         fi
437         if [ -z "$MSG" ] ; then MSG="OK" ; fi
438         test-result $POINTS_PER_TEST "$MSG"
439 }
440
441 # Setup of public commands
442
443 function public-setup
444 {
445         HDIR=$MO_ROOT
446         PDIR=$MO_ROOT/problems/$PROBLEM
447         SDIR=.
448         TDIR=~/.test
449         TMPDIR=~/.test
450         [ -d $PDIR ] || die "Unknown problem $PROBLEM"
451
452         pstart "Initializing... "
453         mkdir -p $TDIR
454         rm -rf $TDIR/*
455         BOXDIR=~/.box
456         mkdir -p $BOXDIR
457         rm -rf $BOXDIR/*
458         BOXCMD="$MO_ROOT/bin/box -c$BOXDIR"
459         exec >check-log
460         pend "OK  (see 'check-log' for details)"
461 }
462
463 # Locate output of open data problem, test case TEST
464 # Beware, SDIR and SRCN can contain spaces and other strange user-supplied characters.
465
466 function open-locate
467 {
468         [ -f $PDIR/$TEST.in ] || die "Unknown test $TEST"
469         if [ -n "$1" ] ; then
470                 SDIR=`dirname "$1"`
471                 SRCN=`basename "$1"`
472         else
473                 SRCN=$SDIR/$PROBLEM$TEST.out
474         fi
475         [ -f "$SDIR/$SRCN" ] || fatal "Output file $SRCN not found"
476 }
477
478 # Translation of runtime error codes for various compilers
479
480 function fpc-exit-code
481 {
482         case "$1" in
483                 200)    echo -n "Division by zero" ;;
484                 201)    echo -n "Range check error" ;;
485                 202)    echo -n "Stack overflow" ;;
486                 203)    echo -n "Heap overflow" ;;
487                 205)    echo -n "Floating point overflow" ;;
488                 215)    echo -n "Arithmetic overflow" ;;
489                 216)    echo -n "Segmentation fault" ;;
490         esac
491 }