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
13 my($file, $line) = (caller(1))[1,2];
14 warn @_, " at $file line $line\n";
20 use vars qw($VERSION @ISA @EXPORT %EXPORT_TAGS $TODO);
22 $VERSION = eval $VERSION; # make the alpha version come out as a number
25 @EXPORT = qw(ok use_ok require_ok
26 is isnt like unlike is_deeply
30 eq_array eq_hash eq_set
37 my $Test = Test::Builder->new;
41 # 5.004's Exporter doesn't have export_to_level.
46 (undef) = shift; # redundant arg
47 my $callpkg = caller($level);
48 $pkg->export($callpkg, @_);
54 Test::More - yet another framework for writing test scripts
58 use Test::More tests => $Num_Tests;
60 use Test::More qw(no_plan);
62 use Test::More skip_all => $reason;
64 BEGIN { use_ok( 'Some::Module' ); }
65 require_ok( 'Some::Module' );
67 # Various ways to say "ok"
68 ok($this eq $that, $test_name);
70 is ($this, $that, $test_name);
71 isnt($this, $that, $test_name);
73 # Rather than print STDERR "# here's what went wrong\n"
74 diag("here's what went wrong");
76 like ($this, qr/that/, $test_name);
77 unlike($this, qr/that/, $test_name);
79 cmp_ok($this, '==', $that, $test_name);
81 is_deeply($complex_structure1, $complex_structure2, $test_name);
84 skip $why, $how_many unless $have_some_feature;
86 ok( foo(), $test_name );
87 is( foo(42), 23, $test_name );
93 ok( foo(), $test_name );
94 is( foo(42), 23, $test_name );
97 can_ok($module, @methods);
98 isa_ok($object, $class);
104 my @status = Test::More::status;
112 B<STOP!> If you're just getting started writing tests, have a look at
113 Test::Simple first. This is a drop in replacement for Test::Simple
114 which you can switch to once you get the hang of basic testing.
116 The purpose of this module is to provide a wide range of testing
117 utilities. Various ways to say "ok" with better diagnostics,
118 facilities to skip tests, test future features and compare complicated
119 data structures. While you can do almost anything with a simple
120 C<ok()> function, it doesn't provide good diagnostic output.
123 =head2 I love it when a plan comes together
125 Before anything else, you need a testing plan. This basically declares
126 how many tests your script is going to run to protect against premature
129 The preferred way to do this is to declare a plan when you C<use Test::More>.
131 use Test::More tests => $Num_Tests;
133 There are rare cases when you will not know beforehand how many tests
134 your script is going to run. In this case, you can declare that you
135 have no plan. (Try to avoid using this as it weakens your test.)
137 use Test::More qw(no_plan);
139 B<NOTE>: using no_plan requires a Test::Harness upgrade else it will
140 think everything has failed. See L<BUGS and CAVEATS>)
142 In some cases, you'll want to completely skip an entire testing script.
144 use Test::More skip_all => $skip_reason;
146 Your script will declare a skip with the reason why you skipped and
147 exit immediately with a zero (success). See L<Test::Harness> for
150 If you want to control what functions Test::More will export, you
151 have to use the 'import' option. For example, to import everything
152 but 'fail', you'd do:
154 use Test::More tests => 23, import => ['!fail'];
156 Alternatively, you can use the plan() function. Useful for when you
157 have to calculate the number of tests.
160 plan tests => keys %Stuff * 3;
162 or for deciding between running the tests at all:
165 if( $^O eq 'MacOS' ) {
166 plan skip_all => 'Test irrelevant on MacOS';
179 while( $idx <= $#plan ) {
180 my $item = $plan[$idx];
182 if( $item eq 'no_diag' ) {
186 push @cleaned_plan, $item;
192 $Test->plan(@cleaned_plan);
200 $Test->exported_to($caller);
205 while( $idx <= $#_ ) {
208 if( $item eq 'import' ) {
209 push @imports, @{$_[$idx+1]};
221 __PACKAGE__->_export_to_level(1, __PACKAGE__, @imports);
227 By convention, each test is assigned a number in order. This is
228 largely done automatically for you. However, it's often very useful to
229 assign a name to each test. Which would you rather see:
237 ok 4 - basic multi-variable
238 not ok 5 - simple exponential
239 ok 6 - force == mass * acceleration
241 The later gives you some idea of what failed. It also makes it easier
242 to find the test in your script, simply search for "simple
245 All test functions take a name argument. It's optional, but highly
246 suggested that you use it.
249 =head2 I'm ok, you're not ok.
251 The basic purpose of this module is to print out either "ok #" or "not
252 ok #" depending on if a given test succeeded or failed. Everything
255 All of the following print "ok" or "not ok" depending on if the test
256 succeeded or failed. They all also return true or false,
263 ok($this eq $that, $test_name);
265 This simply evaluates any expression (C<$this eq $that> is just a
266 simple example) and uses that to determine if the test succeeded or
267 failed. A true expression passes, a false one fails. Very simple.
271 ok( $exp{9} == 81, 'simple exponential' );
272 ok( Film->can('db_Main'), 'set_db()' );
273 ok( $p->tests == 4, 'saw tests' );
274 ok( !grep !defined $_, @items, 'items populated' );
276 (Mnemonic: "This is ok.")
278 $test_name is a very short description of the test that will be printed
279 out. It makes it very easy to find a test in your script when it fails
280 and gives others an idea of your intentions. $test_name is optional,
281 but we B<very> strongly encourage its use.
283 Should an ok() fail, it will produce some diagnostics:
285 not ok 18 - sufficient mucus
286 # Failed test 18 (foo.t at line 42)
288 This is actually Test::Simple's ok() routine.
293 my($test, $name) = @_;
294 $Test->ok($test, $name);
301 is ( $this, $that, $test_name );
302 isnt( $this, $that, $test_name );
304 Similar to ok(), is() and isnt() compare their two arguments
305 with C<eq> and C<ne> respectively and use the result of that to
306 determine if the test succeeded or failed. So these:
308 # Is the ultimate answer 42?
309 is( ultimate_answer(), 42, "Meaning of Life" );
312 isnt( $foo, '', "Got some foo" );
314 are similar to these:
316 ok( ultimate_answer() eq 42, "Meaning of Life" );
317 ok( $foo ne '', "Got some foo" );
319 (Mnemonic: "This is that." "This isn't that.")
321 So why use these? They produce better diagnostics on failure. ok()
322 cannot know what you are testing for (beyond the name), but is() and
323 isnt() know what the test was and why it failed. For example this
326 my $foo = 'waffle'; my $bar = 'yarblokos';
327 is( $foo, $bar, 'Is foo the same as bar?' );
329 Will produce something like this:
331 not ok 17 - Is foo the same as bar?
332 # Failed test (foo.t at line 139)
334 # expected: 'yarblokos'
336 So you can figure out what went wrong without rerunning the test.
338 You are encouraged to use is() and isnt() over ok() where possible,
339 however do not be tempted to use them to find out if something is
343 is( exists $brooklyn{tree}, 1, 'A tree grows in Brooklyn' );
345 This does not check if C<exists $brooklyn{tree}> is true, it checks if
346 it returns 1. Very different. Similar caveats exist for false and 0.
347 In these cases, use ok().
349 ok( exists $brooklyn{tree}, 'A tree grows in Brooklyn' );
351 For those grammatical pedants out there, there's an C<isn't()>
352 function which is an alias of isnt().
369 like( $this, qr/that/, $test_name );
371 Similar to ok(), like() matches $this against the regex C<qr/that/>.
375 like($this, qr/that/, 'this is like that');
379 ok( $this =~ /that/, 'this is like that');
381 (Mnemonic "This is like that".)
383 The second argument is a regular expression. It may be given as a
384 regex reference (i.e. C<qr//>) or (for better compatibility with older
385 perls) as a string that looks like a regex (alternative delimiters are
386 currently not supported):
388 like( $this, '/that/', 'this is like that' );
390 Regex options may be placed on the end (C<'/that/i'>).
392 Its advantages over ok() are similar to that of is() and isnt(). Better
393 diagnostics on failure.
404 unlike( $this, qr/that/, $test_name );
406 Works exactly as like(), only it checks if $this B<does not> match the
418 cmp_ok( $this, $op, $that, $test_name );
420 Halfway between ok() and is() lies cmp_ok(). This allows you to
421 compare two arguments using any binary perl operator.
423 # ok( $this eq $that );
424 cmp_ok( $this, 'eq', $that, 'this eq that' );
426 # ok( $this == $that );
427 cmp_ok( $this, '==', $that, 'this == that' );
429 # ok( $this && $that );
430 cmp_ok( $this, '&&', $that, 'this && that' );
433 Its advantage over ok() is when the test fails you'll know what $this
437 # Failed test (foo.t at line 12)
442 It's also useful in those cases where you are comparing numbers and
443 is()'s use of C<eq> will interfere:
445 cmp_ok( $big_hairy_number, '==', $another_big_hairy_number );
456 can_ok($module, @methods);
457 can_ok($object, @methods);
459 Checks to make sure the $module or $object can do these @methods
460 (works with functions, too).
462 can_ok('Foo', qw(this that whatever));
464 is almost exactly like saying:
466 ok( Foo->can('this') &&
471 only without all the typing and with a better interface. Handy for
472 quickly testing an interface.
474 No matter how many @methods you check, a single can_ok() call counts
475 as one test. If you desire otherwise, use:
477 foreach my $meth (@methods) {
478 can_ok('Foo', $meth);
484 my($proto, @methods) = @_;
485 my $class = ref $proto || $proto;
488 my $ok = $Test->ok( 0, "$class->can(...)" );
489 $Test->diag(' can_ok() called with no methods');
494 foreach my $method (@methods) {
495 local($!, $@); # don't interfere with caller's $@
496 # eval sometimes resets $!
497 eval { $proto->can($method) } || push @nok, $method;
501 $name = @methods == 1 ? "$class->can('$methods[0]')"
502 : "$class->can(...)";
504 my $ok = $Test->ok( !@nok, $name );
506 $Test->diag(map " $class->can('$_') failed\n", @nok);
513 isa_ok($object, $class, $object_name);
514 isa_ok($ref, $type, $ref_name);
516 Checks to see if the given C<< $object->isa($class) >>. Also checks to make
517 sure the object was defined in the first place. Handy for this sort
520 my $obj = Some::Module->new;
521 isa_ok( $obj, 'Some::Module' );
523 where you'd otherwise have to write
525 my $obj = Some::Module->new;
526 ok( defined $obj && $obj->isa('Some::Module') );
528 to safeguard against your test script blowing up.
530 It works on references, too:
532 isa_ok( $array_ref, 'ARRAY' );
534 The diagnostics of this test normally just refer to 'the object'. If
535 you'd like them to be more specific, you can supply an $object_name
536 (for example 'Test customer').
541 my($object, $class, $obj_name) = @_;
544 $obj_name = 'The object' unless defined $obj_name;
545 my $name = "$obj_name isa $class";
546 if( !defined $object ) {
547 $diag = "$obj_name isn't defined";
549 elsif( !ref $object ) {
550 $diag = "$obj_name isn't a reference";
553 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
554 local($@, $!); # eval sometimes resets $!
555 my $rslt = eval { $object->isa($class) };
557 if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) {
558 if( !UNIVERSAL::isa($object, $class) ) {
559 my $ref = ref $object;
560 $diag = "$obj_name isn't a '$class' it's a '$ref'";
564 WHOA! I tried to call ->isa on your object and got some weird error.
565 This should never happen. Please contact the author immediately.
572 my $ref = ref $object;
573 $diag = "$obj_name isn't a '$class' it's a '$ref'";
581 $ok = $Test->ok( 0, $name );
582 $Test->diag(" $diag\n");
585 $ok = $Test->ok( 1, $name );
599 Sometimes you just want to say that the tests have passed. Usually
600 the case is you've got some complicated condition that is difficult to
601 wedge into an ok(). In this case, you can simply use pass() (to
602 declare the test ok) or fail (for not ok). They are synonyms for
605 Use these very, very, very sparingly.
621 If you pick the right test function, you'll usually get a good idea of
622 what went wrong when it failed. But sometimes it doesn't work out
623 that way. So here we have ways for you to write your own diagnostic
624 messages which are safer than just C<print STDERR>.
630 diag(@diagnostic_message);
632 Prints a diagnostic message which is guaranteed not to interfere with
633 test output. Like C<print> @diagnostic_message is simply concatinated
636 Handy for this sort of thing:
638 ok( grep(/foo/, @users), "There's a foo user" ) or
639 diag("Since there's no foo, check that /etc/bar is set up right");
643 not ok 42 - There's a foo user
644 # Failed test (foo.t at line 52)
645 # Since there's no foo, check that /etc/bar is set up right.
647 You might remember C<ok() or diag()> with the mnemonic C<open() or
650 All diag()s can be made silent by passing the "no_diag" option to
651 Test::More. C<use Test::More tests => 1, 'no_diag'>. This is useful
652 if you have diagnostics for personal testing but then wish to make
653 them silent for release without commenting out each individual
656 B<NOTE> The exact formatting of the diagnostic output is still
657 changing, but it is guaranteed that whatever you throw at it it won't
658 interfere with the test.
663 return unless $Show_Diag;
672 You usually want to test if the module you're testing loads ok, rather
673 than just vomiting if its load fails. For such purposes we have
674 C<use_ok> and C<require_ok>.
680 BEGIN { use_ok($module); }
681 BEGIN { use_ok($module, @imports); }
683 These simply use the given $module and test to make sure the load
684 happened ok. It's recommended that you run use_ok() inside a BEGIN
685 block so its functions are exported at compile-time and prototypes are
688 If @imports are given, they are passed through to the use. So this:
690 BEGIN { use_ok('Some::Module', qw(foo bar)) }
694 use Some::Module qw(foo bar);
696 Version numbers can be checked like so:
698 # Just like "use Some::Module 1.02"
699 BEGIN { use_ok('Some::Module', 1.02) }
701 Don't try to do this:
704 use_ok('Some::Module');
706 ...some code that depends on the use...
707 ...happening at compile time...
710 because the notion of "compile-time" is relative. Instead, you want:
712 BEGIN { use_ok('Some::Module') }
713 BEGIN { ...some code that depends on the use... }
719 my($module, @imports) = @_;
720 @imports = () unless @imports;
722 my($pack,$filename,$line) = caller;
724 local($@,$!); # eval sometimes interferes with $!
726 if( @imports == 1 and $imports[0] =~ /^\d+(?:\.\d+)?$/ ) {
727 # probably a version check. Perl needs to see the bare number
728 # for it to work with non-Exporter based modules.
731 use $module $imports[0];
737 use $module \@imports;
741 my $ok = $Test->ok( !$@, "use $module;" );
745 $@ =~ s{^BEGIN failed--compilation aborted at .*$}
746 {BEGIN failed--compilation aborted at $filename line $line.}m;
747 $Test->diag(<<DIAGNOSTIC);
748 Tried to use '$module'.
762 Like use_ok(), except it requires the $module or $file.
771 # Try to deterine if we've been given a module name or file.
772 # Module names must be barewords, files not.
773 $module = qq['$module'] unless _is_module_name($module);
775 local($!, $@); # eval sometimes interferes with $!
781 my $ok = $Test->ok( !$@, "require $module;" );
785 $Test->diag(<<DIAGNOSTIC);
786 Tried to require '$module'.
796 sub _is_module_name {
799 # Module names start with a letter.
800 # End with an alphanumeric.
801 # The rest is an alphanumeric or ::
802 $module =~ s/\b::\b//g;
803 $module =~ /^[a-zA-Z]\w*$/;
808 =head2 Conditional tests
810 Sometimes running a test under certain conditions will cause the
811 test script to die. A certain function or method isn't implemented
812 (such as fork() on MacOS), some resource isn't available (like a
813 net connection) or a module isn't available. In these cases it's
814 necessary to skip tests, or declare that they are supposed to fail
815 but will work in the future (a todo test).
817 For more details on the mechanics of skip and todo tests see
820 The way Test::More handles this is with a named block. Basically, a
821 block of tests which can be skipped over or made todo. It's best if I
829 skip $why, $how_many if $condition;
831 ...normal testing code goes here...
834 This declares a block of tests that might be skipped, $how_many tests
835 there are, $why and under what $condition to skip them. An example is
836 the easiest way to illustrate:
839 eval { require HTML::Lint };
841 skip "HTML::Lint not installed", 2 if $@;
843 my $lint = new HTML::Lint;
844 isa_ok( $lint, "HTML::Lint" );
846 $lint->parse( $html );
847 is( $lint->errors, 0, "No errors found in HTML" );
850 If the user does not have HTML::Lint installed, the whole block of
851 code I<won't be run at all>. Test::More will output special ok's
852 which Test::Harness interprets as skipped, but passing, tests.
854 It's important that $how_many accurately reflects the number of tests
855 in the SKIP block so the # of tests run will match up with your plan.
856 If your plan is C<no_plan> $how_many is optional and will default to 1.
858 It's perfectly safe to nest SKIP blocks. Each SKIP block must have
859 the label C<SKIP>, or Test::More can't work its magic.
861 You don't skip tests which are failing because there's a bug in your
862 program, or for which you don't yet have code written. For that you
869 my($why, $how_many) = @_;
871 unless( defined $how_many ) {
872 # $how_many can only be avoided when no_plan is in use.
873 _carp "skip() needs to know \$how_many tests are in the block"
874 unless $Test->has_plan eq 'no_plan';
878 for( 1..$how_many ) {
890 local $TODO = $why if $condition;
892 ...normal testing code goes here...
895 Declares a block of tests you expect to fail and $why. Perhaps it's
896 because you haven't fixed a bug or haven't finished a new feature:
899 local $TODO = "URI::Geller not finished";
901 my $card = "Eight of clubs";
902 is( URI::Geller->your_card, $card, 'Is THIS your card?' );
905 URI::Geller->bend_spoon;
906 is( $spoon, 'bent', "Spoon bending, that's original" );
909 With a todo block, the tests inside are expected to fail. Test::More
910 will run the tests normally, but print out special flags indicating
911 they are "todo". Test::Harness will interpret failures as being ok.
912 Should anything succeed, it will report it as an unexpected success.
913 You then know the thing you had todo is done and can remove the
916 The nice part about todo tests, as opposed to simply commenting out a
917 block of tests, is it's like having a programmatic todo list. You know
918 how much work is left to be done, you're aware of what bugs there are,
919 and you'll know immediately when they're fixed.
921 Once a todo test starts succeeding, simply move it outside the block.
922 When the block is empty, delete it.
924 B<NOTE>: TODO tests require a Test::Harness upgrade else it will
925 treat it as a normal failure. See L<BUGS and CAVEATS>)
931 todo_skip $why, $how_many if $condition;
933 ...normal testing code...
936 With todo tests, it's best to have the tests actually run. That way
937 you'll know when they start passing. Sometimes this isn't possible.
938 Often a failing test will cause the whole program to die or hang, even
939 inside an C<eval BLOCK> with and using C<alarm>. In these extreme
940 cases you have no choice but to skip over the broken tests entirely.
942 The syntax and behavior is similar to a C<SKIP: BLOCK> except the
943 tests will be marked as failing but todo. Test::Harness will
944 interpret them as passing.
949 my($why, $how_many) = @_;
951 unless( defined $how_many ) {
952 # $how_many can only be avoided when no_plan is in use.
953 _carp "todo_skip() needs to know \$how_many tests are in the block"
954 unless $Test->has_plan eq 'no_plan';
958 for( 1..$how_many ) {
959 $Test->todo_skip($why);
966 =item When do I use SKIP vs. TODO?
968 B<If it's something the user might not be able to do>, use SKIP.
969 This includes optional modules that aren't installed, running under
970 an OS that doesn't have some feature (like fork() or symlinks), or maybe
971 you need an Internet connection and one isn't available.
973 B<If it's something the programmer hasn't done yet>, use TODO. This
974 is for any code you haven't written yet, or bugs you have yet to fix,
975 but want to put tests in your testing script (always a good idea).
980 =head2 Complex data structures
982 Not everything is a simple eq check or regex. There are times you
983 need to see if two data structures are equivalent. For these
984 instances Test::More provides a handful of useful functions.
986 B<NOTE> I'm not quite sure what will happen with filehandles.
992 is_deeply( $this, $that, $test_name );
994 Similar to is(), except that if $this and $that are hash or array
995 references, it does a deep comparison walking each data structure to
996 see if they are equivalent. If the two structures are different, it
997 will display the place where they start differing.
999 Test::Differences and Test::Deep provide more in-depth functionality
1004 use vars qw(@Data_Stack %Refs_Seen);
1005 my $DNE = bless [], 'Does::Not::Exist';
1007 unless( @_ == 2 or @_ == 3 ) {
1008 my $msg = <<WARNING;
1009 is_deeply() takes two or three args, you gave %d.
1010 This usually means you passed an array or hash instead
1011 of a reference to it
1013 chop $msg; # clip off newline so carp() will put in line/file
1015 _carp sprintf $msg, scalar @_;
1017 return $Test->ok(0);
1020 my($this, $that, $name) = @_;
1023 if( !ref $this and !ref $that ) { # neither is a reference
1024 $ok = $Test->is_eq($this, $that, $name);
1026 elsif( !ref $this xor !ref $that ) { # one's a reference, one isn't
1027 $ok = $Test->ok(0, $name);
1028 $Test->diag( _format_stack({ vals => [ $this, $that ] }) );
1030 else { # both references
1031 local @Data_Stack = ();
1032 if( _deep_check($this, $that) ) {
1033 $ok = $Test->ok(1, $name);
1036 $ok = $Test->ok(0, $name);
1037 $Test->diag(_format_stack(@Data_Stack));
1049 foreach my $entry (@Stack) {
1050 my $type = $entry->{type} || '';
1051 my $idx = $entry->{'idx'};
1052 if( $type eq 'HASH' ) {
1053 $var .= "->" unless $did_arrow++;
1056 elsif( $type eq 'ARRAY' ) {
1057 $var .= "->" unless $did_arrow++;
1060 elsif( $type eq 'REF' ) {
1065 my @vals = @{$Stack[-1]{vals}}[0,1];
1067 ($vars[0] = $var) =~ s/\$FOO/ \$got/;
1068 ($vars[1] = $var) =~ s/\$FOO/\$expected/;
1070 my $out = "Structures begin differing at:\n";
1071 foreach my $idx (0..$#vals) {
1072 my $val = $vals[$idx];
1073 $vals[$idx] = !defined $val ? 'undef' :
1074 $val eq $DNE ? "Does not exist" :
1079 $out .= "$vars[0] = $vals[0]\n";
1080 $out .= "$vars[1] = $vals[1]\n";
1090 return '' if !ref $thing;
1092 for my $type (qw(ARRAY HASH REF SCALAR GLOB Regexp)) {
1093 return $type if UNIVERSAL::isa($thing, $type);
1100 =head2 Discouraged comparison functions
1102 The use of the following functions is discouraged as they are not
1103 actually testing functions and produce no diagnostics to help figure
1104 out what went wrong. They were written before is_deeply() existed
1105 because I couldn't figure out how to display a useful diff of two
1106 arbitrary data structures.
1108 These functions are usually used inside an ok().
1110 ok( eq_array(\@this, \@that) );
1112 C<is_deeply()> can do that better and with diagnostics.
1114 is_deeply( \@this, \@that );
1116 They may be deprecated in future versions.
1121 my $is_eq = eq_array(\@this, \@that);
1123 Checks if two arrays are equivalent. This is a deep check, so
1124 multi-level structures are handled correctly.
1137 if( grep !_type($_) eq 'ARRAY', $a1, $a2 ) {
1138 warn "eq_array passed a non-array ref";
1142 return 1 if $a1 eq $a2;
1145 my $max = $#$a1 > $#$a2 ? $#$a1 : $#$a2;
1147 my $e1 = $_ > $#$a1 ? $DNE : $a1->[$_];
1148 my $e2 = $_ > $#$a2 ? $DNE : $a2->[$_];
1150 push @Data_Stack, { type => 'ARRAY', idx => $_, vals => [$e1, $e2] };
1151 $ok = _deep_check($e1,$e2);
1152 pop @Data_Stack if $ok;
1164 # Effectively turn %Refs_Seen into a stack. This avoids picking up
1165 # the same referenced used twice (such as [\$a, \$a]) to be considered
1167 local %Refs_Seen = %Refs_Seen;
1170 # Quiet uninitialized value warnings when comparing undefs.
1173 $Test->_unoverload(\$e1, \$e2);
1175 # Either they're both references or both not.
1176 my $same_ref = !(!ref $e1 xor !ref $e2);
1177 my $not_ref = (!ref $e1 and !ref $e2);
1179 if( defined $e1 xor defined $e2 ) {
1182 elsif ( $e1 == $DNE xor $e2 == $DNE ) {
1185 elsif ( $same_ref and ($e1 eq $e2) ) {
1188 elsif ( $not_ref ) {
1189 push @Data_Stack, { type => '', vals => [$e1, $e2] };
1193 if( $Refs_Seen{$e1} ) {
1194 return $Refs_Seen{$e1} eq $e2;
1197 $Refs_Seen{$e1} = "$e2";
1200 my $type = _type($e1);
1201 $type = 'DIFFERENT' unless _type($e2) eq $type;
1203 if( $type eq 'DIFFERENT' ) {
1204 push @Data_Stack, { type => $type, vals => [$e1, $e2] };
1207 elsif( $type eq 'ARRAY' ) {
1208 $ok = _eq_array($e1, $e2);
1210 elsif( $type eq 'HASH' ) {
1211 $ok = _eq_hash($e1, $e2);
1213 elsif( $type eq 'REF' ) {
1214 push @Data_Stack, { type => $type, vals => [$e1, $e2] };
1215 $ok = _deep_check($$e1, $$e2);
1216 pop @Data_Stack if $ok;
1218 elsif( $type eq 'SCALAR' ) {
1219 push @Data_Stack, { type => 'REF', vals => [$e1, $e2] };
1220 $ok = _deep_check($$e1, $$e2);
1221 pop @Data_Stack if $ok;
1224 _whoa(1, "No type in _deep_check");
1234 my($check, $desc) = @_;
1238 This should never happen! Please contact the author immediately!
1246 my $is_eq = eq_hash(\%this, \%that);
1248 Determines if the two hashes contain the same keys and values. This
1255 return _deep_check(@_);
1261 if( grep !_type($_) eq 'HASH', $a1, $a2 ) {
1262 warn "eq_hash passed a non-hash ref";
1266 return 1 if $a1 eq $a2;
1269 my $bigger = keys %$a1 > keys %$a2 ? $a1 : $a2;
1270 foreach my $k (keys %$bigger) {
1271 my $e1 = exists $a1->{$k} ? $a1->{$k} : $DNE;
1272 my $e2 = exists $a2->{$k} ? $a2->{$k} : $DNE;
1274 push @Data_Stack, { type => 'HASH', idx => $k, vals => [$e1, $e2] };
1275 $ok = _deep_check($e1, $e2);
1276 pop @Data_Stack if $ok;
1286 my $is_eq = eq_set(\@this, \@that);
1288 Similar to eq_array(), except the order of the elements is B<not>
1289 important. This is a deep check, but the irrelevancy of order only
1290 applies to the top level.
1292 ok( eq_set(\@this, \@that) );
1296 is_deeply( [sort @this], [sort @that] );
1298 B<NOTE> By historical accident, this is not a true set comparision.
1299 While the order of elements does not matter, duplicate elements do.
1301 Test::Deep contains much better set comparison functions.
1307 return 0 unless @$a1 == @$a2;
1309 # There's faster ways to do this, but this is easiest.
1312 # We must make sure that references are treated neutrally. It really
1313 # doesn't matter how we sort them, as long as both arrays are sorted
1314 # with the same algorithm.
1315 # Have to inline the sort routine due to a threading/sort bug.
1316 # See [rt.cpan.org 6782]
1318 [sort { ref $a ? -1 : ref $b ? 1 : $a cmp $b } @$a1],
1319 [sort { ref $a ? -1 : ref $b ? 1 : $a cmp $b } @$a2]
1326 =head2 Extending and Embedding Test::More
1328 Sometimes the Test::More interface isn't quite enough. Fortunately,
1329 Test::More is built on top of Test::Builder which provides a single,
1330 unified backend for any test library to use. This means two test
1331 libraries which both use Test::Builder B<can be used together in the
1334 If you simply want to do a little tweaking of how the tests behave,
1335 you can access the underlying Test::Builder object like so:
1341 my $test_builder = Test::More->builder;
1343 Returns the Test::Builder object underlying Test::More for you to play
1349 return Test::Builder->new;
1357 If all your tests passed, Test::Builder will exit with zero (which is
1358 normal). If anything failed it will exit with how many failed. If
1359 you run less (or more) tests than you planned, the missing (or extras)
1360 will be considered failures. If no tests were ever run Test::Builder
1361 will throw a warning and exit with 255. If the test died, even after
1362 having successfully completed all its tests, it will still be
1363 considered a failure and will exit with 255.
1365 So the exit codes are...
1367 0 all tests successful
1369 any other number how many failed (including missing or extras)
1371 If you fail more than 254 tests, it will be reported as 254.
1373 B<NOTE> This behavior may go away in future versions.
1376 =head1 CAVEATS and NOTES
1380 =item Backwards compatibility
1382 Test::More works with Perls as old as 5.004_05.
1385 =item Overloaded objects
1387 String overloaded objects are compared B<as strings>. This prevents
1388 Test::More from piercing an object's interface allowing better blackbox
1389 testing. So if a function starts returning overloaded objects instead of
1390 bare strings your tests won't notice the difference. This is good.
1392 However, it does mean that functions like is_deeply() cannot be used to
1393 test the internals of string overloaded objects. In this case I would
1394 suggest Test::Deep which contains more flexible testing functions for
1395 complex data structures.
1400 Test::More will only be aware of threads if "use threads" has been done
1401 I<before> Test::More is loaded. This is ok:
1406 This may cause problems:
1412 =item Test::Harness upgrade
1414 no_plan and todo depend on new Test::Harness features and fixes. If
1415 you're going to distribute tests that use no_plan or todo your
1416 end-users will have to upgrade Test::Harness to the latest one on
1417 CPAN. If you avoid no_plan and TODO tests, the stock Test::Harness
1420 Installing Test::More should also upgrade Test::Harness.
1427 This is a case of convergent evolution with Joshua Pritikin's Test
1428 module. I was largely unaware of its existence when I'd first
1429 written my own ok() routines. This module exists because I can't
1430 figure out how to easily wedge test names into Test's interface (along
1431 with a few other problems).
1433 The goal here is to have a testing utility that's simple to learn,
1434 quick to use and difficult to trip yourself up with while still
1435 providing more flexibility than the existing Test.pm. As such, the
1436 names of the most common routines are kept tiny, special cases and
1437 magic side-effects are kept to a minimum. WYSIWYG.
1442 L<Test::Simple> if all this confuses you and you just want to write
1443 some tests. You can upgrade to Test::More later (it's forward
1446 L<Test> is the old testing module. Its main benefit is that it has
1447 been distributed with Perl since 5.004_05.
1449 L<Test::Harness> for details on how your test results are interpreted
1452 L<Test::Differences> for more ways to test complex data structures.
1453 And it plays well with Test::More.
1455 L<Test::Class> is like XUnit but more perlish.
1457 L<Test::Deep> gives you more powerful complex data structure testing.
1459 L<Test::Unit> is XUnit style testing.
1461 L<Test::Inline> shows the idea of embedded testing.
1463 L<Bundle::Test> installs a whole bunch of useful test modules.
1468 Michael G Schwern E<lt>schwern@pobox.comE<gt> with much inspiration
1469 from Joshua Pritikin's Test module and lots of help from Barrie
1470 Slaymaker, Tony Bowden, blackstar.co.uk, chromatic, Fergal Daly and
1476 See F<http://rt.cpan.org> to report and view bugs.
1481 Copyright 2001, 2002, 2004 by Michael G Schwern E<lt>schwern@pobox.comE<gt>.
1483 This program is free software; you can redistribute it and/or
1484 modify it under the same terms as Perl itself.
1486 See F<http://www.perl.com/perl/misc/Artistic.html>