1 # (X)Emacs mode: -*- cperl -*-
7 test - tools for helping in test suites (not including running externalprograms).
11 use FindBin 1.42 qw( $Bin );
12 use Test 1.13 qw( ok plan );
14 BEGIN { unshift @INC, $Bin };
16 use test qw( evcheck runcheck );
25 open my $fh, '>', 'foo';
27 for 'Bulgaria', 'Cholet';
29 }, 'write foo'), 1, 'write foo';
31 save_output('stderr', *STDERR{IO});
33 print restore_output('stderr');
37 This package provides some variables, and sets up an environment, for test
38 scripts, such as those used in F<t/>.
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>.
44 Setting up the environment includes:
48 =item Prepending F<blib/script> onto the path
50 =item Pushing the module F<lib/> dir onto the @INC var
52 For internal C<use> calls.
54 =item Changing directory to a temporary directory
56 To avoid cluttering the local dir, and/or allowing the local directory
57 structure to affect matters.
59 =item Cleaning up the temporary directory afterwards
61 Unless TEST_DEBUG is set in the environment.
67 # ----------------------------------------------------------------------------
69 # Pragmas -----------------------------
73 use vars qw( @EXPORT_OK );
75 # Inheritance -------------------------
77 use base qw( Exporter );
81 The following symbols are exported upon request:
107 @EXPORT_OK = qw( check_req compare evcheck only_files
108 save_output restore_output tempdir tmpnam );
110 # Utility -----------------------------
112 use Carp qw( carp croak );
113 use Cwd 2.01 qw( cwd );
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 );
125 # ----------------------------------------------------------------------------
128 if ( File::Spec->file_name_is_absolute($_[0]) ) {
131 return catdir(cwd, $_[0]);
136 File::Spec->catdir(@_);
140 File::Spec->catfile(@_);
144 File::Spec->updir(@_);
148 croak "Can't min over 0 args!\n"
159 # -------------------------------------
161 # -------------------------------------
163 use constant BUILD_SCRIPT_DIR => => catdir $Bin, updir, qw( blib script );
168 for (split /:/, $PATH) {
169 my $try = catfile $_, $exec;
176 # -------------------------------------
178 # -------------------------------------
180 $PATH = join ':', BUILD_SCRIPT_DIR, split /:/, $PATH;
185 my $tmpdn = tempdir();
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;
192 #@INC = map rel2abs($_), @INC;
195 # -------------------------------------
197 # -------------------------------------
209 Arrayref of names of files to expect to exist.
219 1 if exactly expected files exist, false otherwise.
232 my %files = map { $_ => 1 } readdir MYDIR;
237 for (@$expect, '.', '..') {
238 if ( exists $files{$_} ) {
240 } elsif ( ! -e $_ ) { # $_ might be absolute
241 carp "File not found: $_\n"
248 carp "Extra file found: $_\n"
260 # -------------------------------------
264 Eval code, return status
278 Name to use in error messages
288 1 if eval was okay, 0 if not.
297 my ($code, $name) = @_;
305 carp "Code $name failed: $@\n"
313 # -------------------------------------
317 Redirect a filehandle to temporary storage for later examination.
327 Name to store as (used in L<restore_output>)
331 The filehandle to save
337 # Map from names to saved filehandles.
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
347 croak sprintf("%s takes 2 arguments\n", (caller 0)[3])
349 my ($name, $filehandle) = @_;
351 my $tmpfh = do { local *F; *F; };
352 my $savefh = do { local *F; *F; };
354 (undef, $tmpfh) = test::tmpnam();
355 select((select($tmpfh), $| = 1)[0]);
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: $!";
362 push @{$grabs{$name}}, $savefh, $tmpfh, $filehandle;
365 # -------------------------------------
367 =head2 restore_output
369 Restore a saved filehandle to its original state, return the saved output.
379 Name of the filehandle to restore (as passed to L<save_output>).
389 A single string being the output saved.
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;
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]);
412 my $string = <$tmpfh>;
418 sub _test_save_restore_output {
419 warn "to stderr 1\n";
420 save_output("stderr", *STDERR{IO});
422 print 'SAVED:->:', restore_output("stderr"), ":<-\n";
423 warn "to stderr 2\n";
426 # -------------------------------------
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.
441 I<Optional>. If defined, a name by which to refer to the tmpfile in user
452 Name of temporary file.
456 Open filehandle to temp file, in r/w mode. Only created & returned in list
468 my $savewarn = $SIG{__WARN__};
469 # Subvert bizarre (& incorrect) subroutine redefined errors in 5.005_03
470 local $SIG{__WARN__} =
473 if defined $savewarn and
474 UNIVERSAL::isa($savewarn,'CODE') and
475 $_[0] !~ /^Subroutine tmpnam redefined/;
479 my $tmpnam = POSIX::tmpnam;
482 push @tmpfns, [ $tmpnam, $_[0] ];
484 push @tmpfns, $tmpnam;
488 sysopen my $tmpfh, $tmpnam, O_RDWR | O_CREAT | O_EXCL;
489 return $tmpnam, $tmpfh;
497 if ( defined $ENV{TEST_DEBUG} and $ENV{TEST_DEBUG} =~ /\bSAVE\b/ ) {
500 printf "Used temp file: %s (%s)\n", @$_;
502 print "Used temp file: $_\n";
506 unlink map((ref $_ ? $_->[0] : $_), @tmpfns)
511 # -------------------------------------
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).
530 Name of temporary dir.
540 my $tempdir = POSIX::tmpnam;
542 or die "Failed to create temporary directory $tempdir: $!\n";
545 push @tmpdirs, [ $tempdir, $_[0] ];
547 push @tmpdirs, $tempdir;
556 if ( defined $ENV{TEST_DEBUG} and $ENV{TEST_DEBUG} =~ /\bSAVE\b/ ) {
557 printf "Used temp dir: %s (%s)\n", @$_;
559 # Solaris gets narky about removing the pwd.
560 chdir File::Spec->rootdir;
564 if ( defined $ENV{TEST_DEBUG} and $ENV{TEST_DEBUG} =~ /\bSAVE\b/ ) {
565 print "Used temp dir: $_\n";
567 # Solaris gets narky about removing the pwd.
568 chdir File::Spec->rootdir;
575 # -------------------------------------
579 compare(+{ fn1 => $fn1, fn2 => $fn2, gzip => 1 });
581 This performs one test.
587 A single argument is taken, considered as a hash ref, with the following keys:
589 In TEST_DEBUG mode, if the files do not compare equal, outputs file info on
596 B<Mandatory> File to compare
600 B<Mandatory> File to compare
604 B<Mandatory> Test name
608 B<Optional> sort files prior to comparison. Requires the C<sort> command to
609 be on C<$PATH> (else skips).
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.
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.
629 # return codes and old-style call semantics left for backwards compatibility
631 my $savewarn = $SIG{__WARN__};
632 # Subvert bizarre (& incorrect) subroutine redefined errors in 5.005_03
633 local $SIG{__WARN__} =
636 if defined $savewarn and
637 UNIVERSAL::isa($savewarn,'CODE') and
638 $_[0] !~ /^Subroutine compare redefined/;
642 my ($fn1, $fn2, $sort) = @_;
643 my ($gzip, $tar, $name);
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"
654 my ($name1, $name2) = ($fn1, $fn2);
656 for ( grep ! defined, $fn1, $fn2 ) {
657 carp 'Usage: compare({fn1 => $fn1, fn2 => $fn2, name => "some name"})' ."\n"
668 my $fn = ($name1, $name2)[$_];
670 carp "Does not exist: $fn\n"
673 } elsif ( ! -r $fn ) {
674 carp "Cannot read: $fn\n"
688 unless ( find_exec('gzip') ) {
689 print "ok # Skip gzip not found in path\n";
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);
703 unless ( find_exec('tar') ) {
704 print "ok # Skip tar not found in path\n";
709 chomp (my @list1 = sort qx( tar tf $fn1 ));
710 croak "tar tf $fn1 failed with wait status: $?\n"
712 chomp(my @list2 = sort qx( tar tf $fn2 ));
713 croak "tar tf $fn2 failed with wait status: $?\n"
716 if ( @list2 > @list1 ) {
718 sprintf("More files (%d) in $name2 than $name1 (%d)\n",
719 scalar @list2, scalar @list1)
721 ok @list1, @list2, $name
724 } elsif ( @list1 > @list2 ) {
726 sprintf("More files (%d) in $name1 than $name2 (%d)\n",
727 scalar @list1, scalar @list2)
729 ok @list1, @list2, $name
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"
738 ok $list1[$i], $list2[$i], $name
741 } elsif ( $list1[$i] gt $list2[$i] ) {
742 carp "File $list2[$i] is present in $name2 but not $name1\n"
744 ok $list2[$i], $list1[$i], $name
750 for my $fn (@list1) {
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,
762 qq'Subcheck file "$fn" for compare $name1, $name2',
764 unless ( $ok >= 1 ) {
765 carp qq'Difference found testing file "$fn" in tars $name1 ($tmp1), $name2 ($tmp2)\n'
779 unless ( find_exec('sort') ) {
780 print "ok # Skip sort not found in path\n";
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);
793 unless ( File::Compare::compare($fn1, $fn2) ) {
799 if ( $ENV{TEST_DEBUG} ) {
801 die "Fork failed: $!\n"
804 if ( $pid ) { # Parent
805 my $waitpid = waitpid($pid, 0);
806 die "Waitpid got: $waitpid (expected $pid)\n"
807 unless $waitpid == $pid;
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;
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";
823 while ( ! $found and my $line1 = <$fh1> ) {
825 if ( ! defined $line2 ) {
826 print STDERR "$fn2 ended at line: $.\n";
828 } elsif ( $line2 ne $line1 ) {
829 my $maxlength = max(map length($_), $line1, $line2);
830 my $minlength = min(map length($_), $line1, $line2);
832 my @diffchars = grep(substr($line1, $_, 1) ne substr($line2, $_, 1),
834 my $diff = ' ' x $minlength;
835 substr($diff, $_, 1) = '|'
838 my @extrachars, map((length($line1) > length($line2) ? '^' : 'v'),
839 $minlength..$maxlength-1);
841 $diff = join '', $diff, @extrachars;
843 my $diff_count = @diffchars;
844 my $extra_count = @extrachars;
846 print STDERR <<"END";
847 Difference at line $. ($diff_count characters differ) (top line is $extra_count chars longer):
853 Differing characters at positions @{[join ',',@diffchars]} (zero-based)
861 if ( defined $line2 ) {
862 print STDERR "$name1 ended before line: $.\n";
864 print STDERR "Difference between $name1, $name2 not found!\n";
878 # -------------------------------------
882 Perform a requisite check on a given executable. This will skip if the
883 required modules are not present.
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.
892 check_req('ccu-touch',
894 [[REQ_FILE, '/etc/passwd']],
895 [[REQ_FILE, 'passwd.foo']],
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.
911 The arguments to pass to the cmd_name, as an arrayref.
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
921 The expected outputs, in the same format as the L<epres|"epres">.
925 The name to use in error messages.
934 my ($cmd_name, $args, $epres, $eouts, $testname) = @_;
936 eval "use Pipeline::DataFlow 1.03 qw( :req_types );";
941 $skip = 'Skipped: Pipeline::DataFlow 1.03 not found';
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;
954 # Initialize nicely to cope when read_reqs fails
955 my ($pres, $outs) = ([], []);
959 ($pres, $outs) = Pipeline::DataFlow->read_reqs
960 ([catfile($Bin, updir, 'blib', 'script', $cmd_name),
965 $test->(scalar @$pres, scalar @$epres);
968 @epres = sort { $a->[1] cmp $b->[1] } @$epres;
969 @pres = sort { $a->[1] cmp $b->[1] } @$pres;
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);
977 $test->(scalar @$outs, scalar @$eouts);
980 @eouts = sort { $a->[1] cmp $b->[1] } @$eouts;
981 @outs = sort { $a->[1] cmp $b->[1] } @$outs;
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);
989 $test->(only_files([]), 1);
992 # -------------------------------------
1004 The name of the program
1014 The path to the first executable file with the given name on C<$PATH>. Or
1015 nothing, if no such file exists.
1023 # defined further up to use in constants
1025 # ----------------------------------------------------------------------------
1035 =head1 REPORTING BUGS
1041 Martyn J. Pearce C<fluffy@cpan.org>
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
1055 1; # keep require happy.