Commit | Line | Data |
d667a7e6 |
1 | # -*- Mode: cperl; cperl-indent-level: 4 -*- |
a0d0e21e |
2 | package Test::Harness; |
3 | |
17f410f9 |
4 | use 5.005_64; |
a0d0e21e |
5 | use Exporter; |
6 | use Benchmark; |
4633a7c4 |
7 | use Config; |
760ac839 |
8 | use strict; |
9 | |
9c5c68c8 |
10 | our($VERSION, $Verbose, $Switches, $Have_Devel_Corestack, $Curtest, |
11 | $Columns, $verbose, $switches, |
12 | @ISA, @EXPORT, @EXPORT_OK |
13 | ); |
4633a7c4 |
14 | |
9c5c68c8 |
15 | # Backwards compatibility for exportable variable names. |
16 | *verbose = \$Verbose; |
17 | *switches = \$Switches; |
18 | |
19 | $Have_Devel_Corestack = 0; |
20 | |
21 | $VERSION = "1.1702"; |
9b0ceca9 |
22 | |
f19ae7a7 |
23 | $ENV{HARNESS_ACTIVE} = 1; |
24 | |
9b0ceca9 |
25 | # Some experimental versions of OS/2 build have broken $? |
9c5c68c8 |
26 | my $Ignore_Exitcode = $ENV{HARNESS_IGNORE_EXITCODE}; |
27 | |
28 | my $Files_In_Dir = $ENV{HARNESS_FILELEAK_IN_DIR}; |
9b0ceca9 |
29 | |
17a79f5b |
30 | |
9c5c68c8 |
31 | @ISA = ('Exporter'); |
32 | @EXPORT = qw(&runtests); |
33 | @EXPORT_OK = qw($verbose $switches); |
4633a7c4 |
34 | |
9c5c68c8 |
35 | $Verbose = 0; |
36 | $Switches = "-w"; |
37 | $Columns = $ENV{HARNESS_COLUMNS} || $ENV{COLUMNS} || 80; |
a0d0e21e |
38 | |
a0d0e21e |
39 | |
17a79f5b |
40 | sub globdir { opendir DIRH, shift; my @f = readdir DIRH; closedir DIRH; @f } |
41 | |
a0d0e21e |
42 | sub runtests { |
43 | my(@tests) = @_; |
9c5c68c8 |
44 | |
45 | my($tot, $failedtests) = _runtests(@tests); |
46 | _show_results($tot, $failedtests); |
47 | |
48 | return ($tot->{bad} == 0 && $tot->{max}) ; |
49 | } |
50 | |
51 | |
52 | sub _runtests { |
53 | my(@tests) = @_; |
a0d0e21e |
54 | local($|) = 1; |
9c5c68c8 |
55 | my(%failedtests); |
56 | |
57 | # Test-wide totals. |
58 | my(%tot) = ( |
59 | bonus => 0, |
60 | max => 0, |
61 | ok => 0, |
62 | files => 0, |
63 | bad => 0, |
64 | good => 0, |
65 | tests => scalar @tests, |
66 | sub_skipped => 0, |
67 | skipped => 0, |
68 | bench => 0 |
69 | ); |
774d564b |
70 | |
71 | # pass -I flags to children |
81ff29e3 |
72 | my $old5lib = $ENV{PERL5LIB}; |
774d564b |
73 | |
1250aba5 |
74 | # VMS has a 255-byte limit on the length of %ENV entries, so |
75 | # toss the ones that involve perl_root, the install location |
76 | # for VMS |
77 | my $new5lib; |
78 | if ($^O eq 'VMS') { |
79 | $new5lib = join($Config{path_sep}, grep {!/perl_root/i;} @INC); |
9c5c68c8 |
80 | $Switches =~ s/-(\S*[A-Z]\S*)/"-$1"/g; |
1250aba5 |
81 | } |
82 | else { |
83 | $new5lib = join($Config{path_sep}, @INC); |
84 | } |
85 | |
86 | local($ENV{'PERL5LIB'}) = $new5lib; |
a0d0e21e |
87 | |
9c5c68c8 |
88 | my @dir_files = globdir $Files_In_Dir if defined $Files_In_Dir; |
a0d0e21e |
89 | my $t_start = new Benchmark; |
9c5c68c8 |
90 | |
91 | foreach my $test (@tests) { |
92 | my $te = $test; |
93 | chop($te); # XXX chomp? |
94 | |
fe6f1558 |
95 | if ($^O eq 'VMS') { $te =~ s/^.*\.t\./[.t./s; } |
45c0de28 |
96 | my $blank = (' ' x 77); |
0d0c0d42 |
97 | my $leader = "$te" . '.' x (20 - length($te)); |
98 | my $ml = ""; |
23c4718a |
99 | $ml = "\r$blank\r$leader" |
9c5c68c8 |
100 | if -t STDOUT and not $ENV{HARNESS_NOTTY} and not $Verbose; |
0d0c0d42 |
101 | print $leader; |
9c5c68c8 |
102 | |
103 | my $s = _set_switches($test); |
104 | |
9636a016 |
105 | my $cmd = ($ENV{'HARNESS_COMPILE_TEST'}) |
106 | ? "./perl -I../lib ../utils/perlcc $test " |
e4f0d88d |
107 | . "-r 2>> ./compilelog |" |
9636a016 |
108 | : "$^X $s $test|"; |
a5077310 |
109 | $cmd = "MCR $cmd" if $^O eq 'VMS'; |
9c5c68c8 |
110 | open(my $fh, $cmd) or print "can't run $test. $!\n"; |
111 | |
112 | # state of the current test. |
113 | my %test = ( |
114 | ok => 0, |
115 | next => 0, |
116 | max => 0, |
117 | failed => [], |
118 | todo => {}, |
119 | bonus => 0, |
120 | skipped => 0, |
121 | skip_reason => undef, |
122 | ml => $ml, |
123 | ); |
124 | |
125 | my($seen_header, $tests_seen) = (0,0); |
c07a80fd |
126 | while (<$fh>) { |
9c5c68c8 |
127 | if( _parse_header($_, \%test, \%tot) ) { |
128 | warn "Test header seen twice!\n" if $seen_header; |
129 | |
130 | $seen_header = 1; |
131 | |
132 | warn "1..M can only appear at the beginning or end of tests\n" |
133 | if $tests_seen && $test{max} < $tests_seen; |
134 | } |
135 | elsif( _parse_test_line($_, \%test, \%tot) ) { |
136 | $tests_seen++; |
d667a7e6 |
137 | } |
9c5c68c8 |
138 | # else, ignore it. |
c07a80fd |
139 | } |
9c5c68c8 |
140 | |
141 | my($estatus, $wstatus) = _close_fh($fh); |
142 | |
68dc0745 |
143 | if ($wstatus) { |
9c5c68c8 |
144 | $failedtests{$test} = _dubious_return(\%test, \%tot, |
145 | $estatus, $wstatus); |
66fd8cb9 |
146 | $failedtests{$test}{name} = $test; |
9c5c68c8 |
147 | } |
148 | elsif ($test{ok} == $test{max} && $test{next} == $test{max}+1) { |
149 | if ($test{max} and $test{skipped} + $test{bonus}) { |
7b13a3f5 |
150 | my @msg; |
9c5c68c8 |
151 | push(@msg, "$test{skipped}/$test{max} skipped: $test{skip_reason}") |
152 | if $test{skipped}; |
153 | push(@msg, "$test{bonus}/$test{max} unexpectedly succeeded") |
154 | if $test{bonus}; |
155 | print "$test{ml}ok, ".join(', ', @msg)."\n"; |
156 | } elsif ($test{max}) { |
157 | print "$test{ml}ok\n"; |
158 | } elsif (defined $test{skip_reason}) { |
159 | print "skipped: $test{skip_reason}\n"; |
160 | $tot{skipped}++; |
c0ee6f5c |
161 | } else { |
45c0de28 |
162 | print "skipped test on this platform\n"; |
9c5c68c8 |
163 | $tot{skipped}++; |
c0ee6f5c |
164 | } |
9c5c68c8 |
165 | $tot{good}++; |
166 | } elsif ($test{max}) { |
167 | if ($test{next} <= $test{max}) { |
168 | push @{$test{failed}}, $test{next}..$test{max}; |
6c31b336 |
169 | } |
9c5c68c8 |
170 | if (@{$test{failed}}) { |
171 | my ($txt, $canon) = canonfailed($test{max},$test{skipped}, |
172 | @{$test{failed}}); |
173 | print "$test{ml}$txt"; |
174 | $failedtests{$test} = { canon => $canon, |
175 | max => $test{max}, |
176 | failed => scalar @{$test{failed}}, |
177 | name => $test, |
178 | percent => 100*(scalar @{$test{failed}})/$test{max}, |
179 | estat => '', |
180 | wstat => '', |
760ac839 |
181 | }; |
c07a80fd |
182 | } else { |
9c5c68c8 |
183 | print "Don't know which tests failed: got $test{ok} ok, ". |
184 | "expected $test{max}\n"; |
185 | $failedtests{$test} = { canon => '??', |
186 | max => $test{max}, |
187 | failed => '??', |
188 | name => $test, |
189 | percent => undef, |
190 | estat => '', |
191 | wstat => '', |
760ac839 |
192 | }; |
c07a80fd |
193 | } |
9c5c68c8 |
194 | $tot{bad}++; |
195 | } elsif ($test{next} == 0) { |
6c31b336 |
196 | print "FAILED before any test output arrived\n"; |
9c5c68c8 |
197 | $tot{bad}++; |
198 | $failedtests{$test} = { canon => '??', |
199 | max => '??', |
200 | failed => '??', |
201 | name => $test, |
202 | percent => undef, |
203 | estat => '', |
204 | wstat => '', |
760ac839 |
205 | }; |
6c31b336 |
206 | } |
9c5c68c8 |
207 | $tot{sub_skipped} += $test{skipped}; |
208 | |
209 | if (defined $Files_In_Dir) { |
210 | my @new_dir_files = globdir $Files_In_Dir; |
17a79f5b |
211 | if (@new_dir_files != @dir_files) { |
212 | my %f; |
213 | @f{@new_dir_files} = (1) x @new_dir_files; |
214 | delete @f{@dir_files}; |
215 | my @f = sort keys %f; |
216 | print "LEAKED FILES: @f\n"; |
217 | @dir_files = @new_dir_files; |
218 | } |
219 | } |
a0d0e21e |
220 | } |
9c5c68c8 |
221 | $tot{bench} = timediff(new Benchmark, $t_start); |
d667a7e6 |
222 | |
774d564b |
223 | if ($^O eq 'VMS') { |
224 | if (defined $old5lib) { |
225 | $ENV{PERL5LIB} = $old5lib; |
b876d4a6 |
226 | } else { |
774d564b |
227 | delete $ENV{PERL5LIB}; |
228 | } |
229 | } |
9c5c68c8 |
230 | |
231 | return(\%tot, \%failedtests); |
232 | } |
233 | |
234 | |
235 | sub _show_results { |
236 | my($tot, $failedtests) = @_; |
237 | |
238 | my $pct; |
239 | my $bonusmsg = _bonusmsg($tot); |
240 | |
241 | if ($tot->{bad} == 0 && $tot->{max}) { |
7b13a3f5 |
242 | print "All tests successful$bonusmsg.\n"; |
9c5c68c8 |
243 | } elsif ($tot->{tests}==0){ |
6c31b336 |
244 | die "FAILED--no tests were run for some reason.\n"; |
9c5c68c8 |
245 | } elsif ($tot->{max} == 0) { |
246 | my $blurb = $tot->{tests}==1 ? "script" : "scripts"; |
247 | die "FAILED--$tot->{tests} test $blurb could be run, ". |
248 | "alas--no output ever seen\n"; |
c07a80fd |
249 | } else { |
9c5c68c8 |
250 | $pct = sprintf("%.2f", $tot->{good} / $tot->{tests} * 100); |
6c31b336 |
251 | my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.", |
9c5c68c8 |
252 | $tot->{max} - $tot->{ok}, $tot->{max}, |
253 | 100*$tot->{ok}/$tot->{max}; |
0a931e4a |
254 | |
9c5c68c8 |
255 | my($fmt_top, $fmt) = _create_fmts($failedtests); |
0a931e4a |
256 | |
257 | # Now write to formats |
9c5c68c8 |
258 | for my $script (sort keys %$failedtests) { |
259 | $Curtest = $failedtests->{$script}; |
760ac839 |
260 | write; |
261 | } |
9c5c68c8 |
262 | if ($tot->{bad}) { |
9b0ceca9 |
263 | $bonusmsg =~ s/^,\s*//; |
264 | print "$bonusmsg.\n" if $bonusmsg; |
9c5c68c8 |
265 | die "Failed $tot->{bad}/$tot->{tests} test scripts, $pct% okay.". |
266 | "$subpct\n"; |
c07a80fd |
267 | } |
268 | } |
f0a9308e |
269 | |
9c5c68c8 |
270 | printf("Files=%d, Tests=%d, %s\n", |
271 | $tot->{files}, $tot->{max}, timestr($tot->{bench}, 'nop')); |
272 | } |
273 | |
274 | |
275 | sub _parse_header { |
276 | my($line, $test, $tot) = @_; |
277 | |
278 | my $is_header = 0; |
279 | |
280 | print $line if $Verbose; |
281 | |
282 | # 1..10 todo 4 7 10; |
283 | if ($line =~ /^1\.\.([0-9]+) todo([\d\s]+);?/i) { |
284 | $test->{max} = $1; |
285 | for (split(/\s+/, $2)) { $test->{todo}{$_} = 1; } |
286 | |
287 | $tot->{max} += $test->{max}; |
288 | $tot->{files}++; |
289 | |
290 | $is_header = 1; |
291 | } |
292 | # 1..10 |
293 | # 1..0 # skip Why? Because I said so! |
294 | elsif ($line =~ /^1\.\.([0-9]+) |
295 | (\s*\#\s*[Ss]kip\S*(?>\s+) (.+))? |
296 | /x |
297 | ) |
298 | { |
299 | $test->{max} = $1; |
300 | $tot->{max} += $test->{max}; |
301 | $tot->{files}++; |
302 | $test->{next} = 1 unless $test->{next}; |
303 | $test->{skip_reason} = $3 if not $test->{max} and defined $3; |
304 | |
305 | $is_header = 1; |
306 | } |
307 | else { |
308 | $is_header = 0; |
309 | } |
310 | |
311 | return $is_header; |
c07a80fd |
312 | } |
313 | |
9c5c68c8 |
314 | |
315 | sub _parse_test_line { |
316 | my($line, $test, $tot) = @_; |
317 | |
318 | if ($line =~ /^(not\s+)?ok\b/i) { |
319 | my $this = $test->{next} || 1; |
320 | # "not ok 23" |
37ce32a7 |
321 | if ($line =~ /^(not )?ok\s*(\d*)(\s*#.*)?/) { |
322 | my($not, $tnum, $extra) = ($1, $2, $3); |
323 | |
324 | $this = $tnum if $tnum; |
325 | |
326 | my($type, $reason) = $extra =~ /^\s*#\s*([Ss]kip\S*|TODO)(\s+.+)?/ |
327 | if defined $extra; |
328 | |
329 | my($istodo, $isskip); |
330 | if( defined $type ) { |
331 | $istodo = $type =~ /TODO/; |
332 | $isskip = $type =~ /skip/i; |
333 | } |
334 | |
335 | $test->{todo}{$tnum} = 1 if $istodo; |
336 | |
337 | if( $not ) { |
338 | print "$test->{ml}NOK $this" if $test->{ml}; |
339 | if (!$test->{todo}{$this}) { |
340 | push @{$test->{failed}}, $this; |
341 | } else { |
342 | $test->{ok}++; |
343 | $tot->{ok}++; |
344 | } |
345 | } |
346 | else { |
347 | print "$test->{ml}ok $this/$test->{max}" if $test->{ml}; |
348 | $test->{ok}++; |
349 | $tot->{ok}++; |
350 | $test->{skipped}++ if $isskip; |
351 | |
352 | if (defined $reason and defined $test->{skip_reason}) { |
353 | # print "was: '$skip_reason' new '$reason'\n"; |
354 | $test->{skip_reason} = 'various reasons' |
355 | if $test->{skip_reason} ne $reason; |
356 | } elsif (defined $reason) { |
357 | $test->{skip_reason} = $reason; |
358 | } |
359 | |
360 | $test->{bonus}++, $tot->{bonus}++ if $test->{todo}{$this}; |
361 | } |
9c5c68c8 |
362 | } |
363 | # XXX ummm... dunno |
364 | elsif ($line =~ /^ok\s*(\d*)\s*\#([^\r]*)$/) { # XXX multiline ok? |
365 | $this = $1 if $1 > 0; |
366 | print "$test->{ml}ok $this/$test->{max}" if $test->{ml}; |
367 | $test->{ok}++; |
368 | $tot->{ok}++; |
369 | } |
370 | else { |
371 | # an ok or not ok not matching the 3 cases above... |
372 | # just ignore it for compatibility with TEST |
373 | next; |
374 | } |
375 | |
376 | if ($this > $test->{next}) { |
377 | # print "Test output counter mismatch [test $this]\n"; |
378 | # no need to warn probably |
379 | push @{$test->{failed}}, $test->{next}..$this-1; |
380 | } |
381 | elsif ($this < $test->{next}) { |
382 | #we have seen more "ok" lines than the number suggests |
383 | print "Confused test output: test $this answered after ". |
384 | "test ", $test->{next}-1, "\n"; |
385 | $test->{next} = $this; |
386 | } |
387 | $test->{next} = $this + 1; |
388 | |
389 | } |
390 | elsif ($line =~ /^Bail out!\s*(.*)/i) { # magic words |
391 | die "FAILED--Further testing stopped" . |
392 | ($1 ? ": $1\n" : ".\n"); |
393 | } |
394 | } |
395 | |
396 | |
397 | sub _bonusmsg { |
398 | my($tot) = @_; |
399 | |
400 | my $bonusmsg = ''; |
401 | $bonusmsg = (" ($tot->{bonus} subtest".($tot->{bonus} > 1 ? 's' : ''). |
402 | " UNEXPECTEDLY SUCCEEDED)") |
403 | if $tot->{bonus}; |
404 | |
405 | if ($tot->{skipped}) { |
406 | $bonusmsg .= ", $tot->{skipped} test" |
407 | . ($tot->{skipped} != 1 ? 's' : ''); |
408 | if ($tot->{sub_skipped}) { |
409 | $bonusmsg .= " and $tot->{sub_skipped} subtest" |
410 | . ($tot->{sub_skipped} != 1 ? 's' : ''); |
411 | } |
412 | $bonusmsg .= ' skipped'; |
413 | } |
414 | elsif ($tot->{sub_skipped}) { |
415 | $bonusmsg .= ", $tot->{sub_skipped} subtest" |
416 | . ($tot->{sub_skipped} != 1 ? 's' : '') |
417 | . " skipped"; |
418 | } |
419 | |
420 | return $bonusmsg; |
421 | } |
422 | |
423 | # VMS has some subtle nastiness with closing the test files. |
424 | sub _close_fh { |
425 | my($fh) = shift; |
426 | |
427 | close($fh); # must close to reap child resource values |
428 | |
429 | my $wstatus = $Ignore_Exitcode ? 0 : $?; # Can trust $? ? |
430 | my $estatus; |
431 | $estatus = ($^O eq 'VMS' |
432 | ? eval 'use vmsish "status"; $estatus = $?' |
433 | : $wstatus >> 8); |
434 | |
435 | return($estatus, $wstatus); |
436 | } |
437 | |
438 | |
439 | # Set up the command-line switches to run perl as. |
440 | sub _set_switches { |
441 | my($test) = shift; |
442 | |
443 | open(my $fh, $test) or print "can't open $test. $!\n"; |
444 | my $first = <$fh>; |
445 | my $s = $Switches; |
446 | $s .= " $ENV{'HARNESS_PERL_SWITCHES'}" |
447 | if exists $ENV{'HARNESS_PERL_SWITCHES'}; |
448 | $s .= join " ", q[ "-T"], map {qq["-I$_"]} @INC |
449 | if $first =~ /^#!.*\bperl.*-\w*T/; |
450 | |
451 | close($fh) or print "can't close $test. $!\n"; |
452 | |
453 | return $s; |
454 | } |
455 | |
456 | |
457 | # Test program go boom. |
458 | sub _dubious_return { |
459 | my($test, $tot, $estatus, $wstatus) = @_; |
460 | my ($failed, $canon, $percent) = ('??', '??'); |
461 | |
462 | printf "$test->{ml}dubious\n\tTest returned status $estatus ". |
463 | "(wstat %d, 0x%x)\n", |
464 | $wstatus,$wstatus; |
465 | print "\t\t(VMS status is $estatus)\n" if $^O eq 'VMS'; |
466 | |
467 | if (corestatus($wstatus)) { # until we have a wait module |
468 | if ($Have_Devel_Corestack) { |
469 | Devel::CoreStack::stack($^X); |
470 | } else { |
471 | print "\ttest program seems to have generated a core\n"; |
472 | } |
473 | } |
474 | |
475 | $tot->{bad}++; |
476 | |
477 | if ($test->{max}) { |
478 | if ($test->{next} == $test->{max} + 1 and not @{$test->{failed}}) { |
479 | print "\tafter all the subtests completed successfully\n"; |
480 | $percent = 0; |
481 | $failed = 0; # But we do not set $canon! |
482 | } |
483 | else { |
484 | push @{$test->{failed}}, $test->{next}..$test->{max}; |
485 | $failed = @{$test->{failed}}; |
486 | (my $txt, $canon) = canonfailed($test->{max},$test->{skipped},@{$test->{failed}}); |
487 | $percent = 100*(scalar @{$test->{failed}})/$test->{max}; |
488 | print "DIED. ",$txt; |
489 | } |
490 | } |
491 | |
492 | return { canon => $canon, max => $test->{max} || '??', |
493 | failed => $failed, |
66fd8cb9 |
494 | percent => $percent, |
9c5c68c8 |
495 | estat => $estatus, wstat => $wstatus, |
496 | }; |
497 | } |
498 | |
499 | |
500 | sub _garbled_output { |
501 | my($gibberish) = shift; |
502 | warn "Confusing test output: '$gibberish'\n"; |
503 | } |
504 | |
505 | |
506 | sub _create_fmts { |
507 | my($failedtests) = @_; |
508 | |
509 | my $failed_str = "Failed Test"; |
510 | my $middle_str = " Status Wstat Total Fail Failed "; |
511 | my $list_str = "List of Failed"; |
512 | |
513 | # Figure out our longest name string for formatting purposes. |
514 | my $max_namelen = length($failed_str); |
515 | foreach my $script (keys %$failedtests) { |
516 | my $namelen = length $failedtests->{$script}->{name}; |
517 | $max_namelen = $namelen if $namelen > $max_namelen; |
518 | } |
519 | |
520 | my $list_len = $Columns - length($middle_str) - $max_namelen; |
521 | if ($list_len < length($list_str)) { |
522 | $list_len = length($list_str); |
523 | $max_namelen = $Columns - length($middle_str) - $list_len; |
524 | if ($max_namelen < length($failed_str)) { |
525 | $max_namelen = length($failed_str); |
526 | $Columns = $max_namelen + length($middle_str) + $list_len; |
527 | } |
528 | } |
529 | |
530 | my $fmt_top = "format STDOUT_TOP =\n" |
531 | . sprintf("%-${max_namelen}s", $failed_str) |
532 | . $middle_str |
533 | . $list_str . "\n" |
534 | . "-" x $Columns |
535 | . "\n.\n"; |
536 | |
537 | my $fmt = "format STDOUT =\n" |
538 | . "@" . "<" x ($max_namelen - 1) |
539 | . " @>> @>>>> @>>>> @>>> ^##.##% " |
540 | . "^" . "<" x ($list_len - 1) . "\n" |
541 | . '{ $Curtest->{name}, $Curtest->{estat},' |
542 | . ' $Curtest->{wstat}, $Curtest->{max},' |
543 | . ' $Curtest->{failed}, $Curtest->{percent},' |
544 | . ' $Curtest->{canon}' |
545 | . "\n}\n" |
546 | . "~~" . " " x ($Columns - $list_len - 2) . "^" |
547 | . "<" x ($list_len - 1) . "\n" |
548 | . '$Curtest->{canon}' |
549 | . "\n.\n"; |
550 | |
551 | eval $fmt_top; |
552 | die $@ if $@; |
553 | eval $fmt; |
554 | die $@ if $@; |
555 | |
556 | return($fmt_top, $fmt); |
557 | } |
558 | |
559 | |
aa689395 |
560 | my $tried_devel_corestack; |
c0ee6f5c |
561 | sub corestatus { |
562 | my($st) = @_; |
c0ee6f5c |
563 | |
564 | eval {require 'wait.ph'}; |
0dfaec25 |
565 | my $ret = defined &WCOREDUMP ? WCOREDUMP($st) : $st & 0200; |
c0ee6f5c |
566 | |
9c5c68c8 |
567 | eval { require Devel::CoreStack; $Have_Devel_Corestack++ } |
aa689395 |
568 | unless $tried_devel_corestack++; |
c0ee6f5c |
569 | |
570 | $ret; |
571 | } |
572 | |
c07a80fd |
573 | sub canonfailed ($@) { |
89d3b7e2 |
574 | my($max,$skipped,@failed) = @_; |
6c31b336 |
575 | my %seen; |
576 | @failed = sort {$a <=> $b} grep !$seen{$_}++, @failed; |
c07a80fd |
577 | my $failed = @failed; |
578 | my @result = (); |
579 | my @canon = (); |
580 | my $min; |
581 | my $last = $min = shift @failed; |
760ac839 |
582 | my $canon; |
c07a80fd |
583 | if (@failed) { |
584 | for (@failed, $failed[-1]) { # don't forget the last one |
585 | if ($_ > $last+1 || $_ == $last) { |
586 | if ($min == $last) { |
587 | push @canon, $last; |
588 | } else { |
589 | push @canon, "$min-$last"; |
590 | } |
591 | $min = $_; |
592 | } |
593 | $last = $_; |
594 | } |
595 | local $" = ", "; |
596 | push @result, "FAILED tests @canon\n"; |
760ac839 |
597 | $canon = "@canon"; |
a0d0e21e |
598 | } else { |
c07a80fd |
599 | push @result, "FAILED test $last\n"; |
760ac839 |
600 | $canon = $last; |
a0d0e21e |
601 | } |
c07a80fd |
602 | |
603 | push @result, "\tFailed $failed/$max tests, "; |
89d3b7e2 |
604 | push @result, sprintf("%.2f",100*(1-$failed/$max)), "% okay"; |
605 | my $ender = 's' x ($skipped > 1); |
606 | my $good = $max - $failed - $skipped; |
607 | my $goodper = sprintf("%.2f",100*($good/$max)); |
9c5c68c8 |
608 | push @result, " (-$skipped skipped test$ender: $good okay, ". |
609 | "$goodper%)" |
610 | if $skipped; |
89d3b7e2 |
611 | push @result, "\n"; |
760ac839 |
612 | my $txt = join "", @result; |
613 | ($txt, $canon); |
a0d0e21e |
614 | } |
615 | |
616 | 1; |
cb1a09d0 |
617 | __END__ |
618 | |
619 | =head1 NAME |
620 | |
621 | Test::Harness - run perl standard test scripts with statistics |
622 | |
623 | =head1 SYNOPSIS |
624 | |
37ce32a7 |
625 | use Test::Harness; |
cb1a09d0 |
626 | |
37ce32a7 |
627 | runtests(@test_files); |
cb1a09d0 |
628 | |
629 | =head1 DESCRIPTION |
630 | |
9c5c68c8 |
631 | (By using the Test module, you can write test scripts without |
7b13a3f5 |
632 | knowing the exact output this module expects. However, if you need to |
633 | know the specifics, read on!) |
634 | |
cb1a09d0 |
635 | Perl test scripts print to standard output C<"ok N"> for each single |
636 | test, where C<N> is an increasing sequence of integers. The first line |
c0ee6f5c |
637 | output by a standard test script is C<"1..M"> with C<M> being the |
cb1a09d0 |
638 | number of tests that should be run within the test |
c0ee6f5c |
639 | script. Test::Harness::runtests(@tests) runs all the testscripts |
cb1a09d0 |
640 | named as arguments and checks standard output for the expected |
641 | C<"ok N"> strings. |
642 | |
c0ee6f5c |
643 | After all tests have been performed, runtests() prints some |
cb1a09d0 |
644 | performance statistics that are computed by the Benchmark module. |
645 | |
6c31b336 |
646 | =head2 The test script output |
647 | |
37ce32a7 |
648 | The following explains how Test::Harness interprets the output of your |
649 | test program. |
650 | |
9c5c68c8 |
651 | =over 4 |
652 | |
bbc7dcd2 |
653 | =item B<'1..M'> |
9c5c68c8 |
654 | |
655 | This header tells how many tests there will be. It should be the |
656 | first line output by your test program (but its okay if its preceded |
657 | by comments). |
658 | |
659 | In certain instanced, you may not know how many tests you will |
660 | ultimately be running. In this case, it is permitted (but not |
661 | encouraged) for the 1..M header to appear as the B<last> line output |
662 | by your test (again, it can be followed by further comments). But we |
663 | strongly encourage you to put it first. |
664 | |
665 | Under B<no> circumstances should 1..M appear in the middle of your |
666 | output or more than once. |
667 | |
668 | |
669 | =item B<'ok', 'not ok'. Ok?> |
670 | |
6c31b336 |
671 | Any output from the testscript to standard error is ignored and |
672 | bypassed, thus will be seen by the user. Lines written to standard |
c0ee6f5c |
673 | output containing C</^(not\s+)?ok\b/> are interpreted as feedback for |
674 | runtests(). All other lines are discarded. |
6c31b336 |
675 | |
9c5c68c8 |
676 | C</^not ok/> indicates a failed test. C</^ok/> is a successful test. |
677 | |
678 | |
679 | =item B<test numbers> |
680 | |
681 | Perl normally expects the 'ok' or 'not ok' to be followed by a test |
682 | number. It is tolerated if the test numbers after 'ok' are |
683 | omitted. In this case Test::Harness maintains temporarily its own |
684 | counter until the script supplies test numbers again. So the following |
685 | test script |
6c31b336 |
686 | |
687 | print <<END; |
688 | 1..6 |
689 | not ok |
690 | ok |
691 | not ok |
692 | ok |
693 | ok |
694 | END |
695 | |
d667a7e6 |
696 | will generate |
6c31b336 |
697 | |
698 | FAILED tests 1, 3, 6 |
699 | Failed 3/6 tests, 50.00% okay |
700 | |
9c5c68c8 |
701 | |
702 | =item B<$Test::Harness::verbose> |
703 | |
6c31b336 |
704 | The global variable $Test::Harness::verbose is exportable and can be |
c0ee6f5c |
705 | used to let runtests() display the standard output of the script |
6c31b336 |
706 | without altering the behavior otherwise. |
707 | |
9c5c68c8 |
708 | =item B<$Test::Harness::switches> |
709 | |
fb73857a |
710 | The global variable $Test::Harness::switches is exportable and can be |
711 | used to set perl command line options used for running the test |
712 | script(s). The default value is C<-w>. |
713 | |
9c5c68c8 |
714 | =item B<Skipping tests> |
715 | |
37ce32a7 |
716 | If the standard output line contains the substring C< # Skip> (with |
fac76ed7 |
717 | variations in spacing and case) after C<ok> or C<ok NUMBER>, it is |
9c5c68c8 |
718 | counted as a skipped test. If the whole testscript succeeds, the |
719 | count of skipped tests is included in the generated output. |
e1194749 |
720 | C<Test::Harness> reports the text after C< # Skip\S*\s+> as a reason |
37ce32a7 |
721 | for skipping. |
722 | |
723 | ok 23 # skip Insufficient flogiston pressure. |
724 | |
725 | Similarly, one can include a similar explanation in a C<1..0> line |
726 | emitted if the test script is skipped completely: |
45c0de28 |
727 | |
728 | 1..0 # Skipped: no leverage found |
729 | |
37ce32a7 |
730 | =item B<Todo tests> |
731 | |
732 | If the standard output line contains the substring C< # TODO> after |
733 | C<not ok> or C<not ok NUMBER>, it is counted as a todo test. The text |
734 | afterwards is the thing that has to be done before this test will |
735 | succeed. |
736 | |
737 | not ok 13 # TODO harness the power of the atom |
738 | |
739 | These tests represent a feature to be implemented or a bug to be fixed |
740 | and act as something of an executable "thing to do" list. They are |
741 | B<not> expected to succeed. Should a todo test begin succeeding, |
742 | Test::Harness will report it as a bonus. This indicates that whatever |
743 | you were supposed to do has been done and you should promote this to a |
744 | normal test. |
745 | |
9c5c68c8 |
746 | =item B<Bail out!> |
747 | |
d667a7e6 |
748 | As an emergency measure, a test script can decide that further tests |
749 | are useless (e.g. missing dependencies) and testing should stop |
750 | immediately. In that case the test script prints the magic words |
751 | |
752 | Bail out! |
753 | |
754 | to standard output. Any message after these words will be displayed by |
755 | C<Test::Harness> as the reason why testing is stopped. |
756 | |
9c5c68c8 |
757 | =item B<Comments> |
758 | |
759 | Additional comments may be put into the testing output on their own |
760 | lines. Comment lines should begin with a '#', Test::Harness will |
761 | ignore them. |
762 | |
763 | ok 1 |
764 | # Life is good, the sun is shining, RAM is cheap. |
765 | not ok 2 |
766 | # got 'Bush' expected 'Gore' |
767 | |
4ac9195f |
768 | =back |
9c5c68c8 |
769 | |
cb1a09d0 |
770 | =head1 EXPORT |
771 | |
c0ee6f5c |
772 | C<&runtests> is exported by Test::Harness per default. |
cb1a09d0 |
773 | |
9c5c68c8 |
774 | C<$verbose> and C<$switches> are exported upon request. |
775 | |
776 | |
cb1a09d0 |
777 | =head1 DIAGNOSTICS |
778 | |
779 | =over 4 |
780 | |
781 | =item C<All tests successful.\nFiles=%d, Tests=%d, %s> |
782 | |
783 | If all tests are successful some statistics about the performance are |
784 | printed. |
785 | |
6c31b336 |
786 | =item C<FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay.> |
787 | |
788 | For any single script that has failing subtests statistics like the |
789 | above are printed. |
790 | |
791 | =item C<Test returned status %d (wstat %d)> |
792 | |
9c5c68c8 |
793 | Scripts that return a non-zero exit status, both C<$? E<gt>E<gt> 8> |
794 | and C<$?> are printed in a message similar to the above. |
6c31b336 |
795 | |
796 | =item C<Failed 1 test, %.2f%% okay. %s> |
cb1a09d0 |
797 | |
6c31b336 |
798 | =item C<Failed %d/%d tests, %.2f%% okay. %s> |
cb1a09d0 |
799 | |
800 | If not all tests were successful, the script dies with one of the |
801 | above messages. |
802 | |
d667a7e6 |
803 | =item C<FAILED--Further testing stopped%s> |
804 | |
805 | If a single subtest decides that further testing will not make sense, |
806 | the script dies with this message. |
807 | |
cb1a09d0 |
808 | =back |
809 | |
9b0ceca9 |
810 | =head1 ENVIRONMENT |
811 | |
37ce32a7 |
812 | =over 4 |
813 | |
814 | =item C<HARNESS_IGNORE_EXITCODE> |
815 | |
816 | Makes harness ignore the exit status of child processes when defined. |
817 | |
818 | =item C<HARNESS_NOTTY> |
9b0ceca9 |
819 | |
37ce32a7 |
820 | When set to a true value, forces it to behave as though STDOUT were |
821 | not a console. You may need to set this if you don't want harness to |
822 | output more frequent progress messages using carriage returns. Some |
823 | consoles may not handle carriage returns properly (which results in a |
824 | somewhat messy output). |
0d0c0d42 |
825 | |
37ce32a7 |
826 | =item C<HARNESS_COMPILE_TEST> |
9636a016 |
827 | |
37ce32a7 |
828 | When true it will make harness attempt to compile the test using |
829 | C<perlcc> before running it. |
830 | |
831 | =item C<HARNESS_FILELEAK_IN_DIR> |
832 | |
833 | When set to the name of a directory, harness will check after each |
834 | test whether new files appeared in that directory, and report them as |
17a79f5b |
835 | |
836 | LEAKED FILES: scr.tmp 0 my.db |
837 | |
838 | If relative, directory name is with respect to the current directory at |
839 | the moment runtests() was called. Putting absolute path into |
840 | C<HARNESS_FILELEAK_IN_DIR> may give more predicatable results. |
841 | |
37ce32a7 |
842 | =item C<HARNESS_PERL_SWITCHES> |
843 | |
844 | Its value will be prepended to the switches used to invoke perl on |
845 | each test. For example, setting C<HARNESS_PERL_SWITCHES> to "-W" will |
846 | run all tests with all warnings enabled. |
847 | |
848 | =item C<HARNESS_COLUMNS> |
849 | |
850 | This value will be used for the width of the terminal. If it is not |
851 | set then it will default to C<COLUMNS>. If this is not set, it will |
852 | default to 80. Note that users of Bourne-sh based shells will need to |
853 | C<export COLUMNS> for this module to use that variable. |
2b32313b |
854 | |
37ce32a7 |
855 | =item C<HARNESS_ACTIVE> |
856 | |
857 | Harness sets this before executing the individual tests. This allows |
858 | the tests to determine if they are being executed through the harness |
859 | or by any other means. |
860 | |
861 | =back |
0a931e4a |
862 | |
f19ae7a7 |
863 | |
cb1a09d0 |
864 | =head1 SEE ALSO |
865 | |
37ce32a7 |
866 | L<Test> for writing test scripts, L<Benchmark> for the underlying |
867 | timing routines and L<Devel::Coverage> for test coverage analysis. |
c07a80fd |
868 | |
869 | =head1 AUTHORS |
870 | |
871 | Either Tim Bunce or Andreas Koenig, we don't know. What we know for |
872 | sure is, that it was inspired by Larry Wall's TEST script that came |
b876d4a6 |
873 | with perl distributions for ages. Numerous anonymous contributors |
37ce32a7 |
874 | exist. |
875 | |
876 | Current maintainers are Andreas Koenig <andreas.koenig@anima.de> and |
877 | Michael G Schwern <schwern@pobox.com> |
cb1a09d0 |
878 | |
879 | =head1 BUGS |
880 | |
881 | Test::Harness uses $^X to determine the perl binary to run the tests |
6c31b336 |
882 | with. Test scripts running via the shebang (C<#!>) line may not be |
883 | portable because $^X is not consistent for shebang scripts across |
cb1a09d0 |
884 | platforms. This is no problem when Test::Harness is run with an |
6c31b336 |
885 | absolute path to the perl binary or when $^X can be found in the path. |
cb1a09d0 |
886 | |
887 | =cut |