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 env
time --quiet
-f
%U true
2>/dev
/null
; then
134 TIME
="env time --quiet -f%U"
135 elif env
time -f
%U true
2>/dev
/null
; then
137 elif env gtime
-f
%U true
2>/dev
/null
; then
138 TIME
="env gtime -f%U"
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 # $1 is the pattern of the test
158 # $2 is the file to compare to
160 # 0: if the file to compare to do not exists
161 # 1: if the file match
162 # 2: if the file match with soso
163 # 3: if the file do not match
164 function compare_to_result
()
168 if [ ! -r
"$sav" ]; then return 0; fi
169 test "`cat -- "$sav"`" = "UNDEFINED" && return 1
170 diff -u
--strip
-trailing
-cr
-- "$sav" "$outdir/$pattern.res" > "$outdir/$pattern.diff.sav.log"
171 if [ "$?" == 0 ]; then
174 sed '/[Ww]arning/d;/[Ee]rror/d' "$outdir/$pattern.res" > "$outdir/$pattern.res2"
175 sed '/[Ww]arning/d;/[Ee]rror/d' "$sav" > "$outdir/$pattern.sav2"
176 grep '[Ee]rror' "$outdir/$pattern.res" >/dev
/null
&& echo "Error" >> "$outdir/$pattern.res2"
177 grep '[Ee]rror' "$sav" >/dev
/null
&& echo "Error" >> "$outdir/$pattern.sav2"
178 diff -u
--strip
-trailing
-cr
"$outdir/$pattern.sav2" "$outdir/$pattern.res2" > "$outdir/$pattern.diff.sav.log2"
179 if [ "$?" == 0 ]; then
188 sed 's/&/\&/g; s/</\</g; s/>/\>/g; s/"/\"/g; s/'"'"'/\'/g'<<EOF
193 # As argument: the pattern used for the file
194 function process_result
()
212 # Truncate too big res file
213 local size
=$
(wc -c
< "$outdir/$pattern.res")
214 if test -n
"$reslimit" -a
"$size" -gt
"$reslimit"; then
215 # The most portable way to truncate a file is with Perl
216 perl
-e
"truncate \"$outdir/$pattern.res\", $reslimit;"
217 echo "***TRUNCATED***" >> "$outdir/$pattern.res"
220 echo >>$xml "<testcase classname='`xmlesc "$pack"`' name='`xmlesc "$description"`' time='`cat -- "$outdir/$pattern.
time.out
"`' `timestamp`>"
221 #for sav in "sav/$engine/fixme/$pattern.res" "sav/$engine/$pattern.res" "sav/fixme/$pattern.res" "sav/$pattern.res" "sav/$pattern.sav"; do
222 for savdir
in $savdirs; do
223 local sav
=$savdir/fixme
/$pattern.res
224 compare_to_result
"$pattern" "$sav"
234 if [ -z
"$FIRST" ]; then
241 if [ -z
"$FIRST" ]; then
249 sav
=$savdir/$pattern.res
250 compare_to_result
"$pattern" "$sav"
260 if [ -z
"$FIRST" ]; then
267 if [ -z
"$FIRST" ]; then
275 OLD
=`echo "$OLD" | sed -e 's/ */ /g' -e 's/^ //' -e 's/ $//'`
276 istodo
"$outdir/$pattern.res"
278 if [ -n
"$SAV" ]; then
279 if [ -n
"$OLD" ]; then
280 echo "[*ok*] $outdir/$pattern.res $SAV - but $OLD remains!"
281 echo >>$xml "<error message='`xmlesc "ok
$outdir/$pattern.res
- but
$OLD remains
"`'/>"
282 remains
="$remains $OLD"
283 test "$autosav" = "true" && rm "$OLD"
285 echo "[ok] $outdir/$pattern.res $SAV"
288 elif [ -n
"$FIXME" ]; then
289 if [ -n
"$OLD" ]; then
290 echo "[*fixme*] $outdir/$pattern.res $FIXME - but $OLD remains!"
291 echo >>$xml "<error message='`xmlesc "ok
$outdir/$pattern.res
- but
$OLD remains
"`'/>"
292 remains
="$remains $OLD"
293 test "$autosav" = "true" && rm "$OLD"
295 echo "[fixme] $outdir/$pattern.res $FIXME"
296 echo >>$xml "<skipped/>"
298 todos
="$todos $pattern"
299 elif [ "x$NYI" = "x0" ]; then
300 echo "[todo] $outdir/$pattern.res -> not yet implemented"
301 echo >>$xml "<skipped/>"
302 todos
="$todos $pattern"
303 elif [ -n
"$SOSO" ]; then
304 echo "[======= soso $outdir/$pattern.res $SOSO =======]"
305 echo >>$xml "<error message='`xmlesc "soso
$outdir/$pattern.res
$SOSO"`'/>"
306 echo >>$xml "<system-out><![CDATA["
307 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
308 echo >>$xml "]]></system-out>"
310 echo "$ii" >> "$ERRLIST"
311 test "$autosav" = "true" && cp "$outdir/$pattern.res" "$SOSO"
312 elif [ -n
"$SOSOF" ]; then
313 echo "[======= fixme soso $outdir/$pattern.res $SOSOF =======]"
314 echo >>$xml "<error message='`xmlesc "soso
$outdir/$pattern.res
$SOSO"`'/>"
315 echo >>$xml "<system-out><![CDATA["
316 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
317 echo >>$xml "]]></system-out>"
319 echo "$ii" >> "$ERRLIST"
320 test "$autosav" = "true" && cp "$outdir/$pattern.res" && "$SOSO"
321 elif [ -n
"$NSAV" ]; then
322 echo "[======= fail $outdir/$pattern.res $NSAV =======]"
323 echo >>$xml "<error message='`xmlesc "fail
$outdir/$pattern.res
$NSAV"`'/>"
324 echo >>$xml "<system-out><![CDATA["
325 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
326 echo >>$xml "]]></system-out>"
328 echo "$ii" >> "$ERRLIST"
329 test "$autosav" = "true" && cp "$outdir/$pattern.res" "$NSAV"
330 elif [ -n
"$NFIXME" ]; then
331 echo "[======= changed $outdir/$pattern.res $NFIXME ======]"
332 echo >>$xml "<error message='`xmlesc "changed
$outdir/$pattern.res
$NFIXME"`'/>"
333 echo >>$xml "<system-out><![CDATA["
334 cat -v
-- "$outdir/$pattern.diff.sav.log" |
head >>$xml -n
50
335 echo >>$xml "]]></system-out>"
337 echo "$ii" >> "$ERRLIST"
338 test "$autosav" = "true" && cp "$outdir/$pattern.res" "$NFIXME"
339 elif [ -s
"$outdir/$pattern.res" ]; then
340 echo "[=== no sav ===] $outdir/$pattern.res is not empty"
341 echo >>$xml "<error message='no sav and not empty'/>"
342 echo >>$xml "<system-out><![CDATA["
343 cat -v
>>$xml -- "$outdir/$pattern.res"
344 echo >>$xml "]]></system-out>"
346 echo "$ii" >> "$ERRLIST"
347 test "$autosav" = "true" && cp "$outdir/$pattern.res" "sav/"
349 # no sav but empty res
350 echo "[0k] $outdir/$pattern.res is empty"
353 if test -s
"$outdir/$pattern.cmp.err"; then
354 echo >>$xml "<system-err><![CDATA["
355 cat -v
>>$xml -- "$outdir/$pattern.cmp.err"
356 echo >>$xml "]]></system-err>"
358 echo >>$xml "</testcase>"
363 test "$noskip" = true
&& return 1
364 if echo "$1" |
grep -f
"$engine.skip" >/dev
/null
2>&1; then
366 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
369 if test -n
"$isinterpret" && echo "$1" |
grep -f
"exec.skip" >/dev
/null
2>&1; then
370 echo "=> $2: [skip exec]"
371 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
376 local os_skip_file
=`uname`.skip
377 if test -e
$os_skip_file && echo "$1" |
grep -f
"$os_skip_file" >/dev
/null
2>&1; then
378 echo "=> $2: [skip os]"
379 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
384 local host_skip_file
=`$HOSTNAME`.skip
385 if test -e
$host_skip_file && echo "$1" |
grep -f
"$host_skip_file" >/dev
/null
2>&1; then
386 echo "=> $2: [skip hostname]"
387 echo >>$xml "<testcase classname='`xmlesc "$3"`' name='`xmlesc "$2"`' `timestamp`><skipped/></testcase>"
395 test "$noskip" = true
&& return 1
396 for savdir
in $savdirs .
; do
397 local f
="$savdir/exec.skip"
398 test -f
"$f" ||
continue
399 if echo "$1" |
grep -f
"$f" >/dev
/null
2>&1; then
400 echo -n
"_ no exec by $f; "
409 test "$noskip" = true
&& return 1
410 for savdir
in $savdirs .
; do
411 local f
="$savdir/cc.skip"
412 test -f
"$f" ||
continue
413 if echo "$1" |
grep -f
"$f" >/dev
/null
2>&1; then
420 # Check that the resfile ($1) matches some magic strings in `todo` files.
423 test "$no" = true
&& return 1
424 for savdir
in $savdirs .
; do
425 local f
="$savdir/todo"
426 test -f
"$f" ||
continue
427 if grep -f
"$f" "$1" >/dev
/null
2>&1; then
436 local name
="$enginebinname"
437 local recent
=`ls -t ../src/$name ../src/$name_[0-9] ../bin/$name ../c_src/$name 2>/dev/null | head -1`
438 if [[ "x$recent" == "x" ]]; then
439 echo "Could not find binary for engine $engine, aborting"
442 if [ "x$isnode" = "xfalse" ]; then
443 echo "Found binary for engine $engine: $recent $OPT"
455 while [ $stop = false
]; do
457 -o
) OPT
="$OPT $2"; shift; shift;;
458 -v
) verbose
=true
; shift;;
460 --engine
) engine
="$2"; shift; shift;;
461 --noskip
) noskip
=true
; shift;;
462 --outdir
) outdir
="$2"; shift; shift;;
463 --compdir
) compdir
="$2"; shift; shift;;
464 --node
) isnode
=true
; shift;;
465 --autosav
) autosav
=true
; shift;;
469 enginebinname
=$engine
475 OPT
="--separate $OPT --compile-dir $compdir"
476 savdirs
="sav/nitc-common/"
481 OPT
="--separate $OPT --compile-dir $compdir"
482 savdirs
="sav/nitc-common/"
487 OPT
="--erasure $OPT --compile-dir $compdir"
488 savdirs
="sav/nitc-common/"
493 OPT
="--semi-global $OPT --compile-dir $compdir"
494 savdirs
="sav/nitc-common/"
499 OPT
="--global $OPT --compile-dir $compdir"
500 savdirs
="sav/nitc-common/"
518 OPT
="--compile-dir $compdir --ant"
520 savdirs
="sav/nitc-common/"
524 OPT
="-m emscripten_nodejs.nit --semi-global $OPT --compile-dir $compdir"
525 savdirs
="sav/nitcsg/"
528 echo "unknown engine $engine"
533 savdirs
="sav/`$HOSTNAME` sav/`uname` sav/$engine $savdirs sav/"
535 # The default nitc compiler
536 [ -z
"$NITC" ] && find_nitc
538 # Set NIT_DIR if needed
539 [ -z
"$NIT_DIR" ] && export NIT_DIR
=..
541 # Mark to distinguish files among tests
549 # CLEAN the out directory
550 rm -rf
"$outdir/" 2>/dev
/null
551 mkdir
"$outdir" 2>/dev
/null
553 # File where error tests are outputed
554 # Old ERRLIST is backuped
555 ERRLIST
=${ERRLIST:-errlist}
556 ERRLIST_TARGET
=$ERRLIST
558 # Initiate new ERRLIST
559 if [ "x$ERRLIST" = "x" ]; then
570 if [ "x$XMLDIR" = "x" ]; then
571 xml
="tests-$engine.xml"
573 sum=`echo $@ | md5sum | cut -f1 -d " "`
574 xml
="$XMLDIR/tests-$engine-$sum.xml"
578 echo >$xml "<testsuites><testsuite>"
581 if [ ! -f
"$ii" ]; then
582 echo "File '$ii' does not exist."
585 f
=`basename -- "$ii" .nit`
587 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|'`
589 # Sould we skip the file for this engine?
590 need_skip
"$f" "$f" "$pack" && continue
592 local_tmp
=${ii/../AA}
593 if [ "x$local_tmp" = "x$ii" ]; then
594 includes
="-I . -I ../lib/core -I ../lib/core/collection -I alt"
599 for i
in "$ii" `./alterner.pl --start '#' --altsep '_' -- "$ii"`; do
600 bf
=`basename -- "$i" .nit`
603 # Sould we skip the alternative for this engine?
604 need_skip
"$bf" "$bf" "$pack" && continue
608 if [ -f
"$f.inputs" ]; then
610 export MNIT_READ_INPUT
="$f.inputs"
613 export MNIT_READ_INPUT
=/dev
/null
617 if [ "$engine" = "emscripten" ]; then
621 if [ -n
"$isinterpret" ]; then
622 cat > "$ff.bin" <<END
623 exec $NITC --no
-color
$OPT $includes -- $
(printf '%q' "$i") "\$@"
629 echo 0.0 > "$ff.time.out"
631 if skip_cc
"$bf"; then
637 if [ "x$verbose" = "xtrue" ]; then
639 echo $NITC --no
-color
$OPT -o
"$ffout" "$includes" $nocc "$i"
641 NIT_NO_STACK
=1 JNI_LIB_PATH
=$JNI_LIB_PATH JAVA_HOME
=$JAVA_HOME \
642 saferun
-o
"$ff.time.out" $NITC --no
-color
$OPT -o
"$ffout" $includes $nocc "$i" 2> "$ff.cmp.err" > "$ff.compile.log"
644 if [ "x$verbose" = "xtrue" ]; then
645 cat -- "$ff.compile.log"
646 cat >&2 -- "$ff.cmp.err"
649 rm -r
"$compdir" 2>/dev
/null
651 if [ "$engine" = "emscripten" ]; then
652 echo > "$ff.bin" "nodejs $ffout \"\$@\""
654 if grep "Fatal Error: more than one primitive class" "$ff.compile.log" > /dev
/null
; then
655 echo " [skip] do no not imports kernel"
656 echo >>$xml "<testcase classname='`xmlesc "$pack"`' name='`xmlesc "$bf"`' `timestamp`><skipped/></testcase>"
660 if [ "$ERR" != 0 ]; then
662 cat -- "$ff.compile.log" "$ff.cmp.err" > "$ff.res"
663 process_result
"$bf" "$bf" "$pack"
664 elif [ -n
"$nocc" ]; then
668 process_result
"$bf" "$bf" "$pack"
669 elif [ -x
"$ff.bin" ]; then
670 if skip_exec
"$bf"; then
673 process_result
"$bf" "$bf" "$pack"
679 if [ "x$verbose" = "xtrue" ]; then
681 echo "NIT_NO_STACK=1 $ff.bin" $args
683 NIT_NO_STACK
=1 LD_LIBRARY_PATH
=$JNI_LIB_PATH WRITE
="$ff.write" \
684 saferun
-a
-o
"$ff.time.out" "$ff.bin" $args < "$inputs" > "$ff.res" 2>"$ff.err"
685 mv "$ff.time.out" "$ff.times.out"
686 awk '{ SUM += $1} END { print SUM }' "$ff.times.out" > "$ff.time.out"
688 if [ "x$verbose" = "xtrue" ]; then
692 if [ -f
"$ff.write" ]; then
693 cat -- "$ff.write" >> "$ff.res"
694 elif [ -d
"$ff.write" ]; then
695 LANG
=C
/bin
/ls -F
"$ff.write" >> "$ff.res"
697 cp -- "$ff.res" "$ff.res2"
698 cat -- "$ff.cmp.err" "$ff.err" "$ff.res2" > "$ff.res"
699 process_result
"$bf" "$bf" "$pack"
701 if [ -f
"$f.args" ]; then
709 name
="$bf args $cptr"
711 # Sould we skip the input for this engine?
712 need_skip
"$bff" " $name" "$pack" && continue
714 # use a specific inputs file, if required
715 if [ -f
"$bff.inputs" ]; then
716 ffinputs
="$bff.inputs"
721 rm -rf
"$fff.res" "$fff.err" "$fff.write" 2> /dev
/null
722 if [ "x$verbose" = "xtrue" ]; then
724 echo "NIT_NO_STACK=1 $ff.bin" $args
727 echo "$ff.bin $args" > "$fff.bin"
729 WRITE
="$fff.write" saferun
-o
"$fff.time.out" sh
-c
"NIT_NO_STACK=1 $fff.bin < $ffinputs > $fff.res 2>$fff.err"
730 if [ "x$verbose" = "xtrue" ]; then
732 cat >&2 -- "$fff.err"
734 if [ -f
"$fff.write" ]; then
735 cat -- "$fff.write" >> "$fff.res"
736 elif [ -d
"$fff.write" ]; then
737 LANG
=C
/bin
/ls -F
-- "$fff.write" >> "$fff.res"
739 if [ -s
"$fff.err" ]; then
740 cp -- "$fff.res" "$fff.res2"
741 cat -- "$fff.err" "$fff.res2" > "$fff.res"
743 process_result
"$bff" " $name" "$pack"
746 elif [ -f
"$ff.bin" ]; then
747 #Not executable (platform?)"
749 process_result
"$bf" "$bf" "$pack"
752 cat -- "$ff.cmp.err" > "$ff.res"
753 echo "Compilation error" > "$ff.res"
754 process_result
"$bf" "$bf" "$pack"
759 if [ "x$isnode" = "xfalse" ]; then
760 echo "engine: $engine ($enginebinname $OPT)"
761 echo "ok: " `echo $ok | wc -w` "/" `echo $ok $nok $nos $todos | wc -w`
763 if [ -n
"$nok" ]; then
765 echo "There were $(echo $nok | wc -w) errors ! (see file $ERRLIST)"
767 if [ -n
"$nos" ]; then
770 if [ -n
"$todos" ]; then
771 echo "todo/fixme: $todos"
773 if [ -n
"$remains" ]; then
774 echo "sav that remains: $remains"
779 if [ "x$ERRLIST" != "x" ]; then
780 if [ -f
"$ERRLIST_TARGET" ]; then
781 mv "$ERRLIST_TARGET" "${ERRLIST_TARGET}.bak"
783 uniq $ERRLIST > $ERRLIST_TARGET
787 echo >>$xml "</testsuite></testsuites>"
789 if [ -n
"$nok" ]; then