This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 12cad9bd9972
[perl5.git] / t / test.pl
CommitLineData
69026470 1#
91d6f8a5 2# t/test.pl - most of Test::More functionality without the fuss
485f531e
DL
3
4
5# NOTE:
6#
94b9cb53
AC
7# Do not rely on features found only in more modern Perls here, as some CPAN
8# distributions copy this file and must operate on older Perls. Similarly, keep
9# things, simple as this may be run under fairly broken circumstances. For
c42fde61 10# example, increment ($x++) has a certain amount of cleverness for things like
485f531e
DL
11#
12# $x = 'zz';
13# $x++; # $x eq 'aaa';
69026470 14#
c42fde61 15# This stands more chance of breaking than just a simple
485f531e
DL
16#
17# $x = $x + 1
18#
19# In this file, we use the latter "Baby Perl" approach, and increment
20# will be worked over by t/op/inc.t
69026470 21
470e8f06 22$| = 1;
dcc7f481 23$Level = 1;
69026470
JH
24my $test = 1;
25my $planned;
6137113d 26my $noplan;
5fe9b82b 27my $Perl; # Safer version of $^X set by which_perl()
69026470 28
ef237063
NC
29# This defines ASCII/UTF-8 vs EBCDIC/UTF-EBCDIC
30$::IS_ASCII = ord 'A' == 65;
31$::IS_EBCDIC = ord 'A' == 193;
32
7d932aad 33$TODO = 0;
b6345914 34$NO_ENDING = 0;
02455492 35$Tests_Are_Passing = 1;
7d932aad 36
3d66076a
MS
37# Use this instead of print to avoid interference while testing globals.
38sub _print {
39 local($\, $", $,) = (undef, ' ', '');
40 print STDOUT @_;
41}
42
43sub _print_stderr {
44 local($\, $", $,) = (undef, ' ', '');
45 print STDERR @_;
46}
47
69026470
JH
48sub plan {
49 my $n;
50 if (@_ == 1) {
51 $n = shift;
6137113d
NC
52 if ($n eq 'no_plan') {
53 undef $n;
54 $noplan = 1;
55 }
69026470
JH
56 } else {
57 my %plan = @_;
80654023 58 $plan{skip_all} and skip_all($plan{skip_all});
8210c8d3 59 $n = $plan{tests};
69026470 60 }
3d66076a 61 _print "1..$n\n" unless $noplan;
69026470
JH
62 $planned = $n;
63}
64
c4ef7183
MS
65
66# Set the plan at the end. See Test::More::done_testing.
67sub done_testing {
68 my $n = $test - 1;
69 $n = shift if @_;
70
71 _print "1..$n\n";
72 $planned = $n;
73}
74
75
69026470
JH
76END {
77 my $ran = $test - 1;
6137113d
NC
78 if (!$NO_ENDING) {
79 if (defined $planned && $planned != $ran) {
3d66076a 80 _print_stderr
6137113d
NC
81 "# Looks like you planned $planned tests but ran $ran.\n";
82 } elsif ($noplan) {
3d66076a 83 _print "1..$ran\n";
6137113d 84 }
69026470
JH
85 }
86}
87
de522f7a 88sub _diag {
cf8feb78 89 return unless @_;
92c9394b 90 my @mess = _comment(@_);
44826442 91 $TODO ? _print(@mess) : _print_stderr(@mess);
de522f7a
MS
92}
93
93f09d7b 94# Use this instead of "print STDERR" when outputting failure diagnostic
92c9394b 95# messages
485f531e
DL
96sub diag {
97 _diag(@_);
98}
99
93f09d7b 100# Use this instead of "print" when outputting informational messages
92c9394b
MS
101sub note {
102 return unless @_;
103 _print( _comment(@_) );
104}
105
445876fa
KW
106sub is_miniperl {
107 return !defined &DynaLoader::boot_DynaLoader;
108}
109
43ece5b1
FC
110sub set_up_inc {
111 # Don’t clobber @INC under miniperl
112 @INC = () unless is_miniperl;
113 unshift @INC, @_;
114}
115
92c9394b
MS
116sub _comment {
117 return map { /^#/ ? "$_\n" : "# $_\n" }
118 map { split /\n/ } @_;
119}
120
f12ade25
FC
121sub _have_dynamic_extension {
122 my $extension = shift;
123 unless (eval {require Config; 1}) {
124 warn "test.pl had problems loading Config: $@";
125 return 1;
126 }
127 $extension =~ s!::!/!g;
128 return 1 if ($Config::Config{extensions} =~ /\b$extension\b/);
129}
130
69026470
JH
131sub skip_all {
132 if (@_) {
7bb7fa38 133 _print "1..0 # Skip @_\n";
69026470 134 } else {
3d66076a 135 _print "1..0\n";
69026470
JH
136 }
137 exit(0);
138}
139
c82d0e1e 140sub skip_all_if_miniperl {
445876fa 141 skip_all(@_) if is_miniperl();
c82d0e1e
NC
142}
143
273be65c 144sub skip_all_without_dynamic_extension {
f12ade25 145 my ($extension) = @_;
273be65c 146 skip_all("no dynamic loading on miniperl, no $extension") if is_miniperl();
f12ade25 147 return if &_have_dynamic_extension;
7465bc32
NC
148 skip_all("$extension was not built");
149}
150
e05e9c3d
NC
151sub skip_all_without_perlio {
152 skip_all('no PerlIO') unless PerlIO::Layer->find('perlio');
153}
154
9c8416b2 155sub skip_all_without_config {
cb01154c 156 unless (eval {require Config; 1}) {
9c8416b2
NC
157 warn "test.pl had problems loading Config: $@";
158 return;
159 }
77ba2250
NC
160 foreach (@_) {
161 next if $Config::Config{$_};
162 my $key = $_; # Need to copy, before trying to modify.
9c8416b2
NC
163 $key =~ s/^use//;
164 $key =~ s/^d_//;
77ba2250 165 skip_all("no $key");
9c8416b2 166 }
9c8416b2
NC
167}
168
2b08d1e2
FC
169sub skip_all_without_unicode_tables { # (but only under miniperl)
170 if (is_miniperl()) {
171 skip_all_if_miniperl("Unicode tables not built yet")
172 unless eval 'require "unicore/Heavy.pl"';
173 }
174}
175
9c86860c 176sub find_git_or_skip {
fb7d5399 177 my ($source_dir, $reason);
962ff913 178 if (-d '.git') {
fb7d5399 179 $source_dir = '.';
962ff913 180 } elsif (-l 'MANIFEST' && -l 'AUTHORS') {
7eccb5a9
NC
181 my $where = readlink 'MANIFEST';
182 die "Can't readling MANIFEST: $!" unless defined $where;
183 die "Confusing symlink target for MANIFEST, '$where'"
184 unless $where =~ s!/MANIFEST\z!!;
185 if (-d "$where/.git") {
186 # Looks like we are in a symlink tree
fb7d5399
NC
187 if (exists $ENV{GIT_DIR}) {
188 diag("Found source tree at $where, but \$ENV{GIT_DIR} is $ENV{GIT_DIR}. Not changing it");
189 } else {
190 note("Found source tree at $where, setting \$ENV{GIT_DIR}");
191 $ENV{GIT_DIR} = "$where/.git";
192 }
193 $source_dir = $where;
7eccb5a9 194 }
6b44ec68
DK
195 } elsif (exists $ENV{GIT_DIR}) {
196 my $commit = '8d063cd8450e59ea1c611a2f4f5a21059a2804f1';
197 my $out = `git rev-parse --verify --quiet '$commit^{commit}'`;
198 chomp $out;
199 if($out eq $commit) {
200 $source_dir = '.'
201 }
7eccb5a9 202 }
fb7d5399 203 if ($source_dir) {
962ff913
NC
204 my $version_string = `git --version`;
205 if (defined $version_string
206 && $version_string =~ /\Agit version (\d+\.\d+\.\d+)(.*)/) {
fb7d5399 207 return $source_dir if eval "v$1 ge v1.5.0";
962ff913
NC
208 # If you have earlier than 1.5.0 and it works, change this test
209 $reason = "in git checkout, but git version '$1$2' too old";
210 } else {
211 $reason = "in git checkout, but cannot run git";
212 }
213 } else {
214 $reason = 'not being run from a git checkout';
215 }
ba673321
DH
216 if ($ENV{'PERL_BUILD_PACKAGING'}) {
217 $reason = 'PERL_BUILD_PACKAGING is set';
218 }
9c86860c
NC
219 skip_all($reason) if $_[0] && $_[0] eq 'all';
220 skip($reason, @_);
221}
222
779248a0
CK
223sub BAIL_OUT {
224 my ($reason) = @_;
225 _print("Bail out! $reason\n");
226 exit 255;
227}
228
69026470 229sub _ok {
7d932aad 230 my ($pass, $where, $name, @mess) = @_;
69026470
JH
231 # Do not try to microoptimize by factoring out the "not ".
232 # VMS will avenge.
7d932aad
MS
233 my $out;
234 if ($name) {
b734d6c9
MS
235 # escape out '#' or it will interfere with '# skip' and such
236 $name =~ s/#/\\#/g;
7d932aad 237 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
69026470 238 } else {
7d932aad 239 $out = $pass ? "ok $test" : "not ok $test";
69026470 240 }
7d932aad 241
02455492
NC
242 if ($TODO) {
243 $out = $out . " # TODO $TODO";
244 } else {
245 $Tests_Are_Passing = 0 unless $pass;
246 }
247
3d66076a 248 _print "$out\n";
7d932aad 249
9b9ae264
DM
250 if ($pass) {
251 note @mess; # Ensure that the message is properly escaped.
252 }
253 else {
ffb73d65
CB
254 my $msg = "# Failed test $test - ";
255 $msg.= "$name " if $name;
256 $msg .= "$where\n";
257 _diag $msg;
9b9ae264 258 _diag @mess;
69026470 259 }
7d932aad 260
485f531e 261 $test = $test + 1; # don't use ++
1577bb16
MS
262
263 return $pass;
69026470
JH
264}
265
266sub _where {
dcc7f481 267 my @caller = caller($Level);
69026470
JH
268 return "at $caller[1] line $caller[2]";
269}
270
1d662fb6 271# DON'T use this for matches. Use like() instead.
c3029c66 272sub ok ($@) {
7d932aad
MS
273 my ($pass, $name, @mess) = @_;
274 _ok($pass, _where(), $name, @mess);
69026470
JH
275}
276
b3c72391
JH
277sub _q {
278 my $x = shift;
279 return 'undef' unless defined $x;
280 my $q = $x;
d279d8f8
NC
281 $q =~ s/\\/\\\\/g;
282 $q =~ s/'/\\'/g;
b3c72391
JH
283 return "'$q'";
284}
285
677fb045
NC
286sub _qq {
287 my $x = shift;
288 return defined $x ? '"' . display ($x) . '"' : 'undef';
289};
290
94b9cb53
AC
291# Support pre-5.10 Perls, for the benefit of CPAN dists that copy this file.
292# Note that chr(90) exists in both ASCII ("Z") and EBCDIC ("!").
293my $chars_template = defined(eval { pack "W*", 90 }) ? "W*" : "U*";
294eval 'sub re::is_regexp { ref($_[0]) eq "Regexp" }'
295 if !defined &re::is_regexp;
296
677fb045
NC
297# keys are the codes \n etc map to, values are 2 char strings such as \n
298my %backslash_escape;
299foreach my $x (split //, 'nrtfa\\\'"') {
300 $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
301}
302# A way to display scalars containing control characters and Unicode.
303# Trying to avoid setting $_, or relying on local $_ to work.
304sub display {
305 my @result;
306 foreach my $x (@_) {
307 if (defined $x and not ref $x) {
308 my $y = '';
94b9cb53 309 foreach my $c (unpack($chars_template, $x)) {
677fb045 310 if ($c > 255) {
11ea18f2 311 $y = $y . sprintf "\\x{%x}", $c;
677fb045 312 } elsif ($backslash_escape{$c}) {
11ea18f2 313 $y = $y . $backslash_escape{$c};
677fb045
NC
314 } else {
315 my $z = chr $c; # Maybe we can get away with a literal...
9b7098c1
KW
316
317 if ($z !~ /[^[:^print:][:^ascii:]]/) {
318 # The pattern above is equivalent (by de Morgan's
319 # laws) to:
320 # $z !~ /(?[ [:print:] & [:ascii:] ])/
321 # or, $z is not an ascii printable character
26aca2ac
KW
322
323 # Use octal for characters with small ordinals that
324 # are traditionally expressed as octal: the controls
325 # below space, which on EBCDIC are almost all the
326 # controls, but on ASCII don't include DEL nor the C1
327 # controls.
328 if ($c < ord " ") {
1cfccccd
KW
329 $z = sprintf "\\%03o", $c;
330 } else {
331 $z = sprintf "\\x{%x}", $c;
332 }
333 }
11ea18f2 334 $y = $y . $z;
677fb045
NC
335 }
336 }
337 $x = $y;
338 }
339 return $x unless wantarray;
340 push @result, $x;
341 }
342 return @result;
343}
344
c3029c66 345sub is ($$@) {
7d932aad 346 my ($got, $expected, $name, @mess) = @_;
c831d34f
MS
347
348 my $pass;
349 if( !defined $got || !defined $expected ) {
350 # undef only matches undef
351 $pass = !defined $got && !defined $expected;
352 }
353 else {
354 $pass = $got eq $expected;
355 }
356
69026470 357 unless ($pass) {
d5f8084a
KW
358 unshift(@mess, "# got "._qq($got)."\n",
359 "# expected "._qq($expected)."\n");
69026470 360 }
7d932aad 361 _ok($pass, _where(), $name, @mess);
69026470
JH
362}
363
c3029c66 364sub isnt ($$@) {
3e90d5a3 365 my ($got, $isnt, $name, @mess) = @_;
c831d34f
MS
366
367 my $pass;
368 if( !defined $got || !defined $isnt ) {
369 # undef only matches undef
370 $pass = defined $got || defined $isnt;
371 }
372 else {
373 $pass = $got ne $isnt;
374 }
375
3e90d5a3 376 unless( $pass ) {
d5f8084a 377 unshift(@mess, "# it should not be "._qq($got)."\n",
3e90d5a3
MS
378 "# but it is.\n");
379 }
380 _ok($pass, _where(), $name, @mess);
381}
382
c3029c66 383sub cmp_ok ($$$@) {
58d76dfd
JH
384 my($got, $type, $expected, $name, @mess) = @_;
385
386 my $pass;
387 {
388 local $^W = 0;
389 local($@,$!); # don't interfere with $@
390 # eval() sometimes resets $!
391 $pass = eval "\$got $type \$expected";
392 }
393 unless ($pass) {
394 # It seems Irix long doubles can have 2147483648 and 2147483648
93f09d7b 395 # that stringify to the same thing but are actually numerically
58d76dfd
JH
396 # different. Display the numbers if $type isn't a string operator,
397 # and the numbers are stringwise the same.
398 # (all string operators have alphabetic names, so tr/a-z// is true)
93f09d7b
PAR
399 # This will also show numbers for some unneeded cases, but will
400 # definitely be helpful for things such as == and <= that fail
58d76dfd
JH
401 if ($got eq $expected and $type !~ tr/a-z//) {
402 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
403 }
d5f8084a
KW
404 unshift(@mess, "# got "._qq($got)."\n",
405 "# expected $type "._qq($expected)."\n");
58d76dfd
JH
406 }
407 _ok($pass, _where(), $name, @mess);
408}
409
410# Check that $got is within $range of $expected
411# if $range is 0, then check it's exact
412# else if $expected is 0, then $range is an absolute value
413# otherwise $range is a fractional error.
414# Here $range must be numeric, >= 0
415# Non numeric ranges might be a useful future extension. (eg %)
c3029c66 416sub within ($$$@) {
58d76dfd
JH
417 my ($got, $expected, $range, $name, @mess) = @_;
418 my $pass;
419 if (!defined $got or !defined $expected or !defined $range) {
420 # This is a fail, but doesn't need extra diagnostics
421 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
422 # This is a fail
423 unshift @mess, "# got, expected and range must be numeric\n";
424 } elsif ($range < 0) {
425 # This is also a fail
426 unshift @mess, "# range must not be negative\n";
427 } elsif ($range == 0) {
428 # Within 0 is ==
429 $pass = $got == $expected;
430 } elsif ($expected == 0) {
431 # If expected is 0, treat range as absolute
432 $pass = ($got <= $range) && ($got >= - $range);
433 } else {
434 my $diff = $got - $expected;
435 $pass = abs ($diff / $expected) < $range;
436 }
437 unless ($pass) {
438 if ($got eq $expected) {
439 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
440 }
d5f8084a
KW
441 unshift@mess, "# got "._qq($got)."\n",
442 "# expected "._qq($expected)." (within "._qq($range).")\n";
58d76dfd
JH
443 }
444 _ok($pass, _where(), $name, @mess);
445}
446
69026470 447# Note: this isn't quite as fancy as Test::More::like().
724aa791
JC
448
449sub like ($$@) { like_yn (0,@_) }; # 0 for -
450sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
451
452sub like_yn ($$$@) {
0973e8e6 453 my ($flip, undef, $expected, $name, @mess) = @_;
aaa63dae
AB
454
455 # We just accept like(..., qr/.../), not like(..., '...'), and
456 # definitely not like(..., '/.../') like
457 # Test::Builder::maybe_regex() does.
458 unless (re::is_regexp($expected)) {
459 die "PANIC: The value '$expected' isn't a regexp. The like() function needs a qr// pattern, not a string";
460 }
461
69026470 462 my $pass;
0973e8e6
NC
463 $pass = $_[1] =~ /$expected/ if !$flip;
464 $pass = $_[1] !~ /$expected/ if $flip;
d9a72bf2
KW
465 my $display_got = $_[1];
466 $display_got = display($display_got);
467 my $display_expected = $expected;
468 $display_expected = display($display_expected);
724aa791 469 unless ($pass) {
d9a72bf2 470 unshift(@mess, "# got '$display_got'\n",
5a4a8c8b 471 $flip
d9a72bf2
KW
472 ? "# expected !~ /$display_expected/\n"
473 : "# expected /$display_expected/\n");
69026470 474 }
5693d826 475 local $Level = $Level + 1;
7d932aad 476 _ok($pass, _where(), $name, @mess);
69026470
JH
477}
478
479sub pass {
480 _ok(1, '', @_);
481}
482
483sub fail {
484 _ok(0, _where(), @_);
485}
486
ad20d923 487sub curr_test {
cf8feb78 488 $test = shift if @_;
ad20d923
MS
489 return $test;
490}
491
3e90d5a3 492sub next_test {
178eff92 493 my $retval = $test;
485f531e 494 $test = $test + 1; # don't use ++
178eff92 495 $retval;
3e90d5a3
MS
496}
497
69026470
JH
498# Note: can't pass multipart messages since we try to
499# be compatible with Test::More::skip().
500sub skip {
7d932aad 501 my $why = shift;
62904ca6 502 my $n = @_ ? shift : 1;
e96513a2 503 my $bad_swap;
afa691d5 504 my $both_zero;
e96513a2
JH
505 {
506 local $^W = 0;
507 $bad_swap = $why > 0 && $n == 0;
afa691d5 508 $both_zero = $why == 0 && $n == 0;
e96513a2 509 }
afa691d5
JH
510 if ($bad_swap || $both_zero || @_) {
511 my $arg = "'$why', '$n'";
62904ca6
JH
512 if (@_) {
513 $arg .= join(", ", '', map { qq['$_'] } @_);
514 }
515 die qq[$0: expected skip(why, count), got skip($arg)\n];
e96513a2 516 }
69026470 517 for (1..$n) {
7bb7fa38 518 _print "ok $test # skip $why\n";
485f531e 519 $test = $test + 1;
69026470
JH
520 }
521 local $^W = 0;
522 last SKIP;
523}
524
8c49cd2e 525sub skip_if_miniperl {
445876fa 526 skip(@_) if is_miniperl();
8c49cd2e
NC
527}
528
f12ade25 529sub skip_without_dynamic_extension {
afa691d5
JH
530 my $extension = shift;
531 skip("no dynamic loading on miniperl, no extension $extension", @_)
532 if is_miniperl();
533 return if &_have_dynamic_extension($extension);
534 skip("extension $extension was not built", @_);
f12ade25
FC
535}
536
09f04786
MS
537sub todo_skip {
538 my $why = shift;
539 my $n = @_ ? shift : 1;
540
541 for (1..$n) {
7bb7fa38 542 _print "not ok $test # TODO & SKIP $why\n";
485f531e 543 $test = $test + 1;
09f04786
MS
544 }
545 local $^W = 0;
546 last TODO;
547}
548
69026470
JH
549sub eq_array {
550 my ($ra, $rb) = @_;
551 return 0 unless $#$ra == $#$rb;
552 for my $i (0..$#$ra) {
8210c8d3 553 next if !defined $ra->[$i] && !defined $rb->[$i];
135d199b
DM
554 return 0 if !defined $ra->[$i];
555 return 0 if !defined $rb->[$i];
69026470
JH
556 return 0 unless $ra->[$i] eq $rb->[$i];
557 }
558 return 1;
559}
560
677fb045
NC
561sub eq_hash {
562 my ($orig, $suspect) = @_;
563 my $fail;
564 while (my ($key, $value) = each %$suspect) {
565 # Force a hash recompute if this perl's internals can cache the hash key.
566 $key = "" . $key;
567 if (exists $orig->{$key}) {
fb75be7e
HS
568 if (
569 defined $orig->{$key} != defined $value
570 || (defined $value && $orig->{$key} ne $value)
571 ) {
3d66076a 572 _print "# key ", _qq($key), " was ", _qq($orig->{$key}),
de522f7a 573 " now ", _qq($value), "\n";
677fb045
NC
574 $fail = 1;
575 }
576 } else {
3d66076a 577 _print "# key ", _qq($key), " is ", _qq($value),
75385f53 578 ", not in original.\n";
677fb045
NC
579 $fail = 1;
580 }
581 }
582 foreach (keys %$orig) {
583 # Force a hash recompute if this perl's internals can cache the hash key.
584 $_ = "" . $_;
585 next if (exists $suspect->{$_});
3d66076a 586 _print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
677fb045
NC
587 $fail = 1;
588 }
589 !$fail;
590}
591
d47bdea7 592# We only provide a subset of the Test::More functionality.
c3029c66 593sub require_ok ($) {
69026470 594 my ($require) = @_;
d47bdea7
NC
595 if ($require =~ tr/[A-Za-z0-9:.]//c) {
596 fail("Invalid character in \"$require\", passed to require_ok");
597 } else {
598 eval <<REQUIRE_OK;
69026470
JH
599require $require;
600REQUIRE_OK
d47bdea7
NC
601 is($@, '', _where(), "require $require");
602 }
69026470
JH
603}
604
c3029c66 605sub use_ok ($) {
69026470 606 my ($use) = @_;
d47bdea7
NC
607 if ($use =~ tr/[A-Za-z0-9:.]//c) {
608 fail("Invalid character in \"$use\", passed to use");
609 } else {
610 eval <<USE_OK;
69026470
JH
611use $use;
612USE_OK
d47bdea7
NC
613 is($@, '', _where(), "use $use");
614 }
69026470
JH
615}
616
9ff0b393 617# runperl - Runs a separate perl interpreter and returns its output.
137352a2
RGS
618# Arguments :
619# switches => [ command-line switches ]
620# nolib => 1 # don't use -I../lib (included by default)
3d7a9343 621# non_portable => Don't warn if a one liner contains quotes
137352a2 622# prog => one-liner (avoid quotes)
d83945bc 623# progs => [ multi-liner (avoid quotes) ]
137352a2 624# progfile => perl script
53f2736e 625# stdin => string to feed the stdin (or undef to redirect from /dev/null)
97dffe50
KW
626# stderr => If 'devnull' suppresses stderr, if other TRUE value redirect
627# stderr to stdout
137352a2 628# args => [ command-line arguments to the perl program ]
cb9c5e20 629# verbose => print the command line
137352a2
RGS
630
631my $is_mswin = $^O eq 'MSWin32';
632my $is_netware = $^O eq 'NetWare';
137352a2 633my $is_vms = $^O eq 'VMS';
e67ed694 634my $is_cygwin = $^O eq 'cygwin';
137352a2 635
cb9c5e20
JH
636sub _quote_args {
637 my ($runperl, $args) = @_;
638
639 foreach (@$args) {
640 # In VMS protect with doublequotes because otherwise
641 # DCL will lowercase -- unless already doublequoted.
ea9ac5ad 642 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
1cce9906 643 $runperl = $runperl . ' ' . $_;
cb9c5e20 644 }
1cce9906 645 return $runperl;
cb9c5e20
JH
646}
647
4cd2bd1f 648sub _create_runperl { # Create the string to qx in runperl().
137352a2 649 my %args = @_;
5fe9b82b
JH
650 my $runperl = which_perl();
651 if ($runperl =~ m/\s/) {
652 $runperl = qq{"$runperl"};
653 }
6cf707aa
RGS
654 #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
655 if ($ENV{PERL_RUNPERL_DEBUG}) {
656 $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
657 }
f93a5f07 658 unless ($args{nolib}) {
3d7c117d 659 $runperl = $runperl . ' "-I../lib" "-I." '; # doublequotes because of VMS
137352a2 660 }
d83945bc 661 if ($args{switches}) {
343d4a7b
JH
662 local $Level = 2;
663 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
664 unless ref $args{switches} eq "ARRAY";
1cce9906 665 $runperl = _quote_args($runperl, $args{switches});
d83945bc 666 }
137352a2 667 if (defined $args{prog}) {
21820af6
JH
668 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
669 if defined $args{progs};
fc4a4b82 670 $args{progs} = [split /\n/, $args{prog}, -1]
d83945bc
A
671 }
672 if (defined $args{progs}) {
21820af6
JH
673 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
674 unless ref $args{progs} eq "ARRAY";
d83945bc 675 foreach my $prog (@{$args{progs}}) {
ecadf9b7
FC
676 if (!$args{non_portable}) {
677 if ($prog =~ tr/'"//) {
678 warn "quotes in prog >>$prog<< are not portable";
679 }
680 if ($prog =~ /^([<>|]|2>)/) {
681 warn "Initial $1 in prog >>$prog<< is not portable";
682 }
683 if ($prog =~ /&\z/) {
684 warn "Trailing & in prog >>$prog<< is not portable";
685 }
3d7a9343 686 }
d83945bc 687 if ($is_mswin || $is_netware || $is_vms) {
11ea18f2 688 $runperl = $runperl . qq ( -e "$prog" );
d83945bc
A
689 }
690 else {
11ea18f2 691 $runperl = $runperl . qq ( -e '$prog' );
d83945bc
A
692 }
693 }
137352a2 694 } elsif (defined $args{progfile}) {
11ea18f2 695 $runperl = $runperl . qq( "$args{progfile}");
9a731dbd 696 } else {
93f09d7b 697 # You probably didn't want to be sucking in from the upstream stdin
9a731dbd
NC
698 die "test.pl:runperl(): none of prog, progs, progfile, args, "
699 . " switches or stdin specified"
700 unless defined $args{args} or defined $args{switches}
701 or defined $args{stdin};
137352a2
RGS
702 }
703 if (defined $args{stdin}) {
dc459aad
JH
704 # so we don't try to put literal newlines and crs onto the
705 # command line.
706 $args{stdin} =~ s/\n/\\n/g;
707 $args{stdin} =~ s/\r/\\r/g;
5ae09a77 708
137352a2 709 if ($is_mswin || $is_netware || $is_vms) {
5fe9b82b 710 $runperl = qq{$Perl -e "print qq(} .
137352a2
RGS
711 $args{stdin} . q{)" | } . $runperl;
712 }
713 else {
5fe9b82b 714 $runperl = qq{$Perl -e 'print qq(} .
137352a2
RGS
715 $args{stdin} . q{)' | } . $runperl;
716 }
53f2736e
NC
717 } elsif (exists $args{stdin}) {
718 # Using the pipe construction above can cause fun on systems which use
719 # ksh as /bin/sh, as ksh does pipes differently (with one less process)
720 # With sh, for the command line 'perl -e 'print qq()' | perl -e ...'
721 # the sh process forks two children, which use exec to start the two
722 # perl processes. The parent shell process persists for the duration of
723 # the pipeline, and the second perl process starts with no children.
724 # With ksh (and zsh), the shell saves a process by forking a child for
725 # just the first perl process, and execing itself to start the second.
726 # This means that the second perl process starts with one child which
727 # it didn't create. This causes "fun" when if the tests assume that
728 # wait (or waitpid) will only return information about processes
729 # started within the test.
730 # They also cause fun on VMS, where the pipe implementation returns
731 # the exit code of the process at the front of the pipeline, not the
732 # end. This messes up any test using OPTION FATAL.
733 # Hence it's useful to have a way to make STDIN be at eof without
734 # needing a pipeline, so that the fork tests have a sane environment
735 # without these surprises.
736
737 # /dev/null appears to be surprisingly portable.
738 $runperl = $runperl . ($is_mswin ? ' <nul' : ' </dev/null');
137352a2
RGS
739 }
740 if (defined $args{args}) {
1cce9906 741 $runperl = _quote_args($runperl, $args{args});
cb9c5e20 742 }
5fd8fad5 743 if (exists $args{stderr} && $args{stderr} eq 'devnull') {
97dffe50
KW
744 $runperl = $runperl . ($is_mswin ? ' 2>nul' : ' 2>/dev/null');
745 }
746 elsif ($args{stderr}) {
747 $runperl = $runperl . ' 2>&1';
748 }
cb9c5e20
JH
749 if ($args{verbose}) {
750 my $runperldisplay = $runperl;
751 $runperldisplay =~ s/\n/\n\#/g;
3d66076a 752 _print_stderr "# $runperldisplay\n";
137352a2 753 }
4cd2bd1f
JH
754 return $runperl;
755}
756
e2f82642 757# sub run_perl {} is alias to below
4cd2bd1f 758sub runperl {
9a731dbd
NC
759 die "test.pl:runperl() does not take a hashref"
760 if ref $_[0] and ref $_[0] eq 'HASH';
4cd2bd1f 761 my $runperl = &_create_runperl;
613de57f
NC
762 my $result;
763
8210c8d3
MB
764 my $tainted = ${^TAINT};
765 my %args = @_;
485f531e 766 exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
8210c8d3
MB
767
768 if ($tainted) {
613de57f
NC
769 # We will assume that if you're running under -T, you really mean to
770 # run a fresh perl, so we'll brute force launder everything for you
771 my $sep;
772
cb01154c 773 if (! eval {require Config; 1}) {
613de57f
NC
774 warn "test.pl had problems loading Config: $@";
775 $sep = ':';
776 } else {
afe79e7b 777 $sep = $Config::Config{path_sep};
a70a1627 778 }
613de57f
NC
779
780 my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
781 local @ENV{@keys} = ();
782 # Untaint, plus take out . and empty string:
02bb3106 783 local $ENV{'DCL$PATH'} = $1 if $is_vms && exists($ENV{'DCL$PATH'}) && ($ENV{'DCL$PATH'} =~ /(.*)/s);
613de57f 784 $ENV{PATH} =~ /(.*)/s;
8210c8d3 785 local $ENV{PATH} =
3b6d8381 786 join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and
326b5008 787 ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
8210c8d3 788 split quotemeta ($sep), $1;
59aae9bd
JH
789 if ($is_cygwin) { # Must have /bin under Cygwin
790 if (length $ENV{PATH}) {
791 $ENV{PATH} = $ENV{PATH} . $sep;
792 }
793 $ENV{PATH} = $ENV{PATH} . '/bin';
794 }
613de57f
NC
795 $runperl =~ /(.*)/s;
796 $runperl = $1;
797
798 $result = `$runperl`;
799 } else {
800 $result = `$runperl`;
a70a1627 801 }
5b20939a 802 $result =~ s/\n\n/\n/g if $is_vms; # XXX pipes sometimes double these
137352a2
RGS
803 return $result;
804}
805
140f5369
MS
806# Nice alias
807*run_perl = *run_perl = \&runperl; # shut up "used only once" warning
8799135f 808
c4fbe247 809sub DIE {
3d66076a 810 _print_stderr "# @_\n";
c4fbe247 811 exit 1;
8799135f
MS
812}
813
b5fe401b 814# A somewhat safer version of the sometimes wrong $^X.
17a740d5
JH
815sub which_perl {
816 unless (defined $Perl) {
817 $Perl = $^X;
8210c8d3 818
73421c4a 819 # VMS should have 'perl' aliased properly
4b0f0df6 820 return $Perl if $is_vms;
73421c4a 821
17a740d5 822 my $exe;
cb01154c 823 if (! eval {require Config; 1}) {
17a740d5
JH
824 warn "test.pl had problems loading Config: $@";
825 $exe = '';
85363d30 826 } else {
afe79e7b 827 $exe = $Config::Config{_exe};
85363d30 828 }
da405c16 829 $exe = '' unless defined $exe;
8210c8d3 830
17a740d5
JH
831 # This doesn't absolutize the path: beware of future chdirs().
832 # We could do File::Spec->abs2rel() but that does getcwd()s,
833 # which is a bit heavyweight to do here.
8210c8d3 834
17a740d5 835 if ($Perl =~ /^perl\Q$exe\E$/i) {
8db06b02 836 my $perl = "perl$exe";
cb01154c 837 if (! eval {require File::Spec; 1}) {
17a740d5 838 warn "test.pl had problems loading File::Spec: $@";
8db06b02 839 $Perl = "./$perl";
17a740d5 840 } else {
8db06b02 841 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
17a740d5
JH
842 }
843 }
196918b0
PG
844
845 # Build up the name of the executable file from the name of
846 # the command.
847
848 if ($Perl !~ /\Q$exe\E$/i) {
11ea18f2 849 $Perl = $Perl . $exe;
196918b0 850 }
c880be78 851
8db06b02 852 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
8210c8d3 853
17a740d5
JH
854 # For subcommands to use.
855 $ENV{PERLEXE} = $Perl;
85363d30 856 }
17a740d5 857 return $Perl;
b5fe401b
MS
858}
859
435e7af6 860sub unlink_all {
55b0687d 861 my $count = 0;
435e7af6
NC
862 foreach my $file (@_) {
863 1 while unlink $file;
55b0687d
BG
864 if( -f $file ){
865 _print_stderr "# Couldn't unlink '$file': $!\n";
866 }else{
393b66ef 867 $count = $count + 1; # don't use ++
55b0687d 868 }
435e7af6 869 }
55b0687d 870 $count;
435e7af6 871}
eeabcb2d 872
f6e25e60
BG
873# _num_to_alpha - Returns a string of letters representing a positive integer.
874# Arguments :
875# number to convert
2c36667f 876# maximum number of letters
f6e25e60
BG
877
878# returns undef if the number is negative
2c36667f 879# returns undef if the number of letters is greater than the maximum wanted
f6e25e60
BG
880
881# _num_to_alpha( 0) eq 'A';
882# _num_to_alpha( 1) eq 'B';
883# _num_to_alpha(25) eq 'Z';
884# _num_to_alpha(26) eq 'AA';
885# _num_to_alpha(27) eq 'AB';
886
48e9c5d4
BG
887my @letters = qw(A B C D E F G H I J K L M N O P Q R S T U V W X Y Z);
888
f6e25e60
BG
889# Avoid ++ -- ranges split negative numbers
890sub _num_to_alpha{
2c36667f 891 my($num,$max_char) = @_;
f6e25e60
BG
892 return unless $num >= 0;
893 my $alpha = '';
2c36667f
BG
894 my $char_count = 0;
895 $max_char = 0 if $max_char < 0;
896
f6e25e60
BG
897 while( 1 ){
898 $alpha = $letters[ $num % 26 ] . $alpha;
899 $num = int( $num / 26 );
900 last if $num == 0;
901 $num = $num - 1;
2c36667f
BG
902
903 # char limit
904 next unless $max_char;
905 $char_count = $char_count + 1;
906 return if $char_count == $max_char;
f6e25e60
BG
907 }
908 return $alpha;
909}
910
748a4b20
NC
911my %tmpfiles;
912END { unlink_all keys %tmpfiles }
913
914# A regexp that matches the tempfile names
915$::tempfile_regexp = 'tmp\d+[A-Z][A-Z]?';
c1ddc35c 916
7a7e4936 917# Avoid ++, avoid ranges, avoid split //
7b29226f 918my $tempfile_count = 0;
7a7e4936 919sub tempfile {
7b29226f 920 while(1){
c0a22fcc 921 my $try = (-d "t" ? "t/" : "")."tmp$$";
7b29226f
BG
922 my $alpha = _num_to_alpha($tempfile_count,2);
923 last unless defined $alpha;
924 $try = $try . $alpha;
925 $tempfile_count = $tempfile_count + 1;
926
748a4b20
NC
927 # Need to note all the file names we allocated, as a second request may
928 # come before the first is created.
7b29226f 929 if (!$tmpfiles{$try} && !-e $try) {
c1ddc35c 930 # We have a winner
11ea18f2 931 $tmpfiles{$try} = 1;
c1ddc35c
NC
932 return $try;
933 }
7b29226f 934 }
9a8c1c8c 935 die "Can't find temporary file name starting \"tmp$$\"";
7a7e4936
NC
936}
937
5eccd97a
BG
938# register_tempfile - Adds a list of files to be removed at the end of the current test file
939# Arguments :
940# a list of files to be removed later
941
942# returns a count of how many file names were actually added
943
944# Reuses %tmpfiles so that tempfile() will also skip any files added here
945# even if the file doesn't exist yet.
946
947sub register_tempfile {
948 my $count = 0;
949 for( @_ ){
950 if( $tmpfiles{$_} ){
951 _print_stderr "# Temporary file '$_' already added\n";
952 }else{
953 $tmpfiles{$_} = 1;
954 $count = $count + 1;
955 }
956 }
957 return $count;
958}
959
f6203e99 960# This is the temporary file for fresh_perl
7a7e4936 961my $tmpfile = tempfile();
eeabcb2d 962
f6203e99
KW
963sub fresh_perl {
964 my($prog, $runperl_args) = @_;
965
966 # Run 'runperl' with the complete perl program contained in '$prog', and
967 # arguments in the hash referred to by '$runperl_args'. The results are
968 # returned, with $? set to the exit code. Unless overridden, stderr is
969 # redirected to stdout.
eeabcb2d 970
2a91eb11
DC
971 die sprintf "Third argument to fresh_perl_.* must be hashref of args to fresh_perl (or {})"
972 unless !(defined $runperl_args) || ref($runperl_args) eq 'HASH';
973
11ea18f2
NC
974 # Given the choice of the mis-parsable {}
975 # (we want an anon hash, but a borked lexer might think that it's a block)
976 # or relying on taking a reference to a lexical
977 # (\ might be mis-parsed, and the reference counting on the pad may go
978 # awry)
979 # it feels like the least-worse thing is to assume that auto-vivification
980 # works. At least, this is only going to be a run-time failure, so won't
981 # affect tests using this file but not this function.
c49688b0
MS
982 $runperl_args->{progfile} ||= $tmpfile;
983 $runperl_args->{stderr} = 1 unless exists $runperl_args->{stderr};
eeabcb2d 984
1ae6ead9 985 open TEST, '>', $tmpfile or die "Cannot open $tmpfile: $!";
98c155b5 986 binmode TEST, ':utf8' if $runperl_args->{wide_chars};
0d65d7d5 987 print TEST $prog;
eeabcb2d
MS
988 close TEST or die "Cannot close $tmpfile: $!";
989
990 my $results = runperl(%$runperl_args);
f6203e99
KW
991 my $status = $?; # Not necessary to save this, but it makes it clear to
992 # future maintainers.
eeabcb2d
MS
993
994 # Clean up the results into something a bit more predictable.
50f17f89 995 $results =~ s/\n+$//;
748a4b20
NC
996 $results =~ s/at\s+$::tempfile_regexp\s+line/at - line/g;
997 $results =~ s/of\s+$::tempfile_regexp\s+aborted/of - aborted/g;
eeabcb2d
MS
998
999 # bison says 'parse error' instead of 'syntax error',
1000 # various yaccs may or may not capitalize 'syntax'.
1001 $results =~ s/^(syntax|parse) error/syntax error/mig;
1002
4b0f0df6 1003 if ($is_vms) {
eeabcb2d
MS
1004 # some tests will trigger VMS messages that won't be expected
1005 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
1006
1007 # pipes double these sometimes
1008 $results =~ s/\n\n/\n/g;
1009 }
1010
f6203e99
KW
1011 $? = $status;
1012 return $results;
1013}
1014
1015
1016sub _fresh_perl {
1017 my($prog, $action, $expect, $runperl_args, $name) = @_;
1018
1019 my $results = fresh_perl($prog, $runperl_args);
1020 my $status = $?;
1021
e2c38acd
JH
1022 # Use the first line of the program as a name if none was given
1023 unless( $name ) {
1024 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
11ea18f2 1025 $name = $name . '...' if length $first_line > length $name;
e2c38acd 1026 }
eeabcb2d 1027
55280a0d
NC
1028 # Historically this was implemented using a closure, but then that means
1029 # that the tests for closures avoid using this code. Given that there
1030 # are exactly two callers, doing exactly two things, the simpler approach
1031 # feels like a better trade off.
1032 my $pass;
1033 if ($action eq 'eq') {
1034 $pass = is($results, $expect, $name);
1035 } elsif ($action eq '=~') {
1036 $pass = like($results, $expect, $name);
1037 } else {
1038 die "_fresh_perl can't process action '$action'";
1039 }
1040
1041 unless ($pass) {
1042 _diag "# PROG: \n$prog\n";
1043 _diag "# STATUS: $status\n";
1044 }
1045
1046 return $pass;
f5cda331
JH
1047}
1048
1049#
141f445b 1050# fresh_perl_is
f5cda331
JH
1051#
1052# Combination of run_perl() and is().
1053#
1054
1055sub fresh_perl_is {
1056 my($prog, $expected, $runperl_args, $name) = @_;
50f17f89
MS
1057
1058 # _fresh_perl() is going to clip the trailing newlines off the result.
1059 # This will make it so the test author doesn't have to know that.
1060 $expected =~ s/\n+$//;
1061
dcc7f481 1062 local $Level = 2;
55280a0d 1063 _fresh_perl($prog, 'eq', $expected, $runperl_args, $name);
f5cda331
JH
1064}
1065
1066#
141f445b 1067# fresh_perl_like
f5cda331
JH
1068#
1069# Combination of run_perl() and like().
1070#
1071
1072sub fresh_perl_like {
1073 my($prog, $expected, $runperl_args, $name) = @_;
dcc7f481 1074 local $Level = 2;
55280a0d 1075 _fresh_perl($prog, '=~', $expected, $runperl_args, $name);
eeabcb2d
MS
1076}
1077
ebf2da99
NC
1078# Many tests use the same format in __DATA__ or external files to specify a
1079# sequence of (fresh) tests to run, extra files they may temporarily need, and
ebcaaa39
KW
1080# what the expected output is. Putting it here allows common code to serve
1081# these multiple tests.
a8775356
TC
1082#
1083# Each program is source code to run followed by an "EXPECT" line, followed
1084# by the expected output.
1085#
88d057ad
KW
1086# The first line of the code to run may be a command line switch such as -wE
1087# or -0777 (alphanumerics only; only one cluster, beginning with a minus is
1088# allowed). Later lines may contain (note the '# ' on each):
a8775356
TC
1089# # TODO reason for todo
1090# # SKIP reason for skip
1091# # SKIP ?code to test if this should be skipped
1092# # NAME name of the test (as with ok($ok, $name))
1093#
1094# The expected output may contain:
1095# OPTION list of options
1096# OPTIONS list of options
a8775356
TC
1097#
1098# The possible options for OPTION may be:
1099# regex - the expected output is a regular expression
1100# random - all lines match but in any order
1101# fatal - the code will fail fatally (croak, die)
1102#
1103# If the actual output contains a line "SKIPPED" the test will be
1104# skipped.
1105#
708e0e1d
KW
1106# If the actual output contains a line "PREFIX", any output starting with that
1107# line will be ignored when comparing with the expected output
1108#
a8775356
TC
1109# If the global variable $FATAL is true then OPTION fatal is the
1110# default.
ebf2da99 1111
9f5237ac
NC
1112sub _setup_one_file {
1113 my $fh = shift;
41732369
NC
1114 # Store the filename as a program that started at line 0.
1115 # Real files count lines starting at line 1.
1116 my @these = (0, shift);
1117 my ($lineno, $current);
1118 while (<$fh>) {
1119 if ($_ eq "########\n") {
1120 if (defined $current) {
1121 push @these, $lineno, $current;
1122 }
1123 undef $current;
1124 } else {
1125 if (!defined $current) {
1126 $lineno = $.;
1127 }
1128 $current .= $_;
1129 }
1130 }
1131 if (defined $current) {
1132 push @these, $lineno, $current;
1133 }
1134 ((scalar @these) / 2 - 1, @these);
9f5237ac
NC
1135}
1136
fdb35a63
NC
1137sub setup_multiple_progs {
1138 my ($tests, @prgs);
1139 foreach my $file (@_) {
1140 next if $file =~ /(?:~|\.orig|,v)$/;
1141 next if $file =~ /perlio$/ && !PerlIO::Layer->find('perlio');
1142 next if -d $file;
1143
1144 open my $fh, '<', $file or die "Cannot open $file: $!\n" ;
1145 my $found;
1146 while (<$fh>) {
1147 if (/^__END__/) {
393b66ef 1148 $found = $found + 1; # don't use ++
fdb35a63
NC
1149 last;
1150 }
1151 }
1152 # This is an internal error, and should never happen. All bar one of
1153 # the files had an __END__ marker to signal the end of their preamble,
1154 # although for some it wasn't technically necessary as they have no
1155 # tests. It might be possible to process files without an __END__ by
1156 # seeking back to the start and treating the whole file as tests, but
1157 # it's simpler and more reliable just to make the rule that all files
1158 # must have __END__ in. This should never fail - a file without an
1159 # __END__ should not have been checked in, because the regression tests
1160 # would not have passed.
1161 die "Could not find '__END__' in $file"
1162 unless $found;
1163
41732369 1164 my ($t, @p) = _setup_one_file($fh, $file);
9f5237ac 1165 $tests += $t;
41732369 1166 push @prgs, @p;
fdb35a63
NC
1167
1168 close $fh
1169 or die "Cannot close $file: $!\n";
1170 }
1171 return ($tests, @prgs);
1172}
1173
ebf2da99 1174sub run_multiple_progs {
5f7e0818
NC
1175 my $up = shift;
1176 my @prgs;
1177 if ($up) {
1178 # The tests in lib run in a temporary subdirectory of t, and always
1179 # pass in a list of "programs" to run
1180 @prgs = @_;
1181 } else {
41732369
NC
1182 # The tests below t run in t and pass in a file handle. In theory we
1183 # can pass (caller)[1] as the second argument to report errors with
1184 # the filename of our caller, as the handle is always DATA. However,
1185 # line numbers in DATA count from the __END__ token, so will be wrong.
1186 # Which is more confusing than not providing line numbers. So, for now,
1187 # don't provide line numbers. No obvious clean solution - one hack
1188 # would be to seek DATA back to the start and read to the __END__ token,
1189 # but that feels almost like we should just open $0 instead.
1190
9f5237ac
NC
1191 # Not going to rely on undef in list assignment.
1192 my $dummy;
1193 ($dummy, @prgs) = _setup_one_file(shift);
5f7e0818
NC
1194 }
1195
ebf2da99
NC
1196 my $tmpfile = tempfile();
1197
41732369 1198 my ($file, $line);
c0044231 1199 PROGRAM:
41732369
NC
1200 while (defined ($line = shift @prgs)) {
1201 $_ = shift @prgs;
1202 unless ($line) {
1203 $file = $_;
1204 if (defined $file) {
1205 print "# From $file\n";
1206 }
ebf2da99
NC
1207 next;
1208 }
1209 my $switch = "";
1210 my @temps ;
1211 my @temp_path;
1212 if (s/^(\s*-\w+)//) {
1213 $switch = $1;
1214 }
1215 my ($prog, $expected) = split(/\nEXPECT(?:\n|$)/, $_, 2);
1216
1217 my %reason;
1218 foreach my $what (qw(skip todo)) {
1219 $prog =~ s/^#\s*\U$what\E\s*(.*)\n//m and $reason{$what} = $1;
1220 # If the SKIP reason starts ? then it's taken as a code snippet to
1221 # evaluate. This provides the flexibility to have conditional SKIPs
1222 if ($reason{$what} && $reason{$what} =~ s/^\?//) {
1223 my $temp = eval $reason{$what};
1224 if ($@) {
1225 die "# In \U$what\E code reason:\n# $reason{$what}\n$@";
1226 }
1227 $reason{$what} = $temp;
1228 }
1229 }
c0044231 1230
59e38755
TC
1231 my $name = '';
1232 if ($prog =~ s/^#\s*NAME\s+(.+)\n//m) {
1233 $name = $1;
1234 }
ebf2da99 1235
c0044231
TC
1236 if ($reason{skip}) {
1237 SKIP:
1238 {
1239 skip($name ? "$name - $reason{skip}" : $reason{skip}, 1);
1240 }
1241 next PROGRAM;
1242 }
1243
ebf2da99 1244 if ($prog =~ /--FILE--/) {
e330f831 1245 my @files = split(/\n?--FILE--\s*([^\s\n]*)\s*\n/, $prog) ;
ebf2da99
NC
1246 shift @files ;
1247 die "Internal error: test $_ didn't split into pairs, got " .
1248 scalar(@files) . "[" . join("%%%%", @files) ."]\n"
1249 if @files % 2;
1250 while (@files > 2) {
1251 my $filename = shift @files;
1252 my $code = shift @files;
1253 push @temps, $filename;
1254 if ($filename =~ m#(.*)/# && $filename !~ m#^\.\./#) {
1255 require File::Path;
1256 File::Path::mkpath($1);
1257 push(@temp_path, $1);
1258 }
1259 open my $fh, '>', $filename or die "Cannot open $filename: $!\n";
1260 print $fh $code;
1261 close $fh or die "Cannot close $filename: $!\n";
1262 }
1263 shift @files;
1264 $prog = shift @files;
1265 }
1266
1267 open my $fh, '>', $tmpfile or die "Cannot open >$tmpfile: $!";
1268 print $fh q{
1269 BEGIN {
3d7c117d 1270 push @INC, '.';
ebf2da99
NC
1271 open STDERR, '>&', STDOUT
1272 or die "Can't dup STDOUT->STDERR: $!;";
1273 }
1274 };
1275 print $fh "\n#line 1\n"; # So the line numbers don't get messed up.
1276 print $fh $prog,"\n";
1277 close $fh or die "Cannot close $tmpfile: $!";
684b0eca 1278 my $results = runperl( stderr => 1, progfile => $tmpfile,
53f2736e 1279 stdin => undef, $up
5f7e0818
NC
1280 ? (switches => ["-I$up/lib", $switch], nolib => 1)
1281 : (switches => [$switch])
1282 );
ebf2da99
NC
1283 my $status = $?;
1284 $results =~ s/\n+$//;
1285 # allow expected output to be written as if $prog is on STDIN
1286 $results =~ s/$::tempfile_regexp/-/g;
1287 if ($^O eq 'VMS') {
1288 # some tests will trigger VMS messages that won't be expected
1289 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
1290
1291 # pipes double these sometimes
1292 $results =~ s/\n\n/\n/g;
1293 }
1294 # bison says 'parse error' instead of 'syntax error',
1295 # various yaccs may or may not capitalize 'syntax'.
1296 $results =~ s/^(syntax|parse) error/syntax error/mig;
1297 # allow all tests to run when there are leaks
1298 $results =~ s/Scalars leaked: \d+\n//g;
1299
1300 $expected =~ s/\n+$//;
1301 my $prefix = ($results =~ s#^PREFIX(\n|$)##) ;
1302 # any special options? (OPTIONS foo bar zap)
1303 my $option_regex = 0;
1304 my $option_random = 0;
59e38755 1305 my $fatal = $FATAL;
ebf2da99
NC
1306 if ($expected =~ s/^OPTIONS? (.+)\n//) {
1307 foreach my $option (split(' ', $1)) {
1308 if ($option eq 'regex') { # allow regular expressions
1309 $option_regex = 1;
1310 }
1311 elsif ($option eq 'random') { # all lines match, but in any order
1312 $option_random = 1;
1313 }
59e38755
TC
1314 elsif ($option eq 'fatal') { # perl should fail
1315 $fatal = 1;
1316 }
ebf2da99
NC
1317 else {
1318 die "$0: Unknown OPTION '$option'\n";
1319 }
1320 }
1321 }
1322 die "$0: can't have OPTION regex and random\n"
1323 if $option_regex + $option_random > 1;
1324 my $ok = 0;
1325 if ($results =~ s/^SKIPPED\n//) {
1326 print "$results\n" ;
1327 $ok = 1;
1328 }
ebf2da99 1329 else {
59e38755
TC
1330 if ($option_random) {
1331 my @got = sort split "\n", $results;
1332 my @expected = sort split "\n", $expected;
1333
1334 $ok = "@got" eq "@expected";
1335 }
1336 elsif ($option_regex) {
1337 $ok = $results =~ /^$expected/;
1338 }
1339 elsif ($prefix) {
1340 $ok = $results =~ /^\Q$expected/;
1341 }
1342 else {
1343 $ok = $results eq $expected;
1344 }
1345
1346 if ($ok && $fatal && !($status >> 8)) {
1347 $ok = 0;
1348 }
ebf2da99
NC
1349 }
1350
1351 local $::TODO = $reason{todo};
1352
1353 unless ($ok) {
1354 my $err_line = "PROG: $switch\n$prog\n" .
59e38755
TC
1355 "EXPECTED:\n$expected\n";
1356 $err_line .= "EXIT STATUS: != 0\n" if $fatal;
1357 $err_line .= "GOT:\n$results\n";
1358 $err_line .= "EXIT STATUS: " . ($status >> 8) . "\n" if $fatal;
ebf2da99
NC
1359 if ($::TODO) {
1360 $err_line =~ s/^/# /mg;
1361 print $err_line; # Harness can't filter it out from STDERR.
1362 }
1363 else {
1364 print STDERR $err_line;
1365 }
1366 }
1367
41732369
NC
1368 if (defined $file) {
1369 _ok($ok, "at $file line $line", $name);
1370 } else {
1371 # We don't have file and line number data for the test, so report
1372 # errors as coming from our caller.
1373 local $Level = $Level + 1;
1374 ok($ok, $name);
1375 }
ebf2da99
NC
1376
1377 foreach (@temps) {
1378 unlink $_ if $_;
1379 }
1380 foreach (@temp_path) {
1381 File::Path::rmtree $_ if -d $_;
1382 }
1383 }
1384}
1385
35a60386
RGS
1386sub can_ok ($@) {
1387 my($proto, @methods) = @_;
1388 my $class = ref $proto || $proto;
1389
1390 unless( @methods ) {
1391 return _ok( 0, _where(), "$class->can(...)" );
1392 }
1393
1394 my @nok = ();
1395 foreach my $method (@methods) {
1396 local($!, $@); # don't interfere with caller's $@
1397 # eval sometimes resets $!
1398 eval { $proto->can($method) } || push @nok, $method;
1399 }
1400
1401 my $name;
8210c8d3 1402 $name = @methods == 1 ? "$class->can('$methods[0]')"
35a60386 1403 : "$class->can(...)";
8210c8d3 1404
35a60386
RGS
1405 _ok( !@nok, _where(), $name );
1406}
1407
ad4e703e 1408
bbce3ca6 1409# Call $class->new( @$args ); and run the result through object_ok.
ad4e703e
MS
1410# See Test::More::new_ok
1411sub new_ok {
1412 my($class, $args, $obj_name) = @_;
1413 $args ||= [];
1414 $object_name = "The object" unless defined $obj_name;
1415
1416 local $Level = $Level + 1;
1417
1418 my $obj;
1419 my $ok = eval { $obj = $class->new(@$args); 1 };
1420 my $error = $@;
1421
1422 if($ok) {
bbce3ca6 1423 object_ok($obj, $class, $object_name);
ad4e703e
MS
1424 }
1425 else {
1426 ok( 0, "new() died" );
1427 diag("Error was: $@");
1428 }
1429
1430 return $obj;
1431
1432}
1433
1434
35a60386
RGS
1435sub isa_ok ($$;$) {
1436 my($object, $class, $obj_name) = @_;
1437
1438 my $diag;
1439 $obj_name = 'The object' unless defined $obj_name;
1440 my $name = "$obj_name isa $class";
1441 if( !defined $object ) {
1442 $diag = "$obj_name isn't defined";
1443 }
35a60386 1444 else {
b8ab4b0c
MS
1445 my $whatami = ref $object ? 'object' : 'class';
1446
35a60386
RGS
1447 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
1448 local($@, $!); # eval sometimes resets $!
1449 my $rslt = eval { $object->isa($class) };
b8ab4b0c
MS
1450 my $error = $@; # in case something else blows away $@
1451
1452 if( $error ) {
1453 if( $error =~ /^Can't call method "isa" on unblessed reference/ ) {
1454 # It's an unblessed reference
1455 $obj_name = 'The reference' unless defined $obj_name;
35a60386
RGS
1456 if( !UNIVERSAL::isa($object, $class) ) {
1457 my $ref = ref $object;
1458 $diag = "$obj_name isn't a '$class' it's a '$ref'";
1459 }
b8ab4b0c
MS
1460 }
1461 elsif( $error =~ /Can't call method "isa" without a package/ ) {
1462 # It's something that can't even be a class
1463 $obj_name = 'The thing' unless defined $obj_name;
1464 $diag = "$obj_name isn't a class or reference";
1465 }
1466 else {
35a60386
RGS
1467 die <<WHOA;
1468WHOA! I tried to call ->isa on your object and got some weird error.
1469This should never happen. Please contact the author immediately.
1470Here's the error.
1471$@
1472WHOA
1473 }
1474 }
1475 elsif( !$rslt ) {
b8ab4b0c 1476 $obj_name = "The $whatami" unless defined $obj_name;
35a60386
RGS
1477 my $ref = ref $object;
1478 $diag = "$obj_name isn't a '$class' it's a '$ref'";
1479 }
1480 }
1481
1482 _ok( !$diag, _where(), $name );
1483}
1484
bbce3ca6
MS
1485
1486sub class_ok {
1487 my($class, $isa, $class_name) = @_;
1488
1489 # Written so as to count as one test
1490 local $Level = $Level + 1;
1491 if( ref $class ) {
5c25e937 1492 ok( 0, "$class is a reference, not a class name" );
bbce3ca6
MS
1493 }
1494 else {
1495 isa_ok($class, $isa, $class_name);
1496 }
1497}
1498
1499
1500sub object_ok {
1501 my($obj, $isa, $obj_name) = @_;
1502
1503 local $Level = $Level + 1;
1504 if( !ref $obj ) {
1505 ok( 0, "$obj is not a reference" );
1506 }
1507 else {
1508 isa_ok($obj, $isa, $obj_name);
1509 }
1510}
1511
1512
9eb41b69
NC
1513# Purposefully avoiding a closure.
1514sub __capture {
1515 push @::__capture, join "", @_;
1516}
1517
3fbaac97
NC
1518sub capture_warnings {
1519 my $code = shift;
1520
9eb41b69
NC
1521 local @::__capture;
1522 local $SIG {__WARN__} = \&__capture;
7d3a9a28 1523 local $Level = 1;
3fbaac97 1524 &$code;
9eb41b69 1525 return @::__capture;
3fbaac97
NC
1526}
1527
1528# This will generate a variable number of tests.
1529# Use done_testing() instead of a fixed plan.
1530sub warnings_like {
1531 my ($code, $expect, $name) = @_;
f4554ed5
NC
1532 local $Level = $Level + 1;
1533
3fbaac97
NC
1534 my @w = capture_warnings($code);
1535
1536 cmp_ok(scalar @w, '==', scalar @$expect, $name);
1537 foreach my $e (@$expect) {
f4554ed5 1538 if (ref $e) {
3fbaac97 1539 like(shift @w, $e, $name);
4d18b353 1540 } else {
3fbaac97 1541 is(shift @w, $e, $name);
4d18b353 1542 }
96980024 1543 }
3fbaac97
NC
1544 if (@w) {
1545 diag("Saw these additional warnings:");
1546 diag($_) foreach @w;
1547 }
1548}
1549
1550sub _fail_excess_warnings {
1551 my($expect, $got, $name) = @_;
1552 local $Level = $Level + 1;
1553 # This will fail, and produce diagnostics
1554 is($expect, scalar @$got, $name);
1555 diag("Saw these warnings:");
1556 diag($_) foreach @$got;
c11a8df3
NC
1557}
1558
4d18b353
NC
1559sub warning_is {
1560 my ($code, $expect, $name) = @_;
1561 die sprintf "Expect must be a string or undef, not a %s reference", ref $expect
1562 if ref $expect;
f4554ed5 1563 local $Level = $Level + 1;
3fbaac97
NC
1564 my @w = capture_warnings($code);
1565 if (@w > 1) {
1566 _fail_excess_warnings(0 + defined $expect, \@w, $name);
1567 } else {
1568 is($w[0], $expect, $name);
1569 }
4d18b353
NC
1570}
1571
1572sub warning_like {
1573 my ($code, $expect, $name) = @_;
1574 die sprintf "Expect must be a regexp object"
1575 unless ref $expect eq 'Regexp';
f4554ed5 1576 local $Level = $Level + 1;
3fbaac97
NC
1577 my @w = capture_warnings($code);
1578 if (@w > 1) {
1579 _fail_excess_warnings(0 + defined $expect, \@w, $name);
1580 } else {
1581 like($w[0], $expect, $name);
1582 }
4d18b353
NC
1583}
1584
087986a7 1585# Set a watchdog to timeout the entire test file
5fe9b82b
JH
1586# NOTE: If the test file uses 'threads', then call the watchdog() function
1587# _AFTER_ the 'threads' module is loaded.
5732108f 1588sub watchdog ($;$)
087986a7
JH
1589{
1590 my $timeout = shift;
36436324 1591 my $method = shift || "";
087986a7
JH
1592 my $timeout_msg = 'Test process timed out - terminating';
1593
e07ce2e4
GG
1594 # Valgrind slows perl way down so give it more time before dying.
1595 $timeout *= 10 if $ENV{PERL_VALGRIND};
1596
087986a7
JH
1597 my $pid_to_kill = $$; # PID for this process
1598
5732108f
GG
1599 if ($method eq "alarm") {
1600 goto WATCHDOG_VIA_ALARM;
1601 }
1602
140f5369
MS
1603 # shut up use only once warning
1604 my $threads_on = $threads::threads && $threads::threads;
1605
5fe9b82b
JH
1606 # Don't use a watchdog process if 'threads' is loaded -
1607 # use a watchdog thread instead
78325d7a 1608 if (!$threads_on || $method eq "process") {
5fe9b82b
JH
1609
1610 # On Windows and VMS, try launching a watchdog process
1611 # using system(1, ...) (see perlport.pod)
4b0f0df6 1612 if ($is_mswin || $is_vms) {
5fe9b82b 1613 # On Windows, try to get the 'real' PID
4b0f0df6 1614 if ($is_mswin) {
5fe9b82b
JH
1615 eval { require Win32; };
1616 if (defined(&Win32::GetCurrentProcessId)) {
1617 $pid_to_kill = Win32::GetCurrentProcessId();
1618 }
087986a7 1619 }
087986a7 1620
5fe9b82b
JH
1621 # If we still have a fake PID, we can't use this method at all
1622 return if ($pid_to_kill <= 0);
1623
1624 # Launch watchdog process
1625 my $watchdog;
1626 eval {
1627 local $SIG{'__WARN__'} = sub {
1628 _diag("Watchdog warning: $_[0]");
1629 };
4b0f0df6 1630 my $sig = $is_vms ? 'TERM' : 'KILL';
a68d0dcb
SH
1631 my $prog = "sleep($timeout);" .
1632 "warn qq/# $timeout_msg" . '\n/;' .
1633 "kill(q/$sig/, $pid_to_kill);";
1634
1635 # On Windows use the indirect object plus LIST form to guarantee
1636 # that perl is launched directly rather than via the shell (see
1637 # perlfunc.pod), and ensure that the LIST has multiple elements
1638 # since the indirect object plus COMMANDSTRING form seems to
1639 # hang (see perl #121283). Don't do this on VMS, which doesn't
1640 # support the LIST form at all.
1641 if ($is_mswin) {
1642 my $runperl = which_perl();
1643 if ($runperl =~ m/\s/) {
1644 $runperl = qq{"$runperl"};
1645 }
1646 $watchdog = system({ $runperl } 1, $runperl, '-e', $prog);
1647 }
1648 else {
1649 my $cmd = _create_runperl(prog => $prog);
1650 $watchdog = system(1, $cmd);
1651 }
5fe9b82b
JH
1652 };
1653 if ($@ || ($watchdog <= 0)) {
1654 _diag('Failed to start watchdog');
1655 _diag($@) if $@;
1656 undef($watchdog);
1657 return;
1658 }
087986a7 1659
5fe9b82b
JH
1660 # Add END block to parent to terminate and
1661 # clean up watchdog process
a68d0dcb 1662 eval("END { local \$! = 0; local \$? = 0;
18ae2abf 1663 wait() if kill('KILL', $watchdog); };");
5fe9b82b 1664 return;
087986a7 1665 }
087986a7 1666
5fe9b82b
JH
1667 # Try using fork() to generate a watchdog process
1668 my $watchdog;
1669 eval { $watchdog = fork() };
1670 if (defined($watchdog)) {
1671 if ($watchdog) { # Parent process
1672 # Add END block to parent to terminate and
1673 # clean up watchdog process
7e1027b9
JH
1674 eval "END { local \$! = 0; local \$? = 0;
1675 wait() if kill('KILL', $watchdog); };";
5fe9b82b
JH
1676 return;
1677 }
1678
1679 ### Watchdog process code
087986a7 1680
5fe9b82b
JH
1681 # Load POSIX if available
1682 eval { require POSIX; };
087986a7 1683
5fe9b82b
JH
1684 # Execute the timeout
1685 sleep($timeout - 2) if ($timeout > 2); # Workaround for perlbug #49073
1686 sleep(2);
087986a7 1687
5fe9b82b
JH
1688 # Kill test process if still running
1689 if (kill(0, $pid_to_kill)) {
1690 _diag($timeout_msg);
1691 kill('KILL', $pid_to_kill);
1a34b28b
TC
1692 if ($is_cygwin) {
1693 # sometimes the above isn't enough on cygwin
1694 sleep 1; # wait a little, it might have worked after all
1695 system("/bin/kill -f $pid_to_kill");
1696 }
5fe9b82b 1697 }
087986a7 1698
5fe9b82b
JH
1699 # Don't execute END block (added at beginning of this file)
1700 $NO_ENDING = 1;
087986a7 1701
5fe9b82b
JH
1702 # Terminate ourself (i.e., the watchdog)
1703 POSIX::_exit(1) if (defined(&POSIX::_exit));
1704 exit(1);
087986a7
JH
1705 }
1706
5fe9b82b 1707 # fork() failed - fall through and try using a thread
087986a7
JH
1708 }
1709
5fe9b82b
JH
1710 # Use a watchdog thread because either 'threads' is loaded,
1711 # or fork() failed
cb01154c 1712 if (eval {require threads; 1}) {
b296285b 1713 'threads'->create(sub {
087986a7
JH
1714 # Load POSIX if available
1715 eval { require POSIX; };
1716
1717 # Execute the timeout
c1c45e36 1718 my $time_left = $timeout;
a6c9a815 1719 do {
11ea18f2 1720 $time_left = $time_left - sleep($time_left);
a6c9a815 1721 } while ($time_left > 0);
087986a7
JH
1722
1723 # Kill the parent (and ourself)
5fe9b82b 1724 select(STDERR); $| = 1;
087986a7
JH
1725 _diag($timeout_msg);
1726 POSIX::_exit(1) if (defined(&POSIX::_exit));
4b0f0df6 1727 my $sig = $is_vms ? 'TERM' : 'KILL';
c1c45e36 1728 kill($sig, $pid_to_kill);
087986a7
JH
1729 })->detach();
1730 return;
1731 }
1732
5fe9b82b 1733 # If everything above fails, then just use an alarm timeout
5732108f 1734WATCHDOG_VIA_ALARM:
087986a7
JH
1735 if (eval { alarm($timeout); 1; }) {
1736 # Load POSIX if available
1737 eval { require POSIX; };
1738
1739 # Alarm handler will do the actual 'killing'
1740 $SIG{'ALRM'} = sub {
5fe9b82b 1741 select(STDERR); $| = 1;
087986a7
JH
1742 _diag($timeout_msg);
1743 POSIX::_exit(1) if (defined(&POSIX::_exit));
4b0f0df6 1744 my $sig = $is_vms ? 'TERM' : 'KILL';
c1c45e36 1745 kill($sig, $pid_to_kill);
087986a7
JH
1746 };
1747 }
1748}
1749
69026470 17501;