tools/tesh/tesh.pl

   1 #! /usr/bin/env perl
   2
   3 # Copyright (c) 2012-2015. 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 # 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
  13
  14 =encoding UTF-8
  15
  16 =head1 NAME
  17
  18 tesh -- testing shell
  19
  20 =head1 SYNOPSIS
  21
  22 B<tesh> [I<options>]... I<testsuite>
  23
  24 =head1 DESCRIPTION
  25
  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.
  29
  30 =head1 OPTIONS
  31
  32   --cd some/directory : ask tesh to switch the working directory before
  33                         launching the tests
  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
  39
  40 =head1 TEST SUITE FILE SYTAX
  41
  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.
  45
  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.
  48
  49  `$' command to run in foreground
  50  `&' command to run in background
  51
  52  `<' input to pass to the command
  53  `>' output expected from the command
  54
  55  `!' metacommand, which can be one of:
  56      `timeout' <integer>|no
  57      `expect signal' <signal name>
  58      `expect return' <integer>
  59      `output' <ignore|display>
  60      `setenv <key>=<val>'
  61
  62  `p' an informative message to print
  63
  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.
  67
  68 =head2 Command blocks examples
  69
  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.
  72
  73     $ cat
  74     < TOTO
  75     > TOTO
  76
  77     > TOTO
  78     $ cat
  79     < TOTO
  80
  81     > TOTO
  82     < TOTO
  83     $ cat
  84
  85 You can group several commands together, provided that they don't have
  86 any input nor output.
  87
  88     $ mkdir testdir
  89     $ cd testdir
  90
  91 =head2 Enforcing the command return code
  92
  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.
  95
  96 You specify that a given command block is expected to return another
  97 code as follows:
  98
  99     # This command MUST return 42
 100     ! expect return 42
 101     $ sh -e "exit 42"
 102
 103 The I<expect return> construct applies only to the next command block.
 104
 105 =head2 Commands that are expected to raise signals
 106
 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:
 111
 112     # This command MUST raise a segfault
 113     ! expect signal SIGSEGV
 114     $ ./some_failing_code
 115
 116 The I<expect signal> construct applies only to the next command block.
 117
 118 =head2 Timeouts
 119
 120 By default, no command is allowed to run more than 5 seconds. You can
 121 change this value as follows:
 122
 123     # Allow some more time to the command
 124     ! timeout 60
 125     $ ./some_longer_command
 126
 127 You can also disable the timeout completely by passing "no" as a value:
 128
 129     # This command will never timeout
 130     ! timeout no
 131     $ ./some_very_long_but_safe_command
 132
 133 =head2 Setting environment variables
 134
 135 You can modify the environment of the tested commands as follows:
 136
 137     ! setenv PATH=/bin
 138     $ my_command
 139
 140 =head2 Not enforcing the expected output
 141
 142 By default, the commands output is matched against the one expected,
 143 and an error is raised on discrepancy. Metacommands to change this:
 144
 145 =over 4
 146
 147 =item output ignore
 148
 149 The output is completely discarded.
 150
 151 =item output display
 152
 153 The output is displayed, but no error is issued if it differs from the
 154 expected output.
 155
 156 =item output sort
 157
 158 The output is sorted before comparison (see next section).
 159
 160 =back
 161
 162 =head2 Sorting output
 163
 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.
 169
 170 You can sort the command output as follows:
 171
 172     ! output sort
 173     $ ./some_multithreaded_command
 174
 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.
 178
 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:
 183
 184     # Sort only lines depending on the first 19 chars
 185     ! output sort 19
 186     $ ./some_simgrid_simulator --log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n
 187
 188 This approach may seem surprizing at the first glance but it does its job:
 189
 190 =over 4
 191
 192 =item Every timestamps remain separated, as it should;
 193
 194 =item In each timestamp, the output order of processes become
 195    reproducible: that's the lexicographical order of their name;
 196
 197 =item For each process, the order of its execution is preserved: its
 198    messages within a given timestamp are not reordered.
 199
 200 =back
 201
 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).
 206
 207 This example is very SimGrid oriented, but the feature could even be
 208 usable by others, who knows?
 209
 210
 211 =head1 BUILTIN COMMANDS
 212
 213 =head2 mkfile: creating a file
 214
 215 This command creates a file of the name provided as argument, and adds
 216 the content it gets as input.
 217
 218   $ mkfile myFile
 219   > some content
 220   > to the file
 221
 222 It is not possible to use the cat command, as one would expect,
 223 because stream redirections are currently not implemented in Tesh.
 224
 225 =head1 BUGS, LIMITATIONS AND POSSIBLE IMPROVEMENTS
 226
 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.
 230
 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.
 233
 234 =cut
 235
 236 BEGIN {
 237     # Disabling IPC::Run::Debug saves tons of useless calls.
 238     $ENV{'IPCRUNDEBUG'} = 'none'
 239       unless exists $ENV{'IPCRUNDEBUG'};
 240 }
 241
 242 my $enable_coverage        = 0;
 243 my $enable_sanitizers        = 0;
 244 my $diff_tool              = 0;
 245 my $diff_tool_tmp_fh       = 0;
 246 my $diff_tool_tmp_filename = 0;
 247 my $sort_prefix            = -1;
 248 my $tesh_file;
 249 my $tesh_name;
 250 my $error    = 0;
 251 my $exitcode = 0;
 252 my @bg_cmds;
 253 my (%environ);
 254 $SIG{'PIPE'} = 'IGNORE';
 255
 256 my $path = $0;
 257 $path =~ s|[^/]*$||;
 258 push @INC, $path;
 259
 260 use lib "@CMAKE_BINARY_DIR@/bin";
 261
 262 use Diff qw(diff);    # postpone a bit to have time to change INC
 263
 264 use Getopt::Long qw(GetOptions);
 265 use strict;
 266 use Text::ParseWords;
 267 use IPC::Run qw(start run timeout finish);
 268 use IO::File;
 269 use English;
 270
 271 ####
 272 #### Portability bits for windows
 273 ####
 274
 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);
 278
 279 BEGIN {
 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 };
 285
 286         # used on the command lines
 287         $environ{'EXEEXT'} = ".exe";
 288     }
 289 }
 290
 291
 292 ####
 293 #### Command line option handling
 294 ####
 295
 296 my %opts = ( "debug" => 0,
 297              "timeout" => 5, # No command should run any longer than 5 seconds by default
 298            );
 299
 300 Getopt::Long::config( 'bundling', 'no_getopt_compat', 'no_auto_abbrev' );
 301 GetOptions(
 302     'debug|d' => \$opts{"debug"},
 303
 304     'difftool=s' => \$diff_tool,
 305
 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,
 313 );
 314
 315 $tesh_file = pop @ARGV;
 316 $tesh_name = $tesh_file;
 317 $tesh_name =~ s|^.*?/([^/]*)$|$1|;
 318
 319 print "Enable coverage\n" if ($enable_coverage);
 320 print "Enable sanitizers\n" if ($enable_sanitizers);
 321
 322 if ($diff_tool) {
 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";
 326 }
 327
 328 if ( $tesh_file =~ m/(.*)\.tesh/ ) {
 329     my $dir = qx,pwd,;
 330     chomp($dir);
 331     print "Test suite '$dir/$tesh_file'\n";
 332 } else {
 333     $tesh_name = "(stdin)";
 334     print "Test suite from stdin\n";
 335 }
 336
 337 ###########################################################################
 338
 339 sub exec_cmd {
 340     my %cmd = %{ $_[0] };
 341     if ( $opts{'debug'} ) {
 342         map { print "IN: $_\n" } @{ $cmd{'in'} };
 343         map { print "OUT: $_\n" } @{ $cmd{'out'} };
 344         print "CMD: $cmd{'cmd'}\n";
 345     }
 346
 347     # substitute environment variables
 348     foreach my $key ( keys %environ ) {
 349         $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $key, $environ{$key} );
 350     }
 351
 352     # substitute remaining variables, if any
 353     while ( $cmd{'cmd'} =~ /\$\{(\w+)(?::[=-][^}]*)?\}/ ) {
 354         $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $1, "" );
 355     }
 356     while ( $cmd{'cmd'} =~ /\$(\w+)/ ) {
 357         $cmd{'cmd'} = var_subst( $cmd{'cmd'}, $1, "" );
 358     }
 359
 360     # add cfg and log options
 361     $cmd{'cmd'} .= " $opts{'cfg'}"
 362       if ( defined( $opts{'cfg'} ) && length( $opts{'cfg'} ) );
 363     $cmd{'cmd'} .= " $opts{'log'}"
 364       if ( defined( $opts{'log'} ) && length( $opts{'log'} ) );
 365
 366     # finally trim any remaining space chars
 367     $cmd{'cmd'} =~ s/^\s+//;
 368     $cmd{'cmd'} =~ s/\s+$//;
 369
 370     print "[$tesh_name:$cmd{'line'}] $cmd{'cmd'}\n";
 371
 372     $cmd{'return'} ||= 0;
 373     $cmd{'timeout'} ||= $opts{'timeout'};
 374
 375
 376     ###
 377     # exec the command line
 378
 379     my @cmdline;
 380     if(defined $ENV{VALGRIND_COMMAND}) {
 381       push @cmdline, $ENV{VALGRIND_COMMAND};
 382       push @cmdline, split(" ", $ENV{VALGRIND_OPTIONS});
 383       if($cmd{'timeout'} ne 'no'){
 384           $cmd{'timeout'}=$cmd{'timeout'}*20
 385       }
 386     }
 387     push @cmdline, quotewords( '\s+', 0, $cmd{'cmd'} );
 388     my $input = defined($cmd{'in'})? join("\n",@{$cmd{'in'}}) : "";
 389     my $output = " " x 10240; $output = ""; # Preallocate 10kB, and reset length to 0
 390     $cmd{'got'} = \$output;
 391     $cmd{'job'} = start \@cmdline, '<', \$input, '>&', \$output,
 392                   ($cmd{'timeout'} eq 'no' ? () : timeout($cmd{'timeout'}));
 393
 394     if ( $cmd{'background'} ) {
 395         # Just enqueue the job. It will be dealed with at the end
 396         push @bg_cmds, \%cmd;
 397     } else {
 398         # Deal with its ending conditions right away
 399         analyze_result( \%cmd );
 400     }
 401 }
 402
 403 sub analyze_result {
 404     my %cmd    = %{ $_[0] };
 405     $cmd{'timeouted'} = 0; # initialization
 406
 407     # Wait for the end of the child process
 408     #####
 409     eval {
 410         finish( $cmd{'job'} );
 411     };
 412     if ($@) { # deal with the errors that occurred in the child process
 413         if ($@ =~ /timeout/) {
 414             $cmd{'job'}->kill_kill;
 415             $cmd{'timeouted'} = 1;
 416         } elsif ($@ =~ /^ack / and $@ =~ /pipe/) { # IPC::Run is not very expressive about the pipes that it gets :(
 417             print STDERR "Tesh: Broken pipe (ignored).\n";
 418         } else {
 419             die $@; # Don't know what it is, so let it go.
 420         }
 421     }
 422
 423     # Gather information
 424     ####
 425
 426     # pop all output from executing child
 427     my @got;
 428     map { print "GOT: $_\n" } ${$cmd{'got'}} if $opts{'debug'};
 429     foreach my $got ( split("\n", ${$cmd{'got'}}) ) {
 430         $got =~ s/\r//g;
 431         chomp $got;
 432         print $diff_tool_tmp_fh "> $got\n" if ($diff_tool);
 433
 434         unless (( $enable_coverage and $got =~ /^profiling:/ ) or
 435             ( $enable_sanitizers and $got =~ m/WARNING: ASan doesn't fully support/) or
 436             ( $got =~ m/Unable to clean temporary file C:/)) # Crude hack to ignore cruft from Java on Windows
 437         {
 438             push @got, $got;
 439         }
 440     }
 441
 442     # How did the child process terminate?
 443     my $status = $?;
 444     $cmd{'gotret'} = "Unparsable status. Please report this tesh bug.";
 445     if ( $cmd{'timeouted'} ) {
 446         $cmd{'gotret'} = "timeout after $cmd{'timeout'} sec";
 447         $error    = 1;
 448         $exitcode = 3;
 449     } elsif ( WIFEXITED($status) ) {
 450         $exitcode = WEXITSTATUS($status) + 40;
 451         $cmd{'gotret'} = "returned code " . WEXITSTATUS($status);
 452     } elsif ( WIFSIGNALED($status) ) {
 453         my $code;
 454         if    ( WTERMSIG($status) == SIGINT )  { $code = "SIGINT"; }
 455         elsif ( WTERMSIG($status) == SIGTERM ) { $code = "SIGTERM"; }
 456         elsif ( WTERMSIG($status) == SIGKILL ) { $code = "SIGKILL"; }
 457         elsif ( WTERMSIG($status) == SIGABRT ) { $code = "SIGABRT"; }
 458         elsif ( WTERMSIG($status) == SIGSEGV ) { $code = "SIGSEGV"; }
 459         $exitcode = WTERMSIG($status) + 4;
 460         $cmd{'gotret'} = "got signal $code";
 461     }
 462
 463     # How was it supposed to terminate?
 464     my $wantret;
 465     if ( defined( $cmd{'expect'} ) and ( $cmd{'expect'} ne "" ) ) {
 466         $wantret = "got signal $cmd{'expect'}";
 467     } else {
 468         $wantret = "returned code " . ( defined( $cmd{'return'} ) ? $cmd{'return'} : 0 );
 469     }
 470
 471     # Enforce the outcome
 472     ####
 473
 474     # Did it end as expected?
 475     if ( $cmd{'gotret'} ne $wantret ) {
 476         $error = 1;
 477         my $msg = "Test suite `$tesh_name': NOK (<$tesh_name:$cmd{'line'}> $cmd{'gotret'})\n";
 478         if ( scalar @got ) {
 479             $msg = $msg . "Output of <$tesh_name:$cmd{'line'}> so far:\n";
 480             map { $msg .= "|| $_\n" } @got;
 481         } else {
 482             $msg .= "<$tesh_name:$cmd{'line'}> No output so far.\n";
 483         }
 484         print STDERR "$msg";
 485     }
 486
 487     # Does the output match?
 488     if ( $cmd{'sort'} ) {
 489         sub mysort {
 490             substr( $a, 0, $sort_prefix ) cmp substr( $b, 0, $sort_prefix );
 491         }
 492         use sort 'stable';
 493         if ( $sort_prefix > 0 ) {
 494             @got = sort mysort @got;
 495         } else {
 496             @got = sort @got;
 497         }
 498         while ( @got and $got[0] eq "" ) {
 499             shift @got;
 500         }
 501
 502         # Sort the expected output too, to make tesh files easier to write for humans
 503         if ( defined( $cmd{'out'} ) ) {
 504             if ( $sort_prefix > 0 ) {
 505                 @{ $cmd{'out'} } = sort mysort @{ $cmd{'out'} };
 506             } else {
 507                 @{ $cmd{'out'} } = sort @{ $cmd{'out'} };
 508             }
 509             while ( @{ $cmd{'out'} } and ${ $cmd{'out'} }[0] eq "" ) {
 510                 shift @{ $cmd{'out'} };
 511             }
 512         }
 513     }
 514
 515     # Report the output if asked so or if it differs
 516     if ( defined( $cmd{'output display'} ) ) {
 517         print "[Tesh/INFO] Here is the (ignored) command output:\n";
 518         map { print "||$_\n" } @got;
 519     } elsif ( defined( $cmd{'output ignore'} ) ) {
 520         print "(ignoring the output of <$tesh_name:$cmd{'line'}> as requested)\n";
 521     } else {
 522         my $diff = build_diff( \@{ $cmd{'out'} }, \@got );
 523
 524         if ( length $diff ) {
 525             print "Output of <$tesh_name:$cmd{'line'}> mismatch" . ( $cmd{'sort'} ? " (even after sorting)" : "" ) . ":\n";
 526             map { print "$_\n" } split( /\n/, $diff );
 527             if ( $cmd{'sort'} ) {
 528                 print "WARNING: Both the observed output and expected output were sorted as requested.\n";
 529                 print "WARNING: Output were only sorted using the $sort_prefix first chars.\n"
 530                     if ( $sort_prefix > 0 );
 531                 print "WARNING: Use <! output sort 19> to sort by simulated date and process ID only.\n";
 532
 533                 # print "----8<---------------  Begin of unprocessed observed output (as it should appear in file):\n";
 534                 # map {print "> $_\n"} @{$cmd{'unsorted got'}};
 535                 # print "--------------->8----  End of the unprocessed observed output.\n";
 536             }
 537
 538             print "Test suite `$tesh_name': NOK (<$tesh_name:$cmd{'line'}> output mismatch)\n";
 539             exit 2;
 540         }
 541     }
 542 }
 543
 544 # parse tesh file
 545 my $infh;    # The file descriptor from which we should read the teshfile
 546 if ( $tesh_name eq "(stdin)" ) {
 547     $infh = *STDIN;
 548 } else {
 549     open $infh, $tesh_file
 550       or die "[Tesh/CRITICAL] Unable to open $tesh_file: $!\n";
 551 }
 552
 553 my %cmd;     # everything about the next command to run
 554 my $line_num = 0;
 555 LINE: while ( not $error and defined( my $line = <$infh> )) {
 556     chomp $line;
 557     $line =~ s/\r//g;
 558
 559     $line_num++;
 560     print "[TESH/debug] $line_num: $line\n" if $opts{'debug'};
 561
 562     # deal with line continuations
 563     while ( $line =~ /^(.*?)\\$/ ) {
 564         my $next = <$infh>;
 565         die "[TESH/CRITICAL] Continued line at end of file\n"
 566           unless defined($next);
 567         $line_num++;
 568         chomp $next;
 569         print "[TESH/debug] $line_num: $next\n" if $opts{'debug'};
 570         $line = $1 . $next;
 571     }
 572
 573     # If the line is empty, run any previously defined block and proceed to next line
 574     unless ( $line =~ m/^(.)(.*)$/ ) {
 575         if ( defined( $cmd{'cmd'} ) ) {
 576             exec_cmd( \%cmd );
 577             %cmd = ();
 578         }
 579         print $diff_tool_tmp_fh "$line\n" if ($diff_tool);
 580         next LINE;
 581     }
 582
 583     my ( $cmd, $arg ) = ( $1, $2 );
 584     print $diff_tool_tmp_fh "$line\n" if ( $diff_tool and $cmd ne '>' );
 585     $arg =~ s/^ //g;
 586     $arg =~ s/\r//g;
 587     $arg =~ s/\\\\/\\/g;
 588
 589     # Deal with the lines that can contribute to the current command block
 590     if ( $cmd =~ /^#/ ) {    # comment
 591         next LINE;
 592     } elsif ( $cmd eq '>' ) {    # expected result line
 593         print "[TESH/debug] push expected result\n" if $opts{'debug'};
 594         push @{ $cmd{'out'} }, $arg;
 595         next LINE;
 596
 597     } elsif ( $cmd eq '<' ) {    # provided input
 598         print "[TESH/debug] push provided input\n" if $opts{'debug'};
 599         push @{ $cmd{'in'} }, $arg;
 600         next LINE;
 601
 602     } elsif ( $cmd eq 'p' ) {    # comment
 603         print "[$tesh_name:$line_num] $arg\n";
 604         next LINE;
 605
 606     }
 607
 608     # We dealt with all sort of lines that can contribute to a command block, so we have something else here.
 609     # If we have something buffered, run it now and start a new block
 610     if ( defined( $cmd{'cmd'} ) ) {
 611         exec_cmd( \%cmd );
 612         %cmd = ();
 613     }
 614
 615     # Deal with the lines that must be placed before a command block
 616     if ( $cmd eq '$' ) {    # Command
 617         if ( $arg =~ /^mkfile / ) {    # "mkfile" command line
 618             die "[TESH/CRITICAL] Output expected from mkfile command!\n"
 619               if scalar @{ cmd { 'out' } };
 620
 621             $cmd{'arg'} = $arg;
 622             $cmd{'arg'} =~ s/mkfile //;
 623             mkfile_cmd( \%cmd );
 624             %cmd = ();
 625
 626         } elsif ( $arg =~ /^\s*cd / ) {
 627             die "[TESH/CRITICAL] Input provided to cd command!\n"
 628               if scalar @{ cmd { 'in' } };
 629             die "[TESH/CRITICAL] Output expected from cd command!\n"
 630               if scalar @{ cmd { 'out' } };
 631
 632             $arg =~ s/^ *cd //;
 633             cd_cmd($arg);
 634             %cmd = ();
 635
 636         } else {    # regular command
 637             $cmd{'cmd'}  = $arg;
 638             $cmd{'line'} = $line_num;
 639         }
 640
 641     } elsif ( $cmd eq '&' ) {    # background command line
 642         die "[TESH/CRITICAL] mkfile cannot be run in background\n"
 643             if ($arg =~ /^mkfile/);
 644         die "[TESH/CRITICAL] cd cannot be run in background\n"
 645             if ($arg =~ /^cd/);
 646
 647         $cmd{'background'} = 1;
 648         $cmd{'cmd'}        = $arg;
 649         $cmd{'line'}       = $line_num;
 650
 651     # Deal with the meta-commands
 652     } elsif ( $line =~ /^! (.*)/) {
 653         $line = $1;
 654
 655         if ( $line =~ /^output sort/ ) {
 656             $cmd{'sort'} = 1;
 657             if ( $line =~ /^output sort\s+(\d+)/ ) {
 658                 $sort_prefix = $1;
 659             }
 660         } elsif ($line =~ /^output ignore/ ) {
 661             $cmd{'output ignore'} = 1;
 662         } elsif ( $line =~ /^output display/ ) {
 663             $cmd{'output display'} = 1;
 664         } elsif ( $line =~ /^expect signal (\w*)/ ) {
 665             $cmd{'expect'} = $1;
 666         } elsif ( $line =~ /^expect return/ ) {
 667             $line =~ s/^expect return //g;
 668             $line =~ s/\r//g;
 669             $cmd{'return'} = $line;
 670         } elsif ( $line =~ /^setenv/ ) {
 671             $line =~ s/^setenv //g;
 672             $line =~ s/\r//g;
 673             setenv_cmd($line);
 674         } elsif ( $line =~ /^timeout/ ) {
 675             $line =~ s/^timeout //;
 676             $line =~ s/\r//g;
 677             $cmd{'timeout'} = $line;
 678         }
 679     } else {
 680         die "[TESH/CRITICAL] parse error: $line\n";
 681     }
 682 }
 683
 684 # We are done reading the input file
 685 close $infh unless ( $tesh_name eq "(stdin)" );
 686
 687 # Deal with last command, if any
 688 if ( defined( $cmd{'cmd'} ) ) {
 689     exec_cmd( \%cmd );
 690     %cmd = ();
 691 }
 692
 693 foreach (@bg_cmds) {
 694     my %test = %{$_};
 695     analyze_result( \%test );
 696 }
 697
 698 if ($diff_tool) {
 699     close $diff_tool_tmp_fh;
 700     system("$diff_tool $diff_tool_tmp_filename $tesh_file");
 701     unlink $diff_tool_tmp_filename;
 702 }
 703
 704 if ( $error != 0 ) {
 705     exit $exitcode;
 706 } elsif ( $tesh_name eq "(stdin)" ) {
 707     print "Test suite from stdin OK\n";
 708 } else {
 709     print "Test suite `$tesh_name' OK\n";
 710 }
 711
 712 exit 0;
 713
 714 ####
 715 #### Helper functions
 716 ####
 717
 718 sub build_diff {
 719     my $res;
 720     my $diff = Diff->new(@_);
 721
 722     $diff->Base(1);    # Return line numbers, not indices
 723     my $chunk_count = $diff->Next(-1);    # Compute the amount of chuncks
 724     return "" if ( $chunk_count == 1 && $diff->Same() );
 725     $diff->Reset();
 726     while ( $diff->Next() ) {
 727         my @same = $diff->Same();
 728         if ( $diff->Same() ) {
 729             if ( $diff->Next(0) > 1 ) {    # not first chunk: print 2 first lines
 730                 $res .= '  ' . $same[0] . "\n";
 731                 $res .= '  ' . $same[1] . "\n" if ( scalar @same > 1 );
 732             }
 733             $res .= "...\n" if ( scalar @same > 2 );
 734
 735             #    $res .= $diff->Next(0)."/$chunk_count\n";
 736             if ( $diff->Next(0) < $chunk_count ) {    # not last chunk: print 2 last lines
 737                 $res .= '  ' . $same[ scalar @same - 2 ] . "\n"
 738                   if ( scalar @same > 1 );
 739                 $res .= '  ' . $same[ scalar @same - 1 ] . "\n";
 740             }
 741         }
 742         next if $diff->Same();
 743         map { $res .= "- $_\n" } $diff->Items(1);
 744         map { $res .= "+ $_\n" } $diff->Items(2);
 745     }
 746     return $res;
 747 }
 748
 749 # Helper function replacing any occurence of variable '$name' by its '$value'
 750 # As in Bash, ${$value:=BLABLA} is rewritten to $value if set or to BLABLA if $value is not set
 751 sub var_subst {
 752     my ( $text, $name, $value ) = @_;
 753     if ($value) {
 754         $text =~ s/\$\{$name(?::[=-][^}]*)?\}/$value/g;
 755         $text =~ s/\$$name(\W|$)/$value$1/g;
 756     } else {
 757         $text =~ s/\$\{$name:=([^}]*)\}/$1/g;
 758         $text =~ s/\$\{$name\}//g;
 759         $text =~ s/\$$name(\W|$)/$1/g;
 760     }
 761     return $text;
 762 }
 763
 764 ################################  The possible commands  ################################
 765
 766 sub mkfile_cmd($) {
 767     my %cmd  = %{ $_[0] };
 768     my $file = $cmd{'arg'};
 769     print STDERR "[Tesh/INFO] mkfile $file. Ctn: >>".join( '\n', @{ $cmd{'in'} })."<<\n"
 770       if $opts{'debug'};
 771
 772     unlink($file);
 773     open( FILE, ">$file" )
 774       or die "[Tesh/CRITICAL] Unable to create file $file: $!\n";
 775     print FILE join( "\n", @{ $cmd{'in'} } );
 776     print FILE "\n" if ( scalar @{ $cmd{'in'} } > 0 );
 777     close(FILE);
 778 }
 779
 780 # Command CD. Just change to the provided directory
 781 sub cd_cmd($) {
 782     my $directory = shift;
 783     my $failure   = 1;
 784     if ( -e $directory && -d $directory ) {
 785         chdir("$directory");
 786         print "[Tesh/INFO] change directory to $directory\n";
 787         $failure = 0;
 788     } elsif ( -e $directory ) {
 789         print "Cannot change directory to '$directory': it is not a directory\n";
 790     } else {
 791         print "Chdir to $directory failed: No such file or directory\n";
 792     }
 793     if ( $failure == 1 ) {
 794         print "Test suite `$tesh_name': NOK (system error)\n";
 795         exit 4;
 796     }
 797 }
 798
 799 # Command setenv. Gets "variable=content", and update the environment accordingly
 800 sub setenv_cmd($) {
 801     my $arg = shift;
 802     if ( $arg =~ /^(.*?)=(.*)$/ ) {
 803         my ( $var, $ctn ) = ( $1, $2 );
 804         print "[Tesh/INFO] setenv $var=$ctn\n";
 805         $environ{$var} = $ctn;
 806         $ENV{$var} = $ctn;
 807     } else {
 808         die "[Tesh/CRITICAL] Malformed argument to setenv: expected 'name=value' but got '$arg'\n";
 809     }
 810 }