Commit | Line | Data |
3f2ec160 |
1 | package Test::More; |
2 | |
d020a79a |
3 | use 5.004; |
3f2ec160 |
4 | |
d020a79a |
5 | use strict; |
33459055 |
6 | use Test::Builder; |
3f2ec160 |
7 | |
33459055 |
8 | |
9 | # Can't use Carp because it might cause use_ok() to accidentally succeed |
10 | # even though the module being used forgot to use Carp. Yes, this |
11 | # actually happened. |
12 | sub _carp { |
13 | my($file, $line) = (caller(1))[1,2]; |
a9153838 |
14 | warn @_, " at $file line $line\n"; |
3f2ec160 |
15 | } |
16 | |
33459055 |
17 | |
18 | |
3f2ec160 |
19 | require Exporter; |
33459055 |
20 | use vars qw($VERSION @ISA @EXPORT %EXPORT_TAGS $TODO); |
30e302f8 |
21 | $VERSION = '0.50'; |
3f2ec160 |
22 | @ISA = qw(Exporter); |
23 | @EXPORT = qw(ok use_ok require_ok |
a9153838 |
24 | is isnt like unlike is_deeply |
25 | cmp_ok |
26 | skip todo todo_skip |
3f2ec160 |
27 | pass fail |
de2dd90a |
28 | eq_array eq_hash eq_set |
d020a79a |
29 | $TODO |
30 | plan |
31 | can_ok isa_ok |
a9153838 |
32 | diag |
3f2ec160 |
33 | ); |
34 | |
33459055 |
35 | my $Test = Test::Builder->new; |
30e302f8 |
36 | my $Show_Diag = 1; |
3f2ec160 |
37 | |
3f2ec160 |
38 | |
39 | # 5.004's Exporter doesn't have export_to_level. |
40 | sub _export_to_level |
41 | { |
42 | my $pkg = shift; |
43 | my $level = shift; |
a9153838 |
44 | (undef) = shift; # redundant arg |
3f2ec160 |
45 | my $callpkg = caller($level); |
46 | $pkg->export($callpkg, @_); |
47 | } |
48 | |
49 | |
50 | =head1 NAME |
51 | |
52 | Test::More - yet another framework for writing test scripts |
53 | |
54 | =head1 SYNOPSIS |
55 | |
56 | use Test::More tests => $Num_Tests; |
57 | # or |
58 | use Test::More qw(no_plan); |
59 | # or |
d020a79a |
60 | use Test::More skip_all => $reason; |
3f2ec160 |
61 | |
62 | BEGIN { use_ok( 'Some::Module' ); } |
63 | require_ok( 'Some::Module' ); |
64 | |
65 | # Various ways to say "ok" |
66 | ok($this eq $that, $test_name); |
67 | |
68 | is ($this, $that, $test_name); |
69 | isnt($this, $that, $test_name); |
a9153838 |
70 | |
71 | # Rather than print STDERR "# here's what went wrong\n" |
72 | diag("here's what went wrong"); |
73 | |
74 | like ($this, qr/that/, $test_name); |
75 | unlike($this, qr/that/, $test_name); |
76 | |
77 | cmp_ok($this, '==', $that, $test_name); |
3f2ec160 |
78 | |
33459055 |
79 | is_deeply($complex_structure1, $complex_structure2, $test_name); |
80 | |
d020a79a |
81 | SKIP: { |
82 | skip $why, $how_many unless $have_some_feature; |
83 | |
3f2ec160 |
84 | ok( foo(), $test_name ); |
85 | is( foo(42), 23, $test_name ); |
d020a79a |
86 | }; |
87 | |
88 | TODO: { |
89 | local $TODO = $why; |
3f2ec160 |
90 | |
3f2ec160 |
91 | ok( foo(), $test_name ); |
92 | is( foo(42), 23, $test_name ); |
d020a79a |
93 | }; |
94 | |
95 | can_ok($module, @methods); |
96 | isa_ok($object, $class); |
3f2ec160 |
97 | |
98 | pass($test_name); |
99 | fail($test_name); |
100 | |
101 | # Utility comparison functions. |
102 | eq_array(\@this, \@that); |
103 | eq_hash(\%this, \%that); |
104 | eq_set(\@this, \@that); |
105 | |
106 | # UNIMPLEMENTED!!! |
107 | my @status = Test::More::status; |
108 | |
d020a79a |
109 | # UNIMPLEMENTED!!! |
110 | BAIL_OUT($why); |
111 | |
3f2ec160 |
112 | |
113 | =head1 DESCRIPTION |
114 | |
a9153838 |
115 | B<STOP!> If you're just getting started writing tests, have a look at |
d020a79a |
116 | Test::Simple first. This is a drop in replacement for Test::Simple |
117 | which you can switch to once you get the hang of basic testing. |
3f2ec160 |
118 | |
a9153838 |
119 | The purpose of this module is to provide a wide range of testing |
120 | utilities. Various ways to say "ok" with better diagnostics, |
121 | facilities to skip tests, test future features and compare complicated |
122 | data structures. While you can do almost anything with a simple |
123 | C<ok()> function, it doesn't provide good diagnostic output. |
3f2ec160 |
124 | |
125 | |
126 | =head2 I love it when a plan comes together |
127 | |
128 | Before anything else, you need a testing plan. This basically declares |
129 | how many tests your script is going to run to protect against premature |
130 | failure. |
131 | |
4bd4e70a |
132 | The preferred way to do this is to declare a plan when you C<use Test::More>. |
3f2ec160 |
133 | |
134 | use Test::More tests => $Num_Tests; |
135 | |
136 | There are rare cases when you will not know beforehand how many tests |
137 | your script is going to run. In this case, you can declare that you |
138 | have no plan. (Try to avoid using this as it weakens your test.) |
139 | |
140 | use Test::More qw(no_plan); |
141 | |
30e302f8 |
142 | B<NOTE>: using no_plan requires a Test::Harness upgrade else it will |
143 | think everything has failed. See L<BUGS and CAVEATS>) |
144 | |
3f2ec160 |
145 | In some cases, you'll want to completely skip an entire testing script. |
146 | |
d020a79a |
147 | use Test::More skip_all => $skip_reason; |
3f2ec160 |
148 | |
d020a79a |
149 | Your script will declare a skip with the reason why you skipped and |
150 | exit immediately with a zero (success). See L<Test::Harness> for |
151 | details. |
3f2ec160 |
152 | |
33459055 |
153 | If you want to control what functions Test::More will export, you |
154 | have to use the 'import' option. For example, to import everything |
155 | but 'fail', you'd do: |
156 | |
157 | use Test::More tests => 23, import => ['!fail']; |
158 | |
159 | Alternatively, you can use the plan() function. Useful for when you |
160 | have to calculate the number of tests. |
161 | |
162 | use Test::More; |
163 | plan tests => keys %Stuff * 3; |
164 | |
165 | or for deciding between running the tests at all: |
166 | |
167 | use Test::More; |
168 | if( $^O eq 'MacOS' ) { |
4bd4e70a |
169 | plan skip_all => 'Test irrelevant on MacOS'; |
33459055 |
170 | } |
171 | else { |
172 | plan tests => 42; |
173 | } |
174 | |
175 | =cut |
176 | |
177 | sub plan { |
178 | my(@plan) = @_; |
179 | |
180 | my $caller = caller; |
181 | |
182 | $Test->exported_to($caller); |
33459055 |
183 | |
30e302f8 |
184 | my @cleaned_plan; |
33459055 |
185 | my @imports = (); |
30e302f8 |
186 | my $idx = 0; |
187 | while( $idx <= $#plan ) { |
33459055 |
188 | if( $plan[$idx] eq 'import' ) { |
30e302f8 |
189 | @imports = @{$plan[$idx+1]}; |
190 | $idx += 2; |
191 | } |
192 | elsif( $plan[$idx] eq 'no_diag' ) { |
193 | $Show_Diag = 0; |
194 | $idx++; |
195 | } |
196 | else { |
197 | push @cleaned_plan, $plan[$idx]; |
198 | $idx++; |
33459055 |
199 | } |
200 | } |
201 | |
30e302f8 |
202 | $Test->plan(@cleaned_plan); |
89c1e84a |
203 | |
33459055 |
204 | __PACKAGE__->_export_to_level(1, __PACKAGE__, @imports); |
205 | } |
206 | |
207 | sub import { |
208 | my($class) = shift; |
209 | goto &plan; |
210 | } |
211 | |
3f2ec160 |
212 | |
213 | =head2 Test names |
214 | |
215 | By convention, each test is assigned a number in order. This is |
6686786d |
216 | largely done automatically for you. However, it's often very useful to |
3f2ec160 |
217 | assign a name to each test. Which would you rather see: |
218 | |
219 | ok 4 |
220 | not ok 5 |
221 | ok 6 |
222 | |
223 | or |
224 | |
225 | ok 4 - basic multi-variable |
226 | not ok 5 - simple exponential |
227 | ok 6 - force == mass * acceleration |
228 | |
229 | The later gives you some idea of what failed. It also makes it easier |
230 | to find the test in your script, simply search for "simple |
231 | exponential". |
232 | |
6686786d |
233 | All test functions take a name argument. It's optional, but highly |
3f2ec160 |
234 | suggested that you use it. |
235 | |
236 | |
237 | =head2 I'm ok, you're not ok. |
238 | |
239 | The basic purpose of this module is to print out either "ok #" or "not |
240 | ok #" depending on if a given test succeeded or failed. Everything |
241 | else is just gravy. |
242 | |
243 | All of the following print "ok" or "not ok" depending on if the test |
244 | succeeded or failed. They all also return true or false, |
245 | respectively. |
246 | |
247 | =over 4 |
248 | |
249 | =item B<ok> |
250 | |
251 | ok($this eq $that, $test_name); |
252 | |
253 | This simply evaluates any expression (C<$this eq $that> is just a |
254 | simple example) and uses that to determine if the test succeeded or |
255 | failed. A true expression passes, a false one fails. Very simple. |
256 | |
257 | For example: |
258 | |
259 | ok( $exp{9} == 81, 'simple exponential' ); |
260 | ok( Film->can('db_Main'), 'set_db()' ); |
261 | ok( $p->tests == 4, 'saw tests' ); |
262 | ok( !grep !defined $_, @items, 'items populated' ); |
263 | |
264 | (Mnemonic: "This is ok.") |
265 | |
266 | $test_name is a very short description of the test that will be printed |
267 | out. It makes it very easy to find a test in your script when it fails |
268 | and gives others an idea of your intentions. $test_name is optional, |
269 | but we B<very> strongly encourage its use. |
270 | |
271 | Should an ok() fail, it will produce some diagnostics: |
272 | |
273 | not ok 18 - sufficient mucus |
274 | # Failed test 18 (foo.t at line 42) |
275 | |
276 | This is actually Test::Simple's ok() routine. |
277 | |
278 | =cut |
279 | |
33459055 |
280 | sub ok ($;$) { |
281 | my($test, $name) = @_; |
282 | $Test->ok($test, $name); |
283 | } |
3f2ec160 |
284 | |
285 | =item B<is> |
286 | |
287 | =item B<isnt> |
288 | |
289 | is ( $this, $that, $test_name ); |
290 | isnt( $this, $that, $test_name ); |
291 | |
d020a79a |
292 | Similar to ok(), is() and isnt() compare their two arguments |
293 | with C<eq> and C<ne> respectively and use the result of that to |
294 | determine if the test succeeded or failed. So these: |
3f2ec160 |
295 | |
296 | # Is the ultimate answer 42? |
297 | is( ultimate_answer(), 42, "Meaning of Life" ); |
298 | |
299 | # $foo isn't empty |
300 | isnt( $foo, '', "Got some foo" ); |
301 | |
302 | are similar to these: |
303 | |
304 | ok( ultimate_answer() eq 42, "Meaning of Life" ); |
305 | ok( $foo ne '', "Got some foo" ); |
306 | |
307 | (Mnemonic: "This is that." "This isn't that.") |
308 | |
309 | So why use these? They produce better diagnostics on failure. ok() |
310 | cannot know what you are testing for (beyond the name), but is() and |
311 | isnt() know what the test was and why it failed. For example this |
d020a79a |
312 | test: |
3f2ec160 |
313 | |
314 | my $foo = 'waffle'; my $bar = 'yarblokos'; |
315 | is( $foo, $bar, 'Is foo the same as bar?' ); |
316 | |
317 | Will produce something like this: |
318 | |
319 | not ok 17 - Is foo the same as bar? |
60ffb308 |
320 | # Failed test (foo.t at line 139) |
3f2ec160 |
321 | # got: 'waffle' |
322 | # expected: 'yarblokos' |
323 | |
324 | So you can figure out what went wrong without rerunning the test. |
325 | |
326 | You are encouraged to use is() and isnt() over ok() where possible, |
327 | however do not be tempted to use them to find out if something is |
328 | true or false! |
329 | |
30e302f8 |
330 | # XXX BAD! |
331 | is( exists $brooklyn{tree}, 1, 'A tree grows in Brooklyn' ); |
3f2ec160 |
332 | |
30e302f8 |
333 | This does not check if C<exists $brooklyn{tree}> is true, it checks if |
3f2ec160 |
334 | it returns 1. Very different. Similar caveats exist for false and 0. |
335 | In these cases, use ok(). |
336 | |
30e302f8 |
337 | ok( exists $brooklyn{tree}, 'A tree grows in Brooklyn' ); |
3f2ec160 |
338 | |
d020a79a |
339 | For those grammatical pedants out there, there's an C<isn't()> |
340 | function which is an alias of isnt(). |
3f2ec160 |
341 | |
342 | =cut |
343 | |
344 | sub is ($$;$) { |
33459055 |
345 | $Test->is_eq(@_); |
3f2ec160 |
346 | } |
347 | |
348 | sub isnt ($$;$) { |
a9153838 |
349 | $Test->isnt_eq(@_); |
3f2ec160 |
350 | } |
351 | |
352 | *isn't = \&isnt; |
353 | |
354 | |
355 | =item B<like> |
356 | |
357 | like( $this, qr/that/, $test_name ); |
358 | |
359 | Similar to ok(), like() matches $this against the regex C<qr/that/>. |
360 | |
361 | So this: |
362 | |
363 | like($this, qr/that/, 'this is like that'); |
364 | |
365 | is similar to: |
366 | |
367 | ok( $this =~ /that/, 'this is like that'); |
368 | |
369 | (Mnemonic "This is like that".) |
370 | |
371 | The second argument is a regular expression. It may be given as a |
4bd4e70a |
372 | regex reference (i.e. C<qr//>) or (for better compatibility with older |
3f2ec160 |
373 | perls) as a string that looks like a regex (alternative delimiters are |
374 | currently not supported): |
375 | |
376 | like( $this, '/that/', 'this is like that' ); |
377 | |
378 | Regex options may be placed on the end (C<'/that/i'>). |
379 | |
380 | Its advantages over ok() are similar to that of is() and isnt(). Better |
381 | diagnostics on failure. |
382 | |
383 | =cut |
384 | |
385 | sub like ($$;$) { |
33459055 |
386 | $Test->like(@_); |
3f2ec160 |
387 | } |
388 | |
a9153838 |
389 | |
390 | =item B<unlike> |
391 | |
392 | unlike( $this, qr/that/, $test_name ); |
393 | |
394 | Works exactly as like(), only it checks if $this B<does not> match the |
395 | given pattern. |
396 | |
397 | =cut |
398 | |
30e302f8 |
399 | sub unlike ($$;$) { |
a9153838 |
400 | $Test->unlike(@_); |
401 | } |
402 | |
403 | |
404 | =item B<cmp_ok> |
405 | |
406 | cmp_ok( $this, $op, $that, $test_name ); |
407 | |
408 | Halfway between ok() and is() lies cmp_ok(). This allows you to |
409 | compare two arguments using any binary perl operator. |
410 | |
411 | # ok( $this eq $that ); |
412 | cmp_ok( $this, 'eq', $that, 'this eq that' ); |
413 | |
414 | # ok( $this == $that ); |
415 | cmp_ok( $this, '==', $that, 'this == that' ); |
416 | |
417 | # ok( $this && $that ); |
30e302f8 |
418 | cmp_ok( $this, '&&', $that, 'this && that' ); |
a9153838 |
419 | ...etc... |
420 | |
421 | Its advantage over ok() is when the test fails you'll know what $this |
422 | and $that were: |
423 | |
424 | not ok 1 |
425 | # Failed test (foo.t at line 12) |
426 | # '23' |
427 | # && |
428 | # undef |
429 | |
6686786d |
430 | It's also useful in those cases where you are comparing numbers and |
a9153838 |
431 | is()'s use of C<eq> will interfere: |
432 | |
433 | cmp_ok( $big_hairy_number, '==', $another_big_hairy_number ); |
434 | |
435 | =cut |
436 | |
437 | sub cmp_ok($$$;$) { |
438 | $Test->cmp_ok(@_); |
439 | } |
440 | |
441 | |
d020a79a |
442 | =item B<can_ok> |
443 | |
444 | can_ok($module, @methods); |
445 | can_ok($object, @methods); |
446 | |
447 | Checks to make sure the $module or $object can do these @methods |
448 | (works with functions, too). |
449 | |
450 | can_ok('Foo', qw(this that whatever)); |
451 | |
452 | is almost exactly like saying: |
453 | |
454 | ok( Foo->can('this') && |
455 | Foo->can('that') && |
456 | Foo->can('whatever') |
457 | ); |
458 | |
459 | only without all the typing and with a better interface. Handy for |
460 | quickly testing an interface. |
461 | |
a9153838 |
462 | No matter how many @methods you check, a single can_ok() call counts |
463 | as one test. If you desire otherwise, use: |
464 | |
465 | foreach my $meth (@methods) { |
466 | can_ok('Foo', $meth); |
467 | } |
468 | |
d020a79a |
469 | =cut |
470 | |
471 | sub can_ok ($@) { |
472 | my($proto, @methods) = @_; |
89c1e84a |
473 | my $class = ref $proto || $proto; |
d020a79a |
474 | |
a9153838 |
475 | unless( @methods ) { |
476 | my $ok = $Test->ok( 0, "$class->can(...)" ); |
477 | $Test->diag(' can_ok() called with no methods'); |
478 | return $ok; |
479 | } |
480 | |
d020a79a |
481 | my @nok = (); |
482 | foreach my $method (@methods) { |
a9153838 |
483 | local($!, $@); # don't interfere with caller's $@ |
484 | # eval sometimes resets $! |
89c1e84a |
485 | eval { $proto->can($method) } || push @nok, $method; |
d020a79a |
486 | } |
487 | |
488 | my $name; |
6686786d |
489 | $name = @methods == 1 ? "$class->can('$methods[0]')" |
d020a79a |
490 | : "$class->can(...)"; |
491 | |
33459055 |
492 | my $ok = $Test->ok( !@nok, $name ); |
d020a79a |
493 | |
a9153838 |
494 | $Test->diag(map " $class->can('$_') failed\n", @nok); |
d020a79a |
495 | |
33459055 |
496 | return $ok; |
d020a79a |
497 | } |
498 | |
499 | =item B<isa_ok> |
500 | |
33459055 |
501 | isa_ok($object, $class, $object_name); |
a9153838 |
502 | isa_ok($ref, $type, $ref_name); |
d020a79a |
503 | |
30e302f8 |
504 | Checks to see if the given C<< $object->isa($class) >>. Also checks to make |
d020a79a |
505 | sure the object was defined in the first place. Handy for this sort |
506 | of thing: |
507 | |
508 | my $obj = Some::Module->new; |
509 | isa_ok( $obj, 'Some::Module' ); |
510 | |
511 | where you'd otherwise have to write |
512 | |
513 | my $obj = Some::Module->new; |
514 | ok( defined $obj && $obj->isa('Some::Module') ); |
515 | |
516 | to safeguard against your test script blowing up. |
517 | |
a9153838 |
518 | It works on references, too: |
519 | |
520 | isa_ok( $array_ref, 'ARRAY' ); |
521 | |
33459055 |
522 | The diagnostics of this test normally just refer to 'the object'. If |
523 | you'd like them to be more specific, you can supply an $object_name |
524 | (for example 'Test customer'). |
525 | |
d020a79a |
526 | =cut |
527 | |
33459055 |
528 | sub isa_ok ($$;$) { |
529 | my($object, $class, $obj_name) = @_; |
d020a79a |
530 | |
531 | my $diag; |
33459055 |
532 | $obj_name = 'The object' unless defined $obj_name; |
533 | my $name = "$obj_name isa $class"; |
d020a79a |
534 | if( !defined $object ) { |
33459055 |
535 | $diag = "$obj_name isn't defined"; |
d020a79a |
536 | } |
537 | elsif( !ref $object ) { |
33459055 |
538 | $diag = "$obj_name isn't a reference"; |
d020a79a |
539 | } |
a9153838 |
540 | else { |
541 | # We can't use UNIVERSAL::isa because we want to honor isa() overrides |
542 | local($@, $!); # eval sometimes resets $! |
543 | my $rslt = eval { $object->isa($class) }; |
544 | if( $@ ) { |
545 | if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) { |
546 | if( !UNIVERSAL::isa($object, $class) ) { |
547 | my $ref = ref $object; |
6686786d |
548 | $diag = "$obj_name isn't a '$class' it's a '$ref'"; |
a9153838 |
549 | } |
550 | } else { |
551 | die <<WHOA; |
552 | WHOA! I tried to call ->isa on your object and got some weird error. |
553 | This should never happen. Please contact the author immediately. |
554 | Here's the error. |
555 | $@ |
556 | WHOA |
557 | } |
558 | } |
559 | elsif( !$rslt ) { |
560 | my $ref = ref $object; |
6686786d |
561 | $diag = "$obj_name isn't a '$class' it's a '$ref'"; |
a9153838 |
562 | } |
d020a79a |
563 | } |
a9153838 |
564 | |
565 | |
d020a79a |
566 | |
33459055 |
567 | my $ok; |
d020a79a |
568 | if( $diag ) { |
33459055 |
569 | $ok = $Test->ok( 0, $name ); |
a9153838 |
570 | $Test->diag(" $diag\n"); |
d020a79a |
571 | } |
572 | else { |
33459055 |
573 | $ok = $Test->ok( 1, $name ); |
d020a79a |
574 | } |
33459055 |
575 | |
576 | return $ok; |
d020a79a |
577 | } |
578 | |
579 | |
3f2ec160 |
580 | =item B<pass> |
581 | |
582 | =item B<fail> |
583 | |
584 | pass($test_name); |
585 | fail($test_name); |
586 | |
587 | Sometimes you just want to say that the tests have passed. Usually |
588 | the case is you've got some complicated condition that is difficult to |
589 | wedge into an ok(). In this case, you can simply use pass() (to |
590 | declare the test ok) or fail (for not ok). They are synonyms for |
591 | ok(1) and ok(0). |
592 | |
593 | Use these very, very, very sparingly. |
594 | |
595 | =cut |
596 | |
d020a79a |
597 | sub pass (;$) { |
33459055 |
598 | $Test->ok(1, @_); |
3f2ec160 |
599 | } |
600 | |
d020a79a |
601 | sub fail (;$) { |
33459055 |
602 | $Test->ok(0, @_); |
3f2ec160 |
603 | } |
604 | |
605 | =back |
606 | |
a9153838 |
607 | =head2 Diagnostics |
608 | |
609 | If you pick the right test function, you'll usually get a good idea of |
610 | what went wrong when it failed. But sometimes it doesn't work out |
611 | that way. So here we have ways for you to write your own diagnostic |
612 | messages which are safer than just C<print STDERR>. |
613 | |
614 | =over 4 |
615 | |
616 | =item B<diag> |
617 | |
618 | diag(@diagnostic_message); |
619 | |
620 | Prints a diagnostic message which is guaranteed not to interfere with |
621 | test output. Handy for this sort of thing: |
622 | |
623 | ok( grep(/foo/, @users), "There's a foo user" ) or |
624 | diag("Since there's no foo, check that /etc/bar is set up right"); |
625 | |
626 | which would produce: |
627 | |
628 | not ok 42 - There's a foo user |
629 | # Failed test (foo.t at line 52) |
630 | # Since there's no foo, check that /etc/bar is set up right. |
631 | |
632 | You might remember C<ok() or diag()> with the mnemonic C<open() or |
633 | die()>. |
634 | |
30e302f8 |
635 | All diag()s can be made silent by passing the "no_diag" option to |
636 | Test::More. C<use Test::More tests => 1, 'no_diag'>. This is useful |
637 | if you have diagnostics for personal testing but then wish to make |
638 | them silent for release without commenting out each individual |
639 | statement. |
640 | |
a9153838 |
641 | B<NOTE> The exact formatting of the diagnostic output is still |
642 | changing, but it is guaranteed that whatever you throw at it it won't |
643 | interfere with the test. |
644 | |
645 | =cut |
646 | |
647 | sub diag { |
30e302f8 |
648 | return unless $Show_Diag; |
a9153838 |
649 | $Test->diag(@_); |
650 | } |
651 | |
652 | |
653 | =back |
654 | |
3f2ec160 |
655 | =head2 Module tests |
656 | |
657 | You usually want to test if the module you're testing loads ok, rather |
658 | than just vomiting if its load fails. For such purposes we have |
659 | C<use_ok> and C<require_ok>. |
660 | |
661 | =over 4 |
662 | |
663 | =item B<use_ok> |
664 | |
3f2ec160 |
665 | BEGIN { use_ok($module); } |
d020a79a |
666 | BEGIN { use_ok($module, @imports); } |
667 | |
668 | These simply use the given $module and test to make sure the load |
89c1e84a |
669 | happened ok. It's recommended that you run use_ok() inside a BEGIN |
d020a79a |
670 | block so its functions are exported at compile-time and prototypes are |
671 | properly honored. |
672 | |
673 | If @imports are given, they are passed through to the use. So this: |
674 | |
675 | BEGIN { use_ok('Some::Module', qw(foo bar)) } |
676 | |
677 | is like doing this: |
678 | |
679 | use Some::Module qw(foo bar); |
3f2ec160 |
680 | |
30e302f8 |
681 | Version numbers can be checked like so: |
682 | |
683 | # Just like "use Some::Module 1.02" |
684 | BEGIN { use_ok('Some::Module', 1.02) } |
685 | |
686 | Don't try to do this: |
a344be10 |
687 | |
688 | BEGIN { |
689 | use_ok('Some::Module'); |
690 | |
691 | ...some code that depends on the use... |
692 | ...happening at compile time... |
693 | } |
694 | |
30e302f8 |
695 | because the notion of "compile-time" is relative. Instead, you want: |
a344be10 |
696 | |
697 | BEGIN { use_ok('Some::Module') } |
698 | BEGIN { ...some code that depends on the use... } |
699 | |
3f2ec160 |
700 | |
701 | =cut |
702 | |
d020a79a |
703 | sub use_ok ($;@) { |
704 | my($module, @imports) = @_; |
705 | @imports = () unless @imports; |
3f2ec160 |
706 | |
30e302f8 |
707 | my($pack,$filename,$line) = caller; |
3f2ec160 |
708 | |
a9153838 |
709 | local($@,$!); # eval sometimes interferes with $! |
30e302f8 |
710 | |
711 | if( @imports == 1 and $imports[0] =~ /^\d+(?:\.\d+)?$/ ) { |
712 | # probably a version check. Perl needs to see the bare number |
713 | # for it to work with non-Exporter based modules. |
714 | eval <<USE; |
3f2ec160 |
715 | package $pack; |
30e302f8 |
716 | use $module $imports[0]; |
3f2ec160 |
717 | USE |
30e302f8 |
718 | } |
719 | else { |
720 | eval <<USE; |
721 | package $pack; |
722 | use $module \@imports; |
723 | USE |
724 | } |
3f2ec160 |
725 | |
33459055 |
726 | my $ok = $Test->ok( !$@, "use $module;" ); |
3f2ec160 |
727 | |
728 | unless( $ok ) { |
0cd946aa |
729 | chomp $@; |
30e302f8 |
730 | $@ =~ s{^BEGIN failed--compilation aborted at .*$} |
731 | {BEGIN failed--compilation aborted at $filename line $line.}m; |
33459055 |
732 | $Test->diag(<<DIAGNOSTIC); |
a9153838 |
733 | Tried to use '$module'. |
734 | Error: $@ |
3f2ec160 |
735 | DIAGNOSTIC |
736 | |
737 | } |
738 | |
739 | return $ok; |
740 | } |
741 | |
d020a79a |
742 | =item B<require_ok> |
743 | |
744 | require_ok($module); |
745 | |
746 | Like use_ok(), except it requires the $module. |
747 | |
748 | =cut |
3f2ec160 |
749 | |
750 | sub require_ok ($) { |
751 | my($module) = shift; |
752 | |
753 | my $pack = caller; |
754 | |
a9153838 |
755 | local($!, $@); # eval sometimes interferes with $! |
3f2ec160 |
756 | eval <<REQUIRE; |
757 | package $pack; |
758 | require $module; |
759 | REQUIRE |
760 | |
33459055 |
761 | my $ok = $Test->ok( !$@, "require $module;" ); |
3f2ec160 |
762 | |
763 | unless( $ok ) { |
0cd946aa |
764 | chomp $@; |
33459055 |
765 | $Test->diag(<<DIAGNOSTIC); |
a9153838 |
766 | Tried to require '$module'. |
767 | Error: $@ |
3f2ec160 |
768 | DIAGNOSTIC |
769 | |
770 | } |
771 | |
772 | return $ok; |
773 | } |
774 | |
d020a79a |
775 | =back |
3f2ec160 |
776 | |
777 | =head2 Conditional tests |
778 | |
779 | Sometimes running a test under certain conditions will cause the |
780 | test script to die. A certain function or method isn't implemented |
781 | (such as fork() on MacOS), some resource isn't available (like a |
d020a79a |
782 | net connection) or a module isn't available. In these cases it's |
783 | necessary to skip tests, or declare that they are supposed to fail |
3f2ec160 |
784 | but will work in the future (a todo test). |
785 | |
a9153838 |
786 | For more details on the mechanics of skip and todo tests see |
787 | L<Test::Harness>. |
d020a79a |
788 | |
789 | The way Test::More handles this is with a named block. Basically, a |
790 | block of tests which can be skipped over or made todo. It's best if I |
791 | just show you... |
3f2ec160 |
792 | |
793 | =over 4 |
794 | |
d020a79a |
795 | =item B<SKIP: BLOCK> |
796 | |
797 | SKIP: { |
798 | skip $why, $how_many if $condition; |
3f2ec160 |
799 | |
d020a79a |
800 | ...normal testing code goes here... |
801 | } |
3f2ec160 |
802 | |
a344be10 |
803 | This declares a block of tests that might be skipped, $how_many tests |
804 | there are, $why and under what $condition to skip them. An example is |
805 | the easiest way to illustrate: |
3f2ec160 |
806 | |
d020a79a |
807 | SKIP: { |
a344be10 |
808 | eval { require HTML::Lint }; |
3f2ec160 |
809 | |
a344be10 |
810 | skip "HTML::Lint not installed", 2 if $@; |
d020a79a |
811 | |
a344be10 |
812 | my $lint = new HTML::Lint; |
60ffb308 |
813 | isa_ok( $lint, "HTML::Lint" ); |
3f2ec160 |
814 | |
a344be10 |
815 | $lint->parse( $html ); |
60ffb308 |
816 | is( $lint->errors, 0, "No errors found in HTML" ); |
a344be10 |
817 | } |
d020a79a |
818 | |
a344be10 |
819 | If the user does not have HTML::Lint installed, the whole block of |
820 | code I<won't be run at all>. Test::More will output special ok's |
821 | which Test::Harness interprets as skipped, but passing, tests. |
822 | It's important that $how_many accurately reflects the number of tests |
823 | in the SKIP block so the # of tests run will match up with your plan. |
a9153838 |
824 | |
a344be10 |
825 | It's perfectly safe to nest SKIP blocks. Each SKIP block must have |
826 | the label C<SKIP>, or Test::More can't work its magic. |
a9153838 |
827 | |
828 | You don't skip tests which are failing because there's a bug in your |
a344be10 |
829 | program, or for which you don't yet have code written. For that you |
830 | use TODO. Read on. |
3f2ec160 |
831 | |
832 | =cut |
833 | |
d020a79a |
834 | #'# |
1af51bd3 |
835 | sub skip { |
d020a79a |
836 | my($why, $how_many) = @_; |
33459055 |
837 | |
838 | unless( defined $how_many ) { |
d020a79a |
839 | # $how_many can only be avoided when no_plan is in use. |
33459055 |
840 | _carp "skip() needs to know \$how_many tests are in the block" |
841 | unless $Test::Builder::No_Plan; |
d020a79a |
842 | $how_many = 1; |
843 | } |
844 | |
845 | for( 1..$how_many ) { |
33459055 |
846 | $Test->skip($why); |
d020a79a |
847 | } |
848 | |
849 | local $^W = 0; |
850 | last SKIP; |
3f2ec160 |
851 | } |
852 | |
3f2ec160 |
853 | |
d020a79a |
854 | =item B<TODO: BLOCK> |
3f2ec160 |
855 | |
d020a79a |
856 | TODO: { |
a9153838 |
857 | local $TODO = $why if $condition; |
3f2ec160 |
858 | |
d020a79a |
859 | ...normal testing code goes here... |
860 | } |
3f2ec160 |
861 | |
d020a79a |
862 | Declares a block of tests you expect to fail and $why. Perhaps it's |
863 | because you haven't fixed a bug or haven't finished a new feature: |
3f2ec160 |
864 | |
d020a79a |
865 | TODO: { |
866 | local $TODO = "URI::Geller not finished"; |
3f2ec160 |
867 | |
d020a79a |
868 | my $card = "Eight of clubs"; |
869 | is( URI::Geller->your_card, $card, 'Is THIS your card?' ); |
3f2ec160 |
870 | |
d020a79a |
871 | my $spoon; |
872 | URI::Geller->bend_spoon; |
873 | is( $spoon, 'bent', "Spoon bending, that's original" ); |
874 | } |
875 | |
876 | With a todo block, the tests inside are expected to fail. Test::More |
877 | will run the tests normally, but print out special flags indicating |
878 | they are "todo". Test::Harness will interpret failures as being ok. |
879 | Should anything succeed, it will report it as an unexpected success. |
a344be10 |
880 | You then know the thing you had todo is done and can remove the |
881 | TODO flag. |
d020a79a |
882 | |
883 | The nice part about todo tests, as opposed to simply commenting out a |
4bd4e70a |
884 | block of tests, is it's like having a programmatic todo list. You know |
d020a79a |
885 | how much work is left to be done, you're aware of what bugs there are, |
886 | and you'll know immediately when they're fixed. |
887 | |
888 | Once a todo test starts succeeding, simply move it outside the block. |
889 | When the block is empty, delete it. |
890 | |
30e302f8 |
891 | B<NOTE>: TODO tests require a Test::Harness upgrade else it will |
892 | treat it as a normal failure. See L<BUGS and CAVEATS>) |
893 | |
d020a79a |
894 | |
a9153838 |
895 | =item B<todo_skip> |
896 | |
897 | TODO: { |
898 | todo_skip $why, $how_many if $condition; |
899 | |
900 | ...normal testing code... |
901 | } |
902 | |
89c1e84a |
903 | With todo tests, it's best to have the tests actually run. That way |
a9153838 |
904 | you'll know when they start passing. Sometimes this isn't possible. |
905 | Often a failing test will cause the whole program to die or hang, even |
906 | inside an C<eval BLOCK> with and using C<alarm>. In these extreme |
907 | cases you have no choice but to skip over the broken tests entirely. |
908 | |
909 | The syntax and behavior is similar to a C<SKIP: BLOCK> except the |
910 | tests will be marked as failing but todo. Test::Harness will |
911 | interpret them as passing. |
912 | |
913 | =cut |
914 | |
915 | sub todo_skip { |
916 | my($why, $how_many) = @_; |
917 | |
918 | unless( defined $how_many ) { |
919 | # $how_many can only be avoided when no_plan is in use. |
920 | _carp "todo_skip() needs to know \$how_many tests are in the block" |
921 | unless $Test::Builder::No_Plan; |
922 | $how_many = 1; |
923 | } |
924 | |
925 | for( 1..$how_many ) { |
926 | $Test->todo_skip($why); |
927 | } |
928 | |
929 | local $^W = 0; |
930 | last TODO; |
931 | } |
932 | |
a344be10 |
933 | =item When do I use SKIP vs. TODO? |
934 | |
935 | B<If it's something the user might not be able to do>, use SKIP. |
936 | This includes optional modules that aren't installed, running under |
937 | an OS that doesn't have some feature (like fork() or symlinks), or maybe |
938 | you need an Internet connection and one isn't available. |
939 | |
940 | B<If it's something the programmer hasn't done yet>, use TODO. This |
941 | is for any code you haven't written yet, or bugs you have yet to fix, |
942 | but want to put tests in your testing script (always a good idea). |
943 | |
a9153838 |
944 | |
d020a79a |
945 | =back |
3f2ec160 |
946 | |
4bd4e70a |
947 | =head2 Comparison functions |
3f2ec160 |
948 | |
949 | Not everything is a simple eq check or regex. There are times you |
950 | need to see if two arrays are equivalent, for instance. For these |
951 | instances, Test::More provides a handful of useful functions. |
952 | |
953 | B<NOTE> These are NOT well-tested on circular references. Nor am I |
954 | quite sure what will happen with filehandles. |
955 | |
956 | =over 4 |
957 | |
33459055 |
958 | =item B<is_deeply> |
959 | |
960 | is_deeply( $this, $that, $test_name ); |
961 | |
962 | Similar to is(), except that if $this and $that are hash or array |
963 | references, it does a deep comparison walking each data structure to |
964 | see if they are equivalent. If the two structures are different, it |
965 | will display the place where they start differing. |
966 | |
30e302f8 |
967 | Test::Differences and Test::Deep provide more in-depth functionality |
968 | along these lines. |
33459055 |
969 | |
970 | =cut |
971 | |
972 | use vars qw(@Data_Stack); |
973 | my $DNE = bless [], 'Does::Not::Exist'; |
974 | sub is_deeply { |
30e302f8 |
975 | unless( @_ == 2 or @_ == 3 ) { |
976 | my $msg = <<WARNING; |
977 | is_deeply() takes two or three args, you gave %d. |
978 | This usually means you passed an array or hash instead |
979 | of a reference to it |
980 | WARNING |
981 | chop $msg; # clip off newline so carp() will put in line/file |
982 | |
983 | _carp sprintf $msg, scalar @_; |
984 | } |
985 | |
33459055 |
986 | my($this, $that, $name) = @_; |
987 | |
988 | my $ok; |
2f71ccc2 |
989 | if( !ref $this || !ref $that ) { |
33459055 |
990 | $ok = $Test->is_eq($this, $that, $name); |
991 | } |
992 | else { |
993 | local @Data_Stack = (); |
994 | if( _deep_check($this, $that) ) { |
995 | $ok = $Test->ok(1, $name); |
996 | } |
997 | else { |
998 | $ok = $Test->ok(0, $name); |
999 | $ok = $Test->diag(_format_stack(@Data_Stack)); |
1000 | } |
1001 | } |
1002 | |
1003 | return $ok; |
1004 | } |
1005 | |
1006 | sub _format_stack { |
1007 | my(@Stack) = @_; |
1008 | |
1009 | my $var = '$FOO'; |
1010 | my $did_arrow = 0; |
1011 | foreach my $entry (@Stack) { |
1012 | my $type = $entry->{type} || ''; |
1013 | my $idx = $entry->{'idx'}; |
1014 | if( $type eq 'HASH' ) { |
1015 | $var .= "->" unless $did_arrow++; |
1016 | $var .= "{$idx}"; |
1017 | } |
1018 | elsif( $type eq 'ARRAY' ) { |
1019 | $var .= "->" unless $did_arrow++; |
1020 | $var .= "[$idx]"; |
1021 | } |
1022 | elsif( $type eq 'REF' ) { |
1023 | $var = "\${$var}"; |
1024 | } |
1025 | } |
1026 | |
1027 | my @vals = @{$Stack[-1]{vals}}[0,1]; |
1028 | my @vars = (); |
1029 | ($vars[0] = $var) =~ s/\$FOO/ \$got/; |
1030 | ($vars[1] = $var) =~ s/\$FOO/\$expected/; |
1031 | |
1032 | my $out = "Structures begin differing at:\n"; |
1033 | foreach my $idx (0..$#vals) { |
1034 | my $val = $vals[$idx]; |
1035 | $vals[$idx] = !defined $val ? 'undef' : |
2f71ccc2 |
1036 | $val eq $DNE ? "Does not exist" |
1037 | : "'$val'"; |
33459055 |
1038 | } |
1039 | |
1040 | $out .= "$vars[0] = $vals[0]\n"; |
1041 | $out .= "$vars[1] = $vals[1]\n"; |
1042 | |
a9153838 |
1043 | $out =~ s/^/ /msg; |
33459055 |
1044 | return $out; |
1045 | } |
1046 | |
1047 | |
3f2ec160 |
1048 | =item B<eq_array> |
1049 | |
1050 | eq_array(\@this, \@that); |
1051 | |
1052 | Checks if two arrays are equivalent. This is a deep check, so |
1053 | multi-level structures are handled correctly. |
1054 | |
1055 | =cut |
1056 | |
1057 | #'# |
2f71ccc2 |
1058 | sub eq_array { |
3f2ec160 |
1059 | my($a1, $a2) = @_; |
3f2ec160 |
1060 | return 1 if $a1 eq $a2; |
1061 | |
1062 | my $ok = 1; |
33459055 |
1063 | my $max = $#$a1 > $#$a2 ? $#$a1 : $#$a2; |
1064 | for (0..$max) { |
1065 | my $e1 = $_ > $#$a1 ? $DNE : $a1->[$_]; |
1066 | my $e2 = $_ > $#$a2 ? $DNE : $a2->[$_]; |
1067 | |
1068 | push @Data_Stack, { type => 'ARRAY', idx => $_, vals => [$e1, $e2] }; |
3f2ec160 |
1069 | $ok = _deep_check($e1,$e2); |
33459055 |
1070 | pop @Data_Stack if $ok; |
1071 | |
3f2ec160 |
1072 | last unless $ok; |
1073 | } |
1074 | return $ok; |
1075 | } |
1076 | |
1077 | sub _deep_check { |
1078 | my($e1, $e2) = @_; |
1079 | my $ok = 0; |
1080 | |
d020a79a |
1081 | my $eq; |
1082 | { |
4bd4e70a |
1083 | # Quiet uninitialized value warnings when comparing undefs. |
d020a79a |
1084 | local $^W = 0; |
1085 | |
2f71ccc2 |
1086 | if( $e1 eq $e2 ) { |
d020a79a |
1087 | $ok = 1; |
3f2ec160 |
1088 | } |
1089 | else { |
2f71ccc2 |
1090 | if( UNIVERSAL::isa($e1, 'ARRAY') and |
d020a79a |
1091 | UNIVERSAL::isa($e2, 'ARRAY') ) |
1092 | { |
2f71ccc2 |
1093 | $ok = eq_array($e1, $e2); |
d020a79a |
1094 | } |
1095 | elsif( UNIVERSAL::isa($e1, 'HASH') and |
1096 | UNIVERSAL::isa($e2, 'HASH') ) |
1097 | { |
2f71ccc2 |
1098 | $ok = eq_hash($e1, $e2); |
d020a79a |
1099 | } |
33459055 |
1100 | elsif( UNIVERSAL::isa($e1, 'REF') and |
1101 | UNIVERSAL::isa($e2, 'REF') ) |
1102 | { |
1103 | push @Data_Stack, { type => 'REF', vals => [$e1, $e2] }; |
1104 | $ok = _deep_check($$e1, $$e2); |
1105 | pop @Data_Stack if $ok; |
1106 | } |
1107 | elsif( UNIVERSAL::isa($e1, 'SCALAR') and |
1108 | UNIVERSAL::isa($e2, 'SCALAR') ) |
1109 | { |
1110 | push @Data_Stack, { type => 'REF', vals => [$e1, $e2] }; |
1111 | $ok = _deep_check($$e1, $$e2); |
1112 | } |
d020a79a |
1113 | else { |
33459055 |
1114 | push @Data_Stack, { vals => [$e1, $e2] }; |
d020a79a |
1115 | $ok = 0; |
1116 | } |
3f2ec160 |
1117 | } |
1118 | } |
d020a79a |
1119 | |
3f2ec160 |
1120 | return $ok; |
1121 | } |
1122 | |
1123 | |
1124 | =item B<eq_hash> |
1125 | |
1126 | eq_hash(\%this, \%that); |
1127 | |
1128 | Determines if the two hashes contain the same keys and values. This |
1129 | is a deep check. |
1130 | |
1131 | =cut |
1132 | |
1133 | sub eq_hash { |
1134 | my($a1, $a2) = @_; |
3f2ec160 |
1135 | return 1 if $a1 eq $a2; |
1136 | |
1137 | my $ok = 1; |
33459055 |
1138 | my $bigger = keys %$a1 > keys %$a2 ? $a1 : $a2; |
1139 | foreach my $k (keys %$bigger) { |
1140 | my $e1 = exists $a1->{$k} ? $a1->{$k} : $DNE; |
1141 | my $e2 = exists $a2->{$k} ? $a2->{$k} : $DNE; |
1142 | |
1143 | push @Data_Stack, { type => 'HASH', idx => $k, vals => [$e1, $e2] }; |
3f2ec160 |
1144 | $ok = _deep_check($e1, $e2); |
33459055 |
1145 | pop @Data_Stack if $ok; |
1146 | |
3f2ec160 |
1147 | last unless $ok; |
1148 | } |
1149 | |
1150 | return $ok; |
1151 | } |
1152 | |
1153 | =item B<eq_set> |
1154 | |
1155 | eq_set(\@this, \@that); |
1156 | |
1157 | Similar to eq_array(), except the order of the elements is B<not> |
1158 | important. This is a deep check, but the irrelevancy of order only |
1159 | applies to the top level. |
1160 | |
60ffb308 |
1161 | B<NOTE> By historical accident, this is not a true set comparision. |
1162 | While the order of elements does not matter, duplicate elements do. |
1163 | |
3f2ec160 |
1164 | =cut |
1165 | |
1166 | # We must make sure that references are treated neutrally. It really |
1167 | # doesn't matter how we sort them, as long as both arrays are sorted |
1168 | # with the same algorithm. |
30e302f8 |
1169 | sub _bogus_sort { local $^W = 0; ref $a ? -1 : ref $b ? 1 : $a cmp $b } |
3f2ec160 |
1170 | |
1171 | sub eq_set { |
1172 | my($a1, $a2) = @_; |
1173 | return 0 unless @$a1 == @$a2; |
1174 | |
1175 | # There's faster ways to do this, but this is easiest. |
1176 | return eq_array( [sort _bogus_sort @$a1], [sort _bogus_sort @$a2] ); |
1177 | } |
1178 | |
3f2ec160 |
1179 | =back |
1180 | |
d020a79a |
1181 | |
a9153838 |
1182 | =head2 Extending and Embedding Test::More |
d020a79a |
1183 | |
a9153838 |
1184 | Sometimes the Test::More interface isn't quite enough. Fortunately, |
1185 | Test::More is built on top of Test::Builder which provides a single, |
1186 | unified backend for any test library to use. This means two test |
1187 | libraries which both use Test::Builder B<can be used together in the |
1188 | same program>. |
1189 | |
1190 | If you simply want to do a little tweaking of how the tests behave, |
1191 | you can access the underlying Test::Builder object like so: |
3f2ec160 |
1192 | |
d020a79a |
1193 | =over 4 |
1194 | |
a9153838 |
1195 | =item B<builder> |
d020a79a |
1196 | |
a9153838 |
1197 | my $test_builder = Test::More->builder; |
d020a79a |
1198 | |
a9153838 |
1199 | Returns the Test::Builder object underlying Test::More for you to play |
1200 | with. |
1201 | |
1202 | =cut |
d020a79a |
1203 | |
a9153838 |
1204 | sub builder { |
1205 | return Test::Builder->new; |
1206 | } |
d020a79a |
1207 | |
a9153838 |
1208 | =back |
3f2ec160 |
1209 | |
d020a79a |
1210 | |
30e302f8 |
1211 | =head1 EXIT CODES |
1212 | |
1213 | If all your tests passed, Test::Builder will exit with zero (which is |
1214 | normal). If anything failed it will exit with how many failed. If |
1215 | you run less (or more) tests than you planned, the missing (or extras) |
1216 | will be considered failures. If no tests were ever run Test::Builder |
1217 | will throw a warning and exit with 255. If the test died, even after |
1218 | having successfully completed all its tests, it will still be |
1219 | considered a failure and will exit with 255. |
1220 | |
1221 | So the exit codes are... |
1222 | |
1223 | 0 all tests successful |
1224 | 255 test died |
1225 | any other number how many failed (including missing or extras) |
1226 | |
1227 | If you fail more than 254 tests, it will be reported as 254. |
1228 | |
1229 | |
a9153838 |
1230 | =head1 NOTES |
1231 | |
1232 | Test::More is B<explicitly> tested all the way back to perl 5.004. |
d020a79a |
1233 | |
a9153838 |
1234 | =head1 BUGS and CAVEATS |
1235 | |
1236 | =over 4 |
1237 | |
30e302f8 |
1238 | =item Threads |
1239 | |
1240 | Test::More will only be aware of threads if "use threads" has been done |
1241 | I<before> Test::More is loaded. This is ok: |
1242 | |
1243 | use threads; |
1244 | use Test::More; |
1245 | |
1246 | This may cause problems: |
1247 | |
1248 | use Test::More |
1249 | use threads; |
1250 | |
a9153838 |
1251 | =item Making your own ok() |
1252 | |
1253 | If you are trying to extend Test::More, don't. Use Test::Builder |
1254 | instead. |
1255 | |
1256 | =item The eq_* family has some caveats. |
d020a79a |
1257 | |
30e302f8 |
1258 | =item Test::Harness upgrade |
3f2ec160 |
1259 | |
d020a79a |
1260 | no_plan and todo depend on new Test::Harness features and fixes. If |
a9153838 |
1261 | you're going to distribute tests that use no_plan or todo your |
1262 | end-users will have to upgrade Test::Harness to the latest one on |
1263 | CPAN. If you avoid no_plan and TODO tests, the stock Test::Harness |
1264 | will work fine. |
d020a79a |
1265 | |
30e302f8 |
1266 | Installing Test::More should also upgrade Test::Harness. |
d020a79a |
1267 | |
1268 | =back |
3f2ec160 |
1269 | |
3f2ec160 |
1270 | |
1271 | =head1 HISTORY |
1272 | |
1273 | This is a case of convergent evolution with Joshua Pritikin's Test |
4bd4e70a |
1274 | module. I was largely unaware of its existence when I'd first |
3f2ec160 |
1275 | written my own ok() routines. This module exists because I can't |
1276 | figure out how to easily wedge test names into Test's interface (along |
1277 | with a few other problems). |
1278 | |
1279 | The goal here is to have a testing utility that's simple to learn, |
1280 | quick to use and difficult to trip yourself up with while still |
1281 | providing more flexibility than the existing Test.pm. As such, the |
1282 | names of the most common routines are kept tiny, special cases and |
1283 | magic side-effects are kept to a minimum. WYSIWYG. |
1284 | |
1285 | |
1286 | =head1 SEE ALSO |
1287 | |
1288 | L<Test::Simple> if all this confuses you and you just want to write |
89c1e84a |
1289 | some tests. You can upgrade to Test::More later (it's forward |
3f2ec160 |
1290 | compatible). |
1291 | |
a9153838 |
1292 | L<Test> is the old testing module. Its main benefit is that it has |
1293 | been distributed with Perl since 5.004_05. |
3f2ec160 |
1294 | |
1295 | L<Test::Harness> for details on how your test results are interpreted |
1296 | by Perl. |
1297 | |
30e302f8 |
1298 | L<Test::Differences> for more ways to test complex data structures. |
1299 | And it plays well with Test::More. |
1300 | |
1301 | L<Test::Class> is like XUnit but more perlish. |
1302 | |
1303 | L<Test::Deep> gives you more powerful complex data structure testing. |
1304 | |
1305 | L<Test::Unit> is XUnit style testing. |
3f2ec160 |
1306 | |
4bd4e70a |
1307 | L<Test::Inline> shows the idea of embedded testing. |
3f2ec160 |
1308 | |
30e302f8 |
1309 | L<Bundle::Test> installs a whole bunch of useful test modules. |
3f2ec160 |
1310 | |
4bd4e70a |
1311 | |
1312 | =head1 AUTHORS |
1313 | |
a9153838 |
1314 | Michael G Schwern E<lt>schwern@pobox.comE<gt> with much inspiration |
1315 | from Joshua Pritikin's Test module and lots of help from Barrie |
30e302f8 |
1316 | Slaymaker, Tony Bowden, blackstar.co.uk, chromatic and the perl-qa gang. |
4bd4e70a |
1317 | |
1318 | |
1319 | =head1 COPYRIGHT |
1320 | |
30e302f8 |
1321 | Copyright 2001, 2002 by Michael G Schwern E<lt>schwern@pobox.comE<gt>. |
4bd4e70a |
1322 | |
1323 | This program is free software; you can redistribute it and/or |
1324 | modify it under the same terms as Perl itself. |
1325 | |
a9153838 |
1326 | See F<http://www.perl.com/perl/misc/Artistic.html> |
4bd4e70a |
1327 | |
3f2ec160 |
1328 | =cut |
1329 | |
1330 | 1; |