3 # 2 purpose file: 1-test 2-demonstrate (via args, -v -a options)
7 To verify that B::Concise properly reports whether functions are XS,
8 perl, or optimized constant subs, we test against a few core packages
9 which have a stable API, and which have functions of all 3 types.
13 5 core packages are tested; Digest::MD5, B, B::Deparse, Data::Dumper,
14 and POSIX. These have a mix of the 3 expected implementation types;
15 perl, XS, and constant (optimized constant subs).
17 %$testpkgs specifies what packages are tested; each package is loaded,
18 and the stash is scanned for the function-names in that package.
20 Each value in %$testpkgs is a hash-of-lists (HoL) whose keys are
21 implementation-types and values are lists of function-names of that type.
23 To keep these HoLs smaller and more managable, they may carry an
24 additional 'dflt' => $impl_Type, which means that unnamed functions
25 are expected to be of that default implementation type. Those unnamed
26 functions are known from the scan of the package stash.
28 =head1 HOW THEY'RE TESTED
30 Each function is 'rendered' by B::Concise, and result is matched
31 against regexs for each possible implementation-type. For some
32 packages, some functions may be unimplemented on some platforms.
34 To slay this maintenance dragon, the regexs used in like() match
35 against renderings which indicate that there is no implementation.
37 If a function is implemented differently on different platforms, the
38 test for that function will fail on one of those platforms. These
39 specific functions can be skipped by a 'skip' => [ @list ] to the HoL
40 mentioned previously. See usage for skip in B's HoL, which avoids
41 testing a function which doesnt exist on non-threaded builds.
43 =head1 OPTIONS AND ARGUMENTS
45 C<-v> and C<-V> trigger 2 levels of verbosity.
47 C<-a> uses Module::CoreList to run all core packages through the test, which
48 gives some interesting results.
50 C<-c> causes the expected XS/non-XS results to be marked with
51 corrections, which are then reported at program END, in a form that's
52 readily cut-and-pastable into this file.
55 C<< -r <file> >> reads a file, as written by C<-c>, and adjusts the expected
56 results accordingly. The file is 'required', so @INC settings apply.
58 If module-names are given as args, those packages are run through the
59 test harness; this is handy for collecting further items to test, and
60 may be useful otherwise (ie just to see).
66 =item ./perl -Ilib -wS ext/B/t/concise-xs.t -c Storable
68 Tests Storable.pm for XS/non-XS routines, writes findings (along with
69 test results) to stdout. You could edit results to produce a test
70 file, as in next example
72 =item ./perl -Ilib -wS ext/B/t/concise-xs.t -r ./storable
74 Loads file, and uses it to set expectations, and run tests
76 =item ./perl -Ilib -wS ext/B/t/concise-xs.t -avc > ../foo-avc 2> ../foo-avc2
78 Gets module list from Module::Corelist, and runs them all through the
79 test. Since -c is used, this generates corrections, which are saved
80 in a file, which is edited down to produce ../all-xs
82 =item ./perl -Ilib -wS ext/B/t/concise-xs.t -cr ../all-xs > ../foo 2> ../foo2
84 This runs the tests specified in the file created in previous example.
85 -c is used again, and stdout verifies that all the expected results
86 given by -r ../all-xs are now seen.
88 Looking at ../foo2, you'll see 34 occurrences of the following error:
90 # err: Can't use an undefined value as a SCALAR reference at
91 # lib/B/Concise.pm line 634, <DATA> line 1.
98 if ($ENV{PERL_CORE}) {
100 @INC = ('.', '../lib');
103 push @INC, "../../t";
106 if (($Config::Config{'extensions'} !~ /\bB\b/) ){
107 print "1..0 # Skip -- Perl configured without B module\n";
110 unless ($Config::Config{useperlio}) {
111 print "1..0 # Skip -- Perl configured without perlio\n";
118 use Test::More 'no_plan';
120 require_ok("B::Concise");
123 ( constant => qr{ (?-x: is a constant sub, optimized to a \w+)
124 |(?-x: exists in stash, but has no START) }x,
125 XS => qr/ is XS code/,
126 perl => qr/ (next|db)state/,
127 noSTART => qr/ exists in stash, but has no START/,
131 # packages to test, with expected types for named funcs
133 Digest::MD5 => { perl => [qw/ import /],
136 Data::Dumper => { XS => [qw/ bootstrap Dumpxs /],
139 dflt => 'constant', # all but 47/297
140 skip => [ 'regex_padav' ], # threaded only
142 walksymtable walkoptree_slow walkoptree_exec
143 timing_info savesym peekop parents objsym debug
144 compile_stats clearsym class
147 warnhook walkoptree_debug walkoptree threadsv_names
148 svref_2object sv_yes sv_undef sv_no save_BEGINs
149 regex_padav ppname perlstring opnumber minus_c
150 main_start main_root main_cv init_av inc_gv hash
151 formfeed end_av dowarn diehook defstash curstash
152 cstring comppadlist check_av cchar cast_I32 bootstrap
153 begin_av amagic_generation sub_generation address
154 ), $] > 5.009 ? ('unitcheck_av') : ()],
157 B::Deparse => { dflt => 'perl', # 235 functions
159 XS => [qw( svref_2object perlstring opnumber main_start
160 main_root main_cv )],
162 constant => [qw/ ASSIGN CVf_LOCKED CVf_LVALUE
163 CVf_METHOD LIST_CONTEXT OP_CONST OP_LIST OP_RV2SV
164 OP_STRINGIFY OPf_KIDS OPf_MOD OPf_REF OPf_SPECIAL
165 OPf_STACKED OPf_WANT OPf_WANT_LIST OPf_WANT_SCALAR
166 OPf_WANT_VOID OPpCONST_ARYBASE OPpCONST_BARE
167 OPpENTERSUB_AMPER OPpEXISTS_SUB OPpITER_REVERSED
168 OPpLVAL_INTRO OPpOUR_INTRO OPpSLICE OPpSORT_DESCEND
169 OPpSORT_INPLACE OPpSORT_INTEGER OPpSORT_NUMERIC
170 OPpSORT_REVERSE OPpTARGET_MY OPpTRANS_COMPLEMENT
171 OPpTRANS_DELETE OPpTRANS_SQUASH PMf_CONTINUE
172 PMf_EVAL PMf_EXTENDED PMf_FOLD PMf_GLOBAL PMf_KEEP
173 PMf_MULTILINE PMf_ONCE PMf_SINGLELINE
174 POSTFIX SVf_FAKE SVf_IOK SVf_NOK SVf_POK SVf_ROK
175 SVpad_OUR SVs_RMG SVs_SMG SWAP_CHILDREN OPpPAD_STATE
176 /, $] > 5.009 ? ('RXf_SKIPWHITE') : ('PMf_SKIPWHITE')],
179 POSIX => { dflt => 'constant', # all but 252/589
180 skip => [qw/ _POSIX_JOB_CONTROL /], # platform varying
181 perl => [qw/ import croak AUTOLOAD /],
183 XS => [qw/ write wctomb wcstombs uname tzset tzname
184 ttyname tmpnam times tcsetpgrp tcsendbreak
185 tcgetpgrp tcflush tcflow tcdrain tanh tan
186 sysconf strxfrm strtoul strtol strtod
187 strftime strcoll sinh sigsuspend sigprocmask
188 sigpending sigaction setuid setsid setpgid
189 setlocale setgid read pipe pause pathconf
190 open nice modf mktime mkfifo mbtowc mbstowcs
191 mblen lseek log10 localeconv ldexp lchown
192 isxdigit isupper isspace ispunct isprint
193 islower isgraph isdigit iscntrl isalpha
194 isalnum int_macro_int getcwd frexp fpathconf
195 fmod floor dup2 dup difftime cuserid ctime
196 ctermid cosh constant close clock ceil
197 bootstrap atan asin asctime acos access abort
202 IO::Socket => { dflt => 'constant', # 157/190
204 perl => [qw/ timeout socktype sockopt sockname
205 socketpair socket sockdomain sockaddr_un
206 sockaddr_in shutdown setsockopt send
207 register_domain recv protocol peername
208 new listen import getsockopt croak
209 connected connect configure confess close
210 carp bind atmark accept
211 /, $] > 5.009 ? ('blocking') : () ],
213 XS => [qw/ unpack_sockaddr_un unpack_sockaddr_in
214 sockatmark sockaddr_family pack_sockaddr_un
215 pack_sockaddr_in inet_ntoa inet_aton
222 B::Concise::compile('-nobanner'); # set a silent default
223 getopts('vaVcr:', \my %opts) or
226 usage: PERL_CORE=1 ./perl ext/B/t/concise-xs.t [-av] [module-list]
227 tests ability to discern XS funcs using Digest::MD5 package
230 -a : runs all modules in CoreList
231 -c : writes test corrections as a Data::Dumper expression
232 -r <file> : reads file of tests, as written by -c
233 <args> : additional modules are loaded and tested
234 (will report failures, since no XS funcs are known apriori)
240 require Data::Dumper;
241 Data::Dumper->import('Dumper');
242 $Data::Dumper::Sortkeys = 1;
248 my $refpkgs = require "$opts{r}";
249 $testpkgs->{$_} = $refpkgs->{$_} foreach keys %$refpkgs;
254 foreach $pkg (sort keys %$testpkgs) {
255 test_pkg($pkg, $testpkgs->{$pkg});
258 foreach $pkg (@argpkgs) {
259 test_pkg($pkg, $testpkgs->{$pkg});
268 my ($pkg, $fntypes) = @_;
271 # build %stash: keys are func-names, vals filled in below
274 => ( grep exists &{"$pkg\::$_"} # grab CODE symbols
275 => grep !/__ANON__/ # but not anon subs
276 => keys %{$pkg.'::'} # from symbol table
279 for my $type (keys %matchers) {
280 foreach my $fn (@{$fntypes->{$type}}) {
281 carp "$fn can only be one of $type, $stash{$fn}\n"
286 # set default type for un-named functions
287 my $dflt = $fntypes->{dflt} || 'perl';
288 for my $k (keys %stash) {
289 $stash{$k} = $dflt unless $stash{$k};
291 $stash{$_} = 'skip' foreach @{$fntypes->{skip}};
294 diag("fntypes: " => Dumper($fntypes));
295 diag("$pkg stash: " => Dumper(\%stash));
297 foreach my $fn (reverse sort keys %stash) {
298 next if $stash{$fn} eq 'skip';
299 my $res = checkXS("${pkg}::$fn", $stash{$fn});
301 push @{$report{$pkg}{$res}}, $fn;
307 my ($func_name, $want) = @_;
309 croak "unknown type $want: $func_name\n"
310 unless defined $matchers{$want};
312 my ($buf, $err) = render($func_name);
313 my $res = like($buf, $matchers{$want}, "$want sub:\t $func_name");
316 # test failed. return type that would give success
317 for my $m (keys %matchers) {
318 return $m if $buf =~ $matchers{$m};
325 my ($func_name) = @_;
327 B::Concise::reset_sequence();
328 B::Concise::walk_output(\my $buf);
330 my $walker = B::Concise::compile($func_name);
331 eval { $walker->() };
332 diag("err: $@ $buf") if $@;
333 diag("verbose: $buf") if $opts{V};
339 eval { require Module::CoreList };
341 warn "Module::CoreList not available on $]\n";
344 my $mods = $Module::CoreList::version{'5.009002'};
345 $mods = [ sort keys %$mods ];
348 foreach my $pkgnm (@$mods) {
355 $Data::Dumper::Indent = 1;
356 print "Corrections: ", Dumper(\%report);
358 foreach my $pkg (sort keys %report) {
359 for my $type (keys %matchers) {
360 print "$pkg: $type: @{$report{$pkg}{$type}}\n"
361 if @{$report{$pkg}{$type}};