t/test.pm

   1 # (X)Emacs mode: -*- cperl -*-
   2
   3 package test;
   4
   5 =head1 NAME
   6
   7 test - tools for helping in test suites (not including running externalprograms).
   8
   9 =head1 SYNOPSIS
  10
  11   use FindBin               1.42 qw( $Bin );
  12   use Test                  1.13 qw( ok plan );
  13
  14   BEGIN { unshift @INC, $Bin };
  15
  16   use test                  qw(   evcheck runcheck );
  17
  18   BEGIN {
  19     plan tests  => 3,
  20          todo   => [],
  21          ;
  22   }
  23
  24   ok evcheck(sub {
  25                open my $fh, '>', 'foo';
  26                print $fh "$_\n"
  27                  for 'Bulgaria', 'Cholet';
  28                close $fh;
  29              }, 'write foo'), 1, 'write foo';
  30
  31   save_output('stderr', *STDERR{IO});
  32   warn 'Hello, Mum!';
  33   print restore_output('stderr');
  34
  35 =head1 DESCRIPTION
  36
  37 This package provides some variables, and sets up an environment, for test
  38 scripts, such as those used in F<t/>.
  39
  40 This package does not including running external programs; that is provided by
  41 C<test2.pm>.  This is so that suites not needing that can include only
  42 test.pm, and so not require the presence of C<IPC::Run>.
  43
  44 Setting up the environment includes:
  45
  46 =over 4
  47
  48 =item Prepending F<blib/script> onto the path
  49
  50 =item Pushing the module F<lib/> dir onto the @INC var
  51
  52 For internal C<use> calls.
  53
  54 =item Changing directory to a temporary directory
  55
  56 To avoid cluttering the local dir, and/or allowing the local directory
  57 structure to affect matters.
  58
  59 =item Cleaning up the temporary directory afterwards
  60
  61 Unless TEST_DEBUG is set in the environment.
  62
  63 =back
  64
  65 =cut
  66
  67 # ----------------------------------------------------------------------------
  68
  69 # Pragmas -----------------------------
  70
  71 use 5.00503;
  72 use strict;
  73 use vars qw( @EXPORT_OK );
  74
  75 # Inheritance -------------------------
  76
  77 use base qw( Exporter );
  78
  79 =head2 EXPORTS
  80
  81 The following symbols are exported upon request:
  82
  83 =over 4
  84
  85 =item check_req
  86
  87 =item compare
  88
  89 =item evcheck
  90
  91 =item only_files
  92
  93 =item save_output
  94
  95 =item restore_output
  96
  97 =item tmpnam
  98
  99 =item tempdir
 100
 101 =item find_exec
 102
 103 =back
 104
 105 =cut
 106
 107 @EXPORT_OK = qw( check_req compare evcheck only_files
 108                  save_output restore_output tempdir tmpnam );
 109
 110 # Utility -----------------------------
 111
 112 use Carp                          qw( carp croak );
 113 use Cwd                      2.01 qw( cwd );
 114 use Env                           qw( PATH );
 115 use Fatal                    1.02 qw( close open seek sysopen unlink );
 116 use Fcntl                    1.03 qw( :DEFAULT );
 117 use File::Basename                qw( basename );
 118 use File::Compare          1.1002 qw( );
 119 use File::Path             1.0401 qw( mkpath rmtree );
 120 use File::Spec                0.6 qw( );
 121 use FindBin                  1.42 qw( $Bin );
 122 use POSIX                    1.02 qw( );
 123 use Test                    1.122 qw( ok skip );
 124
 125 # ----------------------------------------------------------------------------
 126
 127 sub rel2abs {
 128   if ( File::Spec->file_name_is_absolute($_[0]) ) {
 129     return $_[0];
 130   } else {
 131     return catdir(cwd, $_[0]);
 132   }
 133 }
 134
 135 sub catdir {
 136   File::Spec->catdir(@_);
 137 }
 138
 139 sub catfile {
 140   File::Spec->catfile(@_);
 141 }
 142
 143 sub updir {
 144   File::Spec->updir(@_);
 145 }
 146
 147 sub min {
 148   croak "Can't min over 0 args!\n"
 149     unless @_;
 150   my $min = $_[0];
 151   for (@_[1..$#_]) {
 152     $min = $_
 153       if $_ < $min;
 154   }
 155
 156   return $min;
 157 }
 158
 159 # -------------------------------------
 160 # PACKAGE CONSTANTS
 161 # -------------------------------------
 162
 163 use constant BUILD_SCRIPT_DIR => => catdir $Bin, updir, qw( blib script );
 164
 165 sub find_exec {
 166   my ($exec) = @_;
 167
 168   for (split /:/, $PATH) {
 169     my $try = catfile $_, $exec;
 170     return rel2abs($try)
 171       if -x $try;
 172   }
 173   return;
 174 }
 175
 176 # -------------------------------------
 177 # PACKAGE ACTIONS
 178 # -------------------------------------
 179
 180 $PATH = join ':', BUILD_SCRIPT_DIR, split /:/, $PATH;
 181
 182 $_ = rel2abs($_)
 183   for @INC;
 184
 185 my $tmpdn = tempdir();
 186 $| = 1;
 187
 188 mkpath $tmpdn;
 189 die "Couldn't create temp dir: $tmpdn: $!\n"
 190   unless -r $tmpdn and -w $tmpdn and -x $tmpdn and -o $tmpdn and -d $tmpdn;
 191
 192 #@INC = map rel2abs($_), @INC;
 193 chdir $tmpdn;
 194
 195 # -------------------------------------
 196 # PACKAGE FUNCTIONS
 197 # -------------------------------------
 198
 199 =head2 only_files
 200
 201 =over 4
 202
 203 =item ARGUMENTS
 204
 205 =over 4
 206
 207 =item expect
 208
 209 Arrayref of names of files to expect to exist.
 210
 211 =back
 212
 213 =item RETURNS
 214
 215 =over 4
 216
 217 =item ok
 218
 219 1 if exactly expected files exist, false otherwise.
 220
 221 =back
 222
 223 =back
 224
 225 =cut
 226
 227 sub only_files {
 228   my ($expect) = @_;
 229
 230   local *MYDIR;
 231   opendir MYDIR, '.';
 232   my %files = map { $_ => 1 } readdir MYDIR;
 233   closedir MYDIR;
 234
 235   my $ok = 1;
 236
 237   for (@$expect, '.', '..') {
 238     if ( exists $files{$_} ) {
 239       delete $files{$_};
 240     } elsif ( ! -e $_ ) { # $_ might be absolute
 241       carp "File not found: $_\n"
 242         if $ENV{TEST_DEBUG};
 243       $ok = 0;
 244     }
 245   }
 246
 247   for (keys %files) {
 248     carp "Extra file found: $_\n"
 249       if $ENV{TEST_DEBUG};
 250     $ok = 0;
 251   }
 252
 253   if ( $ok ) {
 254     return 1;
 255   } else {
 256     return;
 257   }
 258 }
 259
 260 # -------------------------------------
 261
 262 =head2 evcheck
 263
 264 Eval code, return status
 265
 266 =over 4
 267
 268 =item ARGUMENTS
 269
 270 =over 4
 271
 272 =item code
 273
 274 Coderef to eval
 275
 276 =item name
 277
 278 Name to use in error messages
 279
 280 =back
 281
 282 =item RETURNS
 283
 284 =over 4
 285
 286 =item okay
 287
 288 1 if eval was okay, 0 if not.
 289
 290 =back
 291
 292 =back
 293
 294 =cut
 295
 296 sub evcheck {
 297   my ($code, $name) = @_;
 298
 299   my $ok = 0;
 300
 301   eval {
 302     &$code;
 303     $ok = 1;
 304   }; if ( $@ ) {
 305     carp "Code $name failed: $@\n"
 306       if $ENV{TEST_DEBUG};
 307     $ok = 0;
 308   }
 309
 310   return $ok;
 311 }
 312
 313 # -------------------------------------
 314
 315 =head2 save_output
 316
 317 Redirect a filehandle to temporary storage for later examination.
 318
 319 =over 4
 320
 321 =item ARGUMENTS
 322
 323 =over 4
 324
 325 =item name
 326
 327 Name to store as (used in L<restore_output>)
 328
 329 =item filehandle
 330
 331 The filehandle to save
 332
 333 =back
 334
 335 =cut
 336
 337 # Map from names to saved filehandles.
 338
 339 # Values are arrayrefs, being filehandle that was saved (to restore), the
 340 # filehandle being printed to in the meantime, and the original filehandle.
 341 # This may be treated as a stack; to allow multiple saves... push & pop this
 342 # stack.
 343
 344 my %grabs;
 345
 346 sub save_output {
 347   croak sprintf("%s takes 2 arguments\n", (caller 0)[3])
 348     unless @_ == 2;
 349   my ($name, $filehandle) = @_;
 350
 351   my $tmpfh  = do { local *F; *F; };
 352   my $savefh = do { local *F; *F; };
 353
 354   (undef, $tmpfh) = test::tmpnam();
 355   select((select($tmpfh), $| = 1)[0]);
 356
 357   open $savefh, '>&' . fileno $filehandle
 358     or die "can't dup $name: $!";
 359   open $filehandle, '>&' . fileno $tmpfh
 360     or die "can't open $name to tempfile: $!";
 361
 362   push @{$grabs{$name}}, $savefh, $tmpfh, $filehandle;
 363 }
 364
 365 # -------------------------------------
 366
 367 =head2 restore_output
 368
 369 Restore a saved filehandle to its original state, return the saved output.
 370
 371 =over 4
 372
 373 =item ARGUMENTS
 374
 375 =over 4
 376
 377 =item name
 378
 379 Name of the filehandle to restore (as passed to L<save_output>).
 380
 381 =back
 382
 383 =item RETURNS
 384
 385 =over 4
 386
 387 =item saved_string
 388
 389 A single string being the output saved.
 390
 391 =back
 392
 393 =cut
 394
 395 sub restore_output {
 396   my ($name) = @_;
 397
 398   croak "$name has not been saved\n"
 399     unless exists $grabs{$name};
 400   croak "All saved instances of $name have been restored\n"
 401     unless @{$grabs{$name}};
 402   my ($savefh, $tmpfh, $origfh) = splice @{$grabs{$name}}, -3;
 403
 404   close $origfh
 405     or die "cannot close $name opened to tempfile: $!";
 406   open  $origfh, '>&' . fileno $savefh
 407     or die "cannot dup $name back again: $!";
 408   select((select($origfh), $| = 1)[0]);
 409
 410   seek $tmpfh, 0, 0;
 411   local $/ = undef;
 412   my $string = <$tmpfh>;
 413   close $tmpfh;
 414
 415   return $string;
 416 }
 417
 418 sub _test_save_restore_output {
 419   warn "to stderr 1\n";
 420   save_output("stderr", *STDERR{IO});
 421   warn "Hello, Mum!";
 422   print 'SAVED:->:', restore_output("stderr"), ":<-\n";
 423   warn "to stderr 2\n";
 424 }
 425
 426 # -------------------------------------
 427
 428 =head2 tmpnam
 429
 430 Very much like the one in L<POSIX> or L<File::Temp>, but does not get deleted
 431 if TEST_DEBUG has SAVE in the value.
 432
 433 =over 4
 434
 435 =item ARGUMENTS
 436
 437 =over 4
 438
 439 =item name
 440
 441 I<Optional>.  If defined, a name by which to refer to the tmpfile in user
 442 messages.
 443
 444 =back
 445
 446 =item RETURNS
 447
 448 =over 4
 449
 450 =item filename
 451
 452 Name of temporary file.
 453
 454 =item fh
 455
 456 Open filehandle to temp file, in r/w mode.  Only created & returned in list
 457 context.
 458
 459 =back
 460
 461 =back
 462
 463 =cut
 464
 465 my @tmpfns;
 466
 467 BEGIN {
 468   my $savewarn = $SIG{__WARN__};
 469   # Subvert bizarre (& incorrect) subroutine redefined errors in 5.005_03
 470   local $SIG{__WARN__} =
 471     sub {
 472       $savewarn->(@_)
 473         if defined $savewarn                        and
 474            UNIVERSAL::isa($savewarn,'CODE')         and
 475            $_[0] !~ /^Subroutine tmpnam redefined/;
 476     };
 477
 478   *tmpnam = sub {
 479     my $tmpnam = POSIX::tmpnam;
 480
 481     if (@_) {
 482       push @tmpfns, [ $tmpnam, $_[0] ];
 483     } else {
 484       push @tmpfns, $tmpnam;
 485     }
 486
 487     if (wantarray) {
 488       sysopen my $tmpfh, $tmpnam, O_RDWR | O_CREAT | O_EXCL;
 489       return $tmpnam, $tmpfh;
 490     } else {
 491       return $tmpnam;
 492     }
 493   }
 494 }
 495
 496 END {
 497   if ( defined $ENV{TEST_DEBUG} and $ENV{TEST_DEBUG} =~ /\bSAVE\b/ ) {
 498     for (@tmpfns) {
 499       if ( ref $_ ) {
 500         printf "Used temp file: %s (%s)\n", @$_;
 501       } else {
 502         print "Used temp file: $_\n";
 503       }
 504     }
 505   } else {
 506     unlink map((ref $_ ? $_->[0] : $_), @tmpfns)
 507       if @tmpfns;
 508   }
 509 }
 510
 511 # -------------------------------------
 512
 513 =head2 tempdir
 514
 515 Very much like the one in L<POSIX> or L<File::Temp>, but does not get deleted
 516 if TEST_DEBUG has SAVE in the value (does get deleted otherwise).
 517
 518 =over 4
 519
 520 =item ARGUMENTS
 521
 522 I<None>
 523
 524 =item RETURNS
 525
 526 =over 4
 527
 528 =item name
 529
 530 Name of temporary dir.
 531
 532 =back
 533
 534 =back
 535
 536 =cut
 537
 538 my @tmpdirs;
 539 sub tempdir {
 540   my $tempdir = POSIX::tmpnam;
 541   mkdir $tempdir, 0700
 542     or die "Failed to create temporary directory $tempdir: $!\n";
 543
 544   if (@_) {
 545     push @tmpdirs, [ $tempdir, $_[0] ];
 546   } else {
 547     push @tmpdirs, $tempdir;
 548   }
 549
 550   return $tempdir;
 551 }
 552
 553 END {
 554   for (@tmpdirs) {
 555     if ( ref $_ ) {
 556       if ( defined $ENV{TEST_DEBUG} and $ENV{TEST_DEBUG} =~ /\bSAVE\b/ ) {
 557         printf "Used temp dir: %s (%s)\n", @$_;
 558       } else {
 559         # Solaris gets narky about removing the pwd.
 560         chdir File::Spec->rootdir;
 561         rmtree $_->[0];
 562       }
 563     } else {
 564       if ( defined $ENV{TEST_DEBUG} and $ENV{TEST_DEBUG} =~ /\bSAVE\b/ ) {
 565         print "Used temp dir: $_\n";
 566       } else {
 567         # Solaris gets narky about removing the pwd.
 568         chdir File::Spec->rootdir;
 569         rmtree $_;
 570       }
 571     }
 572   }
 573 }
 574
 575 # -------------------------------------
 576
 577 =head2 compare
 578
 579   compare(+{ fn1 => $fn1, fn2 => $fn2, gzip => 1 });
 580
 581 This performs one test.
 582
 583 =over 4
 584
 585 =item ARGUMENTS
 586
 587 A single argument is taken, considered as a hash ref, with the following keys:
 588
 589 In TEST_DEBUG mode, if the files do not compare equal, outputs file info on
 590 STDERR.
 591
 592 =over 4
 593
 594 =item fn1
 595
 596 B<Mandatory>  File to compare
 597
 598 =item fn2
 599
 600 B<Mandatory>  File to compare
 601
 602 =item name
 603
 604 B<Mandatory>  Test name
 605
 606 =item sort
 607
 608 B<Optional> sort files prior to comparison.  Requires the C<sort> command to
 609 be on C<$PATH> (else skips).
 610
 611 =item gunzip
 612
 613 B<Optional> gunzip files prior to comparison.  Requires the C<gzip> command to
 614 be on C<$PATH> (else skips).  gzip occurs prior to any sort.
 615
 616 =item untar
 617
 618 B<Optional> untar files prior to comparison.  Requires the C<tar> command to
 619 be on C<$PATH> (else skips).  any gzip occurs prior to any tar.  Tar files are
 620 considered equal if they each contain the same filenames & each file contained
 621 is equal.  If the sort flag is present, each file is sorted prior to comparison.
 622
 623 =back
 624
 625 =back
 626
 627 =cut
 628
 629 # return codes and old-style call semantics left for backwards compatibility
 630 BEGIN {
 631   my $savewarn = $SIG{__WARN__};
 632   # Subvert bizarre (& incorrect) subroutine redefined errors in 5.005_03
 633   local $SIG{__WARN__} =
 634     sub {
 635       $savewarn->(@_)
 636         if defined $savewarn                        and
 637            UNIVERSAL::isa($savewarn,'CODE')         and
 638            $_[0] !~ /^Subroutine compare redefined/;
 639     };
 640
 641   *compare = sub {
 642     my ($fn1, $fn2, $sort) = @_;
 643     my ($gzip, $tar, $name);
 644     my $notest = 1;
 645
 646     if ( @_ == 1 and UNIVERSAL::isa($_[0], 'HASH') ) {
 647       ($fn1, $fn2, $name, $sort, $gzip, $tar, $notest) =
 648         @{$_[0]}{qw( fn1 fn2 name sort gunzip untar notest )};
 649       my @missing = grep ! defined $_[0]->{$_}, qw( fn1 fn2 name );
 650       carp "Missing mandatory key(s): " . join(', ', @missing) . "\n"
 651         if @missing;
 652     }
 653
 654     my ($name1, $name2) = ($fn1, $fn2);
 655
 656     for ( grep ! defined, $fn1, $fn2 ) {
 657       carp 'Usage: compare({fn1 => $fn1, fn2 => $fn2, name => "some name"})' ."\n"
 658           if $ENV{TEST_DEBUG};
 659       ok 0, 1, $name
 660         unless $notest;
 661       return -8;
 662     }
 663
 664     {
 665       my $err = 0;
 666
 667       for (0..1) {
 668         my $fn = ($name1, $name2)[$_];
 669         if ( ! -e $fn ) {
 670           carp "Does not exist: $fn\n"
 671             if $ENV{TEST_DEBUG};
 672           $err |= 2 ** $_;
 673         } elsif ( ! -r $fn ) {
 674           carp "Cannot read: $fn\n"
 675             if $ENV{TEST_DEBUG};
 676           $err |= 2 ** $_;
 677         }
 678       }
 679
 680       if ( $err ) {
 681         ok 0, 1, $name
 682           unless $notest;
 683         return -$err;
 684       }
 685     }
 686
 687     if ( $gzip ) {
 688       unless ( find_exec('gzip') ) {
 689         print "ok # Skip gzip not found in path\n";
 690         return -16;
 691       }
 692
 693       my $tmp1 = tmpnam;
 694       my $tmp2 = tmpnam;
 695       system "gzip $fn1 -cd > $tmp1"
 696         and croak "gzip $fn1 failed: $?\n";
 697       system "gzip $fn2 -cd > $tmp2"
 698         and croak "gzip $fn2 failed: $?\n";
 699       ($fn1, $fn2) = ($tmp1, $tmp2);
 700     }
 701
 702     if ( $tar ) {
 703       unless ( find_exec('tar') ) {
 704         print "ok # Skip tar not found in path\n";
 705         return -16;
 706       }
 707
 708       local $/ = "\n";
 709       chomp (my @list1 = sort qx( tar tf $fn1 ));
 710       croak "tar tf $fn1 failed with wait status: $?\n"
 711         if $?;
 712       chomp(my @list2 = sort qx( tar tf $fn2 ));
 713       croak "tar tf $fn2 failed with wait status: $?\n"
 714         if $?;
 715
 716       if ( @list2 > @list1 ) {
 717         carp
 718           sprintf("More files (%d) in $name2 than $name1 (%d)\n",
 719                   scalar @list2, scalar @list1)
 720           if $ENV{TEST_DEBUG};
 721         ok @list1, @list2, $name
 722           unless $notest;
 723         return 0;
 724       } elsif ( @list1 > @list2 ) {
 725         carp
 726           sprintf("More files (%d) in $name1 than $name2 (%d)\n",
 727                   scalar @list1, scalar @list2)
 728           if $ENV{TEST_DEBUG};
 729         ok @list1, @list2, $name
 730           unless $notest;
 731         return 0;
 732       }
 733
 734       for (my $i = 0; $i < @list1; $i++) {
 735         if ( $list1[$i] lt $list2[$i] ) {
 736           carp "File $list1[$i] is present in $name1 but not $name2\n"
 737             if $ENV{TEST_DEBUG};
 738           ok $list1[$i], $list2[$i], $name
 739             unless $notest;
 740           return 0;
 741         } elsif ( $list1[$i] gt $list2[$i] ) {
 742           carp "File $list2[$i] is present in $name2 but not $name1\n"
 743             if $ENV{TEST_DEBUG};
 744           ok $list2[$i], $list1[$i], $name
 745             unless $notest;
 746           return 0;
 747         }
 748       }
 749
 750       for my $fn (@list1) {
 751         my $tmp1 = tmpnam;
 752         my $tmp2 = tmpnam;
 753         system "tar -xf $fn1 -O $fn > $tmp1"
 754           and croak "tar -xf $fn1 -O $fn failed: $?\n";
 755         system "tar -xf $fn2 -O $fn > $tmp2"
 756           and croak "tar -xf $fn2 -O $fn failed: $?\n";
 757         my $ok = compare({ fn1    => $tmp1,
 758                            fn2    => $tmp2,
 759                            sort   => $sort,
 760                            notest => 1,
 761                            name   =>
 762                              qq'Subcheck file "$fn" for compare $name1, $name2',
 763                          });
 764         unless ( $ok >= 1 ) {
 765           carp qq'Difference found testing file "$fn" in tars $name1 ($tmp1), $name2 ($tmp2)\n'
 766             if $ENV{TEST_DEBUG};
 767           ok 0, 1, $name
 768             unless $notest;
 769           return 0;
 770         }
 771       }
 772
 773       ok 1, 1, $name
 774         unless $notest;
 775       return 1;
 776     }
 777
 778     if ( $sort ) {
 779       unless ( find_exec('sort') ) {
 780         print "ok # Skip sort not found in path\n";
 781         return -16;
 782       }
 783
 784       my $tmp1 = tmpnam;
 785       my $tmp2 = tmpnam;
 786       system sort => $fn1, -o => $tmp1
 787         and croak "Sort $fn1 failed: $?\n";
 788       system sort => $fn2, -o => $tmp2
 789         and croak "Sort $fn2 failed: $?\n";
 790       ($fn1, $fn2) = ($tmp1, $tmp2);
 791     }
 792
 793     unless ( File::Compare::compare($fn1, $fn2) ) {
 794       ok 1, 1, $name
 795         unless $notest;
 796       return 1;
 797     }
 798
 799     if ( $ENV{TEST_DEBUG} ) {
 800       my $pid = fork;
 801       die "Fork failed: $!\n"
 802         unless defined $pid;
 803
 804       if ( $pid ) { # Parent
 805         my $waitpid = waitpid($pid, 0);
 806         die "Waitpid got: $waitpid (expected $pid)\n"
 807           unless $waitpid == $pid;
 808       } else { # Child
 809         open *STDOUT{IO}, ">&" . fileno STDERR;
 810         # Uniquify file names
 811         my @args = keys %{+{ map {;$_=>1} $name1, $name2, $fn1, $fn2 }};
 812         exec qw(ls -l), @args;
 813       }
 814
 815       my $fh1 = IO::File->new($fn1, O_RDONLY)
 816         or die "Couldn't open $fn1: $!\n";
 817       my $fh2 = IO::File->new($fn2, O_RDONLY)
 818         or die "Couldn't open $fn2: $!\n";
 819
 820       local $/ = "\n";
 821
 822       my $found = 0;
 823       while ( ! $found and my $line1 = <$fh1> ) {
 824         my $line2 = <$fh2>;
 825         if ( ! defined $line2 ) {
 826           print STDERR "$fn2 ended at line: $.\n";
 827           $found = 1;
 828         } elsif ( $line2 ne $line1 ) {
 829           my $maxlength = max(map length($_), $line1, $line2);
 830           my $minlength = min(map length($_), $line1, $line2);
 831
 832           my @diffchars = grep(substr($line1, $_, 1) ne substr($line2, $_, 1),
 833                                0..$minlength-1);
 834           my $diff = ' ' x $minlength;
 835           substr($diff, $_, 1) = '|'
 836             for @diffchars;
 837
 838           my @extrachars, map((length($line1) > length($line2) ? '^' : 'v'),
 839                               $minlength..$maxlength-1);
 840
 841           $diff = join '', $diff, @extrachars;
 842
 843           my $diff_count  = @diffchars;
 844           my $extra_count = @extrachars;
 845
 846           print STDERR <<"END";
 847 Difference at line $. ($diff_count characters differ) (top line is $extra_count chars longer):
 848 $name1:
 849 -->$line1<--
 850    $diff
 851 -->$line2<--
 852 $name2:
 853 Differing characters at positions @{[join ',',@diffchars]} (zero-based)
 854 END
 855           $found = 1;
 856         }
 857       }
 858
 859       if ( ! $found ) {
 860         my $line2 = <$fh2>;
 861         if ( defined $line2 ) {
 862           print STDERR "$name1 ended before line: $.\n";
 863         } else {
 864           print STDERR "Difference between $name1, $name2 not found!\n";
 865         }
 866       }
 867
 868       close $fh1;
 869       close $fh2;
 870     }
 871
 872     ok 0, 1, $name
 873       unless $notest;
 874     return 0;
 875   }
 876 }
 877
 878 # -------------------------------------
 879
 880 =head2 check_req
 881
 882 Perform a requisite check on a given executable.  This will skip if the
 883 required modules are not present.
 884
 885 4+(n+m)*2 tests are performed, where n is the number of prerequisites
 886 expected, and m is the number of outputs expected.
 887
 888 =over 4
 889
 890 =item SYNOPSIS
 891
 892   check_req('ccu-touch',
 893             ['/etc/passwd'],
 894             [[REQ_FILE, '/etc/passwd']],
 895             [[REQ_FILE, 'passwd.foo']],
 896             'requisites 1');
 897
 898
 899 =item ARGUMENTS
 900
 901 =over 4
 902
 903 =item cmd_name
 904
 905 The name of the command to run.  It is assumed that this command is in
 906 blib/script; hence it should be an executable in this package, and C<make>
 907 shuold have been run recently.
 908
 909 =item args
 910
 911 The arguments to pass to the cmd_name, as an arrayref.
 912
 913 =item epres
 914
 915 The expected prerequisites, as an arrayref, wherein every member is a
 916 two-element arrayref, the members being the requisite type, and the requisite
 917 value.
 918
 919 =item eouts
 920
 921 The expected outputs, in the same format as the L<epres|"epres">.
 922
 923 =item testname
 924
 925 The name to use in error messages.
 926
 927 =back
 928
 929 =back
 930
 931 =cut
 932
 933 sub check_req {
 934   my ($cmd_name, $args, $epres, $eouts, $testname) = @_;
 935
 936   eval "use Pipeline::DataFlow 1.03 qw( :req_types );";
 937   my $skip;
 938   if ( $@ ) {
 939     print STDERR "$@\n"
 940       if $ENV{TEST_DEBUG};
 941     $skip = 'Skipped: Pipeline::DataFlow 1.03 not found';
 942   } else {
 943     $skip = 0;
 944   }
 945
 946   my $count = 1;
 947   my $test = sub {
 948     my ($code, $expect) = @_;
 949     my $name = sprintf "%s (%2d)", $testname, $count++;
 950     my $value = UNIVERSAL::isa($code, 'CODE') ? $code->($name) : $code;
 951     skip $skip, $value, $expect, $name;
 952   };
 953
 954   # Initialize nicely to cope when read_reqs fails
 955   my ($pres, $outs) = ([], []);
 956
 957   $test->(sub {
 958             evcheck(sub {
 959                       ($pres, $outs) = Pipeline::DataFlow->read_reqs
 960                         ([catfile($Bin, updir, 'blib', 'script', $cmd_name),
 961                           @$args]);
 962                     }, $_[0]),},
 963           1);
 964
 965   $test->(scalar @$pres, scalar @$epres);
 966
 967   my (@epres, @pres);
 968   @epres = sort { $a->[1] cmp $b->[1] } @$epres;
 969   @pres =  sort { $a->[1] cmp $b->[1] } @$pres;
 970
 971   for (my $i = 0; $i < @epres; $i++) {
 972     my ($type, $value) = @{$epres[$i]};
 973     $test->($type,  @pres > $i ? $pres[$i]->[0] : undef);
 974     $test->($value, @pres > $i ? $pres[$i]->[1] : undef);
 975   }
 976
 977   $test->(scalar @$outs, scalar @$eouts);
 978
 979   my (@eouts, @outs);
 980   @eouts = sort { $a->[1] cmp $b->[1] } @$eouts;
 981   @outs =  sort { $a->[1] cmp $b->[1] } @$outs;
 982
 983   for (my $i = 0; $i < @eouts; $i++) {
 984     my ($type, $value) = @{$eouts[$i]};
 985     $test->($type,  @outs > $i ? $outs[$i]->[0] : undef);
 986     $test->($value, @outs > $i ? $outs[$i]->[1] : undef);
 987   }
 988
 989   $test->(only_files([]), 1);
 990 }
 991
 992 # -------------------------------------
 993
 994 =head2 find_exec
 995
 996 =over 4
 997
 998 =item ARGUMENTS
 999
1000 =over 4
1001
1002 =item proggie
1003
1004 The name of the program
1005
1006 =back
1007
1008 =item RETURNS
1009
1010 =over 4
1011
1012 =item path
1013
1014 The path to the first executable file with the given name on C<$PATH>.  Or
1015 nothing, if no such file exists.
1016
1017 =back
1018
1019 =back
1020
1021 =cut
1022
1023 # defined further up to use in constants
1024
1025 # ----------------------------------------------------------------------------
1026
1027 =head1 EXAMPLES
1028
1029 Z<>
1030
1031 =head1 BUGS
1032
1033 Z<>
1034
1035 =head1 REPORTING BUGS
1036
1037 Email the author.
1038
1039 =head1 AUTHOR
1040
1041 Martyn J. Pearce C<fluffy@cpan.org>
1042
1043 =head1 COPYRIGHT
1044
1045 Copyright (c) 2001, 2002, 2004 Martyn J. Pearce.  This program is free
1046 software; you can redistribute it and/or modify it under the same terms as
1047 Perl itself.
1048
1049 =head1 SEE ALSO
1050
1051 Z<>
1052
1053 =cut
1054
1055 1; # keep require happy.
1056
1057 __END__