3 # Copyright (c) 2012-2015. 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;
11 # If you change this file, please stick to the formatting you got with:
12 # perltidy --backup-and-modify-in-place --maximum-line-length=180 --output-line-ending=unix --cuddled-else
22 B<tesh> [I<options>]... I<testsuite>
26 Tesh is the testing shell, a specialized shell for running tests. It
27 provides the specified input to the tested commands, and check that
28 they produce the expected output and return the expected value.
32 --cd some/directory : ask tesh to switch the working directory before
34 --setenv var=value : set a specific environment variable
35 --cfg arg : add parameter --cfg=arg to each command line
36 --log arg : add parameter --log=arg to each command line
37 --enable-coverage : ignore output lines starting with "profiling:"
38 --enable-sanitizers : ignore output lines starting with containing warnings
40 =head1 TEST SUITE FILE SYTAX
42 A test suite is composed of one or several I<command blocks> separated
43 by empty lines, each of them being composed of a command to run, its
44 input text and the expected output.
46 The first char of each line specifies the type of line according to
47 the following list. The second char of each line is ignored.
49 `$' command to run in foreground
50 `&' command to run in background
52 `<' input to pass to the command
53 `>' output expected from the command
55 `!' metacommand, which can be one of:
56 `timeout' <integer>|no
57 `expect signal' <signal name>
58 `expect return' <integer>
59 `output' <ignore|display>
62 `p' an informative message to print
64 If the expected output do not match the produced output, or if the
65 command did not end as expected, Tesh provides an error message (see
66 the OUTPUT section below) and stops.
68 =head2 Command blocks examples
70 In a given command block, you can declare the command, its input and
71 its expected output in the order that you see fit.
85 You can group several commands together, provided that they don't have
91 =head2 Enforcing the command return code
93 By default, Tesh enforces that the tested command returns 0. If not,
94 it fails with an appropriate message and returns I<code+40> itself.
96 You specify that a given command block is expected to return another
99 # This command MUST return 42
103 The I<expect return> construct applies only to the next command block.
105 =head2 Commands that are expected to raise signals
107 By default, Tesh detects when the command is killed by a signal (such
108 as SEGV on segfaults). This is usually unexpected and unfortunate. But
109 if not, you can specify that a given command block is expected to fail
110 with a signal as follows:
112 # This command MUST raise a segfault
113 ! expect signal SIGSEGV
114 $ ./some_failing_code
116 The I<expect signal> construct applies only to the next command block.
120 By default, no command is allowed to run more than 5 seconds. You can
121 change this value as follows:
123 # Allow some more time to the command
125 $ ./some_longer_command
127 You can also disable the timeout completely by passing "no" as a value:
129 # This command will never timeout
131 $ ./some_very_long_but_safe_command
133 =head2 Setting environment variables
135 You can modify the environment of the tested commands as follows:
140 =head2 Not enforcing the expected output
142 By default, the commands output is matched against the one expected,
143 and an error is raised on discrepancy. Metacommands to change this:
149 The output is completely discarded.
153 The output is displayed, but no error is issued if it differs from the
158 The output is sorted before comparison (see next section).
162 =head2 Sorting output
164 If the order of the command output changes between runs, you want to
165 sort it before enforcing that it is exactly what you expect. In
166 SimGrid for example, this happens when parallel execution is
167 activated: User processes are run in parallel at each timestamp, and
168 the output is not reproducible anymore. Until you sort the lines.
170 You can sort the command output as follows:
173 $ ./some_multithreaded_command
175 Sorting lines this ways often makes the tesh output very intricate,
176 complicating the error analysis: the process logical order is defeated
177 by the lexicographical sort.
179 The solution is to prefix each line of your output with temporal
180 information so that lines can be grouped by timestamps. The
181 lexicographical sort then only applies to lines that occurred at the
182 same timestamp. Here is a SimGrid example:
184 # Sort only lines depending on the first 19 chars
186 $ ./some_simgrid_simulator --log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n
188 This approach may seem surprizing at the first glance but it does its job:
192 =item Every timestamps remain separated, as it should;
194 =item In each timestamp, the output order of processes become
195 reproducible: that's the lexicographical order of their name;
197 =item For each process, the order of its execution is preserved: its
198 messages within a given timestamp are not reordered.
202 That way, tesh can do its job (no false positive, no false negative)
203 despite the unpredictable order of executions of processes within a
204 timestamp, and reported errors remain easy to analyze (execution of a
205 given process preserved).
207 This example is very SimGrid oriented, but the feature could even be
208 usable by others, who knows?
211 =head1 BUILTIN COMMANDS
213 =head2 mkfile: creating a file
215 This command creates a file of the name provided as argument, and adds
216 the content it gets as input.
222 It is not possible to use the cat command, as one would expect,
223 because stream redirections are currently not implemented in Tesh.
225 =head1 BUGS, LIMITATIONS AND POSSIBLE IMPROVEMENTS
227 The main limitation is the lack of stream redirections in the commands
228 (">", "<" and "|" shell constructs and friends). The B<mkfile> builtin
229 command makes this situation bearable.
231 It would be nice if we could replace the tesh file completely with
232 command line flags when the output is not to be verified.
237 # Disabling IPC::Run::Debug saves tons of useless calls.
238 $ENV{'IPCRUNDEBUG'} = 'none'
239 unless exists $ENV{'IPCRUNDEBUG'};
242 my $enable_coverage = 0;
243 my $enable_sanitizers = 0;
245 my $diff_tool_tmp_fh = 0;
246 my $diff_tool_tmp_filename = 0;
247 my $sort_prefix = -1;
254 $SIG{'PIPE'} = 'IGNORE';
260 use lib "@CMAKE_BINARY_DIR@/bin";
262 use Diff qw(diff); # postpone a bit to have time to change INC
264 use Getopt::Long qw(GetOptions);
266 use Text::ParseWords;
267 use IPC::Run qw(start run timeout finish);
272 #### Portability bits for windows
275 use constant RUNNING_ON_WINDOWS => ( $OSNAME =~ /^(?:mswin|dos|os2)/oi );
276 use POSIX qw(:sys_wait_h WIFEXITED WIFSIGNALED WIFSTOPPED WEXITSTATUS WTERMSIG WSTOPSIG
277 :signal_h SIGINT SIGTERM SIGKILL SIGABRT SIGSEGV);
280 if (RUNNING_ON_WINDOWS) { # Missing on windows
281 *WIFEXITED = sub { not $_[0] & 127 };
282 *WEXITSTATUS = sub { $_[0] >> 8 };
283 *WIFSIGNALED = sub { ( $_[0] & 127 ) && ( $_[0] & 127 != 127 ) };
284 *WTERMSIG = sub { $_[0] & 127 };
286 # used on the command lines
287 $environ{'EXEEXT'} = ".exe";
293 #### Command line option handling
296 my %opts = ( "debug" => 0,
297 "timeout" => 5, # No command should run any longer than 5 seconds by default
300 Getopt::Long::config( 'bundling', 'no_getopt_compat', 'no_auto_abbrev' );
302 'debug|d' => \$opts{"debug"},
304 'difftool=s' => \$diff_tool,
306 'cd=s' => sub { cd_cmd( $_[1] ) },
307 'timeout=s' => \$opts{'timeout'},
308 'setenv=s' => sub { setenv_cmd( $_[1] ) },
309 'cfg=s' => sub { $opts{'cfg'} .= " --cfg=$_[1]" },
310 'log=s' => sub { $opts{'log'} .= " --log=$_[1]" },
311 'enable-coverage+' => \$enable_coverage,
312 'enable-sanitizers+' => \$enable_sanitizers,
315 $tesh_file = pop @ARGV;
316 $tesh_name = $tesh_file;
317 $tesh_name =~ s|^.*?/([^/]*)$|$1|;
319 print "Enable coverage\n" if ($enable_coverage);
320 print "Enable sanitizers\n" if ($enable_sanitizers);
323 use File::Temp qw/ tempfile /;
324 ( $diff_tool_tmp_fh, $diff_tool_tmp_filename ) = tempfile();
325 print "New tesh: $diff_tool_tmp_filename\n";
328 if ( $tesh_file =~ m/(.*)\.tesh/ ) {
329 print "Test suite `$tesh_file'\n";
331 $tesh_name = "(stdin)";
332 print "Test suite from stdin\n";
335 ###########################################################################
338 my %cmd = %{ $_[0] };
339 if ( $opts{'debug'} ) {
340 map { print "IN: $_\n" } @{ $cmd{'in'} };
341 map { print "OUT: $_\n" } @{ $cmd{'out'} };
342 print "CMD: $cmd{'cmd'}\n";
345 # substitute environment variables
346 foreach my $key ( keys %environ ) {
347 $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $key, $environ{$key} );
350 # substitute remaining variables, if any
351 while ( $cmd{'cmd'} =~ /\$\{(\w+)(?::[=-][^}]*)?\}/ ) {
352 $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $1, "" );
354 while ( $cmd{'cmd'} =~ /\$(\w+)/ ) {
355 $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $1, "" );
358 # add cfg and log options
359 $cmd{'cmd'} .= " $opts{'cfg'}"
360 if ( defined( $opts{'cfg'} ) && length( $opts{'cfg'} ) );
361 $cmd{'cmd'} .= " $opts{'log'}"
362 if ( defined( $opts{'log'} ) && length( $opts{'log'} ) );
364 # finally trim any remaining space chars
365 $cmd{'cmd'} =~ s/^\s+//;
366 $cmd{'cmd'} =~ s/\s+$//;
368 print "[$tesh_name:$cmd{'line'}] $cmd{'cmd'}\n";
370 $cmd{'return'} ||= 0;
371 $cmd{'timeout'} ||= $opts{'timeout'};
375 # exec the command line
378 if(defined $ENV{VALGRIND_COMMAND}) {
379 push @cmdline, $ENV{VALGRIND_COMMAND};
380 push @cmdline, split(" ", $ENV{VALGRIND_OPTIONS});
381 if($cmd{'timeout'} ne 'no'){
382 $cmd{'timeout'}=$cmd{'timeout'}*20
385 push @cmdline, quotewords( '\s+', 0, $cmd{'cmd'} );
386 my $input = defined($cmd{'in'})? join("\n",@{$cmd{'in'}}) : "";
387 my $output = " " x 10240; $output = ""; # Preallocate 10kB, and reset length to 0
388 $cmd{'got'} = \$output;
389 $cmd{'job'} = start \@cmdline, '<', \$input, '>&', \$output,
390 ($cmd{'timeout'} eq 'no' ? () : timeout($cmd{'timeout'}));
392 if ( $cmd{'background'} ) {
393 # Just enqueue the job. It will be dealed with at the end
394 push @bg_cmds, \%cmd;
396 # Deal with its ending conditions right away
397 analyze_result( \%cmd );
402 my %cmd = %{ $_[0] };
403 $cmd{'timeouted'} = 0; # initialization
405 # Wait for the end of the child process
408 finish( $cmd{'job'} );
410 if ($@) { # deal with the errors that occurred in the child process
411 if ($@ =~ /timeout/) {
412 $cmd{'job'}->kill_kill;
413 $cmd{'timeouted'} = 1;
414 } elsif ($@ =~ /^ack / and $@ =~ /pipe/) { # IPC::Run is not very expressive about the pipes that it gets :(
415 print STDERR "Tesh: Broken pipe (ignored).\n";
417 die $@; # Don't know what it is, so let it go.
424 # pop all output from executing child
426 map { print "GOT: $_\n" } ${$cmd{'got'}} if $opts{'debug'};
427 foreach my $got ( split("\n", ${$cmd{'got'}}) ) {
430 print $diff_tool_tmp_fh "> $got\n" if ($diff_tool);
432 unless (( $enable_coverage and $got =~ /^profiling:/ ) or
433 ( $enable_sanitizers and $got =~ m/WARNING: ASan doesn't fully support/))
439 # How did the child process terminate?
441 $cmd{'gotret'} = "Unparsable status. Please report this tesh bug.";
442 if ( $cmd{'timeouted'} ) {
443 $cmd{'gotret'} = "timeout after $cmd{'timeout'} sec";
446 } elsif ( WIFEXITED($status) ) {
447 $exitcode = WEXITSTATUS($status) + 40;
448 $cmd{'gotret'} = "returned code " . WEXITSTATUS($status);
449 } elsif ( WIFSIGNALED($status) ) {
451 if ( WTERMSIG($status) == SIGINT ) { $code = "SIGINT"; }
452 elsif ( WTERMSIG($status) == SIGTERM ) { $code = "SIGTERM"; }
453 elsif ( WTERMSIG($status) == SIGKILL ) { $code = "SIGKILL"; }
454 elsif ( WTERMSIG($status) == SIGABRT ) { $code = "SIGABRT"; }
455 elsif ( WTERMSIG($status) == SIGSEGV ) { $code = "SIGSEGV"; }
456 $exitcode = WTERMSIG($status) + 4;
457 $cmd{'gotret'} = "got signal $code";
460 # How was it supposed to terminate?
462 if ( defined( $cmd{'expect'} ) and ( $cmd{'expect'} ne "" ) ) {
463 $wantret = "got signal $cmd{'expect'}";
465 $wantret = "returned code " . ( defined( $cmd{'return'} ) ? $cmd{'return'} : 0 );
468 # Enforce the outcome
471 # Did it end as expected?
472 if ( $cmd{'gotret'} ne $wantret ) {
474 my $msg = "Test suite `$tesh_name': NOK (<$tesh_name:$cmd{'line'}> $cmd{'gotret'})\n";
476 $msg = $msg . "Output of <$tesh_name:$cmd{'line'}> so far:\n";
477 map { $msg .= "|| $_\n" } @got;
479 $msg .= "<$tesh_name:$cmd{'line'}> No output so far.\n";
484 # Does the output match?
485 if ( $cmd{'sort'} ) {
487 substr( $a, 0, $sort_prefix ) cmp substr( $b, 0, $sort_prefix );
490 if ( $sort_prefix > 0 ) {
491 @got = sort mysort @got;
495 while ( @got and $got[0] eq "" ) {
499 # Sort the expected output too, to make tesh files easier to write for humans
500 if ( defined( $cmd{'out'} ) ) {
501 if ( $sort_prefix > 0 ) {
502 @{ $cmd{'out'} } = sort mysort @{ $cmd{'out'} };
504 @{ $cmd{'out'} } = sort @{ $cmd{'out'} };
506 while ( @{ $cmd{'out'} } and ${ $cmd{'out'} }[0] eq "" ) {
507 shift @{ $cmd{'out'} };
512 # Report the output if asked so or if it differs
513 if ( defined( $cmd{'output display'} ) ) {
514 print "[Tesh/INFO] Here is the (ignored) command output:\n";
515 map { print "||$_\n" } @got;
516 } elsif ( defined( $cmd{'output ignore'} ) ) {
517 print "(ignoring the output of <$tesh_name:$cmd{'line'}> as requested)\n";
519 my $diff = build_diff( \@{ $cmd{'out'} }, \@got );
521 if ( length $diff ) {
522 print "Output of <$tesh_name:$cmd{'line'}> mismatch" . ( $cmd{'sort'} ? " (even after sorting)" : "" ) . ":\n";
523 map { print "$_\n" } split( /\n/, $diff );
524 if ( $cmd{'sort'} ) {
525 print "WARNING: Both the observed output and expected output were sorted as requested.\n";
526 print "WARNING: Output were only sorted using the $sort_prefix first chars.\n"
527 if ( $sort_prefix > 0 );
528 print "WARNING: Use <! output sort 19> to sort by simulated date and process ID only.\n";
530 # print "----8<--------------- Begin of unprocessed observed output (as it should appear in file):\n";
531 # map {print "> $_\n"} @{$cmd{'unsorted got'}};
532 # print "--------------->8---- End of the unprocessed observed output.\n";
535 print "Test suite `$tesh_name': NOK (<$tesh_name:$cmd{'line'}> output mismatch)\n";
542 my $infh; # The file descriptor from which we should read the teshfile
543 if ( $tesh_name eq "(stdin)" ) {
546 open $infh, $tesh_file
547 or die "[Tesh/CRITICAL] Unable to open $tesh_file: $!\n";
550 my %cmd; # everything about the next command to run
552 LINE: while ( not $error and defined( my $line = <$infh> )) {
557 print "[TESH/debug] $line_num: $line\n" if $opts{'debug'};
559 # deal with line continuations
560 while ( $line =~ /^(.*?)\\$/ ) {
562 die "[TESH/CRITICAL] Continued line at end of file\n"
563 unless defined($next);
566 print "[TESH/debug] $line_num: $next\n" if $opts{'debug'};
570 # If the line is empty, run any previously defined block and proceed to next line
571 unless ( $line =~ m/^(.)(.*)$/ ) {
572 if ( defined( $cmd{'cmd'} ) ) {
576 print $diff_tool_tmp_fh "$line\n" if ($diff_tool);
580 my ( $cmd, $arg ) = ( $1, $2 );
581 print $diff_tool_tmp_fh "$line\n" if ( $diff_tool and $cmd ne '>' );
586 # Deal with the lines that can contribute to the current command block
587 if ( $cmd =~ /^#/ ) { # comment
589 } elsif ( $cmd eq '>' ) { # expected result line
590 print "[TESH/debug] push expected result\n" if $opts{'debug'};
591 push @{ $cmd{'out'} }, $arg;
594 } elsif ( $cmd eq '<' ) { # provided input
595 print "[TESH/debug] push provided input\n" if $opts{'debug'};
596 push @{ $cmd{'in'} }, $arg;
599 } elsif ( $cmd eq 'p' ) { # comment
600 print "[$tesh_name:$line_num] $arg\n";
605 # We dealt with all sort of lines that can contribute to a command block, so we have something else here.
606 # If we have something buffered, run it now and start a new block
607 if ( defined( $cmd{'cmd'} ) ) {
612 # Deal with the lines that must be placed before a command block
613 if ( $cmd eq '$' ) { # Command
614 if ( $arg =~ /^mkfile / ) { # "mkfile" command line
615 die "[TESH/CRITICAL] Output expected from mkfile command!\n"
616 if scalar @{ cmd { 'out' } };
619 $cmd{'arg'} =~ s/mkfile //;
623 } elsif ( $arg =~ /^\s*cd / ) {
624 die "[TESH/CRITICAL] Input provided to cd command!\n"
625 if scalar @{ cmd { 'in' } };
626 die "[TESH/CRITICAL] Output expected from cd command!\n"
627 if scalar @{ cmd { 'out' } };
633 } else { # regular command
635 $cmd{'line'} = $line_num;
638 } elsif ( $cmd eq '&' ) { # background command line
639 die "[TESH/CRITICAL] mkfile cannot be run in background\n"
640 if ($arg =~ /^mkfile/);
641 die "[TESH/CRITICAL] cd cannot be run in background\n"
644 $cmd{'background'} = 1;
646 $cmd{'line'} = $line_num;
648 # Deal with the meta-commands
649 } elsif ( $line =~ /^! (.*)/) {
652 if ( $line =~ /^output sort/ ) {
654 if ( $line =~ /^output sort\s+(\d+)/ ) {
657 } elsif ($line =~ /^output ignore/ ) {
658 $cmd{'output ignore'} = 1;
659 } elsif ( $line =~ /^output display/ ) {
660 $cmd{'output display'} = 1;
661 } elsif ( $line =~ /^expect signal (\w*)/ ) {
663 } elsif ( $line =~ /^expect return/ ) {
664 $line =~ s/^expect return //g;
666 $cmd{'return'} = $line;
667 } elsif ( $line =~ /^setenv/ ) {
668 $line =~ s/^setenv //g;
671 } elsif ( $line =~ /^timeout/ ) {
672 $line =~ s/^timeout //;
674 $cmd{'timeout'} = $line;
677 die "[TESH/CRITICAL] parse error: $line\n";
681 # We are done reading the input file
682 close $infh unless ( $tesh_name eq "(stdin)" );
684 # Deal with last command, if any
685 if ( defined( $cmd{'cmd'} ) ) {
692 analyze_result( \%test );
696 close $diff_tool_tmp_fh;
697 system("$diff_tool $diff_tool_tmp_filename $tesh_file");
698 unlink $diff_tool_tmp_filename;
703 } elsif ( $tesh_name eq "(stdin)" ) {
704 print "Test suite from stdin OK\n";
706 print "Test suite `$tesh_name' OK\n";
712 #### Helper functions
717 my $diff = Diff->new(@_);
719 $diff->Base(1); # Return line numbers, not indices
720 my $chunk_count = $diff->Next(-1); # Compute the amount of chuncks
721 return "" if ( $chunk_count == 1 && $diff->Same() );
723 while ( $diff->Next() ) {
724 my @same = $diff->Same();
725 if ( $diff->Same() ) {
726 if ( $diff->Next(0) > 1 ) { # not first chunk: print 2 first lines
727 $res .= ' ' . $same[0] . "\n";
728 $res .= ' ' . $same[1] . "\n" if ( scalar @same > 1 );
730 $res .= "...\n" if ( scalar @same > 2 );
732 # $res .= $diff->Next(0)."/$chunk_count\n";
733 if ( $diff->Next(0) < $chunk_count ) { # not last chunk: print 2 last lines
734 $res .= ' ' . $same[ scalar @same - 2 ] . "\n"
735 if ( scalar @same > 1 );
736 $res .= ' ' . $same[ scalar @same - 1 ] . "\n";
739 next if $diff->Same();
740 map { $res .= "- $_\n" } $diff->Items(1);
741 map { $res .= "+ $_\n" } $diff->Items(2);
746 # Helper function replacing any occurence of variable '$name' by its '$value'
747 # As in Bash, ${$value:=BLABLA} is rewritten to $value if set or to BLABLA if $value is not set
749 my ( $text, $name, $value ) = @_;
751 $text =~ s/\$\{$name(?::[=-][^}]*)?\}/$value/g;
752 $text =~ s/\$$name(\W|$)/$value$1/g;
754 $text =~ s/\$\{$name:=([^}]*)\}/$1/g;
755 $text =~ s/\$\{$name\}//g;
756 $text =~ s/\$$name(\W|$)/$1/g;
761 ################################ The possible commands ################################
764 my %cmd = %{ $_[0] };
765 my $file = $cmd{'arg'};
766 print STDERR "[Tesh/INFO] mkfile $file. Ctn: >>".join( '\n', @{ $cmd{'in'} })."<<\n"
770 open( FILE, ">$file" )
771 or die "[Tesh/CRITICAL] Unable to create file $file: $!\n";
772 print FILE join( "\n", @{ $cmd{'in'} } );
773 print FILE "\n" if ( scalar @{ $cmd{'in'} } > 0 );
777 # Command CD. Just change to the provided directory
779 my $directory = shift;
781 if ( -e $directory && -d $directory ) {
783 print "[Tesh/INFO] change directory to $directory\n";
785 } elsif ( -e $directory ) {
786 print "Cannot change directory to '$directory': it is not a directory\n";
788 print "Chdir to $directory failed: No such file or directory\n";
790 if ( $failure == 1 ) {
791 print "Test suite `$tesh_name': NOK (system error)\n";
796 # Command setenv. Gets "variable=content", and update the environment accordingly
799 if ( $arg =~ /^(.*?)=(.*)$/ ) {
800 my ( $var, $ctn ) = ( $1, $2 );
801 print "[Tesh/INFO] setenv $var=$ctn\n";
802 $environ{$var} = $ctn;
805 die "[Tesh/CRITICAL] Malformed argument to setenv: expected 'name=value' but got '$arg'\n";