The Tcpdump Group git mirrors - tcpdump/blob - tests/TESTrun

   1 #!/usr/bin/env perl
   2
   3 #
   4 # Were we told where to find tcpdump?
   5 #
   6 if (!($TCPDUMP = $ENV{TCPDUMP_BIN})) {
   7     #
   8     # No.  Use the appropriate path.
   9     #
  10     if ($^O eq 'MSWin32') {
  11         #
  12         # XXX - assume, for now, a Visual Studio debug build, so that
  13         # tcpdump is in the Debug subdirectory.
  14         #
  15         $TCPDUMP = "Debug\\tcpdump"
  16     } else {
  17         $TCPDUMP = "./tcpdump"
  18     }
  19 }
  20
  21 use File::Basename;
  22 use POSIX qw( WEXITSTATUS WIFEXITED);
  23 use Cwd qw(abs_path getcwd);
  24 use File::Path qw(mkpath);   # mkpath works with ancient perl, as well as newer perl
  25 use File::Spec;
  26 use Data::Dumper;            # for debugging.
  27
  28 # these are created in the directory where we are run, which might be
  29 # a build directory.
  30 my $newdir = "tests/NEW";
  31 my $diffdir= "tests/DIFF";
  32 mkpath($newdir);
  33 mkpath($diffdir);
  34 my $origdir = getcwd();
  35 my $srcdir  = $ENV{'srcdir'} || ".";
  36
  37 #
  38 # Force UTC, so time stamps are printed in a standard time zone, and
  39 # tests don't have to be run in the time zone in which the output
  40 # file was generated.
  41 #
  42 $ENV{'TZ'}='GMT0';
  43
  44 #
  45 # Get the tests directory from $0.
  46 #
  47 my $testsdir = dirname($0);
  48
  49 #
  50 # Convert it to an absolute path, so it works even after we do a cd.
  51 #
  52 $testsdir = abs_path($testsdir);
  53 print "Running tests from ${testsdir}\n";
  54
  55 unshift(@INC, $testsdir);
  56
  57 $passedcount = 0;
  58 $failedcount = 0;
  59 #
  60 my $failureoutput=$origdir . "/tests/failure-outputs.txt";
  61
  62 # truncate the output file
  63 open(FAILUREOUTPUT, ">" . $failureoutput);
  64 close(FAILUREOUTPUT);
  65
  66 $confighhash = undef;
  67
  68 sub showfile {
  69     local($path) = @_;
  70
  71     #
  72     # XXX - just do this directly in Perl?
  73     #
  74     if ($^O eq 'MSWin32') {
  75         my $winpath = File::Spec->canonpath($path);
  76         system "type $winpath";
  77     } else {
  78         system "cat $path";
  79     }
  80 }
  81
  82 sub runtest {
  83     local($name, $input, $output, $options) = @_;
  84     my $r;
  85
  86     $outputbase = basename($output);
  87     my $coredump = false;
  88     my $status = 0;
  89     my $linecount = 0;
  90     my $rawstderrlog = "tests/NEW/${outputbase}.raw.stderr";
  91     my $stderrlog = "tests/NEW/${outputbase}.stderr";
  92     my $diffstat = 0;
  93     my $errdiffstat = 0;
  94
  95     # we used to do this as a nice pipeline, but the problem is that $r fails to
  96     # to be set properly if the tcpdump core dumps.
  97     #
  98     # Furthermore, on Windows, fc can't read the standard input, so we
  99     # can't do it as a pipeline in any case.
 100     $r = system "$TCPDUMP -# -n -r $input $options >tests/NEW/${outputbase} 2>${rawstderrlog}";
 101     if($r != 0) {
 102         #
 103         # Something other than "tcpdump opened the file, read it, and
 104         # dissected all the packets".  What happened?
 105         #
 106         # We write out an exit status after whatever the subprocess
 107         # wrote out, so it shows up when we diff the expected output
 108         # with it.
 109         #
 110         open(OUTPUT, ">>"."tests/NEW/$outputbase") || die "fail to open $outputbase\n";
 111         if($r == -1) {
 112             # failed to start due to error.
 113             $status = $!;
 114             printf OUTPUT "FAILED TO RUN: status: %d\n", $status;
 115         } else {
 116             if ($^O eq 'MSWin32') {
 117                 #
 118                 # On Windows, the return value of system is the lower 8
 119                 # bits of the exit status of the process, shifted left
 120                 # 8 bits.
 121                 #
 122                 # If the process crashed, rather than exiting, the
 123                 # exit status will be one of the EXCEPTION_ values
 124                 # listed in the documentation for the GetExceptionCode()
 125                 # macro.
 126                 #
 127                 # Those are defined as STATUS_ values, which should have
 128                 # 0xC in the topmost 4 bits (being fatal error
 129                 # statuses); some of them have a value that fits in
 130                 # the lower 8 bits.  We could, I guess, assume that
 131                 # any value that 1) isn't returned by tcpdump and 2)
 132                 # corresponds to the lower 8 bits of a STATUS_ value
 133                 # used as an EXCEPTION_ value indicates that tcpdump
 134                 # exited with that exception.
 135                 #
 136                 # However, as we're running tcpdump with system, which
 137                 # runs the command through cmd.exe, and as cmd.exe
 138                 # doesn't map the command's exit code to its own exit
 139                 # code in any straightforward manner, we can't get
 140                 # that information in any case, so there's no point
 141                 # in trying to interpret it in that fashion.
 142                 #
 143                 $status = $r >> 8;
 144             } else {
 145                 #
 146                 # On UN*Xes, the return status is a POSIX as filled in
 147                 # by wait() or waitpid().
 148                 #
 149                 # POSIX offers some calls for analyzing it, such as
 150                 # WIFSIGNALED() to test whether it indicates that the
 151                 # process was terminated by a signal, WTERMSIG() to
 152                 # get the signal number from it, WIFEXITED() to test
 153                 # whether it indicates that the process exited normally,
 154                 # and WEXITSTATUS() to get the exit status from it.
 155                 #
 156                 # POSIX doesn't standardize core dumps, so the POSIX
 157                 # calls can't test whether a core dump occurred.
 158                 # However, all the UN*Xes we are likely to encounter
 159                 # follow Research UNIX in this regard, with the exit
 160                 # status containing either 0 or a signal number in
 161                 # the lower 7 bits, with 0 meaning "exited rather
 162                 # than being terminated by a signal", the "core dumped"
 163                 # flag in the 0x80 bit, and, if the signal number is
 164                 # 0, the exit status in the next 8 bits up.
 165                 #
 166                 # This should be cleaned up to use the POSIX calls
 167                 # from the Perl library - and to define an additional
 168                 # WCOREDUMP() call to test the "core dumped" bit and
 169                 # use that.
 170                 #
 171                 # But note also that, as we're running tcpdump with
 172                 # system, which runs the command through a shell, if
 173                 # tcpdump crashes, we'll only know that if the shell
 174                 # maps the signal indication and uses that as its
 175                 # exit status.
 176                 #
 177                 # The good news is that the Bourne shell, and compatible
 178                 # shells, have traditionally done that.  If the process
 179                 # for which the shell reports the exit status terminates
 180                 # with a signal, it adds 128 to the signal number and
 181                 # returns that as its exit status.  (This is why the
 182                 # "this is now working right" behavior described in a
 183                 # comment below is occurring.)
 184                 #
 185                 # As tcpdump itself never returns with an exit status
 186                 # >= 128, we can try checking for an exit status with
 187                 # the 0x80 bit set and, if we have one, get the signal
 188                 # number from the lower 7 bits of the exit status.  We
 189                 # can't get the "core dumped" indication from the
 190                 # shell's exit status; all we can do is check whether
 191                 # there's a core file.
 192                 #
 193                 if( $r & 128 ) {
 194                     $coredump = $r & 127;
 195                 }
 196                 if( WIFEXITED($r)) {
 197                     $status = WEXITSTATUS($r);
 198                 }
 199             }
 200
 201             if($coredump || $status) {
 202                 printf OUTPUT "EXIT CODE %08x: dump:%d code: %d\n", $r, $coredump, $status;
 203             } else {
 204                 printf OUTPUT "EXIT CODE %08x\n", $r;
 205             }
 206             $r = 0;
 207         }
 208         close(OUTPUT);
 209     }
 210     if($r == 0) {
 211         #
 212         # Compare tcpdump's output with what we think it should be.
 213         # If tcpdump failed to produce output, we've produced our own
 214         # "output" above, with the exit status.
 215         #
 216         if ($^O eq 'MSWin32') {
 217             my $winoutput = File::Spec->canonpath($output);
 218             $r = system "fc /lb1000 /t /1 $winoutput tests\\NEW\\$outputbase >tests\\DIFF\\$outputbase.diff";
 219             $status = $r >> 8;
 220         } else {
 221             $r = system "diff $output tests/NEW/$outputbase >tests/DIFF/$outputbase.diff";
 222             $diffstat = WEXITSTATUS($r);
 223         }
 224     }
 225
 226     # process the standard error file, sanitize "reading from" line,
 227     # and count lines
 228     $linecount = 0;
 229     open(ERRORRAW, "<" . $rawstderrlog);
 230     open(ERROROUT, ">" . $stderrlog);
 231     while(<ERRORRAW>) {
 232         next if /^$/;  # blank lines are boring
 233         if(/^(reading from file )(.*)(,.*)$/) {
 234             my $filename = basename($2);
 235             print ERROROUT "${1}${filename}${3}\n";
 236             next;
 237         }
 238         print ERROROUT;
 239         $linecount++;
 240     }
 241     close(ERROROUT);
 242     close(ERRORRAW);
 243
 244     if ( -f "$output.stderr" ) {
 245         #
 246         # Compare the standard error with what we think it should be.
 247         #
 248         if ($^O eq 'MSWin32') {
 249             my $winoutput = File::Spec->canonpath($output);
 250             my $canonstderrlog = File::Spec->canonpath($stderrlog);
 251             $nr = system "fc /lb1000 /t /1 $winoutput.stderr $canonstderrlog >tests\DIFF\$outputbase.stderr.diff";
 252             $errdiffstat = $nr >> 8;
 253         } else {
 254             $nr = system "diff $output.stderr $stderrlog >tests/DIFF/$outputbase.stderr.diff";
 255             $errdiffstat = WEXITSTATUS($nr);
 256         }
 257         if($r == 0) {
 258             $r = $nr;
 259         }
 260     }
 261
 262     if($r == 0) {
 263         if($linecount == 0 && $status == 0) {
 264             unlink($stderrlog);
 265         } else {
 266             $errdiffstat = 1;
 267         }
 268     }
 269
 270     #print sprintf("END: %08x\n", $r);
 271
 272     if($r == 0) {
 273         if($linecount == 0) {
 274             printf "    %-40s: passed\n", $name;
 275         } else {
 276             printf "    %-40s: passed with error messages:\n", $name;
 277             showfile($stderrlog);
 278         }
 279         unlink "tests/DIFF/$outputbase.diff";
 280         return 0;
 281     }
 282     # must have failed!
 283     printf "    %-40s: TEST FAILED(exit core=%d/diffstat=%d,%d/r=%d)", $name, $coredump, $diffstat, $errdiffstat, $r;
 284     open FOUT, '>>tests/failure-outputs.txt';
 285     printf FOUT "\nFailed test: $name\n\n";
 286     close FOUT;
 287     if(-f "tests/DIFF/$outputbase.diff") {
 288         #
 289         # XXX - just do this directly in Perl?
 290         #
 291         if ($^O eq 'MSWin32') {
 292             system "type tests\\DIFF\\$outputbase.diff >> tests\\failure-outputs.txt";
 293         } else {
 294             system "cat tests/DIFF/$outputbase.diff >> tests/failure-outputs.txt";
 295         }
 296     }
 297
 298     if($r == -1) {
 299         print " (failed to execute: $!)\n";
 300         return(30);
 301     }
 302
 303     # this is not working right, $r == 0x8b00 when there is a core dump.
 304     # clearly, we need some platform specific perl magic to take this apart, so look for "core"
 305     # too.
 306     # In particular, on Solaris 10 SPARC an alignment problem results in SIGILL,
 307     # a core dump and $r set to 0x00008a00 ($? == 138 in the shell).
 308     if($r & 127 || -f "core") {
 309         my $with = ($r & 128) ? 'with' : 'without';
 310         if(-f "core") {
 311             $with = "with";
 312         }
 313         printf " (terminated with signal %u, %s coredump)", ($r & 127), $with;
 314         if($linecount == 0) {
 315             print "\n";
 316         } else {
 317             print " with error messages:\n";
 318             showfile($stderrlog);
 319         }
 320         return(($r & 128) ? 10 : 20);
 321     }
 322     if($linecount == 0) {
 323         print "\n";
 324     } else {
 325         print " with error messages:\n";
 326         showfile($stderrlog);
 327     }
 328     return(5);
 329 }
 330
 331 sub loadconfighash {
 332     if(defined($confighhash)) {
 333         return $confighhash;
 334     }
 335
 336     $main::confighhash = {};
 337
 338     # this could be loaded once perhaps.
 339     open(CONFIG_H, "config.h") || die "Can not open config.h: $!\n";
 340     while(<CONFIG_H>) {
 341         chomp;
 342         if(/^\#define (.*) 1/) {
 343             #print "Setting $1\n";
 344             $main::confighhash->{$1} = 1;
 345         }
 346     }
 347     close(CONFIG_H);
 348     #print Dumper($main::confighhash);
 349
 350     # also run tcpdump --fp-type to get the type of floating-point
 351     # arithmetic we're doing, setting a HAVE_{fptype} key based
 352     # on the value it prints
 353     open(FPTYPE_PIPE, "$TCPDUMP --fp-type |") or die("piping tcpdump --fp-type failed\n");
 354     my $fptype_val = <FPTYPE_PIPE>;
 355     close(FPTYPE_PIPE);
 356     my $have_fptype;
 357     if($fptype_val == "9877.895") {
 358         $have_fptype = "HAVE_FPTYPE1";
 359     } else {
 360         $have_fptype = "HAVE_FPTYPE2";
 361     }
 362     $main::confighhash->{$have_fptype} = 1;
 363
 364     return $main::confighhash;
 365 }
 366
 367
 368 sub runOneComplexTest {
 369     local($testconfig) = @_;
 370
 371     my $output = $testconfig->{output};
 372     my $input  = $testconfig->{input};
 373     my $name   = $testconfig->{name};
 374     my $options= $testconfig->{args};
 375     my $foundit = 1;
 376     my $unfoundit=1;
 377
 378     my $configset = $testconfig->{config_set};
 379     my $configunset = $testconfig->{config_unset};
 380     my $ch = loadconfighash();
 381     #print Dumper($ch);
 382
 383     if(defined($configset)) {
 384         $foundit = ($ch->{$configset} == 1);
 385     }
 386     if(defined($configunset)) {
 387         $unfoundit=($ch->{$configunset} != 1);
 388     }
 389
 390     if(!$foundit) {
 391         printf "    %-40s: skipped (%s not set)\n", $name, $configset;
 392         return 0;
 393     }
 394
 395     if(!$unfoundit) {
 396         printf "    %-40s: skipped (%s set)\n", $name, $configunset;
 397         return 0;
 398     }
 399
 400     #use Data::Dumper;
 401     #print Dumper($testconfig);
 402
 403     # EXPAND any occurances of @TESTDIR@ to $testsdir
 404     $options =~ s/\@TESTDIR\@/$testsdir/;
 405
 406     my $result = runtest($name,
 407                          $testsdir . "/" . $input,
 408                          $testsdir . "/" . $output,
 409                          $options);
 410
 411     if($result == 0) {
 412         $passedcount++;
 413     } else {
 414         $failedcount++;
 415     }
 416 }
 417
 418 # *.tests files are PERL hash definitions.  They should create an array of hashes
 419 # one per test, and place it into the variable @testlist.
 420 sub runComplexTests {
 421     my @files = glob( $testsdir . '/*.tests' );
 422     foreach $file (@files) {
 423         my @testlist = undef;
 424         my $definitions;
 425         print "FILE: ${file}\n";
 426         open(FILE, "<".$file) || die "can not open $file: $!";
 427         {
 428             local $/ = undef;
 429             $definitions = <FILE>;
 430         }
 431         close(FILE);
 432         #print "STUFF: ${definitions}\n";
 433         eval $definitions;
 434         if(defined($testlist)) {
 435             #use Data::Dumper;
 436             #print Dumper($testlist);
 437             foreach $test (@$testlist) {
 438                 runOneComplexTest($test);
 439             }
 440         } else {
 441             warn "File: ${file} could not be loaded as PERL: $!";
 442         }
 443     }
 444 }
 445
 446 sub runSimpleTests {
 447
 448     local($only)=@_;
 449
 450     open(TESTLIST, "<" . "${testsdir}/TESTLIST") || die "no ${testsdir}/TESTFILE: $!\n";
 451     while(<TESTLIST>) {
 452         next if /^\#/;
 453         next if /^$/;
 454
 455         unlink("core");
 456         ($name, $input, $output, @options) = split;
 457         #print "processing ${only} vs ${name}\n";
 458         next if(defined($only) && $only ne $name);
 459
 460         my $options = join(" ", @options);
 461         #print "@{options} becomes ${options}\n";
 462
 463         my $hash = { name => $name,
 464                      input=> $input,
 465                      output=>$output,
 466                      args => $options };
 467
 468         runOneComplexTest($hash);
 469     }
 470 }
 471
 472 if(scalar(@ARGV) == 0) {
 473     runSimpleTests();
 474     runComplexTests();
 475 } else {
 476     runSimpleTests($ARGV[0]);
 477 }
 478
 479 # exit with number of failing tests.
 480 print "------------------------------------------------\n";
 481 printf("%4u tests failed\n",$failedcount);
 482 printf("%4u tests passed\n",$passedcount);
 483
 484 showfile(${failureoutput});
 485 exit $failedcount;