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 --enable-coverage : ignore output lines starting with "profiling:"
38 =head1 TEST SUITE FILE SYTAX
40 A test suite is composed of one or several I<command blocks> separated
41 by empty lines, each of them being composed of a command to run, its
42 input text and the expected output.
44 The first char of each line specifies the type of line according to
45 the following list. The second char of each line is ignored.
47 `$' command to run in foreground
48 `&' command to run in background
50 `<' input to pass to the command
51 `>' output expected from the command
53 `!' metacommand, which can be one of:
54 `timeout' <integer>|no
55 `expect signal' <signal name>
56 `expect return' <integer>
57 `output' <ignore|display>
60 `p' an informative message to print
62 If the expected output do not match the produced output, or if the
63 command did not end as expected, Tesh provides an error message (see
64 the OUTPUT section below) and stops.
66 =head2 Command blocks examples
68 In a given command block, you can declare the command, its input and
69 its expected output in the order that you see fit.
83 You can group several commands together, provided that they don't have
89 =head2 Enforcing the command return code
91 By default, Tesh enforces that the tested command returns 0. If not,
92 it fails with an appropriate message and returns I<code+40> itself.
94 You specify that a given command block is expected to return another
97 # This command MUST return 42
101 The I<expect return> construct applies only to the next command block.
103 =head2 Commands that are expected to raise signals
105 By default, Tesh detects when the command is killed by a signal (such
106 as SEGV on segfaults). This is usually unexpected and unfortunate. But
107 if not, you can specify that a given command block is expected to fail
108 with a signal as follows:
110 # This command MUST raise a segfault
111 ! expect signal SIGSEGV
112 $ ./some_failing_code
114 The I<expect signal> construct applies only to the next command block.
118 By default, no command is allowed to run more than 5 seconds. You can
119 change this value as follows:
121 # Allow some more time to the command
123 $ ./some_longer_command
125 You can also disable the timeout completely by passing "no" as a value:
127 # This command will never timeout
129 $ ./some_very_long_but_safe_command
131 =head2 Setting environment variables
133 You can modify the environment of the tested commands as follows:
138 =head2 Not enforcing the expected output
140 By default, the commands output is matched against the one expected,
141 and an error is raised on discrepancy. Metacommands to change this:
147 The output is completely discarded.
151 The output is displayed, but no error is issued if it differs from the
156 The output is sorted before comparison (see next section).
160 =head2 Sorting output
162 If the order of the command output changes between runs, you want to
163 sort it before enforcing that it is exactly what you expect. In
164 SimGrid for example, this happens when parallel execution is
165 activated: User processes are run in parallel at each timestamp, and
166 the output is not reproducible anymore. Until you sort the lines.
168 You can sort the command output as follows:
171 $ ./some_multithreaded_command
173 Sorting lines this ways often makes the tesh output very intricate,
174 complicating the error analysis: the process logical order is defeated
175 by the lexicographical sort.
177 The solution is to prefix each line of your output with temporal
178 information so that lines can be grouped by timestamps. The
179 lexicographical sort then only applies to lines that occured at the
180 same timestamp. Here is a SimGrid example:
182 # Sort only lines depending on the first 19 chars
184 $ ./some_simgrid_simulator --log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n
186 This approach may seem surprizing at the first glance but it does its job:
190 =item Every timestamps remain separated, as it should;
192 =item In each timestamp, the output order of processes become
193 reproducible: that's the lexicographical order of their name;
195 =item For each process, the order of its execution is preserved: its
196 messages within a given timestamp are not reordered.
200 That way, tesh can do its job (no false positive, no false negative)
201 despite the unpredictable order of executions of processes within a
202 timestamp, and reported errors remain easy to analyze (execution of a
203 given process preserved).
205 This example is very SimGrid oriented, but the feature could even be
206 usable by others, who knows?
209 =head1 BUILTIN COMMANDS
211 =head2 mkfile: creating a file
213 This command creates a file of the name provided as argument, and adds
214 the content it gets as input.
220 It is not possible to use the cat command, as one would expect,
221 because stream redirections are currently not implemented in Tesh.
223 =head1 BUGS AND LIMITATIONS
225 The main limitation is the lack of stream redirections in the commands
226 (">", "<" and "|" shell constructs and friends). The B<mkfile> builtin
227 command makes this situation bearable.
232 # Disabling IPC::Run::Debug saves tons of useless calls.
233 $ENV{'IPCRUNDEBUG'} = 'none'
234 unless exists $ENV{'IPCRUNDEBUG'};
237 my $enable_coverage = 0;
239 my $diff_tool_tmp_fh = 0;
240 my $diff_tool_tmp_filename = 0;
241 my $sort_prefix = -1;
248 $SIG{'PIPE'} = 'IGNORE';
254 use lib "@CMAKE_BINARY_DIR@/bin";
256 use Diff qw(diff); # postpone a bit to have time to change INC
258 use Getopt::Long qw(GetOptions);
260 use Text::ParseWords;
261 use IPC::Run qw(start run timeout finish);
266 #### Portability bits for windows
269 use constant RUNNING_ON_WINDOWS => ( $OSNAME =~ /^(?:mswin|dos|os2)/oi );
270 use POSIX qw(:sys_wait_h WIFEXITED WIFSIGNALED WIFSTOPPED WEXITSTATUS WTERMSIG WSTOPSIG
271 :signal_h SIGINT SIGTERM SIGKILL SIGABRT SIGSEGV);
274 if (RUNNING_ON_WINDOWS) { # Missing on windows
275 *WIFEXITED = sub { not $_[0] & 127 };
276 *WEXITSTATUS = sub { $_[0] >> 8 };
277 *WIFSIGNALED = sub { ( $_[0] & 127 ) && ( $_[0] & 127 != 127 ) };
278 *WTERMSIG = sub { $_[0] & 127 };
284 #### Command line option handling
287 my %opts = ( "debug" => 0,
288 "timeout" => 5, # No command should run any longer than 5 seconds by default
291 Getopt::Long::config( 'bundling', 'no_getopt_compat', 'no_auto_abbrev' );
293 'debug|d' => \$opts{"debug"},
295 'difftool=s' => \$diff_tool,
297 'cd=s' => sub { cd_cmd( $_[1] ) },
298 'timeout=s' => \$opts{'timeout'},
299 'setenv=s' => sub { setenv_cmd( $_[1] ) },
300 'cfg=s' => sub { $opts{'cfg'} .= " --cfg=$_[1]" },
301 'enable-coverage+' => \$enable_coverage,
304 $tesh_file = pop @ARGV;
306 print "Enable coverage\n" if ($enable_coverage);
309 use File::Temp qw/ tempfile /;
310 ( $diff_tool_tmp_fh, $diff_tool_tmp_filename ) = tempfile();
311 print "New tesh: $diff_tool_tmp_filename\n";
314 if ( $tesh_file =~ m/(.*)\.tesh/ ) {
316 print "Test suite `$tesh_name'\n";
318 $tesh_file = "(stdin)";
319 $tesh_name = "(stdin)";
320 print "Test suite from stdin\n";
323 ###########################################################################
327 if ( WIFEXITED($status) ) {
328 $exitcode = WEXITSTATUS($status) + 40;
329 return "returned code " . WEXITSTATUS($status);
330 } elsif ( WIFSIGNALED($status) ) {
332 if ( WTERMSIG($status) == SIGINT ) { $code = "SIGINT"; }
333 elsif ( WTERMSIG($status) == SIGTERM ) { $code = "SIGTERM"; }
334 elsif ( WTERMSIG($status) == SIGKILL ) { $code = "SIGKILL"; }
335 elsif ( WTERMSIG($status) == SIGABRT ) { $code = "SIGABRT"; }
336 elsif ( WTERMSIG($status) == SIGSEGV ) { $code = "SIGSEGV"; }
337 $exitcode = WTERMSIG($status) + 4;
338 return "got signal $code";
340 return "Unparsable status. Is the process stopped?";
344 my %cmd = %{ $_[0] };
345 if ( $opts{'debug'} ) {
346 map { print "IN: $_\n" } @{ $cmd{'in'} };
347 map { print "OUT: $_\n" } @{ $cmd{'out'} };
348 print "CMD: $cmd{'cmd'}\n";
351 # cleanup the command line
352 if (RUNNING_ON_WINDOWS) {
353 var_subst( $cmd{'cmd'}, "EXEEXT", ".exe" );
355 var_subst( $cmd{'cmd'}, "EXEEXT", "" );
358 # substitute environ variables
359 foreach my $key ( keys %environ ) {
360 $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $key, $environ{$key} );
363 # substitute remaining variables, if any
364 while ( $cmd{'cmd'} =~ /\${(\w+)(?::[=-][^}]*)?}/ ) {
365 $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $1, "" );
367 while ( $cmd{'cmd'} =~ /\$(\w+)/ ) {
368 $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $1, "" );
372 $cmd{'cmd'} .= " $opts{'cfg'}"
373 if ( defined( $opts{'cfg'} ) && length( $opts{'cfg'} ) );
375 # finally trim any remaining space chars
376 $cmd{'cmd'} =~ s/^\s+//;
377 $cmd{'cmd'} =~ s/\s+$//;
379 print "[$tesh_name:$cmd{'line'}] $cmd{'cmd'}\n";
381 $cmd{'return'} ||= 0;
382 $cmd{'timeout'} ||= $opts{'timeout'};
386 # exec the command line
388 my @cmdline = quotewords( '\s+', 0, $cmd{'cmd'} );
389 my $input = defined($cmd{'in'})? join("\n",@{$cmd{'in'}}) : "";
390 my $output = " " x 10240; $output = ""; # Preallocate 10kB, and reset length to 0
391 $cmd{'got'} = \$output;
392 $cmd{'job'} = start \@cmdline, '<', \$input, '>&', \$output,
393 ($cmd{'timeout'} eq 'no' ? () : timeout($cmd{'timeout'}));
395 if ( $cmd{'background'} ) {
396 # Just enqueue the job. It will be dealed with at the end
397 push @bg_cmds, \%cmd;
399 # Deal with its ending conditions right away
400 analyze_result( \%cmd );
405 my %cmd = %{ $_[0] };
408 finish( $cmd{'job'} );
411 if ($@ =~ /timeout/) {
412 $cmd{'job'}->kill_kill;
413 $cmd{'timeouted'} = 1;
414 } elsif ($@ =~ /^ack / and $@ =~ /pipe/) {
415 print STDERR "Tesh: Broken pipe (ignored).\n";
417 die $@; # Don't know what it is, so let it go.
420 $cmd{'timeouted'} ||= 0;
422 my $gotret = $cmd{'gotret'} = exit_status($?);
426 if ( defined( $cmd{'expect'} ) and ( $cmd{'expect'} ne "" ) ) {
427 $wantret = "got signal $cmd{'expect'}";
429 $wantret = "returned code " . ( defined( $cmd{'return'} ) ? $cmd{'return'} : 0 );
432 # pop all output from executing child
434 map { print "GOT: $_\n" } ${$cmd{'got'}} if $opts{'debug'};
435 foreach my $got ( split("\n", ${$cmd{'got'}}) ) {
438 print $diff_tool_tmp_fh "> $got\n" if ($diff_tool);
440 unless ( $enable_coverage and $got =~ /^profiling:/ ) {
445 if ( $cmd{'sort'} ) {
447 # Save the unsorted observed output to report it on error.
448 map { push @{ $cmd{'unsorted got'} }, $_ } @got;
451 substr( $a, 0, $sort_prefix ) cmp substr( $b, 0, $sort_prefix );
454 if ( $sort_prefix > 0 ) {
455 @got = sort mysort @got;
459 while ( @got and $got[0] eq "" ) {
463 # Sort the expected output to make it easier to write for humans
464 if ( defined( $cmd{'out'} ) ) {
465 if ( $sort_prefix > 0 ) {
466 @{ $cmd{'out'} } = sort mysort @{ $cmd{'out'} };
468 @{ $cmd{'out'} } = sort @{ $cmd{'out'} };
470 while ( @{ $cmd{'out'} } and ${ $cmd{'out'} }[0] eq "" ) {
471 shift @{ $cmd{'out'} };
478 if ( $cmd{'timeouted'} ) {
479 $gotret = "timeout after $cmd{'timeout'} sec";
482 print STDERR "<$cmd{'file'}:$cmd{'line'}> timeouted. Kill the process.\n";
484 if ( $gotret ne $wantret ) {
486 my $msg = "Test suite `$cmd{'file'}': NOK (<$cmd{'file'}:$cmd{'line'}> $gotret)\n";
488 $msg = $msg . "Output of <$cmd{'file'}:$cmd{'line'}> so far:\n";
489 map { $msg .= "|| $_\n" } @got;
491 $msg .= "<$cmd{'file'}:$cmd{'line'}> No output so far.\n";
496 # Does the output match?
498 if ( defined( $cmd{'output display'} ) ) {
499 print "[Tesh/INFO] Here is the (ignored) command output:\n";
500 map { print "||$_\n" } @got;
501 } elsif ( defined( $cmd{'output ignore'} ) ) {
502 print "(ignoring the output of <$cmd{'file'}:$cmd{'line'}> as requested)\n";
504 $diff = build_diff( \@{ $cmd{'out'} }, \@got );
506 if ( length $diff ) {
507 print "Output of <$cmd{'file'}:$cmd{'line'}> mismatch" . ( $cmd{'sort'} ? " (even after sorting)" : "" ) . ":\n";
508 map { print "$_\n" } split( /\n/, $diff );
509 if ( $cmd{'sort'} ) {
510 print "WARNING: Both the observed output and expected output were sorted as requested.\n";
511 print "WARNING: Output were only sorted using the $sort_prefix first chars.\n"
512 if ( $sort_prefix > 0 );
513 print "WARNING: Use <! output sort 19> to sort by simulated date and process ID only.\n";
515 # print "----8<--------------- Begin of unprocessed observed output (as it should appear in file):\n";
516 # map {print "> $_\n"} @{$cmd{'unsorted got'}};
517 # print "--------------->8---- End of the unprocessed observed output.\n";
520 print "Test suite `$cmd{'file'}': NOK (<$cmd{'file'}:$cmd{'line'}> output mismatch)\n";
526 my $infh; # The file descriptor from which we should read the teshfile
527 if ( $tesh_file eq "(stdin)" ) {
530 open $infh, $tesh_file
531 or die "[Tesh/CRITICAL] Unable to open $tesh_file: $!\n";
534 my %cmd; # everything about the next command to run
536 LINE: while ( defined( my $line = <$infh> ) and not $error ) {
541 print "[TESH/debug] $line_num: $line\n" if $opts{'debug'};
543 # deal with line continuations
544 while ( $line =~ /^(.*?)\\$/ ) {
546 die "[TESH/CRITICAL] Continued line at end of file\n"
547 unless defined($next);
550 print "[TESH/debug] $line_num: $next\n" if $opts{'debug'};
554 # Push delayed commands on empty lines
555 unless ( $line =~ m/^(.)(.*)$/ ) {
556 if ( defined( $cmd{'cmd'} ) ) {
560 print $diff_tool_tmp_fh "$line\n" if ($diff_tool);
564 my ( $cmd, $arg ) = ( $1, $2 );
565 print $diff_tool_tmp_fh "$line\n" if ( $diff_tool and $cmd ne '>' );
570 # handle the commands
571 if ( $cmd =~ /^#/ ) { # comment
572 } elsif ( $cmd eq '>' ) { # expected result line
573 print "[TESH/debug] push expected result\n" if $opts{'debug'};
574 push @{ $cmd{'out'} }, $arg;
576 } elsif ( $cmd eq '<' ) { # provided input
577 print "[TESH/debug] push provided input\n" if $opts{'debug'};
578 push @{ $cmd{'in'} }, $arg;
580 } elsif ( $cmd eq 'p' ) { # comment
581 print "[$tesh_name:$line_num] $arg\n";
583 } elsif ( $cmd eq '$' ) { # Command
584 # if we have something buffered, run it now
585 if ( defined( $cmd{'cmd'} ) ) {
589 if ( $arg =~ /^\s*mkfile / ) { # "mkfile" command line
590 die "[TESH/CRITICAL] Output expected from mkfile command!\n"
591 if scalar @{ cmd { 'out' } };
594 $cmd{'arg'} =~ s/\s*mkfile //;
598 } elsif ( $arg =~ /^\s*cd / ) {
599 die "[TESH/CRITICAL] Input provided to cd command!\n"
600 if scalar @{ cmd { 'in' } };
601 die "[TESH/CRITICAL] Output expected from cd command!\n"
602 if scalar @{ cmd { 'out' } };
608 } else { # regular command
610 $cmd{'file'} = $tesh_file;
611 $cmd{'line'} = $line_num;
613 } elsif ( $cmd eq '&' ) { # background command line
615 if ( defined( $cmd{'cmd'} ) ) {
619 $cmd{'background'} = 1;
621 $cmd{'file'} = $tesh_file;
622 $cmd{'line'} = $line_num;
624 } elsif ( $line =~ /^!\s*output sort/ ) { #output sort
625 if ( defined( $cmd{'cmd'} ) ) {
630 if ( $line =~ /^!\s*output sort\s+(\d+)/ ) {
633 } elsif ( $line =~ /^!\s*output ignore/ ) { #output ignore
634 if ( defined( $cmd{'cmd'} ) ) {
638 $cmd{'output ignore'} = 1;
639 } elsif ( $line =~ /^!\s*output display/ ) { #output display
640 if ( defined( $cmd{'cmd'} ) ) {
644 $cmd{'output display'} = 1;
645 } elsif ( $line =~ /^!\s*expect signal (\w*)/ ) { #expect signal SIGABRT
646 if ( defined( $cmd{'cmd'} ) ) {
650 $cmd{'expect'} = "$1";
651 } elsif ( $line =~ /^!\s*expect return/ ) { #expect return
652 if ( defined( $cmd{'cmd'} ) ) {
656 $line =~ s/^! expect return //g;
658 $cmd{'return'} = $line;
659 } elsif ( $line =~ /^!\s*setenv/ ) { #setenv
660 if ( defined( $cmd{'cmd'} ) ) {
664 $line =~ s/^! setenv //g;
667 } elsif ( $line =~ /^!\s*timeout/ ) { #timeout
668 if ( defined( $cmd{'cmd'} ) ) {
672 $line =~ s/^! timeout //;
674 $cmd{'timeout'} = $line;
676 die "[TESH/CRITICAL] parse error: $line\n";
680 # We're done reading the input file
681 close $infh unless ( $tesh_file eq "(stdin)" );
683 # Deal with last command
684 if ( defined( $cmd{'cmd'} ) ) {
691 analyze_result( \%test );
695 close $diff_tool_tmp_fh;
696 system("$diff_tool $diff_tool_tmp_filename $tesh_file");
697 unlink $diff_tool_tmp_filename;
702 } elsif ( $tesh_file eq "(stdin)" ) {
703 print "Test suite from stdin OK\n";
705 print "Test suite `$tesh_name' OK\n";
711 #### Helper functions
716 my $diff = Diff->new(@_);
718 $diff->Base(1); # Return line numbers, not indices
719 my $chunk_count = $diff->Next(-1); # Compute the amount of chuncks
720 return "" if ( $chunk_count == 1 && $diff->Same() );
722 while ( $diff->Next() ) {
723 my @same = $diff->Same();
724 if ( $diff->Same() ) {
725 if ( $diff->Next(0) > 1 ) { # not first chunk: print 2 first lines
726 $res .= ' ' . $same[0] . "\n";
727 $res .= ' ' . $same[1] . "\n" if ( scalar @same > 1 );
729 $res .= "...\n" if ( scalar @same > 2 );
731 # $res .= $diff->Next(0)."/$chunk_count\n";
732 if ( $diff->Next(0) < $chunk_count ) { # not last chunk: print 2 last lines
733 $res .= ' ' . $same[ scalar @same - 2 ] . "\n"
734 if ( scalar @same > 1 );
735 $res .= ' ' . $same[ scalar @same - 1 ] . "\n";
738 next if $diff->Same();
739 map { $res .= "- $_\n" } $diff->Items(1);
740 map { $res .= "+ $_\n" } $diff->Items(2);
745 # Helper function replacing any occurence of variable '$name' by its '$value'
746 # As in Bash, ${$value:=BLABLA} is rewritten to $value if set or to BLABLA if $value is not set
748 my ( $text, $name, $value ) = @_;
750 $text =~ s/\${$name(?::[=-][^}]*)?}/$value/g;
751 $text =~ s/\$$name(\W|$)/$value$1/g;
753 $text =~ s/\${$name:=([^}]*)}/$1/g;
754 $text =~ s/\${$name}//g;
755 $text =~ s/\$$name(\W|$)/$1/g;
760 ################################ The possible commands ################################
763 my %cmd = %{ $_[0] };
764 my $file = $cmd{'arg'};
765 print STDERR "[Tesh/INFO] mkfile $file. Ctn: >>".join( '\n', @{ $cmd{'in'} })."<<\n"
769 open( FILE, ">$file" )
770 or die "[Tesh/CRITICAL] Unable to create file $file: $!\n";
771 print FILE join( "\n", @{ $cmd{'in'} } );
772 print FILE "\n" if ( scalar @{ $cmd{'in'} } > 0 );
776 # Command CD. Just change to the provided directory
778 my $directory = shift;
780 if ( -e $directory && -d $directory ) {
782 print "[Tesh/INFO] change directory to $directory\n";
784 } elsif ( -e $directory ) {
785 print "Cannot change directory to '$directory': it is not a directory\n";
787 print "Chdir to $directory failed: No such file or directory\n";
789 if ( $failure == 1 ) {
790 print "Test suite `$tesh_file': NOK (system error)\n";
795 # Command setenv. Gets "variable=content", and update the environment accordingly
798 if ( $arg =~ /^(.*)=(.*)$/ ) {
799 my ( $var, $ctn ) = ( $1, $2 );
800 print "[Tesh/INFO] setenv $var=$ctn\n";
801 $environ{$var} = $ctn;
804 die "[Tesh/CRITICAL] Malformed argument to setenv: expected 'name=value' but got '$arg'\n";