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
  35 my $Is_VMS_traildot = 0;
  36 if ($^O eq 'VMS') {
  37     $extracted_program = '[-.utils]h2xs.com';
  38
  39     # We have to know if VMS is in UNIX mode.  In UNIX mode, trailing dots
  40     # should not be present.  There are actually two settings that control this.
  41
  42     $Is_VMS_traildot = 1;
  43     my $unix_rpt = 0;
  44     my $drop_dot = 0;
  45     if (eval 'require VMS::Feature') {
  46         $unix_rpt = VMS::Feature::current('filename_unix_report');
  47         $drop_dot = VMS::Feature::current('readdir_dropdotnotype');
  48     } else {
  49         my $unix_report = $ENV{'DECC$FILENAME_UNIX_REPORT'} || '';
  50         $unix_rpt = $unix_report =~ /^[ET1]/i;
  51         my $drop_dot_notype = $ENV{'DECC$READDIR_DROPDOTNOTYPE'} || '';
  52         $drop_dot = $drop_dot_notype =~ /^[ET1]/i;
  53     }
  54     $Is_VMS_traildot = 0 if $drop_dot && unix_rpt;
  55 }
  56 if ($^O eq 'MacOS') { $extracted_program = '::utils:h2xs'; }
  57 if (!(-e $extracted_program)) {
  58     print "1..0 # Skip: $extracted_program was not built\n";
  59     exit 0;
  60 }
  61 # You might also wish to bail out if your perl platform does not
  62 # do `$^X -e 'warn "Writing h2xst"' 2>&1`; duplicity.
  63
  64 # ok on unix, nt, VMS, ...
  65 my $dupe = '2>&1';
  66 # ok on unix, nt, The extra \" are for VMS
  67 my $lib = '"-I../lib" "-I../../lib"';
  68 # The >&1 would create a file named &1 on MPW (STDERR && STDOUT are
  69 # already merged).
  70 if ($^O eq 'MacOS') {
  71     $dupe = '';
  72     # -x overcomes MPW $Config{startperl} anomaly
  73     $lib = '-x -I::lib: -I:::lib:';
  74 }
  75 # $name should differ from system header file names and must
  76 # not already be found in the t/ subdirectory for perl.
  77 my $name = 'h2xst';
  78 my $header = "$name.h";
  79 my $thisversion = sprintf "%vd", $^V;
  80 $thisversion =~ s/^v//;
  81
  82 # If this test has failed previously a copy may be left.
  83 rmtree($name);
  84
  85 my @tests = (
  86 "-f -n $name", $], <<"EOXSFILES",
  87 Defaulting to backwards compatibility with perl $thisversion
  88 If you intend this module to be compatible with earlier perl versions, please
  89 specify a minimum perl version with the -b option.
  90
  91 Writing $name/ppport.h
  92 Writing $name/lib/$name.pm
  93 Writing $name/$name.xs
  94 Writing $name/fallback/const-c.inc
  95 Writing $name/fallback/const-xs.inc
  96 Writing $name/Makefile.PL
  97 Writing $name/README
  98 Writing $name/t/$name.t
  99 Writing $name/Changes
 100 Writing $name/MANIFEST
 101 EOXSFILES
 102
 103 "-f -n $name -b $thisversion", $], <<"EOXSFILES",
 104 Writing $name/ppport.h
 105 Writing $name/lib/$name.pm
 106 Writing $name/$name.xs
 107 Writing $name/fallback/const-c.inc
 108 Writing $name/fallback/const-xs.inc
 109 Writing $name/Makefile.PL
 110 Writing $name/README
 111 Writing $name/t/$name.t
 112 Writing $name/Changes
 113 Writing $name/MANIFEST
 114 EOXSFILES
 115
 116 "-f -n $name -b 5.6.1", "5.006001", <<"EOXSFILES",
 117 Writing $name/ppport.h
 118 Writing $name/lib/$name.pm
 119 Writing $name/$name.xs
 120 Writing $name/fallback/const-c.inc
 121 Writing $name/fallback/const-xs.inc
 122 Writing $name/Makefile.PL
 123 Writing $name/README
 124 Writing $name/t/$name.t
 125 Writing $name/Changes
 126 Writing $name/MANIFEST
 127 EOXSFILES
 128
 129 "-f -n $name -b 5.5.3", "5.00503", <<"EOXSFILES",
 130 Writing $name/ppport.h
 131 Writing $name/lib/$name.pm
 132 Writing $name/$name.xs
 133 Writing $name/fallback/const-c.inc
 134 Writing $name/fallback/const-xs.inc
 135 Writing $name/Makefile.PL
 136 Writing $name/README
 137 Writing $name/t/$name.t
 138 Writing $name/Changes
 139 Writing $name/MANIFEST
 140 EOXSFILES
 141
 142 "\"-X\" -f -n $name -b $thisversion", $], <<"EONOXSFILES",
 143 Writing $name/lib/$name.pm
 144 Writing $name/Makefile.PL
 145 Writing $name/README
 146 Writing $name/t/$name.t
 147 Writing $name/Changes
 148 Writing $name/MANIFEST
 149 EONOXSFILES
 150
 151 "-f -n $name -b $thisversion $header", $], <<"EOXSFILES",
 152 Writing $name/ppport.h
 153 Writing $name/lib/$name.pm
 154 Writing $name/$name.xs
 155 Writing $name/fallback/const-c.inc
 156 Writing $name/fallback/const-xs.inc
 157 Writing $name/Makefile.PL
 158 Writing $name/README
 159 Writing $name/t/$name.t
 160 Writing $name/Changes
 161 Writing $name/MANIFEST
 162 EOXSFILES
 163 );
 164
 165 my $total_tests = 3; # opening, closing and deleting the header file.
 166 for (my $i = $#tests; $i > 0; $i-=3) {
 167   # 1 test for running it, 1 test for the expected result, and 1 for each file
 168   # plus 1 to open and 1 to check for the use in lib/$name.pm and Makefile.PL
 169   # And 1 more for our check for "bonus" files, 2 more for ExtUtil::Manifest.
 170   # use the () to force list context and hence count the number of matches.
 171   $total_tests += 9 + (() = $tests[$i] =~ /(Writing)/sg);
 172 }
 173
 174 plan tests => $total_tests;
 175
 176 ok (open (HEADER, ">$header"), "open '$header'");
 177 print HEADER <<HEADER or die $!;
 178 #define Camel 2
 179 #define Dromedary 1
 180 HEADER
 181 ok (close (HEADER), "close '$header'");
 182
 183 while (my ($args, $version, $expectation) = splice @tests, 0, 3) {
 184   # h2xs warns about what it is writing hence the (possibly unportable)
 185   # 2>&1 dupe:
 186   # does it run?
 187   my $prog = "$^X $lib $extracted_program $args $dupe";
 188   @result = `$prog`;
 189   cmp_ok ($?, "==", 0, "running $prog ");
 190   $result = join("",@result);
 191
 192   # accomodate MPW # comment character prependage
 193   if ($^O eq 'MacOS') {
 194     $result =~ s/#\s*//gs;
 195   }
 196
 197   #print "# expectation is >$expectation<\n";
 198   #print "# result is >$result<\n";
 199   # Was the output the list of files that were expected?
 200   is ($result, $expectation, "running $prog");
 201
 202   my (%got);
 203   find (sub {$got{$File::Find::name}++ unless -d $_}, $name);
 204
 205   foreach ($expectation =~ /Writing\s+(\S+)/gm) {
 206     if ($^O eq 'MacOS') {
 207       $_ = ':' . join(':',split(/\//,$_));
 208       $_ =~ s/$name:t:1.t/$name:t\/1.t/; # is this an h2xs bug?
 209     }
 210     if ($^O eq 'VMS') {
 211       if ($Is_VMS_traildot) {
 212           $_ .= '.' unless $_ =~ m/\./;
 213       }
 214       $_ = lc($_) unless exists $got{$_};
 215     }
 216     ok (-e $_, "check for $_") and delete $got{$_};
 217   }
 218   my @extra = keys %got;
 219   unless (ok (!@extra, "Are any extra files present?")) {
 220     print "# These files are unexpectedly present:\n";
 221     print "# $_\n" foreach sort @extra;
 222   }
 223
 224   chdir ($name) or die "chdir $name failed: $!";
 225   # Aargh. Something wants to load a bit of regexp. And we have to chdir
 226   # for ExtUtils::Manifest. Caught between a rock and a hard place, so this
 227   # seems the least evil thing to do:
 228   push @INC, "../../lib";
 229   my ($missing, $extra) = ExtUtils::Manifest::fullcheck();
 230   is_deeply ($missing, [], "No files in the MANIFEST should be missing");
 231   is_deeply ($extra, [],   "and all files present should be in the MANIFEST");
 232   pop @INC;
 233   chdir ($up) or die "chdir $up failed: $!";
 234
 235   foreach my $leaf (File::Spec->catfile('lib', "$name.pm"), 'Makefile.PL') {
 236     my $file = File::Spec->catfile($name, $leaf);
 237     if (ok (open (FILE, $file), "open $file")) {
 238       my $match = qr/use $version;/;
 239       my $found;
 240       while (<FILE>) {
 241         last if $found = /$match/;
 242       }
 243       ok ($found, "looking for /$match/ in $file");
 244       close FILE or die "close $file: $!";
 245     }
 246   }
 247   # clean up
 248   rmtree($name);
 249 }
 250
 251 cmp_ok (unlink ($header), "==", 1, "unlink '$header'") or die "\$! is $!";