This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate:
[perl5.git] / 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
60 # If this test has failed previously a copy may be left.
61 rmtree($name);
62
63 my @tests = (
64 "-f -n $name", $], <<"EOXSFILES",
65 Defaulting to backwards compatibility with perl $thisversion
66 If you intend this module to be compatible with earlier perl versions, please
67 specify a minimum perl version with the -b option.
68
69 Writing $name/ppport.h
70 Writing $name/lib/$name.pm
71 Writing $name/$name.xs
72 Writing $name/fallback/const-c.inc
73 Writing $name/fallback/const-xs.inc
74 Writing $name/Makefile.PL
75 Writing $name/README
76 Writing $name/t/$name.t
77 Writing $name/Changes
78 Writing $name/MANIFEST
79 EOXSFILES
80
81 "-f -n $name -b $thisversion", $], <<"EOXSFILES",
82 Writing $name/ppport.h
83 Writing $name/lib/$name.pm
84 Writing $name/$name.xs
85 Writing $name/fallback/const-c.inc
86 Writing $name/fallback/const-xs.inc
87 Writing $name/Makefile.PL
88 Writing $name/README
89 Writing $name/t/$name.t
90 Writing $name/Changes
91 Writing $name/MANIFEST
92 EOXSFILES
93
94 "-f -n $name -b 5.6.1", "5.006001", <<"EOXSFILES",
95 Writing $name/ppport.h
96 Writing $name/lib/$name.pm
97 Writing $name/$name.xs
98 Writing $name/fallback/const-c.inc
99 Writing $name/fallback/const-xs.inc
100 Writing $name/Makefile.PL
101 Writing $name/README
102 Writing $name/t/$name.t
103 Writing $name/Changes
104 Writing $name/MANIFEST
105 EOXSFILES
106
107 "-f -n $name -b 5.5.3", "5.00503", <<"EOXSFILES",
108 Writing $name/ppport.h
109 Writing $name/lib/$name.pm
110 Writing $name/$name.xs
111 Writing $name/fallback/const-c.inc
112 Writing $name/fallback/const-xs.inc
113 Writing $name/Makefile.PL
114 Writing $name/README
115 Writing $name/t/$name.t
116 Writing $name/Changes
117 Writing $name/MANIFEST
118 EOXSFILES
119
120 "\"-X\" -f -n $name -b $thisversion", $], <<"EONOXSFILES",
121 Writing $name/lib/$name.pm
122 Writing $name/Makefile.PL
123 Writing $name/README
124 Writing $name/t/$name.t
125 Writing $name/Changes
126 Writing $name/MANIFEST
127 EONOXSFILES
128
129 "-f -n $name -b $thisversion $header", $], <<"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
143 my $total_tests = 3; # opening, closing and deleting the header file.
144 for (my $i = $#tests; $i > 0; $i-=3) {
145   # 1 test for running it, 1 test for the expected result, and 1 for each file
146   # plus 1 to open and 1 to check for the use in lib/$name.pm and Makefile.PL
147   # And 1 more for our check for "bonus" files, 2 more for ExtUtil::Manifest.
148   # use the () to force list context and hence count the number of matches.
149   $total_tests += 9 + (() = $tests[$i] =~ /(Writing)/sg);
150 }
151
152 plan tests => $total_tests;
153
154 ok (open (HEADER, ">$header"), "open '$header'");
155 print HEADER <<HEADER or die $!;
156 #define Camel 2
157 #define Dromedary 1
158 HEADER
159 ok (close (HEADER), "close '$header'");
160
161 while (my ($args, $version, $expectation) = splice @tests, 0, 3) {
162   # h2xs warns about what it is writing hence the (possibly unportable)
163   # 2>&1 dupe:
164   # does it run?
165   my $prog = "$^X $lib $extracted_program $args $dupe";
166   @result = `$prog`;
167   cmp_ok ($?, "==", 0, "running $prog ");
168   $result = join("",@result);
169
170   # accomodate MPW # comment character prependage
171   if ($^O eq 'MacOS') {
172     $result =~ s/#\s*//gs;
173   }
174
175   #print "# expectation is >$expectation<\n";
176   #print "# result is >$result<\n";
177   # Was the output the list of files that were expected?
178   is ($result, $expectation, "running $prog");
179
180   my (%got);
181   find (sub {$got{$File::Find::name}++ unless -d $_}, $name);
182
183   foreach ($expectation =~ /Writing\s+(\S+)/gm) {
184     if ($^O eq 'MacOS') {
185       $_ = ':' . join(':',split(/\//,$_));
186       $_ =~ s/$name:t:1.t/$name:t\/1.t/; # is this an h2xs bug?
187     }
188     if ($^O eq 'VMS') {
189       $_ .= '.' unless $_ =~ m/\./;
190       $_ = lc($_) unless exists $got{$_};
191     }
192     ok (-e $_, "check for $_") and delete $got{$_};
193   }
194   my @extra = keys %got;
195   unless (ok (!@extra, "Are any extra files present?")) {
196     print "# These files are unexpectedly present:\n";
197     print "# $_\n" foreach sort @extra;
198   }
199
200   chdir ($name) or die "chdir $name failed: $!";
201   # Aargh. Something wants to load a bit of regexp. And we have to chdir
202   # for ExtUtils::Manifest. Caught between a rock and a hard place, so this
203   # seems the least evil thing to do:
204   push @INC, "../../lib";
205   my ($missing, $extra) = ExtUtils::Manifest::fullcheck();
206   is_deeply ($missing, [], "No files in the MANIFEST should be missing");
207   is_deeply ($extra, [],   "and all files present should be in the MANIFEST");
208   pop @INC;
209   chdir ($up) or die "chdir $up failed: $!";
210  
211   foreach my $leaf (File::Spec->catfile('lib', "$name.pm"), 'Makefile.PL') {
212     my $file = File::Spec->catfile($name, $leaf);
213     if (ok (open (FILE, $file), "open $file")) {
214       my $match = qr/use $version;/;
215       my $found;
216       while (<FILE>) {
217         last if $found = /$match/;
218       }
219       ok ($found, "looking for /$match/ in $file");
220       close FILE or die "close $file: $!";
221     }
222   }
223   # clean up
224   rmtree($name);
225 }
226
227 cmp_ok (unlink ($header), "==", 1, "unlink '$header'") or die "\$! is $!";