lib/h2xs.t

   1 #!./perl -w
   2
   3 # Some quick tests to see if h2xs actually runs and creates files as
   4 # expected.  File contents include date stamps and/or usernames
   5 # hence are not checked.  File existence is checked with -e though.
   6 # This test depends on File::Path::rmtree() to clean up with.
   7 #  - pvhp
   8 #
   9 # We are now checking that the correct use $version; is present in
  10 # Makefile.PL and $module.pm
  11
  12 BEGIN {
  13     chdir 't' if -d 't';
  14     @INC = '../lib';
  15     # FIXME (or rather FIXh2xs)
  16     require Config;
  17     if (($Config::Config{'extensions'} !~ m!\bDevel/PPPort\b!) ){
  18         print "1..0 # Skip -- Perl configured without Devel::PPPort module\n";
  19         exit 0;
  20     }
  21 }
  22
  23 # use strict; # we are not really testing this
  24 use File::Path;  # for cleaning up with rmtree()
  25 use Test::More;
  26 use File::Spec;
  27 use File::Find;
  28 use ExtUtils::Manifest;
  29 # Don't want its diagnostics getting in the way of ours.
  30 $ExtUtils::Manifest::Quiet=1;
  31 my $up = File::Spec->updir();
  32
  33 my $extracted_program = '../utils/h2xs'; # unix, nt, ...
  34 if ($^O eq 'VMS') { $extracted_program = '[-.utils]h2xs.com'; }
  35 if ($^O eq 'MacOS') { $extracted_program = '::utils:h2xs'; }
  36 if (!(-e $extracted_program)) {
  37     print "1..0 # Skip: $extracted_program was not built\n";
  38     exit 0;
  39 }
  40 # You might also wish to bail out if your perl platform does not
  41 # do `$^X -e 'warn "Writing h2xst"' 2>&1`; duplicity.
  42
  43 # ok on unix, nt, VMS, ...
  44 my $dupe = '2>&1';
  45 # ok on unix, nt, The extra \" are for VMS
  46 my $lib = '"-I../lib" "-I../../lib"';
  47 # The >&1 would create a file named &1 on MPW (STDERR && STDOUT are
  48 # already merged).
  49 if ($^O eq 'MacOS') {
  50     $dupe = '';
  51     # -x overcomes MPW $Config{startperl} anomaly
  52     $lib = '-x -I::lib: -I:::lib:';
  53 }
  54 # $name should differ from system header file names and must
  55 # not already be found in the t/ subdirectory for perl.
  56 my $name = 'h2xst';
  57 my $header = "$name.h";
  58 my $thisversion = sprintf "%vd", $^V;
  59 $thisversion =~ s/^v//;
  60
  61 # If this test has failed previously a copy may be left.
  62 rmtree($name);
  63
  64 my @tests = (
  65 "-f -n $name", $], <<"EOXSFILES",
  66 Defaulting to backwards compatibility with perl $thisversion
  67 If you intend this module to be compatible with earlier perl versions, please
  68 specify a minimum perl version with the -b option.
  69
  70 Writing $name/ppport.h
  71 Writing $name/lib/$name.pm
  72 Writing $name/$name.xs
  73 Writing $name/fallback/const-c.inc
  74 Writing $name/fallback/const-xs.inc
  75 Writing $name/Makefile.PL
  76 Writing $name/README
  77 Writing $name/t/$name.t
  78 Writing $name/Changes
  79 Writing $name/MANIFEST
  80 EOXSFILES
  81
  82 "-f -n $name -b $thisversion", $], <<"EOXSFILES",
  83 Writing $name/ppport.h
  84 Writing $name/lib/$name.pm
  85 Writing $name/$name.xs
  86 Writing $name/fallback/const-c.inc
  87 Writing $name/fallback/const-xs.inc
  88 Writing $name/Makefile.PL
  89 Writing $name/README
  90 Writing $name/t/$name.t
  91 Writing $name/Changes
  92 Writing $name/MANIFEST
  93 EOXSFILES
  94
  95 "-f -n $name -b 5.6.1", "5.006001", <<"EOXSFILES",
  96 Writing $name/ppport.h
  97 Writing $name/lib/$name.pm
  98 Writing $name/$name.xs
  99 Writing $name/fallback/const-c.inc
 100 Writing $name/fallback/const-xs.inc
 101 Writing $name/Makefile.PL
 102 Writing $name/README
 103 Writing $name/t/$name.t
 104 Writing $name/Changes
 105 Writing $name/MANIFEST
 106 EOXSFILES
 107
 108 "-f -n $name -b 5.5.3", "5.00503", <<"EOXSFILES",
 109 Writing $name/ppport.h
 110 Writing $name/lib/$name.pm
 111 Writing $name/$name.xs
 112 Writing $name/fallback/const-c.inc
 113 Writing $name/fallback/const-xs.inc
 114 Writing $name/Makefile.PL
 115 Writing $name/README
 116 Writing $name/t/$name.t
 117 Writing $name/Changes
 118 Writing $name/MANIFEST
 119 EOXSFILES
 120
 121 "\"-X\" -f -n $name -b $thisversion", $], <<"EONOXSFILES",
 122 Writing $name/lib/$name.pm
 123 Writing $name/Makefile.PL
 124 Writing $name/README
 125 Writing $name/t/$name.t
 126 Writing $name/Changes
 127 Writing $name/MANIFEST
 128 EONOXSFILES
 129
 130 "-f -n $name -b $thisversion $header", $], <<"EOXSFILES",
 131 Writing $name/ppport.h
 132 Writing $name/lib/$name.pm
 133 Writing $name/$name.xs
 134 Writing $name/fallback/const-c.inc
 135 Writing $name/fallback/const-xs.inc
 136 Writing $name/Makefile.PL
 137 Writing $name/README
 138 Writing $name/t/$name.t
 139 Writing $name/Changes
 140 Writing $name/MANIFEST
 141 EOXSFILES
 142 );
 143
 144 my $total_tests = 3; # opening, closing and deleting the header file.
 145 for (my $i = $#tests; $i > 0; $i-=3) {
 146   # 1 test for running it, 1 test for the expected result, and 1 for each file
 147   # plus 1 to open and 1 to check for the use in lib/$name.pm and Makefile.PL
 148   # And 1 more for our check for "bonus" files, 2 more for ExtUtil::Manifest.
 149   # use the () to force list context and hence count the number of matches.
 150   $total_tests += 9 + (() = $tests[$i] =~ /(Writing)/sg);
 151 }
 152
 153 plan tests => $total_tests;
 154
 155 ok (open (HEADER, ">$header"), "open '$header'");
 156 print HEADER <<HEADER or die $!;
 157 #define Camel 2
 158 #define Dromedary 1
 159 HEADER
 160 ok (close (HEADER), "close '$header'");
 161
 162 while (my ($args, $version, $expectation) = splice @tests, 0, 3) {
 163   # h2xs warns about what it is writing hence the (possibly unportable)
 164   # 2>&1 dupe:
 165   # does it run?
 166   my $prog = "$^X $lib $extracted_program $args $dupe";
 167   @result = `$prog`;
 168   cmp_ok ($?, "==", 0, "running $prog ");
 169   $result = join("",@result);
 170
 171   # accomodate MPW # comment character prependage
 172   if ($^O eq 'MacOS') {
 173     $result =~ s/#\s*//gs;
 174   }
 175
 176   #print "# expectation is >$expectation<\n";
 177   #print "# result is >$result<\n";
 178   # Was the output the list of files that were expected?
 179   is ($result, $expectation, "running $prog");
 180
 181   my (%got);
 182   find (sub {$got{$File::Find::name}++ unless -d $_}, $name);
 183
 184   foreach ($expectation =~ /Writing\s+(\S+)/gm) {
 185     if ($^O eq 'MacOS') {
 186       $_ = ':' . join(':',split(/\//,$_));
 187       $_ =~ s/$name:t:1.t/$name:t\/1.t/; # is this an h2xs bug?
 188     }
 189     if ($^O eq 'VMS') {
 190       $_ .= '.' unless $_ =~ m/\./;
 191       $_ = lc($_) unless exists $got{$_};
 192     }
 193     ok (-e $_, "check for $_") and delete $got{$_};
 194   }
 195   my @extra = keys %got;
 196   unless (ok (!@extra, "Are any extra files present?")) {
 197     print "# These files are unexpectedly present:\n";
 198     print "# $_\n" foreach sort @extra;
 199   }
 200
 201   chdir ($name) or die "chdir $name failed: $!";
 202   # Aargh. Something wants to load a bit of regexp. And we have to chdir
 203   # for ExtUtils::Manifest. Caught between a rock and a hard place, so this
 204   # seems the least evil thing to do:
 205   push @INC, "../../lib";
 206   my ($missing, $extra) = ExtUtils::Manifest::fullcheck();
 207   is_deeply ($missing, [], "No files in the MANIFEST should be missing");
 208   is_deeply ($extra, [],   "and all files present should be in the MANIFEST");
 209   pop @INC;
 210   chdir ($up) or die "chdir $up failed: $!";
 211
 212   foreach my $leaf (File::Spec->catfile('lib', "$name.pm"), 'Makefile.PL') {
 213     my $file = File::Spec->catfile($name, $leaf);
 214     if (ok (open (FILE, $file), "open $file")) {
 215       my $match = qr/use $version;/;
 216       my $found;
 217       while (<FILE>) {
 218         last if $found = /$match/;
 219       }
 220       ok ($found, "looking for /$match/ in $file");
 221       close FILE or die "close $file: $!";
 222     }
 223   }
 224   # clean up
 225   rmtree($name);
 226 }
 227
 228 cmp_ok (unlink ($header), "==", 1, "unlink '$header'") or die "\$! is $!";