Commit | Line | Data |
809908f7 |
1 | |
2 | require 5.004; |
75fa620a |
3 | package Test; |
8d806c1c |
4 | # Time-stamp: "2003-04-18 21:48:01 AHDT" |
809908f7 |
5 | |
6 | use strict; |
7 | |
7b13a3f5 |
8 | use Carp; |
809908f7 |
9 | use vars (qw($VERSION @ISA @EXPORT @EXPORT_OK $ntest $TestLevel), #public-ish |
75fa620a |
10 | qw($TESTOUT $TESTERR %Program_Lines |
711cdd39 |
11 | $ONFAIL %todo %history $planned @FAILDETAIL) #private-ish |
809908f7 |
12 | ); |
13 | |
711cdd39 |
14 | # In case a test is run in a persistent environment. |
15 | sub _reset_globals { |
16 | %todo = (); |
17 | %history = (); |
18 | @FAILDETAIL = (); |
19 | $ntest = 1; |
20 | $TestLevel = 0; # how many extra stack frames to skip |
21 | $planned = 0; |
22 | } |
23 | |
8d806c1c |
24 | $VERSION = '1.24'; |
7b13a3f5 |
25 | require Exporter; |
26 | @ISA=('Exporter'); |
809908f7 |
27 | |
28 | @EXPORT = qw(&plan &ok &skip); |
711cdd39 |
29 | @EXPORT_OK = qw($ntest $TESTOUT $TESTERR); |
7b13a3f5 |
30 | |
31 | $|=1; |
f2ac83ee |
32 | $TESTOUT = *STDOUT{IO}; |
711cdd39 |
33 | $TESTERR = *STDERR{IO}; |
7b13a3f5 |
34 | |
3238f5fe |
35 | # Use of this variable is strongly discouraged. It is set mainly to |
36 | # help test coverage analyzers know which test is running. |
7b13a3f5 |
37 | $ENV{REGRESSION_TEST} = $0; |
38 | |
809908f7 |
39 | |
40 | =head1 NAME |
41 | |
42 | Test - provides a simple framework for writing test scripts |
43 | |
44 | =head1 SYNOPSIS |
45 | |
46 | use strict; |
47 | use Test; |
48 | |
49 | # use a BEGIN block so we print our plan before MyModule is loaded |
50 | BEGIN { plan tests => 14, todo => [3,4] } |
51 | |
52 | # load your module... |
53 | use MyModule; |
54 | |
75fa620a |
55 | # Helpful notes. All note-lines must start with a "#". |
56 | print "# I'm testing MyModule version $MyModule::VERSION\n"; |
57 | |
809908f7 |
58 | ok(0); # failure |
59 | ok(1); # success |
60 | |
61 | ok(0); # ok, expected failure (see todo list, above) |
62 | ok(1); # surprise success! |
63 | |
64 | ok(0,1); # failure: '0' ne '1' |
65 | ok('broke','fixed'); # failure: 'broke' ne 'fixed' |
66 | ok('fixed','fixed'); # success: 'fixed' eq 'fixed' |
67 | ok('fixed',qr/x/); # success: 'fixed' =~ qr/x/ |
68 | |
69 | ok(sub { 1+1 }, 2); # success: '2' eq '2' |
70 | ok(sub { 1+1 }, 3); # failure: '2' ne '3' |
809908f7 |
71 | |
72 | my @list = (0,0); |
75fa620a |
73 | ok @list, 3, "\@list=".join(',',@list); #extra notes |
809908f7 |
74 | ok 'segmentation fault', '/(?i)success/'; #regex match |
75 | |
75fa620a |
76 | skip( |
26bf6773 |
77 | $^O eq 'MSWin' ? "Skip unless MSWin" : 0, # whether to skip |
78 | $foo, $bar # arguments just like for ok(...) |
79 | ); |
80 | skip( |
81 | $^O eq 'MSWin' ? 0 : "Skip if MSWin", # whether to skip |
75fa620a |
82 | $foo, $bar # arguments just like for ok(...) |
83 | ); |
809908f7 |
84 | |
85 | =head1 DESCRIPTION |
86 | |
75fa620a |
87 | This module simplifies the task of writing test files for Perl modules, |
88 | such that their output is in the format that |
89 | L<Test::Harness|Test::Harness> expects to see. |
edd5bad5 |
90 | |
75fa620a |
91 | =head1 QUICK START GUIDE |
809908f7 |
92 | |
75fa620a |
93 | To write a test for your new (and probably not even done) module, create |
94 | a new file called F<t/test.t> (in a new F<t> directory). If you have |
95 | multiple test files, to test the "foo", "bar", and "baz" feature sets, |
96 | then feel free to call your files F<t/foo.t>, F<t/bar.t>, and |
97 | F<t/baz.t> |
809908f7 |
98 | |
99 | =head2 Functions |
100 | |
75fa620a |
101 | This module defines three public functions, C<plan(...)>, C<ok(...)>, |
102 | and C<skip(...)>. By default, all three are exported by |
103 | the C<use Test;> statement. |
809908f7 |
104 | |
105 | =over 4 |
106 | |
75fa620a |
107 | =item C<plan(...)> |
809908f7 |
108 | |
109 | BEGIN { plan %theplan; } |
110 | |
111 | This should be the first thing you call in your test script. It |
112 | declares your testing plan, how many there will be, if any of them |
75fa620a |
113 | should be allowed to fail, and so on. |
809908f7 |
114 | |
115 | Typical usage is just: |
116 | |
117 | use Test; |
118 | BEGIN { plan tests => 23 } |
119 | |
75fa620a |
120 | These are the things that you can put in the parameters to plan: |
121 | |
122 | =over |
123 | |
124 | =item C<tests =E<gt> I<number>> |
125 | |
126 | The number of tests in your script. |
127 | This means all ok() and skip() calls. |
128 | |
129 | =item C<todo =E<gt> [I<1,5,14>]> |
130 | |
131 | A reference to a list of tests which are allowed to fail. |
132 | See L</TODO TESTS>. |
133 | |
134 | =item C<onfail =E<gt> sub { ... }> |
809908f7 |
135 | |
75fa620a |
136 | =item C<onfail =E<gt> \&some_sub> |
809908f7 |
137 | |
75fa620a |
138 | A subroutine reference to be run at the end of the test script, if |
139 | any of the tests fail. See L</ONFAIL>. |
140 | |
141 | =back |
142 | |
143 | You must call C<plan(...)> once and only once. You should call it |
144 | in a C<BEGIN {...}> block, like so: |
145 | |
146 | BEGIN { plan tests => 23 } |
809908f7 |
147 | |
148 | =cut |
149 | |
7b13a3f5 |
150 | sub plan { |
151 | croak "Test::plan(%args): odd number of arguments" if @_ & 1; |
8b3be1d1 |
152 | croak "Test::plan(): should not be called more than once" if $planned; |
809908f7 |
153 | |
154 | local($\, $,); # guard against -l and other things that screw with |
155 | # print |
156 | |
711cdd39 |
157 | _reset_globals(); |
158 | |
75fa620a |
159 | _read_program( (caller)[1] ); |
160 | |
7b13a3f5 |
161 | my $max=0; |
162 | for (my $x=0; $x < @_; $x+=2) { |
163 | my ($k,$v) = @_[$x,$x+1]; |
164 | if ($k =~ /^test(s)?$/) { $max = $v; } |
165 | elsif ($k eq 'todo' or |
166 | $k eq 'failok') { for (@$v) { $todo{$_}=1; }; } |
8b3be1d1 |
167 | elsif ($k eq 'onfail') { |
168 | ref $v eq 'CODE' or croak "Test::plan(onfail => $v): must be CODE"; |
169 | $ONFAIL = $v; |
170 | } |
7b13a3f5 |
171 | else { carp "Test::plan(): skipping unrecognized directive '$k'" } |
172 | } |
173 | my @todo = sort { $a <=> $b } keys %todo; |
174 | if (@todo) { |
f2ac83ee |
175 | print $TESTOUT "1..$max todo ".join(' ', @todo).";\n"; |
7b13a3f5 |
176 | } else { |
f2ac83ee |
177 | print $TESTOUT "1..$max\n"; |
7b13a3f5 |
178 | } |
8b3be1d1 |
179 | ++$planned; |
75fa620a |
180 | print $TESTOUT "# Running under perl version $] for $^O", |
181 | (chr(65) eq 'A') ? "\n" : " in a non-ASCII world\n"; |
182 | |
183 | print $TESTOUT "# Win32::BuildNumber ", &Win32::BuildNumber(), "\n" |
184 | if defined(&Win32::BuildNumber) and defined &Win32::BuildNumber(); |
185 | |
8d806c1c |
186 | print $TESTOUT "# MacPerl version $MacPerl::Version\n" |
75fa620a |
187 | if defined $MacPerl::Version; |
188 | |
189 | printf $TESTOUT |
190 | "# Current time local: %s\n# Current time GMT: %s\n", |
26bf6773 |
191 | scalar(localtime($^T)), scalar(gmtime($^T)); |
75fa620a |
192 | |
193 | print $TESTOUT "# Using Test.pm version $VERSION\n"; |
809908f7 |
194 | |
75fa620a |
195 | # Retval never used: |
809908f7 |
196 | return undef; |
7b13a3f5 |
197 | } |
198 | |
75fa620a |
199 | sub _read_program { |
200 | my($file) = shift; |
201 | return unless defined $file and length $file |
202 | and -e $file and -f _ and -r _; |
203 | open(SOURCEFILE, "<$file") || return; |
204 | $Program_Lines{$file} = [<SOURCEFILE>]; |
205 | close(SOURCEFILE); |
206 | |
207 | foreach my $x (@{$Program_Lines{$file}}) |
8d806c1c |
208 | { $x =~ tr/\cm\cj\n\r//d } |
75fa620a |
209 | |
210 | unshift @{$Program_Lines{$file}}, ''; |
211 | return 1; |
212 | } |
809908f7 |
213 | |
214 | =begin _private |
215 | |
216 | =item B<_to_value> |
217 | |
218 | my $value = _to_value($input); |
219 | |
75fa620a |
220 | Converts an C<ok> parameter to its value. Typically this just means |
221 | running it, if it's a code reference. You should run all inputted |
809908f7 |
222 | values through this. |
223 | |
224 | =cut |
225 | |
226 | sub _to_value { |
3238f5fe |
227 | my ($v) = @_; |
809908f7 |
228 | return (ref $v or '') eq 'CODE' ? $v->() : $v; |
3238f5fe |
229 | } |
230 | |
809908f7 |
231 | =end _private |
232 | |
75fa620a |
233 | =item C<ok(...)> |
809908f7 |
234 | |
235 | ok(1 + 1 == 2); |
236 | ok($have, $expect); |
237 | ok($have, $expect, $diagnostics); |
238 | |
75fa620a |
239 | This function is the reason for C<Test>'s existence. It's |
240 | the basic function that |
241 | handles printing "C<ok>" or "C<not ok>", along with the |
242 | current test number. (That's what C<Test::Harness> wants to see.) |
243 | |
244 | In its most basic usage, C<ok(...)> simply takes a single scalar |
245 | expression. If its value is true, the test passes; if false, |
246 | the test fails. Examples: |
809908f7 |
247 | |
75fa620a |
248 | # Examples of ok(scalar) |
809908f7 |
249 | |
250 | ok( 1 + 1 == 2 ); # ok if 1 + 1 == 2 |
251 | ok( $foo =~ /bar/ ); # ok if $foo contains 'bar' |
252 | ok( baz($x + $y) eq 'Armondo' ); # ok if baz($x + $y) returns |
253 | # 'Armondo' |
254 | ok( @a == @b ); # ok if @a and @b are the same length |
255 | |
256 | The expression is evaluated in scalar context. So the following will |
257 | work: |
258 | |
259 | ok( @stuff ); # ok if @stuff has any elements |
260 | ok( !grep !defined $_, @stuff ); # ok if everything in @stuff is |
261 | # defined. |
262 | |
75fa620a |
263 | A special case is if the expression is a subroutine reference (in either |
264 | C<sub {...}> syntax or C<\&foo> syntax). In |
809908f7 |
265 | that case, it is executed and its value (true or false) determines if |
75fa620a |
266 | the test passes or fails. For example, |
809908f7 |
267 | |
75fa620a |
268 | ok( sub { # See whether sleep works at least passably |
269 | my $start_time = time; |
270 | sleep 5; |
271 | time() - $start_time >= 4 |
272 | }); |
809908f7 |
273 | |
75fa620a |
274 | In its two-argument form, C<ok(I<arg1>,I<arg2>)> compares the two scalar |
275 | values to see if they equal. (The equality is checked with C<eq>). |
809908f7 |
276 | |
75fa620a |
277 | # Example of ok(scalar, scalar) |
278 | |
279 | ok( "this", "that" ); # not ok, 'this' ne 'that' |
809908f7 |
280 | |
75fa620a |
281 | If either (or both!) is a subroutine reference, it is run and used |
282 | as the value for comparing. For example: |
283 | |
284 | ok 4, sub { |
285 | open(OUT, ">x.dat") || die $!; |
286 | print OUT "\x{e000}"; |
287 | close OUT; |
288 | my $bytecount = -s 'x.dat'; |
289 | unlink 'x.dat' or warn "Can't unlink : $!"; |
290 | return $bytecount; |
291 | }, |
292 | ; |
293 | |
294 | The above test passes two values to C<ok(arg1, arg2)> -- the first is |
295 | the number 4, and the second is a coderef. Before C<ok> compares them, |
296 | it calls the coderef, and uses its return value as the real value of |
297 | this parameter. Assuming that C<$bytecount> returns 4, C<ok> ends up |
298 | testing C<4 eq 4>. Since that's true, this test passes. |
299 | |
300 | If C<arg2> is either a regex object (i.e., C<qr/.../>) or a string |
301 | that I<looks like> a regex (e.g., C<'/foo/'>), then |
302 | C<ok(I<arg1>,I<arg2>)> will perform a pattern |
303 | match against it, instead of using C<eq>. |
809908f7 |
304 | |
305 | ok( 'JaffO', '/Jaff/' ); # ok, 'JaffO' =~ /Jaff/ |
306 | ok( 'JaffO', qr/Jaff/ ); # ok, 'JaffO' =~ qr/Jaff/; |
307 | ok( 'JaffO', '/(?i)jaff/ ); # ok, 'JaffO' =~ /jaff/i; |
308 | |
75fa620a |
309 | Finally, you can append an optional third argument, in |
310 | C<ok(I<arg1>,I<arg2>, I<note>)>, where I<note> is a string value that |
311 | will be printed if the test fails. This should be some useful |
312 | information about the test, pertaining to why it failed, and/or |
313 | a description of the test. For example: |
809908f7 |
314 | |
315 | ok( grep($_ eq 'something unique', @stuff), 1, |
316 | "Something that should be unique isn't!\n". |
317 | '@stuff = '.join ', ', @stuff |
318 | ); |
319 | |
75fa620a |
320 | Unfortunately, a note cannot be used with the single argument |
321 | style of C<ok()>. That is, if you try C<ok(I<arg1>, I<note>)>, then |
322 | C<Test> will interpret this as C<ok(I<arg1>, I<arg2>)>, and probably |
323 | end up testing C<I<arg1> eq I<arg2>> -- and that's not what you want! |
809908f7 |
324 | |
75fa620a |
325 | All of the above special cases can occasionally cause some |
326 | problems. See L</BUGS and CAVEATS>. |
809908f7 |
327 | |
328 | =cut |
329 | |
75fa620a |
330 | # A past maintainer of this module said: |
331 | # <<ok(...)'s special handling of subroutine references is an unfortunate |
332 | # "feature" that can't be removed due to compatibility.>> |
333 | # |
334 | |
8b3be1d1 |
335 | sub ok ($;$$) { |
336 | croak "ok: plan before you test!" if !$planned; |
809908f7 |
337 | |
338 | local($\,$,); # guard against -l and other things that screw with |
339 | # print |
340 | |
3238f5fe |
341 | my ($pkg,$file,$line) = caller($TestLevel); |
342 | my $repetition = ++$history{"$file:$line"}; |
343 | my $context = ("$file at line $line". |
8b3be1d1 |
344 | ($repetition > 1 ? " fail \#$repetition" : '')); |
75fa620a |
345 | |
26bf6773 |
346 | # Are we comparing two values? |
347 | my $compare = 0; |
348 | |
3238f5fe |
349 | my $ok=0; |
809908f7 |
350 | my $result = _to_value(shift); |
351 | my ($expected,$diag,$isregex,$regex); |
3238f5fe |
352 | if (@_ == 0) { |
8b3be1d1 |
353 | $ok = $result; |
3238f5fe |
354 | } else { |
26bf6773 |
355 | $compare = 1; |
809908f7 |
356 | $expected = _to_value(shift); |
59e80644 |
357 | if (!defined $expected) { |
358 | $ok = !defined $result; |
359 | } elsif (!defined $result) { |
360 | $ok = 0; |
361 | } elsif ((ref($expected)||'') eq 'Regexp') { |
f2ac83ee |
362 | $ok = $result =~ /$expected/; |
809908f7 |
363 | $regex = $expected; |
f2ac83ee |
364 | } elsif (($regex) = ($expected =~ m,^ / (.+) / $,sx) or |
809908f7 |
365 | (undef, $regex) = ($expected =~ m,^ m([^\w\s]) (.+) \1 $,sx)) { |
8b3be1d1 |
366 | $ok = $result =~ /$regex/; |
3238f5fe |
367 | } else { |
3238f5fe |
368 | $ok = $result eq $expected; |
369 | } |
8b3be1d1 |
370 | } |
f2ac83ee |
371 | my $todo = $todo{$ntest}; |
372 | if ($todo and $ok) { |
373 | $context .= ' TODO?!' if $todo; |
374 | print $TESTOUT "ok $ntest # ($context)\n"; |
8b3be1d1 |
375 | } else { |
809908f7 |
376 | # Issuing two seperate prints() causes problems on VMS. |
377 | if (!$ok) { |
378 | print $TESTOUT "not ok $ntest\n"; |
e5420382 |
379 | } |
809908f7 |
380 | else { |
381 | print $TESTOUT "ok $ntest\n"; |
e5420382 |
382 | } |
8b3be1d1 |
383 | |
384 | if (!$ok) { |
385 | my $detail = { 'repetition' => $repetition, 'package' => $pkg, |
f2ac83ee |
386 | 'result' => $result, 'todo' => $todo }; |
8b3be1d1 |
387 | $$detail{expected} = $expected if defined $expected; |
809908f7 |
388 | |
389 | # Get the user's diagnostic, protecting against multi-line |
390 | # diagnostics. |
391 | $diag = $$detail{diagnostic} = _to_value(shift) if @_; |
392 | $diag =~ s/\n/\n#/g if defined $diag; |
393 | |
f2ac83ee |
394 | $context .= ' *TODO*' if $todo; |
26bf6773 |
395 | if (!$compare) { |
3238f5fe |
396 | if (!$diag) { |
711cdd39 |
397 | print $TESTERR "# Failed test $ntest in $context\n"; |
3238f5fe |
398 | } else { |
711cdd39 |
399 | print $TESTERR "# Failed test $ntest in $context: $diag\n"; |
3238f5fe |
400 | } |
8b3be1d1 |
401 | } else { |
402 | my $prefix = "Test $ntest"; |
711cdd39 |
403 | print $TESTERR "# $prefix got: ". |
59e80644 |
404 | (defined $result? "'$result'":'<UNDEF>')." ($context)\n"; |
8b3be1d1 |
405 | $prefix = ' ' x (length($prefix) - 5); |
809908f7 |
406 | if (defined $regex) { |
407 | $expected = 'qr{'.$regex.'}'; |
408 | } |
26bf6773 |
409 | elsif (defined $expected) { |
f2ac83ee |
410 | $expected = "'$expected'"; |
411 | } |
26bf6773 |
412 | else { |
413 | $expected = '<UNDEF>'; |
414 | } |
8b3be1d1 |
415 | if (!$diag) { |
711cdd39 |
416 | print $TESTERR "# $prefix Expected: $expected\n"; |
3238f5fe |
417 | } else { |
711cdd39 |
418 | print $TESTERR "# $prefix Expected: $expected ($diag)\n"; |
3238f5fe |
419 | } |
420 | } |
75fa620a |
421 | |
422 | if(defined $Program_Lines{$file}[$line]) { |
423 | print $TESTERR |
424 | "# $file line $line is: $Program_Lines{$file}[$line]\n" |
425 | if |
426 | $Program_Lines{$file}[$line] =~ m/[^\s\#\(\)\{\}\[\]\;]/ |
427 | # Otherwise it's a pretty uninteresting line! |
428 | ; |
429 | |
430 | undef $Program_Lines{$file}[$line]; |
431 | # So we won't repeat it. |
432 | } |
433 | |
8b3be1d1 |
434 | push @FAILDETAIL, $detail; |
7b13a3f5 |
435 | } |
7b13a3f5 |
436 | } |
437 | ++ $ntest; |
438 | $ok; |
439 | } |
440 | |
75fa620a |
441 | =item C<skip(I<skip_if_true>, I<args...>)> |
442 | |
443 | This is used for tests that under some conditions can be skipped. It's |
444 | basically equivalent to: |
445 | |
446 | if( $skip_if_true ) { |
447 | ok(1); |
448 | } else { |
449 | ok( args... ); |
450 | } |
451 | |
452 | ...except that the C<ok(1)> emits not just "C<ok I<testnum>>" but |
453 | actually "C<ok I<testnum> # I<skip_if_true_value>>". |
454 | |
455 | The arguments after the I<skip_if_true> are what is fed to C<ok(...)> if |
456 | this test isn't skipped. |
457 | |
458 | Example usage: |
459 | |
460 | my $if_MSWin = |
461 | $^O eq 'MSWin' ? 'Skip if under MSWin' : ''; |
462 | |
463 | # A test to be run EXCEPT under MSWin: |
464 | skip($if_MSWin, thing($foo), thing($bar) ); |
465 | |
466 | Or, going the other way: |
467 | |
468 | my $unless_MSWin = |
469 | $^O eq 'MSWin' ? 'Skip unless under MSWin' : ''; |
470 | |
471 | # A test to be run EXCEPT under MSWin: |
472 | skip($unless_MSWin, thing($foo), thing($bar) ); |
473 | |
26bf6773 |
474 | The tricky thing to remember is that the first parameter is true if |
75fa620a |
475 | you want to I<skip> the test, not I<run> it; and it also doubles as a |
476 | note about why it's being skipped. So in the first codeblock above, read |
477 | the code as "skip if MSWin -- (otherwise) test whether C<thing($foo)> is |
478 | C<thing($bar)>" or for the second case, "skip unless MSWin...". |
479 | |
480 | Also, when your I<skip_if_reason> string is true, it really should (for |
481 | backwards compatibility with older Test.pm versions) start with the |
482 | string "Skip", as shown in the above examples. |
483 | |
484 | Note that in the above cases, C<thing($foo)> and C<thing($bar)> |
485 | I<are> evaluated -- but as long as the C<skip_if_true> is true, |
486 | then we C<skip(...)> just tosses out their value (i.e., not |
487 | bothering to treat them like values to C<ok(...)>. But if |
488 | you need to I<not> eval the arguments when skipping the |
489 | test, use |
490 | this format: |
491 | |
492 | skip( $unless_MSWin, |
493 | sub { |
494 | # This code returns true if the test passes. |
495 | # (But it doesn't even get called if the test is skipped.) |
496 | thing($foo) eq thing($bar) |
497 | } |
498 | ); |
499 | |
500 | or even this, which is basically equivalent: |
501 | |
502 | skip( $unless_MSWin, |
503 | sub { thing($foo) }, sub { thing($bar) } |
504 | ); |
505 | |
506 | That is, both are like this: |
507 | |
508 | if( $unless_MSWin ) { |
509 | ok(1); # but it actually appends "# $unless_MSWin" |
510 | # so that Test::Harness can tell it's a skip |
511 | } else { |
512 | # Not skipping, so actually call and evaluate... |
513 | ok( sub { thing($foo) }, sub { thing($bar) } ); |
514 | } |
515 | |
516 | =cut |
517 | |
809908f7 |
518 | sub skip ($;$$$) { |
519 | local($\, $,); # guard against -l and other things that screw with |
520 | # print |
521 | |
522 | my $whyskip = _to_value(shift); |
523 | if (!@_ or $whyskip) { |
524 | $whyskip = '' if $whyskip =~ m/^\d+$/; |
525 | $whyskip =~ s/^[Ss]kip(?:\s+|$)//; # backwards compatibility, old |
526 | # versions required the reason |
527 | # to start with 'skip' |
528 | # We print in one shot for VMSy reasons. |
529 | my $ok = "ok $ntest # skip"; |
530 | $ok .= " $whyskip" if length $whyskip; |
531 | $ok .= "\n"; |
532 | print $TESTOUT $ok; |
533 | ++ $ntest; |
534 | return 1; |
7b13a3f5 |
535 | } else { |
809908f7 |
536 | # backwards compatiblity (I think). skip() used to be |
316cf57b |
537 | # called like ok(), which is weird. I haven't decided what to do with |
538 | # this yet. |
539 | # warn <<WARN if $^W; |
540 | #This looks like a skip() using the very old interface. Please upgrade to |
541 | #the documented interface as this has been deprecated. |
542 | #WARN |
809908f7 |
543 | |
75fa620a |
544 | local($TestLevel) = $TestLevel+1; #to ignore this stack frame |
809908f7 |
545 | return &ok(@_); |
7b13a3f5 |
546 | } |
547 | } |
548 | |
809908f7 |
549 | =back |
550 | |
551 | =cut |
552 | |
8b3be1d1 |
553 | END { |
554 | $ONFAIL->(\@FAILDETAIL) if @FAILDETAIL && $ONFAIL; |
555 | } |
556 | |
7b13a3f5 |
557 | 1; |
558 | __END__ |
559 | |
3238f5fe |
560 | =head1 TEST TYPES |
7b13a3f5 |
561 | |
562 | =over 4 |
563 | |
564 | =item * NORMAL TESTS |
565 | |
75fa620a |
566 | These tests are expected to succeed. Usually, most or all of your tests |
567 | are in this category. If a normal test doesn't succeed, then that |
568 | means that something is I<wrong>. |
7b13a3f5 |
569 | |
570 | =item * SKIPPED TESTS |
571 | |
75fa620a |
572 | The C<skip(...)> function is for tests that might or might not be |
573 | possible to run, depending |
574 | on the availability of platform-specific features. The first argument |
f2ac83ee |
575 | should evaluate to true (think "yes, please skip") if the required |
75fa620a |
576 | feature is I<not> available. After the first argument, C<skip(...)> works |
577 | exactly the same way as C<ok(...)> does. |
7b13a3f5 |
578 | |
579 | =item * TODO TESTS |
580 | |
f2ac83ee |
581 | TODO tests are designed for maintaining an B<executable TODO list>. |
75fa620a |
582 | These tests are I<expected to fail.> If a TODO test does succeed, |
583 | then the feature in question shouldn't be on the TODO list, now |
584 | should it? |
7b13a3f5 |
585 | |
f2ac83ee |
586 | Packages should NOT be released with succeeding TODO tests. As soon |
75fa620a |
587 | as a TODO test starts working, it should be promoted to a normal test, |
f2ac83ee |
588 | and the newly working feature should be documented in the release |
75fa620a |
589 | notes or in the change log. |
7b13a3f5 |
590 | |
591 | =back |
592 | |
8b3be1d1 |
593 | =head1 ONFAIL |
594 | |
595 | BEGIN { plan test => 4, onfail => sub { warn "CALL 911!" } } |
596 | |
75fa620a |
597 | Although test failures should be enough, extra diagnostics can be |
f2ac83ee |
598 | triggered at the end of a test run. C<onfail> is passed an array ref |
599 | of hash refs that describe each test failure. Each hash will contain |
600 | at least the following fields: C<package>, C<repetition>, and |
601 | C<result>. (The file, line, and test number are not included because |
f610777f |
602 | their correspondence to a particular test is tenuous.) If the test |
75fa620a |
603 | had an expected value or a diagnostic (or "note") string, these will also be |
f2ac83ee |
604 | included. |
605 | |
75fa620a |
606 | The I<optional> C<onfail> hook might be used simply to print out the |
f2ac83ee |
607 | version of your package and/or how to report problems. It might also |
608 | be used to generate extremely sophisticated diagnostics for a |
609 | particularly bizarre test failure. However it's not a panacea. Core |
610 | dumps or other unrecoverable errors prevent the C<onfail> hook from |
611 | running. (It is run inside an C<END> block.) Besides, C<onfail> is |
612 | probably over-kill in most cases. (Your test code should be simpler |
8b3be1d1 |
613 | than the code it is testing, yes?) |
614 | |
809908f7 |
615 | |
616 | =head1 BUGS and CAVEATS |
617 | |
75fa620a |
618 | =over |
619 | |
620 | =item * |
621 | |
622 | C<ok(...)>'s special handing of strings which look like they might be |
623 | regexes can also cause unexpected behavior. An innocent: |
624 | |
625 | ok( $fileglob, '/path/to/some/*stuff/' ); |
626 | |
627 | will fail, since Test.pm considers the second argument to be a regex! |
628 | The best bet is to use the one-argument form: |
629 | |
630 | ok( $fileglob eq '/path/to/some/*stuff/' ); |
809908f7 |
631 | |
75fa620a |
632 | =item * |
633 | |
634 | C<ok(...)>'s use of string C<eq> can sometimes cause odd problems |
635 | when comparing |
809908f7 |
636 | numbers, especially if you're casting a string to a number: |
637 | |
638 | $foo = "1.0"; |
639 | ok( $foo, 1 ); # not ok, "1.0" ne 1 |
640 | |
641 | Your best bet is to use the single argument form: |
642 | |
643 | ok( $foo == 1 ); # ok "1.0" == 1 |
644 | |
75fa620a |
645 | =item * |
809908f7 |
646 | |
75fa620a |
647 | As you may have inferred from the above documentation and examples, |
648 | C<ok>'s prototype is C<($;$$)> (and, incidentally, C<skip>'s is |
649 | C<($;$$$)>). This means, for example, that you can do C<ok @foo, @bar> |
650 | to compare the I<size> of the two arrays. But don't be fooled into |
651 | thinking that C<ok @foo, @bar> means a comparison of the contents of two |
652 | arrays -- you're comparing I<just> the number of elements of each. It's |
653 | so easy to make that mistake in reading C<ok @foo, @bar> that you might |
654 | want to be very explicit about it, and instead write C<ok scalar(@foo), |
655 | scalar(@bar)>. |
809908f7 |
656 | |
26bf6773 |
657 | =item * |
658 | |
659 | This almost definitely doesn't do what you expect: |
660 | |
661 | ok $thingy->can('some_method'); |
662 | |
663 | Why? Because C<can> returns a coderef to mean "yes it can (and the |
664 | method is this...)", and then C<ok> sees a coderef and thinks you're |
665 | passing a function that you want it to call and consider the truth of |
666 | the result of! I.e., just like: |
667 | |
668 | ok $thingy->can('some_method')->(); |
669 | |
670 | What you probably want instead is this: |
671 | |
672 | ok $thingy->can('some_method') && 1; |
673 | |
674 | If the C<can> returns false, then that is passed to C<ok>. If it |
675 | returns true, then the larger expression S<< C<< |
676 | $thingy->can('some_method') && 1 >> >> returns 1, which C<ok> sees as |
677 | a simple signal of success, as you would expect. |
678 | |
679 | |
680 | =item * |
681 | |
682 | The syntax for C<skip> is about the only way it can be, but it's still |
683 | quite confusing. Just start with the above examples and you'll |
684 | be okay. |
685 | |
686 | Moreover, users may expect this: |
687 | |
688 | skip $unless_mswin, foo($bar), baz($quux); |
689 | |
690 | to not evaluate C<foo($bar)> and C<baz($quux)> when the test is being |
691 | skipped. But in reality, they I<are> evaluated, but C<skip> just won't |
692 | bother comparing them if C<$unless_mswin> is true. |
693 | |
694 | You could do this: |
695 | |
696 | skip $unless_mswin, sub{foo($bar)}, sub{baz($quux)}; |
697 | |
698 | But that's not terribly pretty. You may find it simpler or clearer in |
699 | the long run to just do things like this: |
700 | |
701 | if( $^O =~ m/MSWin/ ) { |
702 | print "# Yay, we're under $^O\n"; |
703 | ok foo($bar), baz($quux); |
704 | ok thing($whatever), baz($stuff); |
705 | ok blorp($quux, $whatever); |
706 | ok foo($barzbarz), thang($quux); |
707 | } else { |
708 | print "# Feh, we're under $^O. Watch me skip some tests...\n"; |
709 | for(1 .. 4) { skip "Skip unless under MSWin" } |
710 | } |
711 | |
712 | But be quite sure that C<ok> is called exactly as many times in the |
713 | first block as C<skip> is called in the second block. |
714 | |
75fa620a |
715 | =back |
809908f7 |
716 | |
711cdd39 |
717 | =head1 NOTE |
809908f7 |
718 | |
75fa620a |
719 | A past developer of this module once said that it was no longer being |
720 | actively developed. However, rumors of its demise were greatly |
721 | exaggerated. Feedback and suggestions are quite welcome. |
722 | |
723 | Be aware that the main value of this module is its simplicity. Note |
724 | that there are already more ambitious modules out there, such as |
725 | L<Test::More> and L<Test::Unit>. |
809908f7 |
726 | |
727 | |
7b13a3f5 |
728 | =head1 SEE ALSO |
729 | |
75fa620a |
730 | L<Test::Harness> |
731 | |
732 | L<Test::Simple>, L<Test::More>, L<Devel::Cover> |
809908f7 |
733 | |
711cdd39 |
734 | L<Test::Builder> for building your own testing library. |
735 | |
736 | L<Test::Unit> is an interesting XUnit-style testing library. |
809908f7 |
737 | |
711cdd39 |
738 | L<Test::Inline> and L<SelfTest> let you embed tests in code. |
edd5bad5 |
739 | |
7b13a3f5 |
740 | |
741 | =head1 AUTHOR |
742 | |
809908f7 |
743 | Copyright (c) 1998-2000 Joshua Nathaniel Pritikin. All rights reserved. |
809908f7 |
744 | |
75fa620a |
745 | Copyright (c) 2001-2002 Michael G. Schwern. |
746 | |
8d806c1c |
747 | Copyright (c) 2002-2003 Sean M. Burke. |
75fa620a |
748 | |
749 | Current maintainer: Sean M. Burke. E<lt>sburke@cpan.orgE<gt> |
7b13a3f5 |
750 | |
751 | This package is free software and is provided "as is" without express |
752 | or implied warranty. It may be used, redistributed and/or modified |
711cdd39 |
753 | under the same terms as Perl itself. |
7b13a3f5 |
754 | |
755 | =cut |
75fa620a |
756 | |
757 | # "Your mistake was a hidden intention." |
758 | # -- /Oblique Strategies/, Brian Eno and Peter Schmidt |