Commit | Line | Data |
---|---|---|
69026470 JH |
1 | # |
2 | # t/test.pl - most of Test::More functionality without the fuss | |
485f531e DL |
3 | |
4 | ||
5 | # NOTE: | |
6 | # | |
7 | # Increment ($x++) has a certain amount of cleverness for things like | |
8 | # | |
9 | # $x = 'zz'; | |
10 | # $x++; # $x eq 'aaa'; | |
69026470 | 11 | # |
485f531e DL |
12 | # stands more chance of breaking than just a simple |
13 | # | |
14 | # $x = $x + 1 | |
15 | # | |
16 | # In this file, we use the latter "Baby Perl" approach, and increment | |
17 | # will be worked over by t/op/inc.t | |
69026470 | 18 | |
dcc7f481 | 19 | $Level = 1; |
69026470 JH |
20 | my $test = 1; |
21 | my $planned; | |
6137113d | 22 | my $noplan; |
5fe9b82b | 23 | my $Perl; # Safer version of $^X set by which_perl() |
69026470 | 24 | |
7d932aad | 25 | $TODO = 0; |
b6345914 | 26 | $NO_ENDING = 0; |
7d932aad | 27 | |
3d66076a MS |
28 | # Use this instead of print to avoid interference while testing globals. |
29 | sub _print { | |
30 | local($\, $", $,) = (undef, ' ', ''); | |
31 | print STDOUT @_; | |
32 | } | |
33 | ||
34 | sub _print_stderr { | |
35 | local($\, $", $,) = (undef, ' ', ''); | |
36 | print STDERR @_; | |
37 | } | |
38 | ||
69026470 JH |
39 | sub plan { |
40 | my $n; | |
41 | if (@_ == 1) { | |
42 | $n = shift; | |
6137113d NC |
43 | if ($n eq 'no_plan') { |
44 | undef $n; | |
45 | $noplan = 1; | |
46 | } | |
69026470 JH |
47 | } else { |
48 | my %plan = @_; | |
8210c8d3 | 49 | $n = $plan{tests}; |
69026470 | 50 | } |
3d66076a | 51 | _print "1..$n\n" unless $noplan; |
69026470 JH |
52 | $planned = $n; |
53 | } | |
54 | ||
55 | END { | |
56 | my $ran = $test - 1; | |
6137113d NC |
57 | if (!$NO_ENDING) { |
58 | if (defined $planned && $planned != $ran) { | |
3d66076a | 59 | _print_stderr |
6137113d NC |
60 | "# Looks like you planned $planned tests but ran $ran.\n"; |
61 | } elsif ($noplan) { | |
3d66076a | 62 | _print "1..$ran\n"; |
6137113d | 63 | } |
69026470 JH |
64 | } |
65 | } | |
66 | ||
8210c8d3 | 67 | # Use this instead of "print STDERR" when outputing failure diagnostic |
de522f7a MS |
68 | # messages |
69 | sub _diag { | |
cf8feb78 | 70 | return unless @_; |
8210c8d3 | 71 | my @mess = map { /^#/ ? "$_\n" : "# $_\n" } |
cf8feb78 | 72 | map { split /\n/ } @_; |
44826442 | 73 | $TODO ? _print(@mess) : _print_stderr(@mess); |
de522f7a MS |
74 | } |
75 | ||
485f531e DL |
76 | sub diag { |
77 | _diag(@_); | |
78 | } | |
79 | ||
69026470 JH |
80 | sub skip_all { |
81 | if (@_) { | |
3d66076a | 82 | _print "1..0 # Skipped: @_\n"; |
69026470 | 83 | } else { |
3d66076a | 84 | _print "1..0\n"; |
69026470 JH |
85 | } |
86 | exit(0); | |
87 | } | |
88 | ||
89 | sub _ok { | |
7d932aad | 90 | my ($pass, $where, $name, @mess) = @_; |
69026470 JH |
91 | # Do not try to microoptimize by factoring out the "not ". |
92 | # VMS will avenge. | |
7d932aad MS |
93 | my $out; |
94 | if ($name) { | |
b734d6c9 MS |
95 | # escape out '#' or it will interfere with '# skip' and such |
96 | $name =~ s/#/\\#/g; | |
7d932aad | 97 | $out = $pass ? "ok $test - $name" : "not ok $test - $name"; |
69026470 | 98 | } else { |
7d932aad | 99 | $out = $pass ? "ok $test" : "not ok $test"; |
69026470 | 100 | } |
7d932aad MS |
101 | |
102 | $out .= " # TODO $TODO" if $TODO; | |
3d66076a | 103 | _print "$out\n"; |
7d932aad | 104 | |
69026470 | 105 | unless ($pass) { |
de522f7a | 106 | _diag "# Failed $where\n"; |
69026470 | 107 | } |
7d932aad MS |
108 | |
109 | # Ensure that the message is properly escaped. | |
cf8feb78 | 110 | _diag @mess; |
7d932aad | 111 | |
485f531e | 112 | $test = $test + 1; # don't use ++ |
1577bb16 MS |
113 | |
114 | return $pass; | |
69026470 JH |
115 | } |
116 | ||
117 | sub _where { | |
dcc7f481 | 118 | my @caller = caller($Level); |
69026470 JH |
119 | return "at $caller[1] line $caller[2]"; |
120 | } | |
121 | ||
1d662fb6 | 122 | # DON'T use this for matches. Use like() instead. |
c3029c66 | 123 | sub ok ($@) { |
7d932aad MS |
124 | my ($pass, $name, @mess) = @_; |
125 | _ok($pass, _where(), $name, @mess); | |
69026470 JH |
126 | } |
127 | ||
b3c72391 JH |
128 | sub _q { |
129 | my $x = shift; | |
130 | return 'undef' unless defined $x; | |
131 | my $q = $x; | |
d279d8f8 NC |
132 | $q =~ s/\\/\\\\/g; |
133 | $q =~ s/'/\\'/g; | |
b3c72391 JH |
134 | return "'$q'"; |
135 | } | |
136 | ||
677fb045 NC |
137 | sub _qq { |
138 | my $x = shift; | |
139 | return defined $x ? '"' . display ($x) . '"' : 'undef'; | |
140 | }; | |
141 | ||
142 | # keys are the codes \n etc map to, values are 2 char strings such as \n | |
143 | my %backslash_escape; | |
144 | foreach my $x (split //, 'nrtfa\\\'"') { | |
145 | $backslash_escape{ord eval "\"\\$x\""} = "\\$x"; | |
146 | } | |
147 | # A way to display scalars containing control characters and Unicode. | |
148 | # Trying to avoid setting $_, or relying on local $_ to work. | |
149 | sub display { | |
150 | my @result; | |
151 | foreach my $x (@_) { | |
152 | if (defined $x and not ref $x) { | |
153 | my $y = ''; | |
154 | foreach my $c (unpack("U*", $x)) { | |
155 | if ($c > 255) { | |
156 | $y .= sprintf "\\x{%x}", $c; | |
157 | } elsif ($backslash_escape{$c}) { | |
158 | $y .= $backslash_escape{$c}; | |
159 | } else { | |
160 | my $z = chr $c; # Maybe we can get away with a literal... | |
161 | $z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/; | |
162 | $y .= $z; | |
163 | } | |
164 | } | |
165 | $x = $y; | |
166 | } | |
167 | return $x unless wantarray; | |
168 | push @result, $x; | |
169 | } | |
170 | return @result; | |
171 | } | |
172 | ||
c3029c66 | 173 | sub is ($$@) { |
7d932aad | 174 | my ($got, $expected, $name, @mess) = @_; |
c831d34f MS |
175 | |
176 | my $pass; | |
177 | if( !defined $got || !defined $expected ) { | |
178 | # undef only matches undef | |
179 | $pass = !defined $got && !defined $expected; | |
180 | } | |
181 | else { | |
182 | $pass = $got eq $expected; | |
183 | } | |
184 | ||
69026470 | 185 | unless ($pass) { |
b3c72391 JH |
186 | unshift(@mess, "# got "._q($got)."\n", |
187 | "# expected "._q($expected)."\n"); | |
69026470 | 188 | } |
7d932aad | 189 | _ok($pass, _where(), $name, @mess); |
69026470 JH |
190 | } |
191 | ||
c3029c66 | 192 | sub isnt ($$@) { |
3e90d5a3 | 193 | my ($got, $isnt, $name, @mess) = @_; |
c831d34f MS |
194 | |
195 | my $pass; | |
196 | if( !defined $got || !defined $isnt ) { | |
197 | # undef only matches undef | |
198 | $pass = defined $got || defined $isnt; | |
199 | } | |
200 | else { | |
201 | $pass = $got ne $isnt; | |
202 | } | |
203 | ||
3e90d5a3 | 204 | unless( $pass ) { |
b3c72391 | 205 | unshift(@mess, "# it should not be "._q($got)."\n", |
3e90d5a3 MS |
206 | "# but it is.\n"); |
207 | } | |
208 | _ok($pass, _where(), $name, @mess); | |
209 | } | |
210 | ||
c3029c66 | 211 | sub cmp_ok ($$$@) { |
58d76dfd JH |
212 | my($got, $type, $expected, $name, @mess) = @_; |
213 | ||
214 | my $pass; | |
215 | { | |
216 | local $^W = 0; | |
217 | local($@,$!); # don't interfere with $@ | |
218 | # eval() sometimes resets $! | |
219 | $pass = eval "\$got $type \$expected"; | |
220 | } | |
221 | unless ($pass) { | |
222 | # It seems Irix long doubles can have 2147483648 and 2147483648 | |
223 | # that stringify to the same thing but are acutally numerically | |
224 | # different. Display the numbers if $type isn't a string operator, | |
225 | # and the numbers are stringwise the same. | |
226 | # (all string operators have alphabetic names, so tr/a-z// is true) | |
227 | # This will also show numbers for some uneeded cases, but will | |
228 | # definately be helpful for things such as == and <= that fail | |
229 | if ($got eq $expected and $type !~ tr/a-z//) { | |
230 | unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n"; | |
231 | } | |
232 | unshift(@mess, "# got "._q($got)."\n", | |
233 | "# expected $type "._q($expected)."\n"); | |
234 | } | |
235 | _ok($pass, _where(), $name, @mess); | |
236 | } | |
237 | ||
238 | # Check that $got is within $range of $expected | |
239 | # if $range is 0, then check it's exact | |
240 | # else if $expected is 0, then $range is an absolute value | |
241 | # otherwise $range is a fractional error. | |
242 | # Here $range must be numeric, >= 0 | |
243 | # Non numeric ranges might be a useful future extension. (eg %) | |
c3029c66 | 244 | sub within ($$$@) { |
58d76dfd JH |
245 | my ($got, $expected, $range, $name, @mess) = @_; |
246 | my $pass; | |
247 | if (!defined $got or !defined $expected or !defined $range) { | |
248 | # This is a fail, but doesn't need extra diagnostics | |
249 | } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) { | |
250 | # This is a fail | |
251 | unshift @mess, "# got, expected and range must be numeric\n"; | |
252 | } elsif ($range < 0) { | |
253 | # This is also a fail | |
254 | unshift @mess, "# range must not be negative\n"; | |
255 | } elsif ($range == 0) { | |
256 | # Within 0 is == | |
257 | $pass = $got == $expected; | |
258 | } elsif ($expected == 0) { | |
259 | # If expected is 0, treat range as absolute | |
260 | $pass = ($got <= $range) && ($got >= - $range); | |
261 | } else { | |
262 | my $diff = $got - $expected; | |
263 | $pass = abs ($diff / $expected) < $range; | |
264 | } | |
265 | unless ($pass) { | |
266 | if ($got eq $expected) { | |
267 | unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n"; | |
268 | } | |
269 | unshift@mess, "# got "._q($got)."\n", | |
270 | "# expected "._q($expected)." (within "._q($range).")\n"; | |
271 | } | |
272 | _ok($pass, _where(), $name, @mess); | |
273 | } | |
274 | ||
69026470 | 275 | # Note: this isn't quite as fancy as Test::More::like(). |
724aa791 JC |
276 | |
277 | sub like ($$@) { like_yn (0,@_) }; # 0 for - | |
278 | sub unlike ($$@) { like_yn (1,@_) }; # 1 for un- | |
279 | ||
280 | sub like_yn ($$$@) { | |
281 | my ($flip, $got, $expected, $name, @mess) = @_; | |
69026470 | 282 | my $pass; |
724aa791 JC |
283 | $pass = $got =~ /$expected/ if !$flip; |
284 | $pass = $got !~ /$expected/ if $flip; | |
285 | unless ($pass) { | |
286 | unshift(@mess, "# got '$got'\n", | |
5a4a8c8b NC |
287 | $flip |
288 | ? "# expected !~ /$expected/\n" : "# expected /$expected/\n"); | |
69026470 | 289 | } |
5693d826 | 290 | local $Level = $Level + 1; |
7d932aad | 291 | _ok($pass, _where(), $name, @mess); |
69026470 JH |
292 | } |
293 | ||
294 | sub pass { | |
295 | _ok(1, '', @_); | |
296 | } | |
297 | ||
298 | sub fail { | |
299 | _ok(0, _where(), @_); | |
300 | } | |
301 | ||
ad20d923 | 302 | sub curr_test { |
cf8feb78 | 303 | $test = shift if @_; |
ad20d923 MS |
304 | return $test; |
305 | } | |
306 | ||
3e90d5a3 | 307 | sub next_test { |
178eff92 | 308 | my $retval = $test; |
485f531e | 309 | $test = $test + 1; # don't use ++ |
178eff92 | 310 | $retval; |
3e90d5a3 MS |
311 | } |
312 | ||
69026470 JH |
313 | # Note: can't pass multipart messages since we try to |
314 | # be compatible with Test::More::skip(). | |
315 | sub skip { | |
7d932aad | 316 | my $why = shift; |
982b7cb7 | 317 | my $n = @_ ? shift : 1; |
69026470 | 318 | for (1..$n) { |
3d66076a | 319 | _print "ok $test # skip: $why\n"; |
485f531e | 320 | $test = $test + 1; |
69026470 JH |
321 | } |
322 | local $^W = 0; | |
323 | last SKIP; | |
324 | } | |
325 | ||
09f04786 MS |
326 | sub todo_skip { |
327 | my $why = shift; | |
328 | my $n = @_ ? shift : 1; | |
329 | ||
330 | for (1..$n) { | |
3d66076a | 331 | _print "not ok $test # TODO & SKIP: $why\n"; |
485f531e | 332 | $test = $test + 1; |
09f04786 MS |
333 | } |
334 | local $^W = 0; | |
335 | last TODO; | |
336 | } | |
337 | ||
69026470 JH |
338 | sub eq_array { |
339 | my ($ra, $rb) = @_; | |
340 | return 0 unless $#$ra == $#$rb; | |
341 | for my $i (0..$#$ra) { | |
8210c8d3 | 342 | next if !defined $ra->[$i] && !defined $rb->[$i]; |
135d199b DM |
343 | return 0 if !defined $ra->[$i]; |
344 | return 0 if !defined $rb->[$i]; | |
69026470 JH |
345 | return 0 unless $ra->[$i] eq $rb->[$i]; |
346 | } | |
347 | return 1; | |
348 | } | |
349 | ||
677fb045 NC |
350 | sub eq_hash { |
351 | my ($orig, $suspect) = @_; | |
352 | my $fail; | |
353 | while (my ($key, $value) = each %$suspect) { | |
354 | # Force a hash recompute if this perl's internals can cache the hash key. | |
355 | $key = "" . $key; | |
356 | if (exists $orig->{$key}) { | |
357 | if ($orig->{$key} ne $value) { | |
3d66076a | 358 | _print "# key ", _qq($key), " was ", _qq($orig->{$key}), |
de522f7a | 359 | " now ", _qq($value), "\n"; |
677fb045 NC |
360 | $fail = 1; |
361 | } | |
362 | } else { | |
3d66076a | 363 | _print "# key ", _qq($key), " is ", _qq($value), |
75385f53 | 364 | ", not in original.\n"; |
677fb045 NC |
365 | $fail = 1; |
366 | } | |
367 | } | |
368 | foreach (keys %$orig) { | |
369 | # Force a hash recompute if this perl's internals can cache the hash key. | |
370 | $_ = "" . $_; | |
371 | next if (exists $suspect->{$_}); | |
3d66076a | 372 | _print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n"; |
677fb045 NC |
373 | $fail = 1; |
374 | } | |
375 | !$fail; | |
376 | } | |
377 | ||
c3029c66 | 378 | sub require_ok ($) { |
69026470 JH |
379 | my ($require) = @_; |
380 | eval <<REQUIRE_OK; | |
381 | require $require; | |
382 | REQUIRE_OK | |
1577bb16 | 383 | _ok(!$@, _where(), "require $require"); |
69026470 JH |
384 | } |
385 | ||
c3029c66 | 386 | sub use_ok ($) { |
69026470 JH |
387 | my ($use) = @_; |
388 | eval <<USE_OK; | |
389 | use $use; | |
390 | USE_OK | |
1577bb16 | 391 | _ok(!$@, _where(), "use $use"); |
69026470 JH |
392 | } |
393 | ||
137352a2 RGS |
394 | # runperl - Runs a separate perl interpreter. |
395 | # Arguments : | |
396 | # switches => [ command-line switches ] | |
397 | # nolib => 1 # don't use -I../lib (included by default) | |
398 | # prog => one-liner (avoid quotes) | |
d83945bc | 399 | # progs => [ multi-liner (avoid quotes) ] |
137352a2 RGS |
400 | # progfile => perl script |
401 | # stdin => string to feed the stdin | |
402 | # stderr => redirect stderr to stdout | |
403 | # args => [ command-line arguments to the perl program ] | |
cb9c5e20 | 404 | # verbose => print the command line |
137352a2 RGS |
405 | |
406 | my $is_mswin = $^O eq 'MSWin32'; | |
407 | my $is_netware = $^O eq 'NetWare'; | |
408 | my $is_macos = $^O eq 'MacOS'; | |
409 | my $is_vms = $^O eq 'VMS'; | |
e67ed694 | 410 | my $is_cygwin = $^O eq 'cygwin'; |
137352a2 | 411 | |
cb9c5e20 JH |
412 | sub _quote_args { |
413 | my ($runperl, $args) = @_; | |
414 | ||
415 | foreach (@$args) { | |
416 | # In VMS protect with doublequotes because otherwise | |
417 | # DCL will lowercase -- unless already doublequoted. | |
ea9ac5ad | 418 | $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0; |
cb9c5e20 JH |
419 | $$runperl .= ' ' . $_; |
420 | } | |
421 | } | |
422 | ||
4cd2bd1f | 423 | sub _create_runperl { # Create the string to qx in runperl(). |
137352a2 | 424 | my %args = @_; |
5fe9b82b JH |
425 | my $runperl = which_perl(); |
426 | if ($runperl =~ m/\s/) { | |
427 | $runperl = qq{"$runperl"}; | |
428 | } | |
6cf707aa RGS |
429 | #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind |
430 | if ($ENV{PERL_RUNPERL_DEBUG}) { | |
431 | $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl"; | |
432 | } | |
f93a5f07 JH |
433 | unless ($args{nolib}) { |
434 | if ($is_macos) { | |
cb9c5e20 | 435 | $runperl .= ' -I::lib'; |
f93a5f07 | 436 | # Use UNIX style error messages instead of MPW style. |
cb9c5e20 | 437 | $runperl .= ' -MMac::err=unix' if $args{stderr}; |
137352a2 RGS |
438 | } |
439 | else { | |
cb9c5e20 | 440 | $runperl .= ' "-I../lib"'; # doublequotes because of VMS |
137352a2 RGS |
441 | } |
442 | } | |
d83945bc | 443 | if ($args{switches}) { |
343d4a7b JH |
444 | local $Level = 2; |
445 | die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where() | |
446 | unless ref $args{switches} eq "ARRAY"; | |
d83945bc A |
447 | _quote_args(\$runperl, $args{switches}); |
448 | } | |
137352a2 | 449 | if (defined $args{prog}) { |
21820af6 JH |
450 | die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where() |
451 | if defined $args{progs}; | |
d83945bc A |
452 | $args{progs} = [$args{prog}] |
453 | } | |
454 | if (defined $args{progs}) { | |
21820af6 JH |
455 | die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where() |
456 | unless ref $args{progs} eq "ARRAY"; | |
d83945bc A |
457 | foreach my $prog (@{$args{progs}}) { |
458 | if ($is_mswin || $is_netware || $is_vms) { | |
459 | $runperl .= qq ( -e "$prog" ); | |
460 | } | |
461 | else { | |
462 | $runperl .= qq ( -e '$prog' ); | |
463 | } | |
464 | } | |
137352a2 RGS |
465 | } elsif (defined $args{progfile}) { |
466 | $runperl .= qq( "$args{progfile}"); | |
9a731dbd NC |
467 | } else { |
468 | # You probaby didn't want to be sucking in from the upstream stdin | |
469 | die "test.pl:runperl(): none of prog, progs, progfile, args, " | |
470 | . " switches or stdin specified" | |
471 | unless defined $args{args} or defined $args{switches} | |
472 | or defined $args{stdin}; | |
137352a2 RGS |
473 | } |
474 | if (defined $args{stdin}) { | |
dc459aad JH |
475 | # so we don't try to put literal newlines and crs onto the |
476 | # command line. | |
477 | $args{stdin} =~ s/\n/\\n/g; | |
478 | $args{stdin} =~ s/\r/\\r/g; | |
5ae09a77 | 479 | |
137352a2 | 480 | if ($is_mswin || $is_netware || $is_vms) { |
5fe9b82b | 481 | $runperl = qq{$Perl -e "print qq(} . |
137352a2 RGS |
482 | $args{stdin} . q{)" | } . $runperl; |
483 | } | |
dc459aad JH |
484 | elsif ($is_macos) { |
485 | # MacOS can only do two processes under MPW at once; | |
486 | # the test itself is one; we can't do two more, so | |
487 | # write to temp file | |
5fe9b82b | 488 | my $stdin = qq{$Perl -e 'print qq(} . $args{stdin} . qq{)' > teststdin; }; |
dc459aad JH |
489 | if ($args{verbose}) { |
490 | my $stdindisplay = $stdin; | |
491 | $stdindisplay =~ s/\n/\n\#/g; | |
3d66076a | 492 | _print_stderr "# $stdindisplay\n"; |
dc459aad JH |
493 | } |
494 | `$stdin`; | |
495 | $runperl .= q{ < teststdin }; | |
496 | } | |
137352a2 | 497 | else { |
5fe9b82b | 498 | $runperl = qq{$Perl -e 'print qq(} . |
137352a2 RGS |
499 | $args{stdin} . q{)' | } . $runperl; |
500 | } | |
501 | } | |
502 | if (defined $args{args}) { | |
cb9c5e20 JH |
503 | _quote_args(\$runperl, $args{args}); |
504 | } | |
505 | $runperl .= ' 2>&1' if $args{stderr} && !$is_macos; | |
506 | $runperl .= " \xB3 Dev:Null" if !$args{stderr} && $is_macos; | |
507 | if ($args{verbose}) { | |
508 | my $runperldisplay = $runperl; | |
509 | $runperldisplay =~ s/\n/\n\#/g; | |
3d66076a | 510 | _print_stderr "# $runperldisplay\n"; |
137352a2 | 511 | } |
4cd2bd1f JH |
512 | return $runperl; |
513 | } | |
514 | ||
515 | sub runperl { | |
9a731dbd NC |
516 | die "test.pl:runperl() does not take a hashref" |
517 | if ref $_[0] and ref $_[0] eq 'HASH'; | |
4cd2bd1f | 518 | my $runperl = &_create_runperl; |
613de57f NC |
519 | my $result; |
520 | ||
8210c8d3 MB |
521 | my $tainted = ${^TAINT}; |
522 | my %args = @_; | |
485f531e | 523 | exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1; |
8210c8d3 MB |
524 | |
525 | if ($tainted) { | |
613de57f NC |
526 | # We will assume that if you're running under -T, you really mean to |
527 | # run a fresh perl, so we'll brute force launder everything for you | |
528 | my $sep; | |
529 | ||
530 | eval "require Config; Config->import"; | |
531 | if ($@) { | |
532 | warn "test.pl had problems loading Config: $@"; | |
533 | $sep = ':'; | |
534 | } else { | |
535 | $sep = $Config{path_sep}; | |
a70a1627 | 536 | } |
613de57f NC |
537 | |
538 | my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV); | |
539 | local @ENV{@keys} = (); | |
540 | # Untaint, plus take out . and empty string: | |
326b5008 | 541 | local $ENV{'DCL$PATH'} = $1 if $is_vms && ($ENV{'DCL$PATH'} =~ /(.*)/s); |
613de57f | 542 | $ENV{PATH} =~ /(.*)/s; |
8210c8d3 | 543 | local $ENV{PATH} = |
3b6d8381 | 544 | join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and |
326b5008 | 545 | ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) } |
8210c8d3 | 546 | split quotemeta ($sep), $1; |
e67ed694 | 547 | $ENV{PATH} .= "$sep/bin" if $is_cygwin; # Must have /bin under Cygwin |
613de57f NC |
548 | |
549 | $runperl =~ /(.*)/s; | |
550 | $runperl = $1; | |
551 | ||
552 | $result = `$runperl`; | |
553 | } else { | |
554 | $result = `$runperl`; | |
a70a1627 | 555 | } |
137352a2 RGS |
556 | $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these |
557 | return $result; | |
558 | } | |
559 | ||
d2c6a9c9 | 560 | *run_perl = \&runperl; # Nice alias. |
8799135f | 561 | |
c4fbe247 | 562 | sub DIE { |
3d66076a | 563 | _print_stderr "# @_\n"; |
c4fbe247 | 564 | exit 1; |
8799135f MS |
565 | } |
566 | ||
b5fe401b | 567 | # A somewhat safer version of the sometimes wrong $^X. |
17a740d5 JH |
568 | sub which_perl { |
569 | unless (defined $Perl) { | |
570 | $Perl = $^X; | |
8210c8d3 | 571 | |
73421c4a CB |
572 | # VMS should have 'perl' aliased properly |
573 | return $Perl if $^O eq 'VMS'; | |
574 | ||
17a740d5 JH |
575 | my $exe; |
576 | eval "require Config; Config->import"; | |
85363d30 | 577 | if ($@) { |
17a740d5 JH |
578 | warn "test.pl had problems loading Config: $@"; |
579 | $exe = ''; | |
85363d30 | 580 | } else { |
17a740d5 | 581 | $exe = $Config{_exe}; |
85363d30 | 582 | } |
da405c16 | 583 | $exe = '' unless defined $exe; |
8210c8d3 | 584 | |
17a740d5 JH |
585 | # This doesn't absolutize the path: beware of future chdirs(). |
586 | # We could do File::Spec->abs2rel() but that does getcwd()s, | |
587 | # which is a bit heavyweight to do here. | |
8210c8d3 | 588 | |
17a740d5 | 589 | if ($Perl =~ /^perl\Q$exe\E$/i) { |
8db06b02 | 590 | my $perl = "perl$exe"; |
17a740d5 JH |
591 | eval "require File::Spec"; |
592 | if ($@) { | |
593 | warn "test.pl had problems loading File::Spec: $@"; | |
8db06b02 | 594 | $Perl = "./$perl"; |
17a740d5 | 595 | } else { |
8db06b02 | 596 | $Perl = File::Spec->catfile(File::Spec->curdir(), $perl); |
17a740d5 JH |
597 | } |
598 | } | |
196918b0 PG |
599 | |
600 | # Build up the name of the executable file from the name of | |
601 | # the command. | |
602 | ||
603 | if ($Perl !~ /\Q$exe\E$/i) { | |
604 | $Perl .= $exe; | |
605 | } | |
c880be78 | 606 | |
8db06b02 | 607 | warn "which_perl: cannot find $Perl from $^X" unless -f $Perl; |
8210c8d3 | 608 | |
17a740d5 JH |
609 | # For subcommands to use. |
610 | $ENV{PERLEXE} = $Perl; | |
85363d30 | 611 | } |
17a740d5 | 612 | return $Perl; |
b5fe401b MS |
613 | } |
614 | ||
435e7af6 NC |
615 | sub unlink_all { |
616 | foreach my $file (@_) { | |
617 | 1 while unlink $file; | |
3d66076a | 618 | _print_stderr "# Couldn't unlink '$file': $!\n" if -f $file; |
435e7af6 NC |
619 | } |
620 | } | |
eeabcb2d MS |
621 | |
622 | ||
623 | my $tmpfile = "misctmp000"; | |
624 | 1 while -f ++$tmpfile; | |
625 | END { unlink_all $tmpfile } | |
626 | ||
f5cda331 JH |
627 | # |
628 | # _fresh_perl | |
629 | # | |
630 | # The $resolve must be a subref that tests the first argument | |
631 | # for success, or returns the definition of success (e.g. the | |
632 | # expected scalar) if given no arguments. | |
633 | # | |
634 | ||
635 | sub _fresh_perl { | |
636 | my($prog, $resolve, $runperl_args, $name) = @_; | |
eeabcb2d MS |
637 | |
638 | $runperl_args ||= {}; | |
639 | $runperl_args->{progfile} = $tmpfile; | |
640 | $runperl_args->{stderr} = 1; | |
641 | ||
642 | open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!"; | |
643 | ||
644 | # VMS adjustments | |
645 | if( $^O eq 'VMS' ) { | |
646 | $prog =~ s#/dev/null#NL:#; | |
647 | ||
8210c8d3 | 648 | # VMS file locking |
eeabcb2d MS |
649 | $prog =~ s{if \(-e _ and -f _ and -r _\)} |
650 | {if (-e _ and -f _)} | |
651 | } | |
652 | ||
0d65d7d5 | 653 | print TEST $prog; |
eeabcb2d MS |
654 | close TEST or die "Cannot close $tmpfile: $!"; |
655 | ||
656 | my $results = runperl(%$runperl_args); | |
657 | my $status = $?; | |
658 | ||
659 | # Clean up the results into something a bit more predictable. | |
660 | $results =~ s/\n+$//; | |
661 | $results =~ s/at\s+misctmp\d+\s+line/at - line/g; | |
662 | $results =~ s/of\s+misctmp\d+\s+aborted/of - aborted/g; | |
663 | ||
664 | # bison says 'parse error' instead of 'syntax error', | |
665 | # various yaccs may or may not capitalize 'syntax'. | |
666 | $results =~ s/^(syntax|parse) error/syntax error/mig; | |
667 | ||
668 | if ($^O eq 'VMS') { | |
669 | # some tests will trigger VMS messages that won't be expected | |
670 | $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//; | |
671 | ||
672 | # pipes double these sometimes | |
673 | $results =~ s/\n\n/\n/g; | |
674 | } | |
675 | ||
f5cda331 | 676 | my $pass = $resolve->($results); |
eeabcb2d | 677 | unless ($pass) { |
cf8feb78 MJD |
678 | _diag "# PROG: \n$prog\n"; |
679 | _diag "# EXPECTED:\n", $resolve->(), "\n"; | |
680 | _diag "# GOT:\n$results\n"; | |
681 | _diag "# STATUS: $status\n"; | |
eeabcb2d MS |
682 | } |
683 | ||
e2c38acd JH |
684 | # Use the first line of the program as a name if none was given |
685 | unless( $name ) { | |
686 | ($first_line, $name) = $prog =~ /^((.{1,50}).*)/; | |
687 | $name .= '...' if length $first_line > length $name; | |
688 | } | |
eeabcb2d | 689 | |
f5cda331 JH |
690 | _ok($pass, _where(), "fresh_perl - $name"); |
691 | } | |
692 | ||
693 | # | |
141f445b | 694 | # fresh_perl_is |
f5cda331 JH |
695 | # |
696 | # Combination of run_perl() and is(). | |
697 | # | |
698 | ||
699 | sub fresh_perl_is { | |
700 | my($prog, $expected, $runperl_args, $name) = @_; | |
dcc7f481 | 701 | local $Level = 2; |
f5cda331 JH |
702 | _fresh_perl($prog, |
703 | sub { @_ ? $_[0] eq $expected : $expected }, | |
704 | $runperl_args, $name); | |
705 | } | |
706 | ||
707 | # | |
141f445b | 708 | # fresh_perl_like |
f5cda331 JH |
709 | # |
710 | # Combination of run_perl() and like(). | |
711 | # | |
712 | ||
713 | sub fresh_perl_like { | |
714 | my($prog, $expected, $runperl_args, $name) = @_; | |
dcc7f481 | 715 | local $Level = 2; |
f5cda331 JH |
716 | _fresh_perl($prog, |
717 | sub { @_ ? | |
718 | $_[0] =~ (ref $expected ? $expected : /$expected/) : | |
719 | $expected }, | |
720 | $runperl_args, $name); | |
eeabcb2d MS |
721 | } |
722 | ||
35a60386 RGS |
723 | sub can_ok ($@) { |
724 | my($proto, @methods) = @_; | |
725 | my $class = ref $proto || $proto; | |
726 | ||
727 | unless( @methods ) { | |
728 | return _ok( 0, _where(), "$class->can(...)" ); | |
729 | } | |
730 | ||
731 | my @nok = (); | |
732 | foreach my $method (@methods) { | |
733 | local($!, $@); # don't interfere with caller's $@ | |
734 | # eval sometimes resets $! | |
735 | eval { $proto->can($method) } || push @nok, $method; | |
736 | } | |
737 | ||
738 | my $name; | |
8210c8d3 | 739 | $name = @methods == 1 ? "$class->can('$methods[0]')" |
35a60386 | 740 | : "$class->can(...)"; |
8210c8d3 | 741 | |
35a60386 RGS |
742 | _ok( !@nok, _where(), $name ); |
743 | } | |
744 | ||
745 | sub isa_ok ($$;$) { | |
746 | my($object, $class, $obj_name) = @_; | |
747 | ||
748 | my $diag; | |
749 | $obj_name = 'The object' unless defined $obj_name; | |
750 | my $name = "$obj_name isa $class"; | |
751 | if( !defined $object ) { | |
752 | $diag = "$obj_name isn't defined"; | |
753 | } | |
754 | elsif( !ref $object ) { | |
755 | $diag = "$obj_name isn't a reference"; | |
756 | } | |
757 | else { | |
758 | # We can't use UNIVERSAL::isa because we want to honor isa() overrides | |
759 | local($@, $!); # eval sometimes resets $! | |
760 | my $rslt = eval { $object->isa($class) }; | |
761 | if( $@ ) { | |
762 | if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) { | |
763 | if( !UNIVERSAL::isa($object, $class) ) { | |
764 | my $ref = ref $object; | |
765 | $diag = "$obj_name isn't a '$class' it's a '$ref'"; | |
766 | } | |
767 | } else { | |
768 | die <<WHOA; | |
769 | WHOA! I tried to call ->isa on your object and got some weird error. | |
770 | This should never happen. Please contact the author immediately. | |
771 | Here's the error. | |
772 | $@ | |
773 | WHOA | |
774 | } | |
775 | } | |
776 | elsif( !$rslt ) { | |
777 | my $ref = ref $object; | |
778 | $diag = "$obj_name isn't a '$class' it's a '$ref'"; | |
779 | } | |
780 | } | |
781 | ||
782 | _ok( !$diag, _where(), $name ); | |
783 | } | |
784 | ||
087986a7 | 785 | # Set a watchdog to timeout the entire test file |
5fe9b82b JH |
786 | # NOTE: If the test file uses 'threads', then call the watchdog() function |
787 | # _AFTER_ the 'threads' module is loaded. | |
087986a7 JH |
788 | sub watchdog ($) |
789 | { | |
790 | my $timeout = shift; | |
791 | my $timeout_msg = 'Test process timed out - terminating'; | |
792 | ||
793 | my $pid_to_kill = $$; # PID for this process | |
794 | ||
5fe9b82b JH |
795 | # Don't use a watchdog process if 'threads' is loaded - |
796 | # use a watchdog thread instead | |
797 | if (! $threads::threads) { | |
798 | ||
799 | # On Windows and VMS, try launching a watchdog process | |
800 | # using system(1, ...) (see perlport.pod) | |
801 | if (($^O eq 'MSWin32') || ($^O eq 'VMS')) { | |
802 | # On Windows, try to get the 'real' PID | |
803 | if ($^O eq 'MSWin32') { | |
804 | eval { require Win32; }; | |
805 | if (defined(&Win32::GetCurrentProcessId)) { | |
806 | $pid_to_kill = Win32::GetCurrentProcessId(); | |
807 | } | |
087986a7 | 808 | } |
087986a7 | 809 | |
5fe9b82b JH |
810 | # If we still have a fake PID, we can't use this method at all |
811 | return if ($pid_to_kill <= 0); | |
812 | ||
813 | # Launch watchdog process | |
814 | my $watchdog; | |
815 | eval { | |
816 | local $SIG{'__WARN__'} = sub { | |
817 | _diag("Watchdog warning: $_[0]"); | |
818 | }; | |
819 | $watchdog = system(1, which_perl(), '-e', | |
820 | "sleep($timeout);" . | |
821 | "kill('KILL', $pid_to_kill);"); | |
822 | }; | |
823 | if ($@ || ($watchdog <= 0)) { | |
824 | _diag('Failed to start watchdog'); | |
825 | _diag($@) if $@; | |
826 | undef($watchdog); | |
827 | return; | |
828 | } | |
087986a7 | 829 | |
5fe9b82b JH |
830 | # Add END block to parent to terminate and |
831 | # clean up watchdog process | |
832 | eval "END { local \$!; local \$?; | |
833 | wait() if kill('KILL', $watchdog); }"; | |
834 | return; | |
087986a7 | 835 | } |
087986a7 | 836 | |
5fe9b82b JH |
837 | # Try using fork() to generate a watchdog process |
838 | my $watchdog; | |
839 | eval { $watchdog = fork() }; | |
840 | if (defined($watchdog)) { | |
841 | if ($watchdog) { # Parent process | |
842 | # Add END block to parent to terminate and | |
843 | # clean up watchdog process | |
844 | eval "END { local \$!; local \$?; | |
845 | wait() if kill('KILL', $watchdog); }"; | |
846 | return; | |
847 | } | |
848 | ||
849 | ### Watchdog process code | |
087986a7 | 850 | |
5fe9b82b JH |
851 | # Load POSIX if available |
852 | eval { require POSIX; }; | |
087986a7 | 853 | |
5fe9b82b JH |
854 | # Execute the timeout |
855 | sleep($timeout - 2) if ($timeout > 2); # Workaround for perlbug #49073 | |
856 | sleep(2); | |
087986a7 | 857 | |
5fe9b82b JH |
858 | # Kill test process if still running |
859 | if (kill(0, $pid_to_kill)) { | |
860 | _diag($timeout_msg); | |
861 | kill('KILL', $pid_to_kill); | |
862 | } | |
087986a7 | 863 | |
5fe9b82b JH |
864 | # Don't execute END block (added at beginning of this file) |
865 | $NO_ENDING = 1; | |
087986a7 | 866 | |
5fe9b82b JH |
867 | # Terminate ourself (i.e., the watchdog) |
868 | POSIX::_exit(1) if (defined(&POSIX::_exit)); | |
869 | exit(1); | |
087986a7 JH |
870 | } |
871 | ||
5fe9b82b | 872 | # fork() failed - fall through and try using a thread |
087986a7 JH |
873 | } |
874 | ||
5fe9b82b JH |
875 | # Use a watchdog thread because either 'threads' is loaded, |
876 | # or fork() failed | |
087986a7 JH |
877 | if (eval { require threads; }) { |
878 | threads->create(sub { | |
879 | # Load POSIX if available | |
880 | eval { require POSIX; }; | |
881 | ||
882 | # Execute the timeout | |
883 | sleep($timeout); | |
884 | ||
885 | # Kill the parent (and ourself) | |
5fe9b82b | 886 | select(STDERR); $| = 1; |
087986a7 JH |
887 | _diag($timeout_msg); |
888 | POSIX::_exit(1) if (defined(&POSIX::_exit)); | |
889 | kill('KILL', $pid_to_kill); | |
890 | })->detach(); | |
891 | return; | |
892 | } | |
893 | ||
5fe9b82b | 894 | # If everything above fails, then just use an alarm timeout |
087986a7 JH |
895 | if (eval { alarm($timeout); 1; }) { |
896 | # Load POSIX if available | |
897 | eval { require POSIX; }; | |
898 | ||
899 | # Alarm handler will do the actual 'killing' | |
900 | $SIG{'ALRM'} = sub { | |
5fe9b82b | 901 | select(STDERR); $| = 1; |
087986a7 JH |
902 | _diag($timeout_msg); |
903 | POSIX::_exit(1) if (defined(&POSIX::_exit)); | |
904 | kill('KILL', $pid_to_kill); | |
905 | }; | |
906 | } | |
907 | } | |
908 | ||
69026470 | 909 | 1; |