5 # $^C was only introduced in 5.005-ish. We do this to prevent
6 # use of uninitialized value warnings in older perls.
10 use vars qw($VERSION);
12 $VERSION = eval $VERSION; # make the alpha version come out as a number
14 # Make Test::Builder thread-safe for ithreads.
17 # Load threads::shared when threads are turned on.
18 # 5.8.0's threads are so busted we no longer support them.
19 if( $] >= 5.008001 && $Config{useithreads} && $INC{'threads.pm'}) {
20 require threads::shared;
22 # Hack around YET ANOTHER threads::shared bug. It would
23 # occassionally forget the contents of the variable when sharing it.
24 # So we first copy the data, then share, then put our copy back.
25 *share = sub (\[$@%]) {
29 if( $type eq 'HASH' ) {
32 elsif( $type eq 'ARRAY' ) {
35 elsif( $type eq 'SCALAR' ) {
39 die("Unknown type: ".$type);
42 $_[0] = &threads::shared::share($_[0]);
44 if( $type eq 'HASH' ) {
47 elsif( $type eq 'ARRAY' ) {
50 elsif( $type eq 'SCALAR' ) {
54 die("Unknown type: ".$type);
60 # 5.8.0's threads::shared is busted when threads are off
61 # and earlier Perls just don't have that module at all.
63 *share = sub { return $_[0] };
71 Test::Builder - Backend for building test libraries
75 package My::Test::Module;
81 my $Test = Test::Builder->new;
82 $Test->output('my_logfile');
88 $Test->exported_to($pack);
91 $self->export_to_level(1, $self, 'ok');
95 my($test, $name) = @_;
97 $Test->ok($test, $name);
103 Test::Simple and Test::More have proven to be popular testing modules,
104 but they're not always flexible enough. Test::Builder provides the a
105 building block upon which to write your own test libraries I<which can
114 my $Test = Test::Builder->new;
116 Returns a Test::Builder object representing the current state of the
119 Since you only run one test per program C<new> always returns the same
120 Test::Builder object. No matter how many times you call new(), you're
121 getting the same object. This is called a singleton. This is done so that
122 multiple modules share such global information as the test counter and
123 where test output is going.
125 If you want a completely new Test::Builder object different from the
126 singleton, use C<create>.
130 my $Test = Test::Builder->new;
133 $Test ||= $class->create;
140 my $Test = Test::Builder->create;
142 Ok, so there can be more than one Test::Builder object and this is how
143 you get it. You might use this instead of C<new()> if you're testing
144 a Test::Builder based module, but otherwise you probably want C<new>.
146 B<NOTE>: the implementation is not complete. C<level>, for example, is
147 still shared amongst B<all> Test::Builder objects, even ones created using
148 this method. Also, the method name may change in the future.
155 my $self = bless {}, $class;
165 Reinitializes the Test::Builder singleton to its original state.
166 Mostly useful for tests run in persistent environments where the same
167 test might be run multiple times in the same process.
176 # We leave this a global because it has to be localized and localizing
177 # hash keys is just asking for pain. Also, it was documented.
180 $self->{Test_Died} = 0;
181 $self->{Have_Plan} = 0;
182 $self->{No_Plan} = 0;
183 $self->{Original_Pid} = $$;
185 share($self->{Curr_Test});
186 $self->{Curr_Test} = 0;
187 $self->{Test_Results} = &share([]);
189 $self->{Exported_To} = undef;
190 $self->{Expected_Tests} = 0;
192 $self->{Skip_All} = 0;
194 $self->{Use_Nums} = 1;
196 $self->{No_Header} = 0;
197 $self->{No_Ending} = 0;
199 $self->_dup_stdhandles unless $^C;
206 =head2 Setting up tests
208 These methods are for setting up tests and declaring how many there
209 are. You usually only want to call one of these methods.
215 my $pack = $Test->exported_to;
216 $Test->exported_to($pack);
218 Tells Test::Builder what package you exported your functions to.
219 This is important for getting TODO tests right.
224 my($self, $pack) = @_;
226 if( defined $pack ) {
227 $self->{Exported_To} = $pack;
229 return $self->{Exported_To};
234 $Test->plan('no_plan');
235 $Test->plan( skip_all => $reason );
236 $Test->plan( tests => $num_tests );
238 A convenient way to set up your tests. Call this and Test::Builder
239 will print the appropriate headers and take the appropriate actions.
241 If you call plan(), don't call any of the other methods below.
246 my($self, $cmd, $arg) = @_;
250 local $Level = $Level + 1;
252 if( $self->{Have_Plan} ) {
253 $self->croak("You tried to plan twice");
256 if( $cmd eq 'no_plan' ) {
259 elsif( $cmd eq 'skip_all' ) {
260 return $self->skip_all($arg);
262 elsif( $cmd eq 'tests' ) {
264 local $Level = $Level + 1;
265 return $self->expected_tests($arg);
267 elsif( !defined $arg ) {
268 $self->croak("Got an undefined number of tests");
271 $self->croak("You said to run 0 tests");
275 my @args = grep { defined } ($cmd, $arg);
276 $self->croak("plan() doesn't understand @args");
282 =item B<expected_tests>
284 my $max = $Test->expected_tests;
285 $Test->expected_tests($max);
287 Gets/sets the # of tests we expect this test to run and prints out
288 the appropriate headers.
297 $self->croak("Number of tests must be a positive integer. You gave it '$max'")
298 unless $max =~ /^\+?\d+$/ and $max > 0;
300 $self->{Expected_Tests} = $max;
301 $self->{Have_Plan} = 1;
303 $self->_print("1..$max\n") unless $self->no_header;
305 return $self->{Expected_Tests};
313 Declares that this test will run an indeterminate # of tests.
320 $self->{No_Plan} = 1;
321 $self->{Have_Plan} = 1;
326 $plan = $Test->has_plan
328 Find out whether a plan has been defined. $plan is either C<undef> (no plan has been set), C<no_plan> (indeterminate # of tests) or an integer (the number of expected tests).
335 return($self->{Expected_Tests}) if $self->{Expected_Tests};
336 return('no_plan') if $self->{No_Plan};
344 $Test->skip_all($reason);
346 Skips all the tests, using the given $reason. Exits immediately with 0.
351 my($self, $reason) = @_;
354 $out .= " # Skip $reason" if $reason;
357 $self->{Skip_All} = 1;
359 $self->_print($out) unless $self->no_header;
367 These actually run the tests, analogous to the functions in Test::More.
369 They all return true if the test passed, false if the test failed.
371 $name is always optional.
377 $Test->ok($test, $name);
379 Your basic test. Pass if $test is true, fail if $test is false. Just
380 like Test::Simple's ok().
385 my($self, $test, $name) = @_;
387 # $test might contain an object which we don't want to accidentally
388 # store, so we turn it into a boolean.
389 $test = $test ? 1 : 0;
393 lock $self->{Curr_Test};
394 $self->{Curr_Test}++;
396 # In case $name is a string overloaded object, force it to stringify.
397 $self->_unoverload_str(\$name);
399 $self->diag(<<ERR) if defined $name and $name =~ /^[\d\s]+$/;
400 You named your test '$name'. You shouldn't use numbers for your test names.
404 my($pack, $file, $line) = $self->caller;
406 my $todo = $self->todo($pack);
407 $self->_unoverload_str(\$todo);
410 my $result = &share({});
414 @$result{ 'ok', 'actual_ok' } = ( ( $todo ? 1 : 0 ), 0 );
417 @$result{ 'ok', 'actual_ok' } = ( 1, $test );
421 $out .= " $self->{Curr_Test}" if $self->use_numbers;
423 if( defined $name ) {
424 $name =~ s|#|\\#|g; # # in a name can confuse Test::Harness.
426 $result->{name} = $name;
429 $result->{name} = '';
433 $out .= " # TODO $todo";
434 $result->{reason} = $todo;
435 $result->{type} = 'todo';
438 $result->{reason} = '';
439 $result->{type} = '';
442 $self->{Test_Results}[$self->{Curr_Test}-1] = $result;
448 my $msg = $todo ? "Failed (TODO)" : "Failed";
449 $self->_print_diag("\n") if $ENV{HARNESS_ACTIVE};
451 if( defined $name ) {
452 $self->diag(qq[ $msg test '$name'\n]);
453 $self->diag(qq[ at $file line $line.\n]);
456 $self->diag(qq[ $msg test at $file line $line.\n]);
460 return $test ? 1 : 0;
468 $self->_try(sub { require overload } ) || return;
470 foreach my $thing (@_) {
471 if( $self->_is_object($$thing) ) {
472 if( my $string_meth = overload::Method($$thing, $type) ) {
473 $$thing = $$thing->$string_meth();
481 my($self, $thing) = @_;
483 return $self->_try(sub { ref $thing && $thing->isa('UNIVERSAL') }) ? 1 : 0;
487 sub _unoverload_str {
490 $self->_unoverload(q[""], @_);
493 sub _unoverload_num {
496 $self->_unoverload('0+', @_);
499 next unless $self->_is_dualvar($$val);
505 # This is a hack to detect a dualvar such as $!
507 my($self, $val) = @_;
511 return 1 if $numval != 0 and $numval ne $val;
518 $Test->is_eq($got, $expected, $name);
520 Like Test::More's is(). Checks if $got eq $expected. This is the
525 $Test->is_num($got, $expected, $name);
527 Like Test::More's is(). Checks if $got == $expected. This is the
533 my($self, $got, $expect, $name) = @_;
534 local $Level = $Level + 1;
536 $self->_unoverload_str(\$got, \$expect);
538 if( !defined $got || !defined $expect ) {
539 # undef only matches undef and nothing else
540 my $test = !defined $got && !defined $expect;
542 $self->ok($test, $name);
543 $self->_is_diag($got, 'eq', $expect) unless $test;
547 return $self->cmp_ok($got, 'eq', $expect, $name);
551 my($self, $got, $expect, $name) = @_;
552 local $Level = $Level + 1;
554 $self->_unoverload_num(\$got, \$expect);
556 if( !defined $got || !defined $expect ) {
557 # undef only matches undef and nothing else
558 my $test = !defined $got && !defined $expect;
560 $self->ok($test, $name);
561 $self->_is_diag($got, '==', $expect) unless $test;
565 return $self->cmp_ok($got, '==', $expect, $name);
569 my($self, $got, $type, $expect) = @_;
571 foreach my $val (\$got, \$expect) {
572 if( defined $$val ) {
573 if( $type eq 'eq' ) {
574 # quote and force string context
578 # force numeric context
579 $self->_unoverload_num($val);
587 return $self->diag(sprintf <<DIAGNOSTIC, $got, $expect);
596 $Test->isnt_eq($got, $dont_expect, $name);
598 Like Test::More's isnt(). Checks if $got ne $dont_expect. This is
603 $Test->isnt_num($got, $dont_expect, $name);
605 Like Test::More's isnt(). Checks if $got ne $dont_expect. This is
611 my($self, $got, $dont_expect, $name) = @_;
612 local $Level = $Level + 1;
614 if( !defined $got || !defined $dont_expect ) {
615 # undef only matches undef and nothing else
616 my $test = defined $got || defined $dont_expect;
618 $self->ok($test, $name);
619 $self->_cmp_diag($got, 'ne', $dont_expect) unless $test;
623 return $self->cmp_ok($got, 'ne', $dont_expect, $name);
627 my($self, $got, $dont_expect, $name) = @_;
628 local $Level = $Level + 1;
630 if( !defined $got || !defined $dont_expect ) {
631 # undef only matches undef and nothing else
632 my $test = defined $got || defined $dont_expect;
634 $self->ok($test, $name);
635 $self->_cmp_diag($got, '!=', $dont_expect) unless $test;
639 return $self->cmp_ok($got, '!=', $dont_expect, $name);
645 $Test->like($this, qr/$regex/, $name);
646 $Test->like($this, '/$regex/', $name);
648 Like Test::More's like(). Checks if $this matches the given $regex.
650 You'll want to avoid qr// if you want your tests to work before 5.005.
654 $Test->unlike($this, qr/$regex/, $name);
655 $Test->unlike($this, '/$regex/', $name);
657 Like Test::More's unlike(). Checks if $this B<does not match> the
663 my($self, $this, $regex, $name) = @_;
665 local $Level = $Level + 1;
666 $self->_regex_ok($this, $regex, '=~', $name);
670 my($self, $this, $regex, $name) = @_;
672 local $Level = $Level + 1;
673 $self->_regex_ok($this, $regex, '!~', $name);
679 $Test->cmp_ok($this, $type, $that, $name);
681 Works just like Test::More's cmp_ok().
683 $Test->cmp_ok($big_num, '!=', $other_big_num);
688 my %numeric_cmps = map { ($_, 1) }
689 ("<", "<=", ">", ">=", "==", "!=", "<=>");
692 my($self, $got, $type, $expect, $name) = @_;
694 # Treat overloaded objects as numbers if we're asked to do a
695 # numeric comparison.
696 my $unoverload = $numeric_cmps{$type} ? '_unoverload_num'
699 $self->$unoverload(\$got, \$expect);
704 local($@,$!,$SIG{__DIE__}); # isolate eval
706 my $code = $self->_caller_context;
708 # Yes, it has to look like this or 5.4.5 won't see the #line directive.
709 # Don't ask me, man, I just work here.
711 $code" . "\$got $type \$expect;";
714 local $Level = $Level + 1;
715 my $ok = $self->ok($test, $name);
718 if( $type =~ /^(eq|==)$/ ) {
719 $self->_is_diag($got, $type, $expect);
722 $self->_cmp_diag($got, $type, $expect);
729 my($self, $got, $type, $expect) = @_;
731 $got = defined $got ? "'$got'" : 'undef';
732 $expect = defined $expect ? "'$expect'" : 'undef';
733 return $self->diag(sprintf <<DIAGNOSTIC, $got, $type, $expect);
741 sub _caller_context {
744 my($pack, $file, $line) = $self->caller(1);
747 $code .= "#line $line $file\n" if defined $file and defined $line;
755 =head2 Other Testing Methods
757 These are methods which are used in the course of writing a test but are not themselves tests.
763 $Test->BAIL_OUT($reason);
765 Indicates to the Test::Harness that things are going so badly all
766 testing should terminate. This includes running any additional test
769 It will exit with 255.
774 my($self, $reason) = @_;
776 $self->{Bailed_Out} = 1;
777 $self->_print("Bail out! $reason");
782 BAIL_OUT() used to be BAILOUT()
786 *BAILOUT = \&BAIL_OUT;
794 Skips the current test, reporting $why.
799 my($self, $why) = @_;
801 $self->_unoverload_str(\$why);
805 lock($self->{Curr_Test});
806 $self->{Curr_Test}++;
808 $self->{Test_Results}[$self->{Curr_Test}-1] = &share({
817 $out .= " $self->{Curr_Test}" if $self->use_numbers;
819 $out .= " $why" if length $why;
831 $Test->todo_skip($why);
833 Like skip(), only it will declare the test as failing and TODO. Similar
836 print "not ok $tnum # TODO $why\n";
841 my($self, $why) = @_;
846 lock($self->{Curr_Test});
847 $self->{Curr_Test}++;
849 $self->{Test_Results}[$self->{Curr_Test}-1] = &share({
858 $out .= " $self->{Curr_Test}" if $self->use_numbers;
859 $out .= " # TODO & SKIP $why\n";
867 =begin _unimplemented
872 $Test->skip_rest($reason);
874 Like skip(), only it skips all the rest of the tests you plan to run
875 and terminates the test.
877 If you're running under no_plan, it skips once and terminates the
885 =head2 Test building utility methods
887 These methods are useful when writing your own test methods.
893 $Test->maybe_regex(qr/$regex/);
894 $Test->maybe_regex('/$regex/');
896 Convenience method for building testing functions that take regular
897 expressions as arguments, but need to work before perl 5.005.
899 Takes a quoted regular expression produced by qr//, or a string
900 representing a regular expression.
902 Returns a Perl value which may be used instead of the corresponding
903 regular expression, or undef if it's argument is not recognised.
905 For example, a version of like(), sans the useful diagnostic messages,
909 my ($self, $this, $regex, $name) = @_;
910 my $usable_regex = $self->maybe_regex($regex);
911 die "expecting regex, found '$regex'\n"
912 unless $usable_regex;
913 $self->ok($this =~ m/$usable_regex/, $name);
920 my ($self, $regex) = @_;
921 my $usable_regex = undef;
923 return $usable_regex unless defined $regex;
928 if( ref $regex eq 'Regexp' ) {
929 $usable_regex = $regex;
931 # Check for '/foo/' or 'm,foo,'
932 elsif( ($re, $opts) = $regex =~ m{^ /(.*)/ (\w*) $ }sx or
933 (undef, $re, $opts) = $regex =~ m,^ m([^\w\s]) (.+) \1 (\w*) $,sx
936 $usable_regex = length $opts ? "(?$opts)$re" : $re;
939 return $usable_regex;
943 my($self, $this, $regex, $cmp, $name) = @_;
946 my $usable_regex = $self->maybe_regex($regex);
947 unless (defined $usable_regex) {
948 $ok = $self->ok( 0, $name );
949 $self->diag(" '$regex' doesn't look much like a regex to me.");
955 my $code = $self->_caller_context;
957 local($@, $!, $SIG{__DIE__}); # isolate eval
959 # Yes, it has to look like this or 5.4.5 won't see the #line directive.
960 # Don't ask me, man, I just work here.
962 $code" . q{$test = $this =~ /$usable_regex/ ? 1 : 0};
964 $test = !$test if $cmp eq '!~';
966 local $Level = $Level + 1;
967 $ok = $self->ok( $test, $name );
971 $this = defined $this ? "'$this'" : 'undef';
972 my $match = $cmp eq '=~' ? "doesn't match" : "matches";
973 $self->diag(sprintf <<DIAGNOSTIC, $this, $match, $regex);
984 # I'm not ready to publish this. It doesn't deal with array return
985 # values from the code or context.
990 my $return_from_code = $Test->try(sub { code });
991 my($return_from_code, $error) = $Test->try(sub { code });
993 Works like eval BLOCK except it ensures it has no effect on the rest of the test (ie. $@ is not set) nor is effected by outside interference (ie. $SIG{__DIE__}) and works around some quirks in older Perls.
995 $error is what would normally be in $@.
997 It is suggested you use this in place of eval BLOCK.
1002 my($self, $code) = @_;
1004 local $!; # eval can mess up $!
1005 local $@; # don't set $@ in the test
1006 local $SIG{__DIE__}; # don't trip an outside DIE handler.
1007 my $return = eval { $code->() };
1009 return wantarray ? ($return, $@) : $return;
1017 my $is_fh = $Test->is_fh($thing);
1019 Determines if the given $thing can be used as a filehandle.
1025 my $maybe_fh = shift;
1026 return 0 unless defined $maybe_fh;
1028 return 1 if ref \$maybe_fh eq 'GLOB'; # its a glob
1030 return eval { $maybe_fh->isa("GLOB") } ||
1031 eval { $maybe_fh->isa("IO::Handle") } ||
1032 # 5.5.4's tied() and can() doesn't like getting undef
1033 eval { (tied($maybe_fh) || '')->can('TIEHANDLE') };
1047 $Test->level($how_high);
1049 How far up the call stack should $Test look when reporting where the
1054 Setting L<$Test::Builder::Level> overrides. This is typically useful
1060 local $Test::Builder::Level = $Test::Builder::Level + 1;
1064 To be polite to other functions wrapping your own you usually want to increment C<$Level> rather than set it to a constant.
1069 my($self, $level) = @_;
1071 if( defined $level ) {
1078 =item B<use_numbers>
1080 $Test->use_numbers($on_or_off);
1082 Whether or not the test should output numbers. That is, this if true:
1094 Most useful when you can't depend on the test output order, such as
1095 when threads or forking is involved.
1102 my($self, $use_nums) = @_;
1104 if( defined $use_nums ) {
1105 $self->{Use_Nums} = $use_nums;
1107 return $self->{Use_Nums};
1113 $Test->no_diag($no_diag);
1115 If set true no diagnostics will be printed. This includes calls to
1120 $Test->no_ending($no_ending);
1122 Normally, Test::Builder does some extra diagnostics when the test
1123 ends. It also changes the exit code as described below.
1125 If this is true, none of that will be done.
1129 $Test->no_header($no_header);
1131 If set to true, no "1..N" header will be printed.
1135 foreach my $attribute (qw(No_Header No_Ending No_Diag)) {
1136 my $method = lc $attribute;
1139 my($self, $no) = @_;
1142 $self->{$attribute} = $no;
1144 return $self->{$attribute};
1148 *{__PACKAGE__.'::'.$method} = $code;
1156 Controlling where the test output goes.
1158 It's ok for your test to change where STDOUT and STDERR point to,
1159 Test::Builder's default output settings will not be affected.
1167 Prints out the given @msgs. Like C<print>, arguments are simply
1170 Normally, it uses the failure_output() handle, but if this is for a
1171 TODO test, the todo_output() handle is used.
1173 Output will be indented and marked with a # so as not to interfere
1174 with test output. A newline will be put on the end if there isn't one
1177 We encourage using this rather than calling print directly.
1179 Returns false. Why? Because diag() is often used in conjunction with
1180 a failing test (C<ok() || diag()>) it "passes through" the failure.
1182 return ok(...) || diag(...);
1185 Mark Fowler <mark@twoshortplanks.com>
1190 my($self, @msgs) = @_;
1192 return if $self->no_diag;
1193 return unless @msgs;
1195 # Prevent printing headers when compiling (i.e. -c)
1198 # Smash args together like print does.
1199 # Convert undef to 'undef' so its readable.
1200 my $msg = join '', map { defined($_) ? $_ : 'undef' } @msgs;
1202 # Escape each line with a #.
1205 # Stick a newline on the end if it needs it.
1206 $msg .= "\n" unless $msg =~ /\n\Z/;
1208 local $Level = $Level + 1;
1209 $self->_print_diag($msg);
1218 $Test->_print(@msgs);
1220 Prints to the output() filehandle.
1227 my($self, @msgs) = @_;
1229 # Prevent printing headers when only compiling. Mostly for when
1230 # tests are deparsed with B::Deparse
1233 my $msg = join '', @msgs;
1235 local($\, $", $,) = (undef, ' ', '');
1236 my $fh = $self->output;
1238 # Escape each line after the first with a # so we don't
1239 # confuse Test::Harness.
1240 $msg =~ s/\n(.)/\n# $1/sg;
1242 # Stick a newline on the end if it needs it.
1243 $msg .= "\n" unless $msg =~ /\n\Z/;
1250 =item B<_print_diag>
1252 $Test->_print_diag(@msg);
1254 Like _print, but prints to the current diagnostic filehandle.
1263 local($\, $", $,) = (undef, ' ', '');
1264 my $fh = $self->todo ? $self->todo_output : $self->failure_output;
1271 $Test->output($file);
1273 Where normal "ok/not ok" test output should go.
1277 =item B<failure_output>
1279 $Test->failure_output($fh);
1280 $Test->failure_output($file);
1282 Where diagnostic output on test failures and diag() should go.
1286 =item B<todo_output>
1288 $Test->todo_output($fh);
1289 $Test->todo_output($file);
1291 Where diagnostics about todo test failures and diag() should go.
1298 my($self, $fh) = @_;
1301 $self->{Out_FH} = $self->_new_fh($fh);
1303 return $self->{Out_FH};
1306 sub failure_output {
1307 my($self, $fh) = @_;
1310 $self->{Fail_FH} = $self->_new_fh($fh);
1312 return $self->{Fail_FH};
1316 my($self, $fh) = @_;
1319 $self->{Todo_FH} = $self->_new_fh($fh);
1321 return $self->{Todo_FH};
1327 my($file_or_fh) = shift;
1330 if( $self->is_fh($file_or_fh) ) {
1334 $fh = do { local *FH };
1335 open $fh, ">$file_or_fh" or
1336 $self->croak("Can't open test output log $file_or_fh: $!");
1346 my $old_fh = select $fh;
1352 sub _dup_stdhandles {
1355 $self->_open_testhandles;
1357 # Set everything to unbuffered else plain prints to STDOUT will
1358 # come out in the wrong order from our own prints.
1359 _autoflush(\*TESTOUT);
1360 _autoflush(\*STDOUT);
1361 _autoflush(\*TESTERR);
1362 _autoflush(\*STDERR);
1364 $self->output(\*TESTOUT);
1365 $self->failure_output(\*TESTERR);
1366 $self->todo_output(\*TESTOUT);
1370 my $Opened_Testhandles = 0;
1371 sub _open_testhandles {
1372 return if $Opened_Testhandles;
1373 # We dup STDOUT and STDERR so people can change them in their
1374 # test suites while still getting normal test output.
1375 open(TESTOUT, ">&STDOUT") or die "Can't dup STDOUT: $!";
1376 open(TESTERR, ">&STDERR") or die "Can't dup STDERR: $!";
1377 $Opened_Testhandles = 1;
1383 $tb->carp(@message);
1385 Warns with C<@message> but the message will appear to come from the
1386 point where the original test function was called (C<$tb->caller>).
1390 $tb->croak(@message);
1392 Dies with C<@message> but the message will appear to come from the
1393 point where the original test function was called (C<$tb->caller>).
1397 sub _message_at_caller {
1400 local $Level = $Level + 1;
1401 my($pack, $file, $line) = $self->caller;
1402 return join("", @_) . " at $file line $line.\n";
1407 warn $self->_message_at_caller(@_);
1412 die $self->_message_at_caller(@_);
1418 unless( $self->{Have_Plan} ) {
1419 local $Level = $Level + 2;
1420 $self->croak("You tried to run a test without a plan");
1427 =head2 Test Status and Info
1431 =item B<current_test>
1433 my $curr_test = $Test->current_test;
1434 $Test->current_test($num);
1436 Gets/sets the current test number we're on. You usually shouldn't
1439 If set forward, the details of the missing tests are filled in as 'unknown'.
1440 if set backward, the details of the intervening tests are deleted. You
1441 can erase history if you really want to.
1446 my($self, $num) = @_;
1448 lock($self->{Curr_Test});
1449 if( defined $num ) {
1450 unless( $self->{Have_Plan} ) {
1451 $self->croak("Can't change the current test number without a plan!");
1454 $self->{Curr_Test} = $num;
1456 # If the test counter is being pushed forward fill in the details.
1457 my $test_results = $self->{Test_Results};
1458 if( $num > @$test_results ) {
1459 my $start = @$test_results ? @$test_results : 0;
1460 for ($start..$num-1) {
1461 $test_results->[$_] = &share({
1464 reason => 'incrementing test number',
1470 # If backward, wipe history. Its their funeral.
1471 elsif( $num < @$test_results ) {
1472 $#{$test_results} = $num - 1;
1475 return $self->{Curr_Test};
1481 my @tests = $Test->summary;
1483 A simple summary of the tests so far. True for pass, false for fail.
1484 This is a logical pass/fail, so todos are passes.
1486 Of course, test #1 is $tests[0], etc...
1493 return map { $_->{'ok'} } @{ $self->{Test_Results} };
1498 my @tests = $Test->details;
1500 Like summary(), but with a lot more detail.
1502 $tests[$test_num - 1] =
1503 { 'ok' => is the test considered a pass?
1504 actual_ok => did it literally say 'ok'?
1505 name => name of the test (if any)
1506 type => type of test (if any, see below).
1507 reason => reason for the above (if any)
1510 'ok' is true if Test::Harness will consider the test to be a pass.
1512 'actual_ok' is a reflection of whether or not the test literally
1513 printed 'ok' or 'not ok'. This is for examining the result of 'todo'
1516 'name' is the name of the test.
1518 'type' indicates if it was a special test. Normal tests have a type
1519 of ''. Type can be one of the following:
1523 todo_skip see todo_skip()
1526 Sometimes the Test::Builder test counter is incremented without it
1527 printing any test output, for example, when current_test() is changed.
1528 In these cases, Test::Builder doesn't know the result of the test, so
1529 it's type is 'unkown'. These details for these tests are filled in.
1530 They are considered ok, but the name and actual_ok is left undef.
1532 For example "not ok 23 - hole count # TODO insufficient donuts" would
1533 result in this structure:
1535 $tests[22] = # 23 - 1, since arrays start from 0.
1536 { ok => 1, # logically, the test passed since it's todo
1537 actual_ok => 0, # in absolute terms, it failed
1538 name => 'hole count',
1540 reason => 'insufficient donuts'
1547 return @{ $self->{Test_Results} };
1552 my $todo_reason = $Test->todo;
1553 my $todo_reason = $Test->todo($pack);
1555 todo() looks for a $TODO variable in your tests. If set, all tests
1556 will be considered 'todo' (see Test::More and Test::Harness for
1557 details). Returns the reason (ie. the value of $TODO) if running as
1558 todo tests, false otherwise.
1560 todo() is about finding the right package to look for $TODO in. It
1561 uses the exported_to() package to find it. If that's not set, it's
1562 pretty good at guessing the right package to look at based on $Level.
1564 Sometimes there is some confusion about where todo() should be looking
1565 for the $TODO variable. If you want to be sure, tell it explicitly
1571 my($self, $pack) = @_;
1573 $pack = $pack || $self->exported_to || $self->caller($Level);
1574 return 0 unless $pack;
1577 return defined ${$pack.'::TODO'} ? ${$pack.'::TODO'}
1583 my $package = $Test->caller;
1584 my($pack, $file, $line) = $Test->caller;
1585 my($pack, $file, $line) = $Test->caller($height);
1587 Like the normal caller(), except it reports according to your level().
1592 my($self, $height) = @_;
1595 my @caller = CORE::caller($self->level + $height + 1);
1596 return wantarray ? @caller : $caller[0];
1607 =item B<_sanity_check>
1609 $self->_sanity_check();
1611 Runs a bunch of end of test sanity checks to make sure reality came
1612 through ok. If anything is wrong it will die with a fairly friendly
1621 $self->_whoa($self->{Curr_Test} < 0, 'Says here you ran a negative number of tests!');
1622 $self->_whoa(!$self->{Have_Plan} and $self->{Curr_Test},
1623 'Somehow your tests ran without a plan!');
1624 $self->_whoa($self->{Curr_Test} != @{ $self->{Test_Results} },
1625 'Somehow you got a different number of results than tests ran!');
1630 $self->_whoa($check, $description);
1632 A sanity check, similar to assert(). If the $check is true, something
1633 has gone horribly wrong. It will die with the given $description and
1634 a note to contact the author.
1639 my($self, $check, $desc) = @_;
1641 local $Level = $Level + 1;
1642 $self->croak(<<"WHOA");
1644 This should never happen! Please contact the author immediately!
1651 _my_exit($exit_num);
1653 Perl seems to have some trouble with exiting inside an END block. 5.005_03
1654 and 5.6.1 both seem to do odd things. Instead, this function edits $?
1655 directly. It should ONLY be called from inside an END block. It
1656 doesn't actually exit, that's your job.
1673 $SIG{__DIE__} = sub {
1674 # We don't want to muck with death in an eval, but $^S isn't
1675 # totally reliable. 5.005_03 and 5.6.1 both do the wrong thing
1676 # with it. Instead, we use caller. This also means it runs under
1679 for( my $stack = 1; my $sub = (CORE::caller($stack))[3]; $stack++ ) {
1680 $in_eval = 1 if $sub =~ /^\(eval\)/;
1682 $Test->{Test_Died} = 1 unless $in_eval;
1688 $self->_sanity_check();
1690 # Don't bother with an ending if this is a forked copy. Only the parent
1691 # should do the ending.
1692 # Exit if plan() was never called. This is so "require Test::Simple"
1694 # Don't do an ending if we bailed out.
1695 if( ($self->{Original_Pid} != $$) or
1696 (!$self->{Have_Plan} && !$self->{Test_Died}) or
1704 # Figure out if we passed or failed and print helpful messages.
1705 my $test_results = $self->{Test_Results};
1706 if( @$test_results ) {
1707 # The plan? We have no plan.
1708 if( $self->{No_Plan} ) {
1709 $self->_print("1..$self->{Curr_Test}\n") unless $self->no_header;
1710 $self->{Expected_Tests} = $self->{Curr_Test};
1713 # Auto-extended arrays and elements which aren't explicitly
1714 # filled in with a shared reference will puke under 5.8.0
1715 # ithreads. So we have to fill them in by hand. :(
1716 my $empty_result = &share({});
1717 for my $idx ( 0..$self->{Expected_Tests}-1 ) {
1718 $test_results->[$idx] = $empty_result
1719 unless defined $test_results->[$idx];
1722 my $num_failed = grep !$_->{'ok'},
1723 @{$test_results}[0..$self->{Curr_Test}-1];
1725 my $num_extra = $self->{Curr_Test} - $self->{Expected_Tests};
1727 if( $num_extra < 0 ) {
1728 my $s = $self->{Expected_Tests} == 1 ? '' : 's';
1729 $self->diag(<<"FAIL");
1730 Looks like you planned $self->{Expected_Tests} test$s but only ran $self->{Curr_Test}.
1733 elsif( $num_extra > 0 ) {
1734 my $s = $self->{Expected_Tests} == 1 ? '' : 's';
1735 $self->diag(<<"FAIL");
1736 Looks like you planned $self->{Expected_Tests} test$s but ran $num_extra extra.
1740 if ( $num_failed ) {
1741 my $num_tests = $self->{Curr_Test};
1742 my $s = $num_failed == 1 ? '' : 's';
1744 my $qualifier = $num_extra == 0 ? '' : ' run';
1746 $self->diag(<<"FAIL");
1747 Looks like you failed $num_failed test$s of $num_tests$qualifier.
1751 if( $self->{Test_Died} ) {
1752 $self->diag(<<"FAIL");
1753 Looks like your test died just after $self->{Curr_Test}.
1756 _my_exit( 255 ) && return;
1761 $exit_code = $num_failed <= 254 ? $num_failed : 254;
1763 elsif( $num_extra != 0 ) {
1770 _my_exit( $exit_code ) && return;
1772 elsif ( $self->{Skip_All} ) {
1773 _my_exit( 0 ) && return;
1775 elsif ( $self->{Test_Died} ) {
1776 $self->diag(<<'FAIL');
1777 Looks like your test died before it could output anything.
1779 _my_exit( 255 ) && return;
1782 $self->diag("No tests run!\n");
1783 _my_exit( 255 ) && return;
1788 $Test->_ending if defined $Test and !$Test->no_ending;
1793 If all your tests passed, Test::Builder will exit with zero (which is
1794 normal). If anything failed it will exit with how many failed. If
1795 you run less (or more) tests than you planned, the missing (or extras)
1796 will be considered failures. If no tests were ever run Test::Builder
1797 will throw a warning and exit with 255. If the test died, even after
1798 having successfully completed all its tests, it will still be
1799 considered a failure and will exit with 255.
1801 So the exit codes are...
1803 0 all tests successful
1804 255 test died or all passed but wrong # of tests run
1805 any other number how many failed (including missing or extras)
1807 If you fail more than 254 tests, it will be reported as 254.
1812 In perl 5.8.1 and later, Test::Builder is thread-safe. The test
1813 number is shared amongst all threads. This means if one thread sets
1814 the test number using current_test() they will all be effected.
1816 While versions earlier than 5.8.1 had threads they contain too many
1819 Test::Builder is only thread-aware if threads.pm is loaded I<before>
1824 CPAN can provide the best examples. Test::Simple, Test::More,
1825 Test::Exception and Test::Differences all use Test::Builder.
1829 Test::Simple, Test::More, Test::Harness
1833 Original code by chromatic, maintained by Michael G Schwern
1834 E<lt>schwern@pobox.comE<gt>
1838 Copyright 2002, 2004 by chromatic E<lt>chromatic@wgz.orgE<gt> and
1839 Michael G Schwern E<lt>schwern@pobox.comE<gt>.
1841 This program is free software; you can redistribute it and/or
1842 modify it under the same terms as Perl itself.
1844 See F<http://www.perl.com/perl/misc/Artistic.html>