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