This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Get inccode.t working under miniperl
[perl5.git] / t / op / inccode.t
1 #!./perl -w
2
3 # Tests for the coderef-in-@INC feature
4
5 BEGIN {
6     chdir 't' if -d 't';
7     require './test.pl';
8     @INC = () unless is_miniperl();
9     unshift @INC, '../lib';
10 }
11
12 use Config;
13
14 my $can_fork   = 0;
15 my $has_perlio = $Config{useperlio};
16
17 unless (is_miniperl()) {
18     if ($Config{d_fork} && eval 'require POSIX; 1') {
19         $can_fork = 1;
20     }
21 }
22
23 use strict;
24
25 plan(tests => 68 + !is_miniperl() * (3 + 14 * $can_fork));
26
27 sub get_temp_fh {
28     my $f = tempfile();
29     open my $fh, ">$f" or die "Can't create $f: $!";
30     print $fh "package ".substr($_[0],0,-3).";\n1;\n";
31     print $fh $_[1] if @_ > 1;
32     close $fh or die "Couldn't close: $!";
33     open $fh, $f or die "Can't open $f: $!";
34     return $fh;
35 }
36
37 sub fooinc {
38     my ($self, $filename) = @_;
39     if (substr($filename,0,3) eq 'Foo') {
40         return get_temp_fh($filename);
41     }
42     else {
43         return undef;
44     }
45 }
46
47 push @INC, \&fooinc;
48
49 my $evalret = eval { require Bar; 1 };
50 ok( !$evalret,      'Trying non-magic package' );
51
52 $evalret = eval { require Foo; 1 };
53 die $@ if $@;
54 ok( $evalret,                      'require Foo; magic via code ref'  );
55 ok( exists $INC{'Foo.pm'},         '  %INC sees Foo.pm' );
56 is( ref $INC{'Foo.pm'}, 'CODE',    '  val Foo.pm is a coderef in %INC' );
57 is( $INC{'Foo.pm'}, \&fooinc,      '  val Foo.pm is correct in %INC' );
58
59 $evalret = eval "use Foo1; 1;";
60 die $@ if $@;
61 ok( $evalret,                      'use Foo1' );
62 ok( exists $INC{'Foo1.pm'},        '  %INC sees Foo1.pm' );
63 is( ref $INC{'Foo1.pm'}, 'CODE',   '  val Foo1.pm is a coderef in %INC' );
64 is( $INC{'Foo1.pm'}, \&fooinc,     '  val Foo1.pm is correct in %INC' );
65
66 $evalret = eval { do 'Foo2.pl'; 1 };
67 die $@ if $@;
68 ok( $evalret,                      'do "Foo2.pl"' );
69 ok( exists $INC{'Foo2.pl'},        '  %INC sees Foo2.pl' );
70 is( ref $INC{'Foo2.pl'}, 'CODE',   '  val Foo2.pl is a coderef in %INC' );
71 is( $INC{'Foo2.pl'}, \&fooinc,     '  val Foo2.pl is correct in %INC' );
72
73 pop @INC;
74
75
76 sub fooinc2 {
77     my ($self, $filename) = @_;
78     if (substr($filename, 0, length($self->[1])) eq $self->[1]) {
79         return get_temp_fh($filename);
80     }
81     else {
82         return undef;
83     }
84 }
85
86 my $arrayref = [ \&fooinc2, 'Bar' ];
87 push @INC, $arrayref;
88
89 $evalret = eval { require Foo; 1; };
90 die $@ if $@;
91 ok( $evalret,                     'Originally loaded packages preserved' );
92 $evalret = eval { require Foo3; 1; };
93 ok( !$evalret,                    'Original magic INC purged' );
94
95 $evalret = eval { require Bar; 1 };
96 die $@ if $@;
97 ok( $evalret,                     'require Bar; magic via array ref' );
98 ok( exists $INC{'Bar.pm'},        '  %INC sees Bar.pm' );
99 is( ref $INC{'Bar.pm'}, 'ARRAY',  '  val Bar.pm is an arrayref in %INC' );
100 is( $INC{'Bar.pm'}, $arrayref,    '  val Bar.pm is correct in %INC' );
101
102 ok( eval "use Bar1; 1;",          'use Bar1' );
103 ok( exists $INC{'Bar1.pm'},       '  %INC sees Bar1.pm' );
104 is( ref $INC{'Bar1.pm'}, 'ARRAY', '  val Bar1.pm is an arrayref in %INC' );
105 is( $INC{'Bar1.pm'}, $arrayref,   '  val Bar1.pm is correct in %INC' );
106
107 ok( eval { do 'Bar2.pl'; 1 },     'do "Bar2.pl"' );
108 ok( exists $INC{'Bar2.pl'},       '  %INC sees Bar2.pl' );
109 is( ref $INC{'Bar2.pl'}, 'ARRAY', '  val Bar2.pl is an arrayref in %INC' );
110 is( $INC{'Bar2.pl'}, $arrayref,   '  val Bar2.pl is correct in %INC' );
111
112 pop @INC;
113
114 sub FooLoader::INC {
115     my ($self, $filename) = @_;
116     if (substr($filename,0,4) eq 'Quux') {
117         return get_temp_fh($filename);
118     }
119     else {
120         return undef;
121     }
122 }
123
124 my $href = bless( {}, 'FooLoader' );
125 push @INC, $href;
126
127 $evalret = eval { require Quux; 1 };
128 die $@ if $@;
129 ok( $evalret,                      'require Quux; magic via hash object' );
130 ok( exists $INC{'Quux.pm'},        '  %INC sees Quux.pm' );
131 is( ref $INC{'Quux.pm'}, 'FooLoader',
132                                    '  val Quux.pm is an object in %INC' );
133 is( $INC{'Quux.pm'}, $href,        '  val Quux.pm is correct in %INC' );
134
135 pop @INC;
136
137 my $aref = bless( [], 'FooLoader' );
138 push @INC, $aref;
139
140 $evalret = eval { require Quux1; 1 };
141 die $@ if $@;
142 ok( $evalret,                      'require Quux1; magic via array object' );
143 ok( exists $INC{'Quux1.pm'},       '  %INC sees Quux1.pm' );
144 is( ref $INC{'Quux1.pm'}, 'FooLoader',
145                                    '  val Quux1.pm is an object in %INC' );
146 is( $INC{'Quux1.pm'}, $aref,       '  val Quux1.pm  is correct in %INC' );
147
148 pop @INC;
149
150 my $sref = bless( \(my $x = 1), 'FooLoader' );
151 push @INC, $sref;
152
153 $evalret = eval { require Quux2; 1 };
154 die $@ if $@;
155 ok( $evalret,                      'require Quux2; magic via scalar object' );
156 ok( exists $INC{'Quux2.pm'},       '  %INC sees Quux2.pm' );
157 is( ref $INC{'Quux2.pm'}, 'FooLoader',
158                                    '  val Quux2.pm is an object in %INC' );
159 is( $INC{'Quux2.pm'}, $sref,       '  val Quux2.pm is correct in %INC' );
160
161 pop @INC;
162
163 push @INC, sub {
164     my ($self, $filename) = @_;
165     if (substr($filename,0,4) eq 'Toto') {
166         $INC{$filename} = 'xyz';
167         return get_temp_fh($filename);
168     }
169     else {
170         return undef;
171     }
172 };
173
174 $evalret = eval { require Toto; 1 };
175 die $@ if $@;
176 ok( $evalret,                      'require Toto; magic via anonymous code ref'  );
177 ok( exists $INC{'Toto.pm'},        '  %INC sees Toto.pm' );
178 ok( ! ref $INC{'Toto.pm'},         q/  val Toto.pm isn't a ref in %INC/ );
179 is( $INC{'Toto.pm'}, 'xyz',        '  val Toto.pm is correct in %INC' );
180
181 pop @INC;
182
183 push @INC, sub {
184     my ($self, $filename) = @_;
185     if ($filename eq 'abc.pl') {
186         return get_temp_fh($filename, qq(return "abc";\n));
187     }
188     else {
189         return undef;
190     }
191 };
192
193 my $ret = "";
194 $ret ||= do 'abc.pl';
195 is( $ret, 'abc', 'do "abc.pl" sees return value' );
196
197 {
198     my $got;
199     #local @INC; # local fails on tied @INC
200     my @old_INC = @INC; # because local doesn't work on tied arrays
201     @INC = ('lib', 'lib/Devel', sub { $got = $_[1]; return undef; });
202     foreach my $filename ('/test_require.pm', './test_require.pm',
203                           '../test_require.pm') {
204         local %INC;
205         undef $got;
206         undef $test_require::loaded;
207         eval { require $filename; };
208         is($got, $filename, "the coderef sees the pathname $filename");
209         is($test_require::loaded, undef, 'no module is loaded' );
210     }
211
212     local %INC;
213     undef $got;
214     undef $test_require::loaded;
215
216     eval { require 'test_require.pm'; };
217     is($got, undef, 'the directory is scanned for test_require.pm');
218     is($test_require::loaded, 1, 'the module is loaded');
219     @INC = @old_INC;
220 }
221
222 # this will segfault if it fails
223
224 sub PVBM () { 'foo' }
225 { my $dummy = index 'foo', PVBM }
226
227 # I don't know whether these requires should succeed or fail. 5.8 failed
228 # all of them; 5.10 with an ordinary constant in place of PVBM lets the
229 # latter two succeed. For now I don't care, as long as they don't
230 # segfault :).
231
232 unshift @INC, sub { PVBM };
233 eval 'require foo';
234 ok( 1, 'returning PVBM doesn\'t segfault require' );
235 eval 'use foo';
236 ok( 1, 'returning PVBM doesn\'t segfault use' );
237 shift @INC;
238 unshift @INC, sub { \PVBM };
239 eval 'require foo';
240 ok( 1, 'returning PVBM ref doesn\'t segfault require' );
241 eval 'use foo';
242 ok( 1, 'returning PVBM ref doesn\'t segfault use' );
243 shift @INC;
244
245 # [perl #92252]
246 {
247     my $die = sub { die };
248     my $data = [];
249     unshift @INC, sub { $die, $data };
250
251     my $initial_sub_refcnt = &Internals::SvREFCNT($die);
252     my $initial_data_refcnt = &Internals::SvREFCNT($data);
253
254     do "foo";
255     is(&Internals::SvREFCNT($die), $initial_sub_refcnt, "no leaks");
256     is(&Internals::SvREFCNT($data), $initial_data_refcnt, "no leaks");
257
258     do "bar";
259     is(&Internals::SvREFCNT($die), $initial_sub_refcnt, "no leaks");
260     is(&Internals::SvREFCNT($data), $initial_data_refcnt, "no leaks");
261
262     shift @INC;
263 }
264
265 unshift @INC, sub { \(my $tmp = '$_ = "are temps freed prematurely?"') };
266 eval { require foom };
267 is $_||$@, "are temps freed prematurely?",
268            "are temps freed prematurely when returned from inc filters?";
269 shift @INC;
270
271 # [perl #120657]
272 sub fake_module {
273     my (undef,$module_file) = @_;
274     !1
275 }
276 {
277     local @INC = @INC;
278     unshift @INC, (\&fake_module)x2;
279     eval { require "${\'bralbalhablah'}" };
280     like $@, qr/^Can't locate/,
281         'require PADTMP passing freed var when @INC has multiple subs';\r
282 }    
283
284 SKIP: {
285     skip ("Not applicable when run from inccode-tie.t", 6) if tied @INC;
286     require Tie::Scalar;
287     package INCtie {
288         sub TIESCALAR { bless \my $foo }
289         sub FETCH { study; our $count++; ${$_[0]} }
290     }
291     local @INC = undef;
292     my $t = tie $INC[0], 'INCtie';
293     my $called;
294     $$t = sub { $called ++; !1 };
295     delete $INC{'foo.pm'}; # in case another test uses foo
296     eval { require foo };
297     is $INCtie::count, 2, # 2nd time for "Can't locate" -- XXX correct?
298         'FETCH is called once on undef scalar-tied @INC elem';
299     is $called, 1, 'sub in scalar-tied @INC elem is called';
300     () = "$INC[0]"; # force a fetch, so the SV is ROK
301     $INCtie::count = 0;
302     eval { require foo };
303     is $INCtie::count, 2,
304         'FETCH is called once on scalar-tied @INC elem holding ref';
305     is $called, 2, 'sub in scalar-tied @INC elem holding ref is called';
306     $$t = [];
307     $INCtie::count = 0;
308     eval { require foo };
309     is $INCtie::count, 1,
310        'FETCH called once on scalar-tied @INC elem returning array';
311     $$t = "string";
312     $INCtie::count = 0;
313     eval { require foo };
314     is $INCtie::count, 2,
315        'FETCH called once on scalar-tied @INC elem returning string';
316 }
317
318
319 exit if is_miniperl();
320
321 SKIP: {
322     skip( "No PerlIO available", 3 ) unless $has_perlio;
323     pop @INC;
324
325     push @INC, sub {
326         my ($cr, $filename) = @_;
327         my $module = $filename; $module =~ s,/,::,g; $module =~ s/\.pm$//;
328         open my $fh, '<',
329              \"package $module; sub complain { warn q() }; \$::file = __FILE__;"
330             or die $!;
331         $INC{$filename} = "/custom/path/to/$filename";
332         return $fh;
333     };
334
335     require Publius::Vergilius::Maro;
336     is( $INC{'Publius/Vergilius/Maro.pm'},
337         '/custom/path/to/Publius/Vergilius/Maro.pm', '%INC set correctly');
338     is( our $file, '/custom/path/to/Publius/Vergilius/Maro.pm',
339         '__FILE__ set correctly' );
340     {
341         my $warning;
342         local $SIG{__WARN__} = sub { $warning = shift };
343         Publius::Vergilius::Maro::complain();
344         like( $warning, qr{something's wrong at /custom/path/to/Publius/Vergilius/Maro.pm}, 'warn() reports correct file source' );
345     }
346 }
347 pop @INC;
348
349 if ($can_fork) {
350     require PerlIO::scalar;
351     # This little bundle of joy generates n more recursive use statements,
352     # with each module chaining the next one down to 0. If it works, then we
353     # can safely nest subprocesses
354     my $use_filter_too;
355     push @INC, sub {
356         return unless $_[1] =~ /^BBBLPLAST(\d+)\.pm/;
357         my $pid = open my $fh, "-|";
358         if ($pid) {
359             # Parent
360             return $fh unless $use_filter_too;
361             # Try filters and state in addition.
362             return ($fh, sub {s/$_[1]/pass/; return}, "die")
363         }
364         die "Can't fork self: $!" unless defined $pid;
365
366         # Child
367         my $count = $1;
368         # Lets force some fun with odd sized reads.
369         $| = 1;
370         print 'push @main::bbblplast, ';
371         print "$count;\n";
372         if ($count--) {
373             print "use BBBLPLAST$count;\n";
374         }
375         if ($use_filter_too) {
376             print "die('In $_[1]');";
377         } else {
378             print "pass('In $_[1]');";
379         }
380         print '"Truth"';
381         POSIX::_exit(0);
382         die "Can't get here: $!";
383     };
384
385     @::bbblplast = ();
386     require BBBLPLAST5;
387     is ("@::bbblplast", "0 1 2 3 4 5", "All ran");
388
389     foreach (keys %INC) {
390         delete $INC{$_} if /^BBBLPLAST/;
391     }
392
393     @::bbblplast = ();
394     $use_filter_too = 1;
395
396     require BBBLPLAST5;
397
398     is ("@::bbblplast", "0 1 2 3 4 5", "All ran with a filter");
399 }