3 # Copyright (c) 2012-2014. The SimGrid Team.
6 # This program is free software; you can redistribute it and/or modify it
7 # under the terms of the license (GNU LGPL) which comes with this package.
8 eval 'exec perl -S $0 ${1+"$@"}'
9 if $running_under_some_shell;
19 B<tesh> [I<options>] I<tesh_file>
28 my $enable_coverage=0;
30 my $diff_tool_tmp_fh=0;
31 my $diff_tool_tmp_filename=0;
39 $SIG{'PIPE'} = 'IGNORE';
43 use Getopt::Long qw(GetOptions);
55 $ENV{"PRINTF_EXPONENT_DIGITS"} = "2";
59 ## Command line option handling
63 my ($text, $name, $value) = @_;
65 $text =~ s/\${$name(?::[=-][^}]*)?}/$value/g;
66 $text =~ s/\$$name(\W|$)/$value$1/g;
69 $text =~ s/\${$name:=([^}]*)}/$1/g;
70 $text =~ s/\${$name}//g;
71 $text =~ s/\$$name(\W|$)/$1/g;
76 # option handling helper subs
80 if (-e $directory && -d $directory) {
82 print "[Tesh/INFO] change directory to $directory\n";
84 } elsif (-e $directory) {
85 print "Cannot change directory to '$directory': it is not a directory\n";
87 print "Chdir to $directory failed: No such file or directory\n";
92 print "Test suite `$tesh_file': NOK (system error)\n";
99 if ($_[0] =~ /^(.*)=(.*)$/) {
101 }elsif ($_[1] =~ /^(.*)=(.*)$/) {
104 die "[Tesh/CRITICAL] Malformed argument to setenv: expected 'name=value' but got '$_[1]'\n";
107 print "[Tesh/INFO] setenv $var=$ctn\n";
108 $environ{$var} = $ctn;
111 # Main option parsing sub
114 # remove the tesh file from the ARGV used
116 $tesh_file = pop @ARGV;
118 # temporary arrays for GetOption
130 Getopt::Long::config('bundling', 'no_getopt_compat', 'no_auto_abbrev');
133 'help|h' => \$opt{'help'},
135 'verbose|v' => \@verbose,
136 'debug|d' => \$opt{"debug"},
138 'difftool=s' => \$diff_tool,
141 'timeout=s' => \$opt{'timeout'},
142 'setenv=s' => \&setenv_cmd,
145 'enable-coverage+' => \$enable_coverage,
148 if($enable_coverage){
149 print "Enable coverage\n";
153 use File::Temp qw/ tempfile /;
154 ($diff_tool_tmp_fh, $diff_tool_tmp_filename) = tempfile();
155 print "New tesh: $diff_tool_tmp_filename\n";
158 unless($tesh_file=~/(.*)\.tesh/){
159 $tesh_file="(stdin)";
160 $tesh_name="(stdin)";
161 print "Test suite from stdin\n";
164 print "Test suite `$tesh_name'\n";
167 $opt{'verbose'} = scalar @verbose;
169 $opt{'cfg'} .= " --cfg=$_";
174 my %opts = get_options(@ARGV);
198 if (POSIX::WIFEXITED($status)) {
199 $exitcode=POSIX::WEXITSTATUS($status)+40;
200 return "returned code ".POSIX::WEXITSTATUS($status);
201 } elsif (POSIX::WIFSIGNALED($status)) {
203 if (POSIX::WTERMSIG($status) == SIGINT){$code="SIGINT"; }
204 elsif (POSIX::WTERMSIG($status) == SIGTERM) {$code="SIGTERM"; }
205 elsif (POSIX::WTERMSIG($status) == SIGKILL) {$code= "SIGKILL"; }
206 elsif (POSIX::WTERMSIG($status) == SIGABRT) {$code="SIGABRT"; }
207 elsif (POSIX::WTERMSIG($status) == SIGSEGV) {$code="SIGSEGV" ;}
208 $exitcode=POSIX::WTERMSIG($status)+4;
209 return "got signal $code";
211 return "Unparsable status. Is the process stopped?";
214 #if ($@) { # no POSIX available?
215 # warn "POSIX not usable to parse the return value of forked child: $@\n";
217 # return "returned code -1 $@ ";
223 if ($opts{'debug'}) {
225 map {print " $_"} @{$cmd{'in'}};
228 map {print " $_"} @{$cmd{'out'}};
230 print "CMD: $cmd{'cmd'}\n";
233 # cleanup the command line
235 var_subst($cmd{'cmd'}, "EXEEXT", ".exe");
237 var_subst($cmd{'cmd'}, "EXEEXT", "");
240 # substitute environ variables
241 foreach my $key (keys %environ) {
242 $cmd{'cmd'} = var_subst($cmd{'cmd'}, $key, $environ{$key});
244 # substitute remaining variables, if any
245 while ($cmd{'cmd'} =~ /\${(\w+)(?::[=-][^}]*)?}/) {
246 $cmd{'cmd'} = var_subst($cmd{'cmd'}, $1, "");
248 while ($cmd{'cmd'} =~ /\$(\w+)/) {
249 $cmd{'cmd'} = var_subst($cmd{'cmd'}, $1, "");
253 $cmd{'cmd'} .= " $opts{'cfg'}" if (defined($opts{'cfg'}) && length($opts{'cfg'}));
256 $cmd{'cmd'} =~ s/^\s+//;
257 $cmd{'cmd'} =~ s/\s+$//;
259 print "[$tesh_name:$cmd{'line'}] $cmd{'cmd'}\n" ;
262 # exec the command line
263 ### $line =~ s/\r//g;
265 $cmd{'got'} = IO::File->new_tmpfile;
266 $cmd{'got'}->autoflush(1);
267 local *E = $cmd{'got'};
268 $cmd{'pid'} = open3(\*CHILD_IN, ">&E", ">&E",
269 quotewords('\s+', 0, $cmd{'cmd'}));
271 # push all provided input to executing child
272 map { print CHILD_IN "$_\n"; } @{$cmd{'in'}};
275 # if timeout specified, fork and kill executing child at the end of timeout
276 if (defined($cmd{'timeout'}) or defined($opts{'timeout'})){
277 $time_to_wait= defined($cmd{'timeout'}) ? $cmd{'timeout'} : $opts{'timeout'};
280 die "fork() failed: $!" unless defined $forked;
281 if ( $forked == 0 ) { # child
283 kill(SIGKILL, $cmd{'pid'});
289 # Cleanup the executing child, and kill the timeouter brother on need
290 $cmd{'return'} = 0 unless defined($cmd{'return'});
291 if($cmd{'background'} != 1){
292 waitpid ($cmd{'pid'}, 0);
293 $cmd{'gotret'} = exit_status($?);
296 # & commands, which will be handled at the end
297 push @bg_cmds, \%cmd;
298 # no timeout for background commands
300 kill(SIGKILL, $forked);
310 my $gotret=$cmd{'gotret'};
314 if(defined($cmd{'expect'}) and ($cmd{'expect'} ne "")){
315 $wantret = "got signal $cmd{'expect'}";
317 $wantret = "returned code ".(defined($cmd{'return'})? $cmd{'return'} : 0);
320 local *got = $cmd{'got'};
322 # pop all output from executing child
324 while(defined(my $got=<got>)) {
327 print $diff_tool_tmp_fh "> $got\n" if ($diff_tool);
329 if (!($enable_coverage and $got=~ /^profiling:/)){
335 # Save the unsorted observed output to report it on error.
336 map { push @{$cmd{'unsorted got'}}, $_ } @got;
339 substr($a, 0, $sort_prefix) cmp substr($b, 0, $sort_prefix)
342 if ($sort_prefix>0) {
343 @got = sort mysort @got;
347 while (@got and $got[0] eq "") {
351 # Sort the expected output to make it easier to write for humans
352 if(defined($cmd{'out'})){
353 if ($sort_prefix>0) {
354 @{$cmd{'out'}} = sort mysort @{$cmd{'out'}};
356 @{$cmd{'out'}} = sort @{$cmd{'out'}};
358 while (@{$cmd{'out'}} and ${$cmd{'out'}}[0] eq "") {
359 shift @{$cmd{'out'}};
364 # Did we timeout ? If yes, handle it. If not, kill the forked process.
366 if($timeout==-1 and $gotret eq "got signal SIGKILL"){
367 $gotret="return code 0";
369 $gotret= "timeout after $time_to_wait sec";
372 print STDERR "<$cmd{'file'}:$cmd{'line'}> timeouted. Kill the process.\n";
376 if($gotret ne $wantret) {
378 my $msg = "Test suite `$cmd{'file'}': NOK (<$cmd{'file'}:$cmd{'line'}> $gotret)\n";
380 $msg=$msg."Output of <$cmd{'file'}:$cmd{'line'}> so far:\n";
382 map {$msg .= "|| $_\n"} @got;
385 print STDERR "<$cmd{'file'}:$cmd{'line'}> No output before timeout\n";
396 # Check the result of execution
399 if (defined($cmd{'output display'})){
400 print "[Tesh/INFO] Here is the (ignored) command output:\n";
401 map { print "||$_\n" } @got;
403 elsif (!defined($cmd{'output ignore'})){
404 $diff = build_diff(\@{$cmd{'out'}}, \@got);
406 print "(ignoring the output of <$cmd{'file'}:$cmd{'line'}> as requested)\n"
409 print "Output of <$cmd{'file'}:$cmd{'line'}> mismatch".($cmd{'sort'}?" (even after sorting)":"").":\n";
410 map { print "$_\n" } split(/\n/,$diff);
412 print "WARNING: Both the observed output and expected output were sorted as requested.\n";
413 print "WARNING: Output were only sorted using the $sort_prefix first chars.\n"
415 print "WARNING: Use <! output sort 19> to sort by simulated date and process ID only.\n";
416 # print "----8<--------------- Begin of unprocessed observed output (as it should appear in file):\n";
417 # map {print "> $_\n"} @{$cmd{'unsorted got'}};
418 # print "--------------->8---- End of the unprocessed observed output.\n";
421 print "Test suite `$cmd{'file'}': NOK (<$cmd{'file'}:$cmd{'line'}> output mismatch)\n";
429 my $file = $cmd{'arg'};
430 print "[Tesh/INFO] mkfile $file\n";
433 open(FILE,">$file") or die "[Tesh/CRITICAL] Unable to create file $file: $!\n";
434 print FILE join("\n", @{$cmd{'in'}});
435 print FILE "\n" if (scalar @{$cmd{'in'}} > 0);
440 #my $teshfile=$tesh_file;
441 #$teshfile=~ s{\.[^.]+$}{};
443 unless($tesh_file eq "(stdin)"){
444 open TESH_FILE, $tesh_file or die "[Tesh/CRITICAL] Unable to open $tesh_file $!\n";
447 my %cmd; # everything about the next command to run
450 LINE: while (not $finished and not $error) {
454 if ($tesh_file ne "(stdin)" and !defined($line=<TESH_FILE>)){
457 }elsif ($tesh_file eq "(stdin)" and !defined($line=<>)){
465 print "[TESH/debug] $line_num: $line\n" if $opts{'debug'};
467 # deal with line continuations
468 while ($line =~ /^(.*?)\\$/) {
470 die "[TESH/CRITICAL] Continued line at end of file\n"
471 unless defined($next);
474 print "[TESH/debug] $line_num: $next\n" if $opts{'debug'};
478 # Push delayed commands on empty lines
479 unless ($line =~ m/^(.)(.*)$/) {
480 if (defined($cmd{'cmd'})) {
484 print $diff_tool_tmp_fh "$line\n" if ($diff_tool);
488 my ($cmd,$arg) = ($1,$2);
489 print $diff_tool_tmp_fh "$line\n" if ($diff_tool and $cmd ne '>');
493 # handle the commands
494 if ($cmd =~ /^#/) { #comment
495 } elsif ($cmd eq '>'){ #expected result line
496 print "[TESH/debug] push expected result\n" if $opts{'debug'};
497 push @{$cmd{'out'}}, $arg;
499 } elsif ($cmd eq '<') { # provided input
500 print "[TESH/debug] push provided input\n" if $opts{'debug'};
501 push @{$cmd{'in'}}, $arg;
503 } elsif ($cmd eq 'p') { # comment
504 print "[$tesh_name:$line_num] $arg\n";
506 } elsif ($cmd eq '$') { # Command
507 # if we have something buffered, run it now
508 if (defined($cmd{'cmd'})) {
512 if ($arg =~ /^\s*mkfile /){ # "mkfile" command line
513 die "[TESH/CRITICAL] Output expected from mkfile command!\n" if scalar @{cmd{'out'}};
516 $cmd{'arg'} =~ s/\s*mkfile //;
520 } elsif ($arg =~ /^\s*cd /) {
521 die "[TESH/CRITICAL] Input provided to cd command!\n" if scalar @{cmd{'in'}};
522 die "[TESH/CRITICAL] Output expected from cd command!\n" if scalar @{cmd{'out'}};
528 } else { # regular command
530 $cmd{'file'} = $tesh_file;
531 $cmd{'line'} = $line_num;
534 elsif($cmd eq '&'){ # parallel command line
536 if (defined($cmd{'cmd'})) {
540 $cmd{'background'} = 1;
542 $cmd{'file'} = $tesh_file;
543 $cmd{'line'} = $line_num;
545 elsif($line =~ /^!\s*output sort/){ #output sort
546 if (defined($cmd{'cmd'})) {
551 if ($line =~ /^!\s*output sort\s+(\d+)/) {
555 elsif($line =~ /^!\s*output ignore/){ #output ignore
556 if (defined($cmd{'cmd'})) {
560 $cmd{'output ignore'} = 1;
562 elsif($line =~ /^!\s*output display/){ #output display
563 if (defined($cmd{'cmd'})) {
567 $cmd{'output display'} = 1;
569 elsif($line =~ /^!\s*expect signal (\w*)/) {#expect signal SIGABRT
570 if (defined($cmd{'cmd'})) {
575 $cmd{'expect'} = "$1";
577 elsif($line =~ /^!\s*expect return/){ #expect return
578 if (defined($cmd{'cmd'})) {
582 $line =~ s/^! expect return //g;
584 $cmd{'return'} = $line;
586 elsif($line =~ /^!\s*setenv/){ #setenv
587 if (defined($cmd{'cmd'})) {
591 $line =~ s/^! setenv //g;
595 elsif($line =~ /^!\s*include/){ #include
596 if (defined($cmd{'cmd'})) {
600 print color("red"), "[Tesh/CRITICAL] need include";
601 print color("reset"), "\n";
604 elsif($line =~ /^!\s*timeout/){ #timeout
605 if (defined($cmd{'cmd'})) {
609 $line =~ s/^! timeout //;
611 $cmd{'timeout'} = $line;
613 die "[TESH/CRITICAL] parse error: $line\n";
616 kill(SIGKILL, $forked);
624 # Deal with last command
625 if (defined($cmd{'cmd'})) {
632 kill(SIGKILL, $forked);
638 waitpid ($test{'pid'}, 0);
639 $test{'gotret'} = exit_status($?);
646 close $diff_tool_tmp_fh;
647 system("$diff_tool $diff_tool_tmp_filename $tesh_file");
648 unlink $diff_tool_tmp_filename;
653 }elsif($tesh_file eq "(stdin)"){
654 print "Test suite from stdin OK\n";
656 print "Test suite `$tesh_name' OK\n";
660 #push @a,"bl1"; push @b,"bl1";
661 #push @a,"bl2"; push @b,"bl2";
662 #push @a,"bl3"; push @b,"bl3";
663 #push @a,"bl4"; push @b,"bl4";
664 #push @a,"bl5"; push @b,"bl5";
665 #push @a,"bl6"; push @b,"bl6";
666 #push @a,"bl7"; push @b,"bl7";
667 ##push @a,"Perl"; push @b,"ruby";
668 #push @a,"END1"; push @b,"END1";
669 #push @a,"END2"; push @b,"END2";
670 #push @a,"END3"; push @b,"END3";
671 #push @a,"END4"; push @b,"END4";
672 #push @a,"END5"; push @b,"END5";
673 #push @a,"END6"; push @b,"END6";
674 #push @a,"END7"; push @b,"END7";
675 #print "Identical:\n". build_diff(\@a,\@b);
678 #push @a,"AZE"; push @b,"EZA";
679 #print "Different:\n".build_diff(\@a,\@b);
681 use lib "@CMAKE_BINARY_DIR@/bin" ;
683 use Diff qw(diff); # postpone a bit to have time to change INC
687 my $diff = Diff->new(@_);
689 $diff->Base( 1 ); # Return line numbers, not indices
690 my $chunk_count = $diff->Next(-1); # Compute the amount of chuncks
691 return "" if ($chunk_count == 1 && $diff->Same());
693 while( $diff->Next() ) {
694 my @same = $diff->Same();
695 if ($diff->Same() ) {
696 if ($diff->Next(0) > 1) { # not first chunk: print 2 first lines
697 $res .= ' '.$same[0]."\n" ;
698 $res .= ' '.$same[1]."\n" if (scalar @same>1);
700 $res .= "...\n" if (scalar @same>2);
701 # $res .= $diff->Next(0)."/$chunk_count\n";
702 if ($diff->Next(0) < $chunk_count) { # not last chunk: print 2 last lines
703 $res .= ' '.$same[scalar @same -2]."\n" if (scalar @same>1);
704 $res .= ' '.$same[scalar @same -1]."\n";
707 next if $diff->Same();
708 map { $res .= "- $_\n" } $diff->Items(1);
709 map { $res .= "+ $_\n" } $diff->Items(2);