Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
9f218e91019d646e66a25c2e47cbdcf9ebb57786
[simgrid.git] / buildtools / Cmake / Scripts / tesh.pl
1 #! /usr/bin/perl
2
3 # Copyright (c) 2012-2014. The SimGrid Team.
4 # All rights reserved.
5
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;
10
11 =encoding UTF-8
12
13 =head1 NAME
14
15 tesh -- testing shell
16
17 =head1 SYNOPSIS
18
19 B<tesh> [I<options>] I<tesh_file>
20
21 =cut
22 my($bindir)=".";
23 my($srcdir)=".";
24 my($timeout)=0;
25 my($time_to_wait)=0;
26 my $path = $0;
27 my $OS;
28 my $enable_coverage=0;
29 my $diff_tool=0;
30 my $diff_tool_tmp_fh=0;
31 my $diff_tool_tmp_filename=0;
32 my $sort_prefix = 19;
33 my $tesh_file;
34 my $tesh_name;
35 my $error=0;
36 my $exitcode=0;
37 my @bg_cmds;
38 my (%environ);
39 $SIG{'PIPE'} = 'IGNORE';
40 $path =~ s|[^/]*$||;
41 push @INC,$path;
42
43 use Getopt::Long qw(GetOptions);
44 use strict;
45 use Term::ANSIColor;
46 use Text::ParseWords;
47 use IPC::Open3;
48 use IO::File;
49
50 if($^O eq "linux"){
51     $OS = "UNIX";
52 }
53 else{
54     $OS = "WIN";
55     $ENV{"PRINTF_EXPONENT_DIGITS"} = "2";
56 }
57
58 ##
59 ## Command line option handling
60 ##
61
62 sub var_subst {
63     my ($text, $name, $value) = @_;
64     if ($value) {
65         $text =~ s/\${$name(?::[=-][^}]*)?}/$value/g;
66         $text =~ s/\$$name(\W|$)/$value$1/g;
67     }
68     else {
69         $text =~ s/\${$name:=([^}]*)}/$1/g;
70         $text =~ s/\${$name}//g;
71         $text =~ s/\$$name(\W|$)/$1/g;
72     }
73     return $text;
74 }
75
76 # option handling helper subs
77 sub cd_cmd {
78   my $directory=$_[1];
79   my $failure=1;
80   if (-e $directory && -d $directory) {
81     chdir("$directory");
82     print "[Tesh/INFO] change directory to $directory\n";
83   $failure=0;
84   } elsif (-e $directory) {
85     print "Cannot change directory to '$directory': it is not a directory\n";
86   } else {
87     print "Chdir to $directory failed: No such file or directory\n";
88   }
89   if($failure==1){
90   $error=1;
91   $exitcode=4;
92   print "Test suite `$tesh_file': NOK (system error)\n";
93   exit 4;
94   }
95 }
96
97 sub setenv_cmd {
98   my($var,$ctn);
99   if ($_[0] =~ /^(.*)=(.*)$/) {
100     ($var,$ctn)=($1,$2);
101   }elsif ($_[1] =~ /^(.*)=(.*)$/) {
102     ($var,$ctn)=($1,$2);
103   } else {
104       die "[Tesh/CRITICAL] Malformed argument to setenv: expected 'name=value' but got '$_[1]'\n";
105   }
106
107   print "[Tesh/INFO] setenv $var=$ctn\n";
108   $environ{$var} = $ctn;
109 }
110
111 # Main option parsing sub
112
113 sub get_options {
114   # remove the tesh file from the ARGV used
115   my @ARGV = @_;
116   $tesh_file = pop @ARGV;
117
118   # temporary arrays for GetOption
119   my @verbose = ();
120   my @cfg;
121   my $log; # ignored
122
123
124   my %opt = (
125     "help"  => 0,
126     "debug"   => 0,
127     "verbose" => 0
128     );
129
130   Getopt::Long::config('bundling', 'no_getopt_compat', 'no_auto_abbrev');
131
132   GetOptions(
133     'help|h'   => \$opt{'help'},
134
135     'verbose|v'  => \@verbose,
136     'debug|d'  => \$opt{"debug"},
137
138     'difftool=s' => \$diff_tool,
139
140     'cd=s'     => \&cd_cmd,
141     'timeout=s'  => \$opt{'timeout'},
142     'setenv=s'   => \&setenv_cmd,
143     'cfg=s'    => \@cfg,
144     'log=s'    => \$log,
145     'enable-coverage+'  => \$enable_coverage,
146     );
147
148   if($enable_coverage){
149     print "Enable coverage\n";
150   }
151
152   if($diff_tool){
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";
156   }
157
158   unless($tesh_file=~/(.*)\.tesh/){
159     $tesh_file="(stdin)";
160     $tesh_name="(stdin)";
161     print "Test suite from stdin\n";
162   }else{
163     $tesh_name=$1;
164     print "Test suite `$tesh_name'\n";
165   }
166
167   $opt{'verbose'} = scalar @verbose;
168   foreach (@cfg) {
169     $opt{'cfg'} .= " --cfg=$_";
170   }
171   return %opt;
172 }
173
174 my %opts = get_options(@ARGV);
175
176 ##
177 ## File parsing
178 ##
179 my($nb_arg)=0;
180 my($old_buffer);
181 my($linebis);
182 my($SIGABRT)=0;
183 my($verbose)=0;
184 my($return)=-1;
185 my($pid);
186 my($result);
187 my($result_err);
188 my($forked);
189 my($config)="";
190 my($tesh_command)=0;
191 my(@buffer_tesh)=();
192
193 #eval {
194   use POSIX;
195
196   sub exit_status {
197     my $status = shift;
198     if (POSIX::WIFEXITED($status)) {
199       $exitcode=POSIX::WEXITSTATUS($status)+40;
200       return "returned code ".POSIX::WEXITSTATUS($status);
201     } elsif (POSIX::WIFSIGNALED($status)) {
202       my $code;
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";
210     }
211     return "Unparsable status. Is the process stopped?";
212   }
213 #};
214 #if ($@) { # no POSIX available?
215 #  warn "POSIX not usable to parse the return value of forked child: $@\n";
216 #  sub exit_status {
217 #    return "returned code -1 $@ ";
218 #  }
219 #}
220
221 sub exec_cmd {
222   my %cmd = %{$_[0]};
223   if ($opts{'debug'}) {
224     print "IN BEGIN\n";
225     map {print "  $_"} @{$cmd{'in'}};
226     print "IN END\n";
227     print "OUT BEGIN\n";
228     map {print "  $_"} @{$cmd{'out'}};
229     print "OUT END\n";
230     print "CMD: $cmd{'cmd'}\n";
231   }
232
233   # cleanup the command line
234   if($OS eq "WIN") {
235       var_subst($cmd{'cmd'}, "EXEEXT", ".exe");
236   } else {
237       var_subst($cmd{'cmd'}, "EXEEXT", "");
238   }
239
240   # substitute environ variables
241   foreach my $key (keys %environ) {
242       $cmd{'cmd'} = var_subst($cmd{'cmd'}, $key, $environ{$key});
243   }
244   # substitute remaining variables, if any
245   while ($cmd{'cmd'} =~ /\${(\w+)(?::[=-][^}]*)?}/) {
246       $cmd{'cmd'} = var_subst($cmd{'cmd'}, $1, "");
247   }
248   while ($cmd{'cmd'} =~ /\$(\w+)/) {
249       $cmd{'cmd'} = var_subst($cmd{'cmd'}, $1, "");
250   }
251
252   # add cfg options
253   $cmd{'cmd'} .= " $opts{'cfg'}" if (defined($opts{'cfg'}) && length($opts{'cfg'}));
254
255   # final cleanup
256   $cmd{'cmd'} =~ s/^\s+//;
257   $cmd{'cmd'} =~ s/\s+$//;
258
259   print "[$tesh_name:$cmd{'line'}] $cmd{'cmd'}\n" ;
260
261   ###
262   # exec the command line
263   ###  $line =~ s/\r//g;
264
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'}));
270
271   # push all provided input to executing child
272   map { print CHILD_IN "$_\n"; }  @{$cmd{'in'}};
273   close CHILD_IN;
274
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'};
278     $forked = fork();
279     $timeout=-1;
280     die "fork() failed: $!" unless defined $forked;
281     if ( $forked == 0 ) { # child
282       sleep $time_to_wait;
283       kill(SIGKILL, $cmd{'pid'});
284       exit $time_to_wait;
285     }
286   }
287
288
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($?);
294     parse_out(\%cmd);
295   }else{
296     # & commands, which will be handled at the end
297     push @bg_cmds, \%cmd;
298     # no timeout for background commands
299     if($forked){
300        kill(SIGKILL, $forked);
301        $timeout=0;
302        $forked=0;
303     }
304   }
305 }
306
307
308 sub parse_out {
309   my %cmd = %{$_[0]};
310   my $gotret=$cmd{'gotret'};
311
312   my $wantret;
313
314   if(defined($cmd{'expect'}) and ($cmd{'expect'} ne "")){
315     $wantret = "got signal $cmd{'expect'}";
316   }else{
317     $wantret = "returned code ".(defined($cmd{'return'})? $cmd{'return'} : 0);
318   }
319
320   local *got = $cmd{'got'};
321   seek(got,0,0);
322   # pop all output from executing child
323   my @got;
324   while(defined(my $got=<got>)) {
325     $got =~ s/\r//g;
326     chomp $got;
327     print $diff_tool_tmp_fh "> $got\n" if ($diff_tool);
328
329     if (!($enable_coverage and $got=~ /^profiling:/)){
330       push @got, $got;
331     }
332   }
333
334   if ($cmd{'sort'}){
335     sub mysort{
336         substr($a, 0, $sort_prefix) cmp substr($b, 0, $sort_prefix)
337     }
338     use sort 'stable';
339     @got = sort mysort @got;
340     while (@got and $got[0] eq "") {
341       shift @got;
342     }
343
344     #also resort the other one, as perl sort is not the same as the C one used to generate teshes
345     if(defined($cmd{'out'})){
346       @{$cmd{'out'}}=sort mysort @{$cmd{'out'}};
347       while (@{$cmd{'out'}} and ${$cmd{'out'}}[0] eq "") {
348         shift @{$cmd{'out'}};
349       }
350     }
351   }
352
353   #Did we timeout ? If yes, handle it. If not, kill the forked process.
354
355   if($timeout==-1 and $gotret eq "got signal SIGKILL"){
356     $gotret="return code 0";
357     $timeout=1;
358     $gotret= "timeout after $time_to_wait sec";
359     $error=1;
360     $exitcode=3;
361     print STDERR "<$cmd{'file'}:$cmd{'line'}> timeouted. Kill the process.\n";
362   }else{
363     $timeout=0;
364   }
365   if($gotret ne $wantret) {
366     $error=1;
367     my $msg = "Test suite `$cmd{'file'}': NOK (<$cmd{'file'}:$cmd{'line'}> $gotret)\n";
368     if ($timeout!=1) {
369         $msg=$msg."Output of <$cmd{'file'}:$cmd{'line'}> so far:\n";
370     }
371     map {$msg .=  "|| $_\n"} @got;
372     if(!@got) {
373         if($timeout==1){
374         print STDERR "<$cmd{'file'}:$cmd{'line'}> No output before timeout\n";
375         }else{
376         $msg .= "||\n";
377         }
378     }
379     $timeout = 0;
380     print STDERR "$msg";
381   }
382
383
384   ###
385   # Check the result of execution
386   ###
387   my $diff;
388   if (defined($cmd{'output display'})){
389     print "[Tesh/INFO] Here is the (ignored) command output:\n";
390     map { print "||$_\n" } @got;
391   }
392   elsif (!defined($cmd{'output ignore'})){
393     $diff = build_diff(\@{$cmd{'out'}}, \@got);
394   }else{
395     print "(ignoring the output of <$cmd{'file'}:$cmd{'line'}> as requested)\n"
396   }
397   if (length $diff) {
398     print "Output of <$cmd{'file'}:$cmd{'line'}> mismatch:\n";
399     map { print "$_\n" } split(/\n/,$diff);
400
401     print "Test suite `$cmd{'file'}': NOK (<$cmd{'file'}:$cmd{'line'}> output mismatch)\n";
402     $error=1;
403     $exitcode=2;
404   }
405 }
406
407 sub mkfile_cmd {
408   my %cmd = %{$_[0]};
409   my $file = $cmd{'arg'};
410   print "[Tesh/INFO] mkfile $file\n";
411
412   unlink($file);
413   open(FILE,">$file") or die "[Tesh/CRITICAL] Unable to create file $file: $!\n";
414   print FILE join("\n", @{$cmd{'in'}});
415   print FILE "\n" if (scalar @{$cmd{'in'}} > 0);
416   close(FILE);
417 }
418
419 # parse tesh file
420 #my $teshfile=$tesh_file;
421 #$teshfile=~ s{\.[^.]+$}{};
422
423 unless($tesh_file eq "(stdin)"){
424   open TESH_FILE, $tesh_file or die "[Tesh/CRITICAL] Unable to open $tesh_file $!\n";
425 }
426
427 my %cmd; # everything about the next command to run
428 my $line_num=0;
429 my $finished =0;
430 LINE: while (not $finished and not $error) {
431   my $line;
432
433
434   if ($tesh_file ne "(stdin)" and !defined($line=<TESH_FILE>)){
435     $finished=1;
436     next LINE;
437   }elsif ($tesh_file eq "(stdin)" and !defined($line=<>)){
438     $finished=1;
439     next LINE;
440   }
441
442   $line_num++;
443   chomp $line;
444   $line =~ s/\r//g;
445   print "[TESH/debug] $line_num: $line\n" if $opts{'debug'};
446   my $next;
447   # deal with line continuations
448   while ($line =~ /^(.*?)\\$/) {
449     $next=<TESH_FILE>;
450     die "[TESH/CRITICAL] Continued line at end of file\n"
451       unless defined($next);
452     $line_num++;
453     chomp $next;
454     print "[TESH/debug] $line_num: $next\n" if $opts{'debug'};
455     $line = $1.$next;
456   }
457
458   # Push delayed commands on empty lines
459   unless ($line =~ m/^(.)(.*)$/) {
460     if (defined($cmd{'cmd'}))  {
461       exec_cmd(\%cmd);
462       %cmd = ();
463     }
464     print $diff_tool_tmp_fh "$line\n" if ($diff_tool);
465     next LINE;
466   }
467
468   my ($cmd,$arg) = ($1,$2);
469   print $diff_tool_tmp_fh "$line\n" if ($diff_tool and $cmd ne '>');
470   $arg =~ s/^ //g;
471   $arg =~ s/\r//g;
472   $arg =~ s/\\\\/\\/g;
473   # handle the commands
474   if ($cmd =~ /^#/) {    #comment
475   } elsif ($cmd eq '>'){    #expected result line
476     print "[TESH/debug] push expected result\n" if $opts{'debug'};
477     push @{$cmd{'out'}}, $arg;
478
479   } elsif ($cmd eq '<') {    # provided input
480     print "[TESH/debug] push provided input\n" if $opts{'debug'};
481     push @{$cmd{'in'}}, $arg;
482
483   } elsif ($cmd eq 'p') {    # comment
484     print "[$tesh_name:$line_num] $arg\n";
485
486   } elsif ($cmd eq '$') {  # Command
487     # if we have something buffered, run it now
488     if (defined($cmd{'cmd'})) {
489       exec_cmd(\%cmd);
490       %cmd = ();
491     }
492     if ($arg =~ /^\s*mkfile /){      # "mkfile" command line
493       die "[TESH/CRITICAL] Output expected from mkfile command!\n" if scalar @{cmd{'out'}};
494
495       $cmd{'arg'} = $arg;
496       $cmd{'arg'} =~ s/\s*mkfile //;
497       mkfile_cmd(\%cmd);
498       %cmd = ();
499
500     } elsif ($arg =~ /^\s*cd /) {
501       die "[TESH/CRITICAL] Input provided to cd command!\n" if scalar @{cmd{'in'}};
502       die "[TESH/CRITICAL] Output expected from cd command!\n" if scalar @{cmd{'out'}};
503
504       $arg =~ s/^ *cd //;
505       cd_cmd("",$arg);
506       %cmd = ();
507
508     } else { # regular command
509       $cmd{'cmd'} = $arg;
510       $cmd{'file'} = $tesh_file;
511       $cmd{'line'} = $line_num;
512     }
513   }
514   elsif($cmd eq '&'){      # parallel command line
515
516     if (defined($cmd{'cmd'})) {
517       exec_cmd(\%cmd);
518       %cmd = ();
519     }
520     $cmd{'background'} = 1;
521     $cmd{'cmd'} = $arg;
522     $cmd{'file'} = $tesh_file;
523     $cmd{'line'} = $line_num;
524   }
525   elsif($line =~ /^!\s*output sort/){    #output sort
526     if (defined($cmd{'cmd'})) {
527       exec_cmd(\%cmd);
528       %cmd = ();
529     }
530     $cmd{'sort'} = 1;
531     if ($line =~ /^!\s*output sort\s+(\d+)/) {
532         $sort_prefix = $1;
533     }
534   }
535   elsif($line =~ /^!\s*output ignore/){    #output ignore
536     if (defined($cmd{'cmd'})) {
537       exec_cmd(\%cmd);
538       %cmd = ();
539     }
540     $cmd{'output ignore'} = 1;
541   }
542   elsif($line =~ /^!\s*output display/){    #output display
543     if (defined($cmd{'cmd'})) {
544       exec_cmd(\%cmd);
545       %cmd = ();
546     }
547     $cmd{'output display'} = 1;
548   }
549   elsif($line =~ /^!\s*expect signal (\w*)/) {#expect signal SIGABRT
550     if (defined($cmd{'cmd'})) {
551       exec_cmd(\%cmd);
552       %cmd = ();
553     }
554 print "hey\n";
555     $cmd{'expect'} = "$1";
556   }
557   elsif($line =~ /^!\s*expect return/){    #expect return
558     if (defined($cmd{'cmd'})) {
559       exec_cmd(\%cmd);
560       %cmd = ();
561     }
562     $line =~ s/^! expect return //g;
563     $line =~ s/\r//g;
564     $cmd{'return'} = $line;
565   }
566   elsif($line =~ /^!\s*setenv/){    #setenv
567     if (defined($cmd{'cmd'})) {
568       exec_cmd(\%cmd);
569       %cmd = ();
570     }
571     $line =~ s/^! setenv //g;
572     $line =~ s/\r//g;
573     setenv_cmd($line);
574   }
575   elsif($line =~ /^!\s*include/){    #include
576     if (defined($cmd{'cmd'})) {
577       exec_cmd(\%cmd);
578       %cmd = ();
579     }
580     print color("red"), "[Tesh/CRITICAL] need include";
581     print color("reset"), "\n";
582     die;
583   }
584   elsif($line =~ /^!\s*timeout/){    #timeout
585     if (defined($cmd{'cmd'})) {
586       exec_cmd(\%cmd);
587       %cmd = ();
588     }
589     $line =~ s/^! timeout //;
590     $line =~ s/\r//g;
591     $cmd{'timeout'} = $line;
592   } else {
593     die "[TESH/CRITICAL] parse error: $line\n";
594   }
595   if($forked){
596    kill(SIGKILL, $forked);
597    $timeout=0;
598   }
599
600 }
601
602
603
604 # Deal with last command
605 if (defined($cmd{'cmd'})) {
606   exec_cmd(\%cmd);
607   %cmd = ();
608 }
609
610
611 if($forked){
612    kill(SIGKILL, $forked);
613    $timeout=0;
614 }
615
616 foreach(@bg_cmds){
617   my %test=%{$_};
618   waitpid ($test{'pid'}, 0);
619   $test{'gotret'} = exit_status($?);
620   parse_out(\%test);
621 }
622
623 @bg_cmds=();
624
625 if ($diff_tool) {
626   close $diff_tool_tmp_fh;
627   system("$diff_tool $diff_tool_tmp_filename $tesh_file");
628   unlink $diff_tool_tmp_filename;
629 }
630
631 if($error !=0){
632     exit $exitcode;
633 }elsif($tesh_file eq "(stdin)"){
634     print "Test suite from stdin OK\n";
635 }else{
636     print "Test suite `$tesh_name' OK\n";
637 }
638
639 #my (@a,@b);
640 #push @a,"bl1";   push @b,"bl1";
641 #push @a,"bl2";   push @b,"bl2";
642 #push @a,"bl3";   push @b,"bl3";
643 #push @a,"bl4";   push @b,"bl4";
644 #push @a,"bl5";   push @b,"bl5";
645 #push @a,"bl6";   push @b,"bl6";
646 #push @a,"bl7";   push @b,"bl7";
647 ##push @a,"Perl";  push @b,"ruby";
648 #push @a,"END1";   push @b,"END1";
649 #push @a,"END2";   push @b,"END2";
650 #push @a,"END3";   push @b,"END3";
651 #push @a,"END4";   push @b,"END4";
652 #push @a,"END5";   push @b,"END5";
653 #push @a,"END6";   push @b,"END6";
654 #push @a,"END7";   push @b,"END7";
655 #print "Identical:\n". build_diff(\@a,\@b);
656
657 #@a = (); @b =();
658 #push @a,"AZE"; push @b,"EZA";
659 #print "Different:\n".build_diff(\@a,\@b);
660
661 use lib "@CMAKE_BINARY_DIR@/bin" ;
662
663 use Diff qw(diff); # postpone a bit to have time to change INC
664
665 sub build_diff {
666   my $res;
667   my $diff = Diff->new(@_);
668
669   $diff->Base( 1 );   # Return line numbers, not indices
670   my $chunk_count = $diff->Next(-1); # Compute the amount of chuncks
671   return ""   if ($chunk_count == 1 && $diff->Same());
672   $diff->Reset();
673   while(  $diff->Next()  ) {
674     my @same = $diff->Same();
675     if ($diff->Same() ) {
676       if ($diff->Next(0) > 1) { # not first chunk: print 2 first lines
677         $res .= '  '.$same[0]."\n" ;
678         $res .= '  '.$same[1]."\n" if (scalar @same>1);
679       }
680       $res .= "...\n"  if (scalar @same>2);
681 #    $res .= $diff->Next(0)."/$chunk_count\n";
682       if ($diff->Next(0) < $chunk_count) { # not last chunk: print 2 last lines
683         $res .= '  '.$same[scalar @same -2]."\n" if (scalar @same>1);
684         $res .= '  '.$same[scalar @same -1]."\n";
685       }
686     }
687     next if  $diff->Same();
688     map { $res .= "- $_\n" } $diff->Items(1);
689     map { $res .= "+ $_\n" } $diff->Items(2);
690   }
691   return $res;
692 }
693
694