File | /usr/local/lib/perl5/5.10.1/Test/Builder/Module.pm |
Statements Executed | 43 |
Statement Execution Time | 3.07ms |
Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
---|---|---|---|---|---|
1 | 1 | 1 | 19.2ms | 20.6ms | BEGIN@5 | Test::Builder::Module::
2 | 2 | 2 | 54µs | 2.97ms | import | Test::Builder::Module::
5 | 4 | 2 | 44µs | 63µs | builder | Test::Builder::Module::
1 | 1 | 1 | 18µs | 21µs | BEGIN@3 | Test::Builder::Module::
1 | 1 | 1 | 12µs | 12µs | _strip_imports | Test::Builder::Module::
0 | 0 | 0 | 0s | 0s | import_extra | Test::Builder::Module::
Line | State ments |
Time on line |
Calls | Time in subs |
Code |
---|---|---|---|---|---|
1 | package Test::Builder::Module; | ||||
2 | |||||
3 | 3 | 28µs | 2 | 25µs | # spent 21µs (18+4) within Test::Builder::Module::BEGIN@3 which was called
# once (18µs+4µs) by Test::More::BEGIN@23 at line 3 # spent 21µs making 1 call to Test::Builder::Module::BEGIN@3
# spent 4µs making 1 call to strict::import |
4 | |||||
5 | 3 | 1.84ms | 1 | 20.6ms | # spent 20.6ms (19.2+1.37) within Test::Builder::Module::BEGIN@5 which was called
# once (19.2ms+1.37ms) by Test::More::BEGIN@23 at line 5 # spent 20.6ms making 1 call to Test::Builder::Module::BEGIN@5 |
6 | |||||
7 | 1 | 1.06ms | require Exporter; | ||
8 | 1 | 14µs | our @ISA = qw(Exporter); | ||
9 | |||||
10 | 1 | 700ns | our $VERSION = '0.94'; | ||
11 | 1 | 30µs | $VERSION = eval $VERSION; ## no critic (BuiltinFunctions::ProhibitStringyEval) | ||
12 | |||||
13 | |||||
14 | =head1 NAME | ||||
15 | |||||
16 | Test::Builder::Module - Base class for test modules | ||||
17 | |||||
18 | =head1 SYNOPSIS | ||||
19 | |||||
20 | # Emulates Test::Simple | ||||
21 | package Your::Module; | ||||
22 | |||||
23 | my $CLASS = __PACKAGE__; | ||||
24 | |||||
25 | use base 'Test::Builder::Module'; | ||||
26 | @EXPORT = qw(ok); | ||||
27 | |||||
28 | sub ok ($;$) { | ||||
29 | my $tb = $CLASS->builder; | ||||
30 | return $tb->ok(@_); | ||||
31 | } | ||||
32 | |||||
33 | 1; | ||||
34 | |||||
35 | |||||
36 | =head1 DESCRIPTION | ||||
37 | |||||
38 | This is a superclass for Test::Builder-based modules. It provides a | ||||
39 | handful of common functionality and a method of getting at the underlying | ||||
40 | Test::Builder object. | ||||
41 | |||||
42 | |||||
43 | =head2 Importing | ||||
44 | |||||
45 | Test::Builder::Module is a subclass of Exporter which means your | ||||
46 | module is also a subclass of Exporter. @EXPORT, @EXPORT_OK, etc... | ||||
47 | all act normally. | ||||
48 | |||||
49 | A few methods are provided to do the C<use Your::Module tests => 23> part | ||||
50 | for you. | ||||
51 | |||||
52 | =head3 import | ||||
53 | |||||
54 | Test::Builder::Module provides an import() method which acts in the | ||||
55 | same basic way as Test::More's, setting the plan and controling | ||||
56 | exporting of functions and variables. This allows your module to set | ||||
57 | the plan independent of Test::More. | ||||
58 | |||||
59 | All arguments passed to import() are passed onto | ||||
60 | C<< Your::Module->builder->plan() >> with the exception of | ||||
61 | C<import =>[qw(things to import)]>. | ||||
62 | |||||
63 | use Your::Module import => [qw(this that)], tests => 23; | ||||
64 | |||||
65 | says to import the functions this() and that() as well as set the plan | ||||
66 | to be 23 tests. | ||||
67 | |||||
68 | import() also sets the exported_to() attribute of your builder to be | ||||
69 | the caller of the import() function. | ||||
70 | |||||
71 | Additional behaviors can be added to your import() method by overriding | ||||
72 | import_extra(). | ||||
73 | |||||
74 | =cut | ||||
75 | |||||
76 | # spent 2.97ms (54µs+2.92) within Test::Builder::Module::import which was called 2 times, avg 1.49ms/call:
# once (49µs+2.92ms) by main::BEGIN@1 at line 1 of 01.HTTP.t
# once (5µs+0s) by Test::More::BEGIN@23 at line 23 of Test/More.pm | ||||
77 | 2 | 2µs | my($class) = shift; | ||
78 | |||||
79 | # Don't run all this when loading ourself. | ||||
80 | 2 | 9µs | return 1 if $class eq 'Test::Builder::Module'; | ||
81 | |||||
82 | 1 | 3µs | 1 | 10µs | my $test = $class->builder; # spent 10µs making 1 call to Test::Builder::Module::builder |
83 | |||||
84 | 1 | 900ns | my $caller = caller; | ||
85 | |||||
86 | 1 | 2µs | 1 | 5µs | $test->exported_to($caller); # spent 5µs making 1 call to Test::Builder::exported_to |
87 | |||||
88 | 1 | 2µs | 1 | 16µs | $class->import_extra( \@_ ); # spent 16µs making 1 call to Test::More::import_extra |
89 | 1 | 5µs | 1 | 12µs | my(@imports) = $class->_strip_imports( \@_ ); # spent 12µs making 1 call to Test::Builder::Module::_strip_imports |
90 | |||||
91 | 1 | 2µs | 1 | 139µs | $test->plan(@_); # spent 139µs making 1 call to Test::Builder::plan |
92 | |||||
93 | 1 | 11µs | 1 | 2.45ms | $class->export_to_level( 1, $class, @imports ); # spent 2.45ms making 1 call to Exporter::export_to_level |
94 | } | ||||
95 | |||||
96 | # spent 12µs within Test::Builder::Module::_strip_imports which was called
# once (12µs+0s) by Test::Builder::Module::import at line 89 | ||||
97 | 1 | 700ns | my $class = shift; | ||
98 | 1 | 200ns | my $list = shift; | ||
99 | |||||
100 | 1 | 300ns | my @imports = (); | ||
101 | 1 | 300ns | my @other = (); | ||
102 | 1 | 300ns | my $idx = 0; | ||
103 | 1 | 1µs | while( $idx <= $#{$list} ) { | ||
104 | 2 | 900ns | my $item = $list->[$idx]; | ||
105 | |||||
106 | 2 | 800ns | if( defined $item and $item eq 'import' ) { | ||
107 | push @imports, @{ $list->[ $idx + 1 ] }; | ||||
108 | $idx++; | ||||
109 | } | ||||
110 | else { | ||||
111 | 2 | 1µs | push @other, $item; | ||
112 | } | ||||
113 | |||||
114 | 2 | 1µs | $idx++; | ||
115 | } | ||||
116 | |||||
117 | 1 | 2µs | @$list = @other; | ||
118 | |||||
119 | 1 | 5µs | return @imports; | ||
120 | } | ||||
121 | |||||
122 | =head3 import_extra | ||||
123 | |||||
124 | Your::Module->import_extra(\@import_args); | ||||
125 | |||||
126 | import_extra() is called by import(). It provides an opportunity for you | ||||
127 | to add behaviors to your module based on its import list. | ||||
128 | |||||
129 | Any extra arguments which shouldn't be passed on to plan() should be | ||||
130 | stripped off by this method. | ||||
131 | |||||
132 | See Test::More for an example of its use. | ||||
133 | |||||
134 | B<NOTE> This mechanism is I<VERY ALPHA AND LIKELY TO CHANGE> as it | ||||
135 | feels like a bit of an ugly hack in its current form. | ||||
136 | |||||
137 | =cut | ||||
138 | |||||
139 | sub import_extra { } | ||||
140 | |||||
141 | =head2 Builder | ||||
142 | |||||
143 | Test::Builder::Module provides some methods of getting at the underlying | ||||
144 | Test::Builder object. | ||||
145 | |||||
146 | =head3 builder | ||||
147 | |||||
148 | my $builder = Your::Class->builder; | ||||
149 | |||||
150 | This method returns the Test::Builder object associated with Your::Class. | ||||
151 | It is not a constructor so you can call it as often as you like. | ||||
152 | |||||
153 | This is the preferred way to get the Test::Builder object. You should | ||||
154 | I<not> get it via C<< Test::Builder->new >> as was previously | ||||
155 | recommended. | ||||
156 | |||||
157 | The object returned by builder() may change at runtime so you should | ||||
158 | call builder() inside each function rather than store it in a global. | ||||
159 | |||||
160 | sub ok { | ||||
161 | my $builder = Your::Class->builder; | ||||
162 | |||||
163 | return $builder->ok(@_); | ||||
164 | } | ||||
165 | |||||
166 | |||||
167 | =cut | ||||
168 | |||||
169 | # spent 63µs (44+19) within Test::Builder::Module::builder which was called 5 times, avg 13µs/call:
# 2 times (19µs+9µs) by Test::More::ok at line 293 of Test/More.pm, avg 14µs/call
# once (11µs+5µs) by Test::More::isa_ok at line 576 of Test/More.pm
# once (7µs+3µs) by Test::More::use_ok at line 811 of Test/More.pm
# once (7µs+2µs) by Test::Builder::Module::import at line 82 | ||||
170 | 5 | 36µs | 5 | 19µs | return Test::Builder->new; # spent 19µs making 5 calls to Test::Builder::new, avg 4µs/call |
171 | } | ||||
172 | |||||
173 | 1 | 8µs | 1; |