2 # This file is part of NIT ( http://www.nitlanguage.org ).
4 # Copyright 2004-2008 Jean Privat <jean@pryen.org>
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
18 # This shell script compile, run and verify Nit program files
20 # Set lang do default to avoid failed tests because of locale
23 export NIT_TESTING
=true
24 # Use the pid as a collision prevention
25 export NIT_TESTING_ID
=$$
30 # Get the first Java lib available
31 if which_java
=$
(which javac
2>/dev
/null
); then
32 JAVA_HOME
=$
(dirname $
(dirname $
(readlink
-f
"$which_java")))
35 paths
=`echo $JAVA_HOME/jre/lib/*/{client,server}/libjvm.so`
37 JNI_LIB_PATH
=`dirname ${paths[0]}`
44 # User CPU time limit (in seconds)
45 # Is used to avoid to CPU intensive test (infinite loops). See ulimit -t
46 usertimelimit
=600 # 1 CPU minute
48 # Real-time limit (in seconds)
49 # Is used to avoid waiting or sleeping tests.
50 # Require timeout or timelimit, or else is not used.
51 realtimelimit
=300 # 5 min
53 # User limit for write files (in kilo-bytes)
54 # Is used to avoid execution that loop and fill the hard drive. See ulimit -f
55 # Note that a test might require a lot of temporary disk space (eg. nitc+gcc)
56 filelimit
=100000 # ~100MB
58 # Limit (in bytes) for generated .res file.
59 # Larger ones are truncated and will fail tests
60 # Is used to avoid processing huge crappy res file (diff, xml, etc)
61 reslimit
=100000 # ~100KB
67 Usage
: $e [options
] modulenames
68 -o option Pass option to the engine
69 -v Verbose
(show tests steps
)
71 --engine Use a specific engine
(default
=nitc
)
72 --noskip Do not skip a
test even
if the .skip
file matches
73 --outdir Use a specific output folder
(default
=out
/)
74 --compdir Use a specific temporary compilation folder
(default
=$compdir)
75 --node Run as a node
in parallel
, will not output context information
76 --autosav Copy the .res files directly
in the sav folder overriding existing .res files
80 # Run a command with a timeout and a time count.
82 # -o file write the user time into file (REQUIRED). see `-o` in `man time`
83 # -a append the time to the file (instead of overwriting it). see `-a` in `man time`
89 while [ $stop = false
]; do
91 -o
) o
="$2"; shift; shift;;
97 ulimit -f
"$filelimit" 2> /dev
/null
98 ulimit -t
"$usertimelimit" 2> /dev
/null
101 elif test -n
"$TIME"; then
102 $TIME -o
"$o" $a $TIMEOUT "$@"
104 if test -n
"$a"; then echo 0 >> "$o"; else echo 0 > "$o"; fi
110 # Output a timestamp attribute for XML, or an empty line
113 if test -n
"$TIMESTAMP"; then
114 echo "timestamp='`$TIMESTAMP`'"
121 # Get platform specific commands ##########################
123 # Detect a working timeout
124 if sh
-c
"timelimit echo" 1>/dev
/null
2>&1; then
125 TIMEOUT
="timelimit -t $realtimelimit"
126 elif sh
-c
"timeout 1 echo" 1>/dev
/null
2>&1; then
127 TIMEOUT
="timeout ${realtimelimit}s"
129 echo "No timelimit or timeout command detected. Tests may hang :("
132 # Detect a working time command
133 if command time --quiet
-f
%e true
2>/dev
/null
; then
134 TIME
="command time --quiet -f%e"
135 elif command time -f
%e true
2>/dev
/null
; then
136 TIME
="command time -f%e"
137 elif command gtime
-f
%e true
2>/dev
/null
; then
138 TIME
="command gtime -f%e"
143 # Detect a working date command
144 if date -Iseconds
>/dev
/null
2>&1; then
145 TIMESTAMP
="date -Iseconds"
150 # Detect a working hostname command
151 if hostname
--version
2>&1 |
grep coreutils
>/dev
/null
2>&1; then
154 HOSTNAME
="hostname -s"
157 UNAME
=`uname | sed s/-.*//`
159 # $1 is the pattern of the test
160 # $2 is the file to compare to
162 # 0: if the file to compare to do not exists
163 # 1: if the file match
164 # 2: if the file match with soso
165 # 3: if the file do not match
166 function compare_to_result
()
170 if [ ! -r
"$sav" ]; then return 0; fi
171 test "`cat -- "$sav"`" = "UNDEFINED" && return 1
172 diff -u
--strip
-trailing
-cr
-- "$sav" "$outdir/$pattern.res" > "$outdir/$pattern.diff.sav.log"
173 if [ "$?" == 0 ]; then
176 sed '/[Ww]arning/d;/[Ee]rror/d' "$outdir/$pattern.res" > "$outdir/$pattern.res2"
177 sed '/[Ww]arning/d;/[Ee]rror/d' "$sav" > "$outdir/$pattern.sav2"
178 grep '[Ee]rror' "$outdir/$pattern.res" >/dev
/null
&& echo "Error" >> "$outdir/$pattern.res2"
179 grep '[Ee]rror' "$sav" >/dev
/null
&& echo "Error" >> "$outdir/$pattern.sav2"
180 diff -u
--strip
-trailing
-cr
"$outdir/$pattern.sav2" "$outdir/$pattern.res2" > "$outdir/$pattern.diff.sav.log2"
181 if [ "$?" == 0 ]; then
190 sed 's/&/\&/g; s/</\</g; s/>/\>/g; s/"/\"/g; s/'"'"'/\'/g'<<EOF
195 # As argument: the pattern used for the file
196 function process_result
()
214 # Truncate too big res file
215 local size
=$
(wc -c
< "$outdir/$pattern.res")
216 if test -n
"$reslimit" -a
"$size" -gt
"$reslimit"; then
217 # The most portable way to truncate a file is with Perl
218 perl
-e
"truncate \"$outdir/$pattern.res\", $reslimit;"
219 echo "***TRUNCATED***" >> "$outdir/$pattern.res"
222 echo >>$xml "<testcase classname='`xmlesc "$pack"`' name='`xmlesc "$description"`' time='`cat -- "$outdir/$pattern.
time.out
"`' `timestamp`>"
223 #for sav in "sav/$engine/fixme/$pattern.res" "sav/$engine/$pattern.res" "sav/fixme/$pattern.res" "sav/$pattern.res" "sav/$pattern.sav"; do
224 for savdir
in $savdirs; do
225 local sav
=$savdir/fixme
/$pattern.res
226 compare_to_result
"$pattern" "$sav"
236 if [ -z
"$FIRST" ]; then
243 if [ -z
"$FIRST" ]; then
251 sav
=$savdir/$pattern.res
252 compare_to_result
"$pattern" "$sav"
262 if [ -z
"$FIRST" ]; then
269 if [ -z
"$FIRST" ]; then
277 OLD
=`echo "$OLD" | sed -e 's/ */ /g' -e 's/^ //' -e 's/ $//'`
278 istodo
"$outdir/$pattern.res"
280 if [ -n
"$SAV" ]; then
281 if [ -n
"$OLD" ]; then
282 echo "[*ok*] $outdir/$pattern.res $SAV - but $OLD remains!"
283 echo >>$xml "<error message='`xmlesc "ok
$outdir/$pattern.res
- but
$OLD remains
"`'/>"
284 remains
="$remains $OLD"
285 test "$autosav" = "true" && rm "$OLD"
287 echo "[ok] $outdir/$pattern.res $SAV"
290 elif [ -n
"$FIXME" ]; then
291 if [ -n
"$OLD" ]; then
292 echo "[*fixme*] $outdir/$pattern.res $FIXME - but $OLD remains!"
293 echo >>$xml "<error message='`xmlesc "ok
$outdir/$pattern.res
- but
$OLD remains
"`'/>"
294 remains
="$remains $OLD"
295 test "$autosav" = "true" && rm "$OLD"
297 echo "[fixme] $outdir/$pattern.res $FIXME"
298 echo >>$xml "<skipped/>"
300 todos
="$todos $pattern"
301 elif [ "x$NYI" = "x0" ]; then
302 echo "[todo] $outdir/$pattern.res -> not yet implemented"
303 echo >>$xml "<skipped/>"
304 todos
="$todos $pattern"
305 elif [ -n
"$SOSO" ]; then
306 echo "[======= soso $outdir/$pattern.res $SOSO =======]"
307 echo >>$xml "<error message='`xmlesc "soso
$outdir/$pattern.res
$SOSO"`'/>"
308 echo >>$xml "<system-out><![CDATA["
309 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
310 echo >>$xml "]]></system-out>"
312 echo "$ii" >> "$ERRLIST"
313 test "$autosav" = "true" && cp "$outdir/$pattern.res" "$SOSO"
314 elif [ -n
"$SOSOF" ]; then
315 echo "[======= fixme soso $outdir/$pattern.res $SOSOF =======]"
316 echo >>$xml "<error message='`xmlesc "soso
$outdir/$pattern.res
$SOSO"`'/>"
317 echo >>$xml "<system-out><![CDATA["
318 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
319 echo >>$xml "]]></system-out>"
321 echo "$ii" >> "$ERRLIST"
322 test "$autosav" = "true" && cp "$outdir/$pattern.res" && "$SOSO"
323 elif [ -n
"$NSAV" ]; then
324 echo "[======= fail $outdir/$pattern.res $NSAV =======]"
325 echo >>$xml "<error message='`xmlesc "fail
$outdir/$pattern.res
$NSAV"`'/>"
326 echo >>$xml "<system-out><![CDATA["
327 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
328 echo >>$xml "]]></system-out>"
330 echo "$ii" >> "$ERRLIST"
331 test "$autosav" = "true" && cp "$outdir/$pattern.res" "$NSAV"
332 elif [ -n
"$NFIXME" ]; then
333 echo "[======= changed $outdir/$pattern.res $NFIXME ======]"
334 echo >>$xml "<error message='`xmlesc "changed
$outdir/$pattern.res
$NFIXME"`'/>"
335 echo >>$xml "<system-out><![CDATA["
336 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
337 echo >>$xml "]]></system-out>"
339 echo "$ii" >> "$ERRLIST"
340 test "$autosav" = "true" && cp "$outdir/$pattern.res" "$NFIXME"
341 elif [ -s
"$outdir/$pattern.res" ]; then
342 echo "[=== no sav ===] $outdir/$pattern.res is not empty"
343 echo >>$xml "<error message='no sav and not empty'/>"
344 echo >>$xml "<system-out><![CDATA["
345 cat -v
>>$xml -- "$outdir/$pattern.res"
346 echo >>$xml "]]></system-out>"
348 echo "$ii" >> "$ERRLIST"
349 test "$autosav" = "true" && cp "$outdir/$pattern.res" "sav/"
351 # no sav but empty res
352 echo "[0k] $outdir/$pattern.res is empty"
355 if test -s
"$outdir/$pattern.cmp.err"; then
356 echo >>$xml "<system-err><![CDATA["
357 cat -v
>>$xml -- "$outdir/$pattern.cmp.err"
358 echo >>$xml "]]></system-err>"
360 echo >>$xml "</testcase>"
365 test "$noskip" = true
&& return 1
366 if echo "$1" |
grep -f
"$engine.skip" >/dev
/null
2>&1; then
368 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
371 if test -n
"$isinterpret" && echo "$1" |
grep -f
"exec.skip" >/dev
/null
2>&1; then
372 echo "=> $2: [skip exec]"
373 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
378 local os_skip_file
=$UNAME.skip
379 if test -e
$os_skip_file && echo "$1" |
grep -f
"$os_skip_file" >/dev
/null
2>&1; then
380 echo "=> $2: [skip os]"
381 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
386 local host_skip_file
=`$HOSTNAME`.skip
387 if test -e
$host_skip_file && echo "$1" |
grep -f
"$host_skip_file" >/dev
/null
2>&1; then
388 echo "=> $2: [skip hostname]"
389 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
397 test "$noskip" = true
&& return 1
398 for savdir
in $savdirs .
; do
399 local f
="$savdir/exec.skip"
400 test -f
"$f" ||
continue
401 if echo "$1" |
grep -f
"$f" >/dev
/null
2>&1; then
402 echo -n
"_ no exec by $f; "
411 test "$noskip" = true
&& return 1
412 for savdir
in $savdirs .
; do
413 local f
="$savdir/cc.skip"
414 test -f
"$f" ||
continue
415 if echo "$1" |
grep -f
"$f" >/dev
/null
2>&1; then
422 # Check that the resfile ($1) matches some magic strings in `todo` files.
425 test "$no" = true
&& return 1
426 for savdir
in $savdirs .
; do
427 local f
="$savdir/todo"
428 test -f
"$f" ||
continue
429 if grep -f
"$f" "$1" >/dev
/null
2>&1; then
438 local name
="$enginebinname"
439 local recent
=`ls -t ../src/$name ../src/$name_[0-9] ../bin/$name ../contrib/nitin/bin/$name ../c_src/$name 2>/dev/null | head -1`
440 if [[ "x$recent" == "x" ]]; then
441 echo "Could not find binary for engine $engine, aborting"
444 if [ "x$isnode" = "xfalse" ]; then
445 echo "Found binary for engine $engine: $recent $OPT"
457 while [ $stop = false
]; do
459 -o
) OPT
="$OPT $2"; shift; shift;;
460 -v
) verbose
=true
; shift;;
462 --engine
) engine
="$2"; shift; shift;;
463 --noskip
) noskip
=true
; shift;;
464 --outdir
) outdir
="$2"; shift; shift;;
465 --compdir
) compdir
="$2"; shift; shift;;
466 --node
) isnode
=true
; shift;;
467 --autosav
) autosav
=true
; shift;;
471 enginebinname
=$engine
478 OPT
="--separate $OPT --compile-dir $compdir"
479 savdirs
="sav/nitc-common/"
484 OPT
="--separate $OPT --compile-dir $compdir"
485 savdirs
="sav/nitc-common/"
490 OPT
="--erasure $OPT --compile-dir $compdir"
491 savdirs
="sav/nitc-common/"
496 OPT
="--semi-global $OPT --compile-dir $compdir"
497 savdirs
="sav/nitc-common/"
502 OPT
="--global $OPT --compile-dir $compdir"
503 savdirs
="sav/nitc-common/"
525 OPT
="--compile-dir $compdir --ant"
527 savdirs
="sav/nitc-common/"
531 OPT
="-m emscripten_nodejs.nit --semi-global $OPT --compile-dir $compdir"
532 savdirs
="sav/nitcsg/"
535 echo "unknown engine $engine"
540 savdirs
="sav/`$HOSTNAME` sav/$UNAME sav/$engine $savdirs sav/"
542 # The default nitc compiler
543 [ -z
"$NITC" ] && find_nitc
545 # Set NIT_DIR if needed
546 [ -z
"$NIT_DIR" ] && export NIT_DIR
=..
548 # Mark to distinguish files among tests
556 # CLEAN the out directory
557 rm -rf
"$outdir/" 2>/dev
/null
558 mkdir
"$outdir" 2>/dev
/null
560 # File where error tests are outputed
561 # Old ERRLIST is backuped
562 ERRLIST
=${ERRLIST:-errlist}
563 ERRLIST_TARGET
=$ERRLIST
565 # Initiate new ERRLIST
566 if [ "x$ERRLIST" = "x" ]; then
577 if [ "x$XMLDIR" = "x" ]; then
578 xml
="tests-$engine.xml"
580 sum=`echo $@ | md5sum | cut -f1 -d " "`
581 xml
="$XMLDIR/tests-$engine-$sum.xml"
585 echo >$xml "<testsuites><testsuite>"
588 if [ ! -f
"$ii" ]; then
589 echo "File '$ii' does not exist."
592 f
=`basename -- "$ii" .nit`
594 pack
="tests.${engine}".
`echo $ii | perl -p -e 's|^../([^/]*)/([a-zA-Z_]*).*|\1.\2| || s|^([a-zA-Z]*)[^_]*_([a-zA-Z]*).*|\1.\2| || s|\W*([a-zA-Z_]*).*|\1|'`
596 # Sould we skip the file for this engine?
597 need_skip
"$f" "$f" "$pack" && continue
599 local_tmp
=${ii/../AA}
600 if [ "x$local_tmp" = "x$ii" ]; then
601 includes
="-I . -I ../lib/core -I ../lib/core/collection -I alt"
606 for i
in "$ii" `./alterner.pl --start '#' --altsep '_' -- "$ii"`; do
607 bf
=`basename -- "$i" .nit`
610 # Sould we skip the alternative for this engine?
611 need_skip
"$bf" "$bf" "$pack" && continue
615 if [ -f
"$f.inputs" ]; then
617 export MNIT_READ_INPUT
="$f.inputs"
620 export MNIT_READ_INPUT
=/dev
/null
624 if [ "$engine" = "emscripten" ]; then
628 if [ -n
"$isinterpret" ]; then
629 cat > "$ff.bin" <<END
630 exec $NITC --no
-color
$OPT $includes -- $
(printf '%q' "$i") "\$@"
636 echo 0.0 > "$ff.time.out"
637 elif [ -n
"$isinteractive" ]; then
638 cat > "$ff.bin" <<END
639 exec $NITC --no
-color
--no
-prompt
--source-name $
(printf '%q' "$i") $OPT $includes < $
(printf '%q' "$i") "\$@"
645 echo 0.0 > "$ff.time.out"
647 if skip_cc
"$bf"; then
653 if [ "x$verbose" = "xtrue" ]; then
655 echo $NITC --no
-color
$OPT -o
"$ffout" "$includes" $nocc "$i"
657 NIT_NO_STACK
=1 JNI_LIB_PATH
=$JNI_LIB_PATH JAVA_HOME
=$JAVA_HOME \
658 saferun
-o
"$ff.time.out" $NITC --no
-color
$OPT -o
"$ffout" $includes $nocc "$i" 2> "$ff.cmp.err" > "$ff.compile.log"
660 if [ "x$verbose" = "xtrue" ]; then
661 cat -- "$ff.compile.log"
662 cat >&2 -- "$ff.cmp.err"
665 rm -r
"$compdir" 2>/dev
/null
667 if [ "$engine" = "emscripten" ]; then
668 echo > "$ff.bin" "nodejs $ffout \"\$@\""
670 if grep "Fatal Error: more than one primitive class" "$ff.compile.log" > /dev
/null
; then
671 echo " [skip] do no not imports kernel"
672 echo >>$xml "<testcase classname='`xmlesc "$pack"`' name='`xmlesc "$bf"`' `timestamp`><skipped/></testcase>"
676 if [ "$ERR" != 0 ]; then
678 cat -- "$ff.compile.log" "$ff.cmp.err" > "$ff.res"
679 process_result
"$bf" "$bf" "$pack"
680 elif [ -n
"$nocc" ]; then
684 process_result
"$bf" "$bf" "$pack"
685 elif [ -x
"$ff.bin" ]; then
686 if skip_exec
"$bf"; then
689 process_result
"$bf" "$bf" "$pack"
695 if [ "x$verbose" = "xtrue" ]; then
697 echo "NIT_NO_STACK=1 $ff.bin" $args
699 NIT_NO_STACK
=1 LD_LIBRARY_PATH
=$JNI_LIB_PATH WRITE
="$ff.write" \
700 saferun
-a
-o
"$ff.time.out" "$ff.bin" $args < "$inputs" > "$ff.res" 2>"$ff.err"
701 mv "$ff.time.out" "$ff.times.out"
702 awk '{ SUM += $1} END { print SUM }' "$ff.times.out" > "$ff.time.out"
704 if [ "x$verbose" = "xtrue" ]; then
708 if [ -f
"$ff.write" ]; then
709 cat -- "$ff.write" >> "$ff.res"
710 elif [ -d
"$ff.write" ]; then
711 LANG
=C
/bin
/ls -F
"$ff.write" >> "$ff.res"
713 cp -- "$ff.res" "$ff.res2"
714 cat -- "$ff.cmp.err" "$ff.err" "$ff.res2" > "$ff.res"
715 process_result
"$bf" "$bf" "$pack"
717 if [ -f
"$f.args" ]; then
725 name
="$bf args $cptr"
727 # Sould we skip the input for this engine?
728 need_skip
"$bff" " $name" "$pack" && continue
730 # use a specific inputs file, if required
731 if [ -f
"$bff.inputs" ]; then
732 ffinputs
="$bff.inputs"
737 rm -rf
"$fff.res" "$fff.err" "$fff.write" 2> /dev
/null
738 if [ "x$verbose" = "xtrue" ]; then
740 echo "NIT_NO_STACK=1 $ff.bin" $args
743 echo "$ff.bin $args" > "$fff.bin"
745 WRITE
="$fff.write" saferun
-o
"$fff.time.out" sh
-c
"NIT_NO_STACK=1 $fff.bin < $ffinputs > $fff.res 2>$fff.err"
746 if [ "x$verbose" = "xtrue" ]; then
748 cat >&2 -- "$fff.err"
750 if [ -f
"$fff.write" ]; then
751 cat -- "$fff.write" >> "$fff.res"
752 elif [ -d
"$fff.write" ]; then
753 LANG
=C
/bin
/ls -F
-- "$fff.write" >> "$fff.res"
755 if [ -s
"$fff.err" ]; then
756 cp -- "$fff.res" "$fff.res2"
757 cat -- "$fff.err" "$fff.res2" > "$fff.res"
759 process_result
"$bff" " $name" "$pack"
762 elif [ -f
"$ff.bin" ]; then
763 #Not executable (platform?)"
765 process_result
"$bf" "$bf" "$pack"
768 cat -- "$ff.cmp.err" > "$ff.res"
769 echo "Compilation error" > "$ff.res"
770 process_result
"$bf" "$bf" "$pack"
775 if [ "x$isnode" = "xfalse" ]; then
776 echo "engine: $engine ($enginebinname $OPT)"
777 echo "ok: " `echo $ok | wc -w` "/" `echo $ok $nok $nos $todos | wc -w`
779 if [ -n
"$nok" ]; then
781 echo "There were $(echo $nok | wc -w) errors ! (see file $ERRLIST)"
783 if [ -n
"$nos" ]; then
786 if [ -n
"$todos" ]; then
787 echo "todo/fixme: $todos"
789 if [ -n
"$remains" ]; then
790 echo "sav that remains: $remains"
795 if [ "x$ERRLIST" != "x" ]; then
796 if [ -f
"$ERRLIST_TARGET" ]; then
797 mv "$ERRLIST_TARGET" "${ERRLIST_TARGET}.bak"
799 uniq $ERRLIST > $ERRLIST_TARGET
803 echo >>$xml "</testsuite></testsuites>"
805 if [ -n
"$nok" ]; then