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);
103 # Utility comparison functions.
104 eq_array(\@this, \@that);
105 eq_hash(\%this, \%that);
106 eq_set(\@this, \@that);
109 my @status = Test::More::status;
117 B<STOP!> If you're just getting started writing tests, have a look at
118 Test::Simple first. This is a drop in replacement for Test::Simple
119 which you can switch to once you get the hang of basic testing.
121 The purpose of this module is to provide a wide range of testing
122 utilities. Various ways to say "ok" with better diagnostics,
123 facilities to skip tests, test future features and compare complicated
124 data structures. While you can do almost anything with a simple
125 C<ok()> function, it doesn't provide good diagnostic output.
128 =head2 I love it when a plan comes together
130 Before anything else, you need a testing plan. This basically declares
131 how many tests your script is going to run to protect against premature
134 The preferred way to do this is to declare a plan when you C<use Test::More>.
136 use Test::More tests => $Num_Tests;
138 There are rare cases when you will not know beforehand how many tests
139 your script is going to run. In this case, you can declare that you
140 have no plan. (Try to avoid using this as it weakens your test.)
142 use Test::More qw(no_plan);
144 B<NOTE>: using no_plan requires a Test::Harness upgrade else it will
145 think everything has failed. See L<BUGS and CAVEATS>)
147 In some cases, you'll want to completely skip an entire testing script.
149 use Test::More skip_all => $skip_reason;
151 Your script will declare a skip with the reason why you skipped and
152 exit immediately with a zero (success). See L<Test::Harness> for
155 If you want to control what functions Test::More will export, you
156 have to use the 'import' option. For example, to import everything
157 but 'fail', you'd do:
159 use Test::More tests => 23, import => ['!fail'];
161 Alternatively, you can use the plan() function. Useful for when you
162 have to calculate the number of tests.
165 plan tests => keys %Stuff * 3;
167 or for deciding between running the tests at all:
170 if( $^O eq 'MacOS' ) {
171 plan skip_all => 'Test irrelevant on MacOS';
184 while( $idx <= $#plan ) {
185 my $item = $plan[$idx];
187 if( $item eq 'no_diag' ) {
191 push @cleaned_plan, $item;
197 $Test->plan(@cleaned_plan);
205 $Test->exported_to($caller);
210 while( $idx <= $#_ ) {
213 if( $item eq 'import' ) {
214 push @imports, @{$_[$idx+1]};
226 __PACKAGE__->_export_to_level(1, __PACKAGE__, @imports);
232 By convention, each test is assigned a number in order. This is
233 largely done automatically for you. However, it's often very useful to
234 assign a name to each test. Which would you rather see:
242 ok 4 - basic multi-variable
243 not ok 5 - simple exponential
244 ok 6 - force == mass * acceleration
246 The later gives you some idea of what failed. It also makes it easier
247 to find the test in your script, simply search for "simple
250 All test functions take a name argument. It's optional, but highly
251 suggested that you use it.
254 =head2 I'm ok, you're not ok.
256 The basic purpose of this module is to print out either "ok #" or "not
257 ok #" depending on if a given test succeeded or failed. Everything
260 All of the following print "ok" or "not ok" depending on if the test
261 succeeded or failed. They all also return true or false,
268 ok($this eq $that, $test_name);
270 This simply evaluates any expression (C<$this eq $that> is just a
271 simple example) and uses that to determine if the test succeeded or
272 failed. A true expression passes, a false one fails. Very simple.
276 ok( $exp{9} == 81, 'simple exponential' );
277 ok( Film->can('db_Main'), 'set_db()' );
278 ok( $p->tests == 4, 'saw tests' );
279 ok( !grep !defined $_, @items, 'items populated' );
281 (Mnemonic: "This is ok.")
283 $test_name is a very short description of the test that will be printed
284 out. It makes it very easy to find a test in your script when it fails
285 and gives others an idea of your intentions. $test_name is optional,
286 but we B<very> strongly encourage its use.
288 Should an ok() fail, it will produce some diagnostics:
290 not ok 18 - sufficient mucus
291 # Failed test 18 (foo.t at line 42)
293 This is actually Test::Simple's ok() routine.
298 my($test, $name) = @_;
299 $Test->ok($test, $name);
306 is ( $this, $that, $test_name );
307 isnt( $this, $that, $test_name );
309 Similar to ok(), is() and isnt() compare their two arguments
310 with C<eq> and C<ne> respectively and use the result of that to
311 determine if the test succeeded or failed. So these:
313 # Is the ultimate answer 42?
314 is( ultimate_answer(), 42, "Meaning of Life" );
317 isnt( $foo, '', "Got some foo" );
319 are similar to these:
321 ok( ultimate_answer() eq 42, "Meaning of Life" );
322 ok( $foo ne '', "Got some foo" );
324 (Mnemonic: "This is that." "This isn't that.")
326 So why use these? They produce better diagnostics on failure. ok()
327 cannot know what you are testing for (beyond the name), but is() and
328 isnt() know what the test was and why it failed. For example this
331 my $foo = 'waffle'; my $bar = 'yarblokos';
332 is( $foo, $bar, 'Is foo the same as bar?' );
334 Will produce something like this:
336 not ok 17 - Is foo the same as bar?
337 # Failed test (foo.t at line 139)
339 # expected: 'yarblokos'
341 So you can figure out what went wrong without rerunning the test.
343 You are encouraged to use is() and isnt() over ok() where possible,
344 however do not be tempted to use them to find out if something is
348 is( exists $brooklyn{tree}, 1, 'A tree grows in Brooklyn' );
350 This does not check if C<exists $brooklyn{tree}> is true, it checks if
351 it returns 1. Very different. Similar caveats exist for false and 0.
352 In these cases, use ok().
354 ok( exists $brooklyn{tree}, 'A tree grows in Brooklyn' );
356 For those grammatical pedants out there, there's an C<isn't()>
357 function which is an alias of isnt().
374 like( $this, qr/that/, $test_name );
376 Similar to ok(), like() matches $this against the regex C<qr/that/>.
380 like($this, qr/that/, 'this is like that');
384 ok( $this =~ /that/, 'this is like that');
386 (Mnemonic "This is like that".)
388 The second argument is a regular expression. It may be given as a
389 regex reference (i.e. C<qr//>) or (for better compatibility with older
390 perls) as a string that looks like a regex (alternative delimiters are
391 currently not supported):
393 like( $this, '/that/', 'this is like that' );
395 Regex options may be placed on the end (C<'/that/i'>).
397 Its advantages over ok() are similar to that of is() and isnt(). Better
398 diagnostics on failure.
409 unlike( $this, qr/that/, $test_name );
411 Works exactly as like(), only it checks if $this B<does not> match the
423 cmp_ok( $this, $op, $that, $test_name );
425 Halfway between ok() and is() lies cmp_ok(). This allows you to
426 compare two arguments using any binary perl operator.
428 # ok( $this eq $that );
429 cmp_ok( $this, 'eq', $that, 'this eq that' );
431 # ok( $this == $that );
432 cmp_ok( $this, '==', $that, 'this == that' );
434 # ok( $this && $that );
435 cmp_ok( $this, '&&', $that, 'this && that' );
438 Its advantage over ok() is when the test fails you'll know what $this
442 # Failed test (foo.t at line 12)
447 It's also useful in those cases where you are comparing numbers and
448 is()'s use of C<eq> will interfere:
450 cmp_ok( $big_hairy_number, '==', $another_big_hairy_number );
461 can_ok($module, @methods);
462 can_ok($object, @methods);
464 Checks to make sure the $module or $object can do these @methods
465 (works with functions, too).
467 can_ok('Foo', qw(this that whatever));
469 is almost exactly like saying:
471 ok( Foo->can('this') &&
476 only without all the typing and with a better interface. Handy for
477 quickly testing an interface.
479 No matter how many @methods you check, a single can_ok() call counts
480 as one test. If you desire otherwise, use:
482 foreach my $meth (@methods) {
483 can_ok('Foo', $meth);
489 my($proto, @methods) = @_;
490 my $class = ref $proto || $proto;
493 my $ok = $Test->ok( 0, "$class->can(...)" );
494 $Test->diag(' can_ok() called with no methods');
499 foreach my $method (@methods) {
500 local($!, $@); # don't interfere with caller's $@
501 # eval sometimes resets $!
502 eval { $proto->can($method) } || push @nok, $method;
506 $name = @methods == 1 ? "$class->can('$methods[0]')"
507 : "$class->can(...)";
509 my $ok = $Test->ok( !@nok, $name );
511 $Test->diag(map " $class->can('$_') failed\n", @nok);
518 isa_ok($object, $class, $object_name);
519 isa_ok($ref, $type, $ref_name);
521 Checks to see if the given C<< $object->isa($class) >>. Also checks to make
522 sure the object was defined in the first place. Handy for this sort
525 my $obj = Some::Module->new;
526 isa_ok( $obj, 'Some::Module' );
528 where you'd otherwise have to write
530 my $obj = Some::Module->new;
531 ok( defined $obj && $obj->isa('Some::Module') );
533 to safeguard against your test script blowing up.
535 It works on references, too:
537 isa_ok( $array_ref, 'ARRAY' );
539 The diagnostics of this test normally just refer to 'the object'. If
540 you'd like them to be more specific, you can supply an $object_name
541 (for example 'Test customer').
546 my($object, $class, $obj_name) = @_;
549 $obj_name = 'The object' unless defined $obj_name;
550 my $name = "$obj_name isa $class";
551 if( !defined $object ) {
552 $diag = "$obj_name isn't defined";
554 elsif( !ref $object ) {
555 $diag = "$obj_name isn't a reference";
558 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
559 local($@, $!); # eval sometimes resets $!
560 my $rslt = eval { $object->isa($class) };
562 if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) {
563 if( !UNIVERSAL::isa($object, $class) ) {
564 my $ref = ref $object;
565 $diag = "$obj_name isn't a '$class' it's a '$ref'";
569 WHOA! I tried to call ->isa on your object and got some weird error.
570 This should never happen. Please contact the author immediately.
577 my $ref = ref $object;
578 $diag = "$obj_name isn't a '$class' it's a '$ref'";
586 $ok = $Test->ok( 0, $name );
587 $Test->diag(" $diag\n");
590 $ok = $Test->ok( 1, $name );
604 Sometimes you just want to say that the tests have passed. Usually
605 the case is you've got some complicated condition that is difficult to
606 wedge into an ok(). In this case, you can simply use pass() (to
607 declare the test ok) or fail (for not ok). They are synonyms for
610 Use these very, very, very sparingly.
626 If you pick the right test function, you'll usually get a good idea of
627 what went wrong when it failed. But sometimes it doesn't work out
628 that way. So here we have ways for you to write your own diagnostic
629 messages which are safer than just C<print STDERR>.
635 diag(@diagnostic_message);
637 Prints a diagnostic message which is guaranteed not to interfere with
638 test output. Like C<print> @diagnostic_message is simply concatinated
641 Handy for this sort of thing:
643 ok( grep(/foo/, @users), "There's a foo user" ) or
644 diag("Since there's no foo, check that /etc/bar is set up right");
648 not ok 42 - There's a foo user
649 # Failed test (foo.t at line 52)
650 # Since there's no foo, check that /etc/bar is set up right.
652 You might remember C<ok() or diag()> with the mnemonic C<open() or
655 All diag()s can be made silent by passing the "no_diag" option to
656 Test::More. C<use Test::More tests => 1, 'no_diag'>. This is useful
657 if you have diagnostics for personal testing but then wish to make
658 them silent for release without commenting out each individual
661 B<NOTE> The exact formatting of the diagnostic output is still
662 changing, but it is guaranteed that whatever you throw at it it won't
663 interfere with the test.
668 return unless $Show_Diag;
677 You usually want to test if the module you're testing loads ok, rather
678 than just vomiting if its load fails. For such purposes we have
679 C<use_ok> and C<require_ok>.
685 BEGIN { use_ok($module); }
686 BEGIN { use_ok($module, @imports); }
688 These simply use the given $module and test to make sure the load
689 happened ok. It's recommended that you run use_ok() inside a BEGIN
690 block so its functions are exported at compile-time and prototypes are
693 If @imports are given, they are passed through to the use. So this:
695 BEGIN { use_ok('Some::Module', qw(foo bar)) }
699 use Some::Module qw(foo bar);
701 Version numbers can be checked like so:
703 # Just like "use Some::Module 1.02"
704 BEGIN { use_ok('Some::Module', 1.02) }
706 Don't try to do this:
709 use_ok('Some::Module');
711 ...some code that depends on the use...
712 ...happening at compile time...
715 because the notion of "compile-time" is relative. Instead, you want:
717 BEGIN { use_ok('Some::Module') }
718 BEGIN { ...some code that depends on the use... }
724 my($module, @imports) = @_;
725 @imports = () unless @imports;
727 my($pack,$filename,$line) = caller;
729 local($@,$!); # eval sometimes interferes with $!
731 if( @imports == 1 and $imports[0] =~ /^\d+(?:\.\d+)?$/ ) {
732 # probably a version check. Perl needs to see the bare number
733 # for it to work with non-Exporter based modules.
736 use $module $imports[0];
742 use $module \@imports;
746 my $ok = $Test->ok( !$@, "use $module;" );
750 $@ =~ s{^BEGIN failed--compilation aborted at .*$}
751 {BEGIN failed--compilation aborted at $filename line $line.}m;
752 $Test->diag(<<DIAGNOSTIC);
753 Tried to use '$module'.
767 Like use_ok(), except it requires the $module or $file.
776 # Try to deterine if we've been given a module name or file.
777 # Module names must be barewords, files not.
778 $module = qq['$module'] unless _is_module_name($module);
780 local($!, $@); # eval sometimes interferes with $!
786 my $ok = $Test->ok( !$@, "require $module;" );
790 $Test->diag(<<DIAGNOSTIC);
791 Tried to require '$module'.
801 sub _is_module_name {
804 # Module names start with a letter.
805 # End with an alphanumeric.
806 # The rest is an alphanumeric or ::
807 $module =~ s/\b::\b//g;
808 $module =~ /^[a-zA-Z]\w+$/;
813 =head2 Conditional tests
815 Sometimes running a test under certain conditions will cause the
816 test script to die. A certain function or method isn't implemented
817 (such as fork() on MacOS), some resource isn't available (like a
818 net connection) or a module isn't available. In these cases it's
819 necessary to skip tests, or declare that they are supposed to fail
820 but will work in the future (a todo test).
822 For more details on the mechanics of skip and todo tests see
825 The way Test::More handles this is with a named block. Basically, a
826 block of tests which can be skipped over or made todo. It's best if I
834 skip $why, $how_many if $condition;
836 ...normal testing code goes here...
839 This declares a block of tests that might be skipped, $how_many tests
840 there are, $why and under what $condition to skip them. An example is
841 the easiest way to illustrate:
844 eval { require HTML::Lint };
846 skip "HTML::Lint not installed", 2 if $@;
848 my $lint = new HTML::Lint;
849 isa_ok( $lint, "HTML::Lint" );
851 $lint->parse( $html );
852 is( $lint->errors, 0, "No errors found in HTML" );
855 If the user does not have HTML::Lint installed, the whole block of
856 code I<won't be run at all>. Test::More will output special ok's
857 which Test::Harness interprets as skipped, but passing, tests.
859 It's important that $how_many accurately reflects the number of tests
860 in the SKIP block so the # of tests run will match up with your plan.
861 If your plan is C<no_plan> $how_many is optional and will default to 1.
863 It's perfectly safe to nest SKIP blocks. Each SKIP block must have
864 the label C<SKIP>, or Test::More can't work its magic.
866 You don't skip tests which are failing because there's a bug in your
867 program, or for which you don't yet have code written. For that you
874 my($why, $how_many) = @_;
876 unless( defined $how_many ) {
877 # $how_many can only be avoided when no_plan is in use.
878 _carp "skip() needs to know \$how_many tests are in the block"
879 unless $Test->has_plan eq 'no_plan';
883 for( 1..$how_many ) {
895 local $TODO = $why if $condition;
897 ...normal testing code goes here...
900 Declares a block of tests you expect to fail and $why. Perhaps it's
901 because you haven't fixed a bug or haven't finished a new feature:
904 local $TODO = "URI::Geller not finished";
906 my $card = "Eight of clubs";
907 is( URI::Geller->your_card, $card, 'Is THIS your card?' );
910 URI::Geller->bend_spoon;
911 is( $spoon, 'bent', "Spoon bending, that's original" );
914 With a todo block, the tests inside are expected to fail. Test::More
915 will run the tests normally, but print out special flags indicating
916 they are "todo". Test::Harness will interpret failures as being ok.
917 Should anything succeed, it will report it as an unexpected success.
918 You then know the thing you had todo is done and can remove the
921 The nice part about todo tests, as opposed to simply commenting out a
922 block of tests, is it's like having a programmatic todo list. You know
923 how much work is left to be done, you're aware of what bugs there are,
924 and you'll know immediately when they're fixed.
926 Once a todo test starts succeeding, simply move it outside the block.
927 When the block is empty, delete it.
929 B<NOTE>: TODO tests require a Test::Harness upgrade else it will
930 treat it as a normal failure. See L<BUGS and CAVEATS>)
936 todo_skip $why, $how_many if $condition;
938 ...normal testing code...
941 With todo tests, it's best to have the tests actually run. That way
942 you'll know when they start passing. Sometimes this isn't possible.
943 Often a failing test will cause the whole program to die or hang, even
944 inside an C<eval BLOCK> with and using C<alarm>. In these extreme
945 cases you have no choice but to skip over the broken tests entirely.
947 The syntax and behavior is similar to a C<SKIP: BLOCK> except the
948 tests will be marked as failing but todo. Test::Harness will
949 interpret them as passing.
954 my($why, $how_many) = @_;
956 unless( defined $how_many ) {
957 # $how_many can only be avoided when no_plan is in use.
958 _carp "todo_skip() needs to know \$how_many tests are in the block"
959 unless $Test->has_plan eq 'no_plan';
963 for( 1..$how_many ) {
964 $Test->todo_skip($why);
971 =item When do I use SKIP vs. TODO?
973 B<If it's something the user might not be able to do>, use SKIP.
974 This includes optional modules that aren't installed, running under
975 an OS that doesn't have some feature (like fork() or symlinks), or maybe
976 you need an Internet connection and one isn't available.
978 B<If it's something the programmer hasn't done yet>, use TODO. This
979 is for any code you haven't written yet, or bugs you have yet to fix,
980 but want to put tests in your testing script (always a good idea).
985 =head2 Comparison functions
987 Not everything is a simple eq check or regex. There are times you
988 need to see if two arrays are equivalent, for instance. For these
989 instances, Test::More provides a handful of useful functions.
991 B<NOTE> I'm not quite sure what will happen with filehandles.
997 is_deeply( $this, $that, $test_name );
999 Similar to is(), except that if $this and $that are hash or array
1000 references, it does a deep comparison walking each data structure to
1001 see if they are equivalent. If the two structures are different, it
1002 will display the place where they start differing.
1004 Test::Differences and Test::Deep provide more in-depth functionality
1009 use vars qw(@Data_Stack %Refs_Seen);
1010 my $DNE = bless [], 'Does::Not::Exist';
1012 unless( @_ == 2 or @_ == 3 ) {
1013 my $msg = <<WARNING;
1014 is_deeply() takes two or three args, you gave %d.
1015 This usually means you passed an array or hash instead
1016 of a reference to it
1018 chop $msg; # clip off newline so carp() will put in line/file
1020 _carp sprintf $msg, scalar @_;
1023 my($this, $that, $name) = @_;
1026 if( !ref $this xor !ref $that ) { # one's a reference, one isn't
1029 if( !ref $this and !ref $that ) {
1030 $ok = $Test->is_eq($this, $that, $name);
1033 local @Data_Stack = ();
1034 local %Refs_Seen = ();
1035 if( _deep_check($this, $that) ) {
1036 $ok = $Test->ok(1, $name);
1039 $ok = $Test->ok(0, $name);
1040 $ok = $Test->diag(_format_stack(@Data_Stack));
1052 foreach my $entry (@Stack) {
1053 my $type = $entry->{type} || '';
1054 my $idx = $entry->{'idx'};
1055 if( $type eq 'HASH' ) {
1056 $var .= "->" unless $did_arrow++;
1059 elsif( $type eq 'ARRAY' ) {
1060 $var .= "->" unless $did_arrow++;
1063 elsif( $type eq 'REF' ) {
1068 my @vals = @{$Stack[-1]{vals}}[0,1];
1070 ($vars[0] = $var) =~ s/\$FOO/ \$got/;
1071 ($vars[1] = $var) =~ s/\$FOO/\$expected/;
1073 my $out = "Structures begin differing at:\n";
1074 foreach my $idx (0..$#vals) {
1075 my $val = $vals[$idx];
1076 $vals[$idx] = !defined $val ? 'undef' :
1077 $val eq $DNE ? "Does not exist"
1081 $out .= "$vars[0] = $vals[0]\n";
1082 $out .= "$vars[1] = $vals[1]\n";
1092 return '' if !ref $thing;
1094 for my $type (qw(ARRAY HASH REF SCALAR GLOB Regexp)) {
1095 return $type if UNIVERSAL::isa($thing, $type);
1104 eq_array(\@this, \@that);
1106 Checks if two arrays are equivalent. This is a deep check, so
1107 multi-level structures are handled correctly.
1121 if( grep !_type($_) eq 'ARRAY', $a1, $a2 ) {
1122 warn "eq_array passed a non-array ref";
1126 return 1 if $a1 eq $a2;
1128 if($Refs_Seen{$a1}) {
1129 return $Refs_Seen{$a1} eq $a2;
1132 $Refs_Seen{$a1} = "$a2";
1136 my $max = $#$a1 > $#$a2 ? $#$a1 : $#$a2;
1138 my $e1 = $_ > $#$a1 ? $DNE : $a1->[$_];
1139 my $e2 = $_ > $#$a2 ? $DNE : $a2->[$_];
1141 push @Data_Stack, { type => 'ARRAY', idx => $_, vals => [$e1, $e2] };
1142 $ok = _deep_check($e1,$e2);
1143 pop @Data_Stack if $ok;
1156 # Quiet uninitialized value warnings when comparing undefs.
1159 $Test->_unoverload(\$e1, \$e2);
1161 # Either they're both references or both not.
1162 my $same_ref = !(!ref $e1 xor !ref $e2);
1164 if( defined $e1 xor defined $e2 ) {
1167 elsif ( $e1 == $DNE xor $e2 == $DNE ) {
1170 elsif ( $same_ref and ($e1 eq $e2) ) {
1174 my $type = _type($e1);
1175 $type = '' unless _type($e2) eq $type;
1178 push @Data_Stack, { vals => [$e1, $e2] };
1181 elsif( $type eq 'ARRAY' ) {
1182 $ok = _eq_array($e1, $e2);
1184 elsif( $type eq 'HASH' ) {
1185 $ok = _eq_hash($e1, $e2);
1187 elsif( $type eq 'REF' ) {
1188 push @Data_Stack, { type => 'REF', vals => [$e1, $e2] };
1189 $ok = _deep_check($$e1, $$e2);
1190 pop @Data_Stack if $ok;
1192 elsif( $type eq 'SCALAR' ) {
1193 push @Data_Stack, { type => 'REF', vals => [$e1, $e2] };
1194 $ok = _deep_check($$e1, $$e2);
1195 pop @Data_Stack if $ok;
1206 eq_hash(\%this, \%that);
1208 Determines if the two hashes contain the same keys and values. This
1216 return _eq_hash(@_);
1222 if( grep !_type($_) eq 'HASH', $a1, $a2 ) {
1223 warn "eq_hash passed a non-hash ref";
1227 return 1 if $a1 eq $a2;
1229 if( $Refs_Seen{$a1} ) {
1230 return $Refs_Seen{$a1} eq $a2;
1233 $Refs_Seen{$a1} = "$a2";
1237 my $bigger = keys %$a1 > keys %$a2 ? $a1 : $a2;
1238 foreach my $k (keys %$bigger) {
1239 my $e1 = exists $a1->{$k} ? $a1->{$k} : $DNE;
1240 my $e2 = exists $a2->{$k} ? $a2->{$k} : $DNE;
1242 push @Data_Stack, { type => 'HASH', idx => $k, vals => [$e1, $e2] };
1243 $ok = _deep_check($e1, $e2);
1244 pop @Data_Stack if $ok;
1254 eq_set(\@this, \@that);
1256 Similar to eq_array(), except the order of the elements is B<not>
1257 important. This is a deep check, but the irrelevancy of order only
1258 applies to the top level.
1260 B<NOTE> By historical accident, this is not a true set comparision.
1261 While the order of elements does not matter, duplicate elements do.
1267 return 0 unless @$a1 == @$a2;
1269 # There's faster ways to do this, but this is easiest.
1272 # We must make sure that references are treated neutrally. It really
1273 # doesn't matter how we sort them, as long as both arrays are sorted
1274 # with the same algorithm.
1275 # Have to inline the sort routine due to a threading/sort bug.
1276 # See [rt.cpan.org 6782]
1278 [sort { ref $a ? -1 : ref $b ? 1 : $a cmp $b } @$a1],
1279 [sort { ref $a ? -1 : ref $b ? 1 : $a cmp $b } @$a2]
1286 =head2 Extending and Embedding Test::More
1288 Sometimes the Test::More interface isn't quite enough. Fortunately,
1289 Test::More is built on top of Test::Builder which provides a single,
1290 unified backend for any test library to use. This means two test
1291 libraries which both use Test::Builder B<can be used together in the
1294 If you simply want to do a little tweaking of how the tests behave,
1295 you can access the underlying Test::Builder object like so:
1301 my $test_builder = Test::More->builder;
1303 Returns the Test::Builder object underlying Test::More for you to play
1309 return Test::Builder->new;
1317 If all your tests passed, Test::Builder will exit with zero (which is
1318 normal). If anything failed it will exit with how many failed. If
1319 you run less (or more) tests than you planned, the missing (or extras)
1320 will be considered failures. If no tests were ever run Test::Builder
1321 will throw a warning and exit with 255. If the test died, even after
1322 having successfully completed all its tests, it will still be
1323 considered a failure and will exit with 255.
1325 So the exit codes are...
1327 0 all tests successful
1329 any other number how many failed (including missing or extras)
1331 If you fail more than 254 tests, it will be reported as 254.
1334 =head1 CAVEATS and NOTES
1338 =item Backwards compatibility
1340 Test::More works with Perls as old as 5.004_05.
1343 =item Overloaded objects
1345 String overloaded objects are compared B<as strings>. This prevents
1346 Test::More from piercing an object's interface allowing better blackbox
1347 testing. So if a function starts returning overloaded objects instead of
1348 bare strings your tests won't notice the difference. This is good.
1350 However, it does mean that functions like is_deeply() cannot be used to
1351 test the internals of string overloaded objects. In this case I would
1352 suggest Test::Deep which contains more flexible testing functions for
1353 complex data structures.
1358 Test::More will only be aware of threads if "use threads" has been done
1359 I<before> Test::More is loaded. This is ok:
1364 This may cause problems:
1370 =item Test::Harness upgrade
1372 no_plan and todo depend on new Test::Harness features and fixes. If
1373 you're going to distribute tests that use no_plan or todo your
1374 end-users will have to upgrade Test::Harness to the latest one on
1375 CPAN. If you avoid no_plan and TODO tests, the stock Test::Harness
1378 Installing Test::More should also upgrade Test::Harness.
1385 This is a case of convergent evolution with Joshua Pritikin's Test
1386 module. I was largely unaware of its existence when I'd first
1387 written my own ok() routines. This module exists because I can't
1388 figure out how to easily wedge test names into Test's interface (along
1389 with a few other problems).
1391 The goal here is to have a testing utility that's simple to learn,
1392 quick to use and difficult to trip yourself up with while still
1393 providing more flexibility than the existing Test.pm. As such, the
1394 names of the most common routines are kept tiny, special cases and
1395 magic side-effects are kept to a minimum. WYSIWYG.
1400 L<Test::Simple> if all this confuses you and you just want to write
1401 some tests. You can upgrade to Test::More later (it's forward
1404 L<Test> is the old testing module. Its main benefit is that it has
1405 been distributed with Perl since 5.004_05.
1407 L<Test::Harness> for details on how your test results are interpreted
1410 L<Test::Differences> for more ways to test complex data structures.
1411 And it plays well with Test::More.
1413 L<Test::Class> is like XUnit but more perlish.
1415 L<Test::Deep> gives you more powerful complex data structure testing.
1417 L<Test::Unit> is XUnit style testing.
1419 L<Test::Inline> shows the idea of embedded testing.
1421 L<Bundle::Test> installs a whole bunch of useful test modules.
1426 Michael G Schwern E<lt>schwern@pobox.comE<gt> with much inspiration
1427 from Joshua Pritikin's Test module and lots of help from Barrie
1428 Slaymaker, Tony Bowden, blackstar.co.uk, chromatic, Fergal Daly and
1434 See F<http://rt.cpan.org> to report and view bugs.
1439 Copyright 2001, 2002, 2004 by Michael G Schwern E<lt>schwern@pobox.comE<gt>.
1441 This program is free software; you can redistribute it and/or
1442 modify it under the same terms as Perl itself.
1444 See F<http://www.perl.com/perl/misc/Artistic.html>