2 ### This version is rather 5.8-centric, because DBIC itself is 5.8
3 ### It certainly can be rewritten to degrade well on 5.6
6 # Very important to grab the snapshot early, as we will be reporting
7 # the INC indices from the POV of whoever ran the script, *NOT* from
8 # the POV of the internals
15 unshift @INC, 't/lib';
19 # Pre-5.10 perls pollute %INC on unsuccesfull module
20 # require, making it appear as if the module is already
21 # loaded on subsequent require()s
22 # Can't seem to find the exact RT/perldelta entry
24 # The reason we can't just use a sane, clean loader, is because
25 # if a Module require()s another module the %INC will still
26 # get filled with crap and we are back to square one. A global
27 # fix is really the only way for this test, as we try to load
28 # each available module separately, and have no control (nor
29 # knowledge) over their common dependencies.
31 # we want to do this here, in the very beginning, before even
32 # warnings/strict are loaded
34 require DBICTest::Util::OverrideRequire;
36 DBICTest::Util::OverrideRequire::override_global_require( sub {
37 my $res = eval { $_[0]->() };
50 use Test::More 'no_plan';
52 use File::Find 'find';
57 use ExtUtils::MakeMaker;
59 use DBICTest::RunMode;
60 use DBICTest::Util 'visit_namespaces';
61 use DBIx::Class::Optional::Dependencies;
65 config_key => 'sitearch',
68 config_key => 'sitelib',
71 config_key => 'sitelib_stem',
75 config_key => 'siteprefix',
79 config_key => 'vendorarch',
82 config_key => 'vendorlib',
85 config_key => 'vendorlib_stem',
89 config_key => 'vendorprefix',
93 config_key => 'archlib',
96 config_key => 'privlib',
99 config_key => 'prefix',
103 rel_path => './blib/arch',
104 skip_unversioned_modules => 1,
107 rel_path => './blib/lib',
108 skip_unversioned_modules => 1,
115 skip_unversioned_modules => 1,
119 skip_unversioned_modules => 1,
123 skip_unversioned_modules => 1,
130 abs_unix_path => abs_unix_path (
131 eval { require File::HomeDir and File::HomeDir->my_home }
142 for my $k (keys %$known_paths) {
143 my $v = $known_paths->{$k};
145 # never use home as a found-in-dir marker - it is too broad
146 # HOME is only used by the shortener
147 $v->{marker} = $k unless $k eq 'HOME';
149 unless ( $v->{abs_unix_path} ) {
150 if ( $v->{rel_path} ) {
151 $v->{abs_unix_path} = abs_unix_path( $v->{rel_path} );
153 elsif ( $Config{ $v->{config_key} || '' } ) {
154 $v->{abs_unix_path} = abs_unix_path (
155 $Config{"$v->{config_key}exp"} || $Config{$v->{config_key}}
160 delete $known_paths->{$k} unless $v->{abs_unix_path} and -d $v->{abs_unix_path};
162 my $seen_markers = {};
164 # first run through lib/ and *try* to load anything we can find
165 # within our own project
170 # can't just `require $fn`, as we need %INC to be
172 my ($mod) = $_ =~ /^ lib [\/\\] (.+) \.pm $/x
175 try_module_require(join ('::', File::Spec->splitdir($mod)) )
182 # now run through OptDeps and attempt loading everything else
184 # some things needs to be sorted before other things
185 # positive - load first
186 # negative - load last
188 # Make sure oracle is tried last - some clients (e.g. 10.2) have symbol
189 # clashes with libssl, and will segfault everything coming after them
190 "DBD::Oracle" => -999,
193 my @known_modules = sort
194 { ($load_weights->{$b}||0) <=> ($load_weights->{$a}||0) }
196 DBIx::Class::Optional::Dependencies->req_list_for([
198 # some DBDs are notoriously problematic to load
199 # hence only show stuff based on test_rdbms which will
200 # take into account necessary ENVs
201 { $_ !~ /^ (?: rdbms | dist )_ /x }
202 keys %{DBIx::Class::Optional::Dependencies->req_group_list}
207 try_module_require($_) for @known_modules;
209 my $has_versionpm = eval { require version };
212 # At this point we've loaded everything we ever could, but some modules
213 # (understandably) crapped out. For an even more thorough report, note
214 # everthing present in @INC we excplicitly know about (via OptDeps)
215 # *even though* it didn't load
216 my $known_failed_loads;
218 for my $mod (@known_modules) {
219 my $inc_key = module_notional_filename($mod);
220 next if defined $INC{$inc_key};
222 if (defined( my $idx = module_found_at_inc_index( $mod, \@INC ) ) ) {
223 $known_failed_loads->{$mod} = abs_unix_path( "$INC[$idx]/$inc_key" );
230 # This is a cool idea, but the line is too long even with shortening :(
232 #for my $i ( 1 .. $Config{config_argc} ) {
233 # my $conf_arg = $Config{"config_arg$i"};
237 # '=' . shorten_fn($1)
240 # $perl .= " $conf_arg";
243 my $interesting_modules = {
247 abs_unix_path => abs_unix_path($^X),
252 # drill through the *ENTIRE* symtable and build a map of interesting modules
253 visit_namespaces( action => sub {
257 # keep going, but nothing to see here
258 return 1 if $pkg eq 'main';
260 # private - not interested, including no further descent
261 return 0 if $pkg =~ / (?: ^ | :: ) _ /x;
263 my $inc_key = module_notional_filename($pkg);
265 my $abs_unix_path = (
272 abs_unix_path($INC{$inc_key})
275 # handle versions first (not interested in synthetic classes)
277 defined ${"${pkg}::VERSION"}
279 ${"${pkg}::VERSION"} !~ /\Qset by base.pm/
282 # make sure a version can be extracted, be noisy when it doesn't work
283 # do this even if we are throwing away the result below in lieu of EUMM
284 my $mod_ver = eval { $pkg->VERSION };
289 "Calling `$pkg->VERSION` resulted in an exception, which should never "
290 . "happen - please file a bug with the distribution containing $pkg. "
291 . "Complete exception text below:\n\n$err"
294 elsif( ! defined $mod_ver or ! length $mod_ver ) {
295 my $ret = defined $mod_ver
296 ? "the empty string ''"
301 "Calling `$pkg->VERSION` returned $ret, even though \$${pkg}::VERSION "
302 . "is defined, which should never happen - please file a bug with the "
303 . "distribution containing $pkg."
312 defined ( my $eumm_ver = eval { MM->parse_version( $abs_unix_path ) } )
315 # can only run the check reliably if v.pm is there
321 $eumm_ver ne $mod_ver
324 ( eval { version->parse( do { (my $v = $eumm_ver) =~ s/_//g; $v } ) } || 0 )
326 ( eval { version->parse( do { (my $v = $mod_ver) =~ s/_//g; $v } ) } || 0 )
330 "Mismatch of versions '$mod_ver' and '$eumm_ver', obtained respectively "
331 . "via `$pkg->VERSION` and parsing the version out of @{[ shorten_fn( $abs_unix_path ) ]} "
332 . "with ExtUtils::MakeMaker\@@{[ ExtUtils::MakeMaker->VERSION ]}. "
333 . "This should never happen - please check whether this is still present "
334 . "in the latest version, and then file a bug with the distribution "
339 $interesting_modules->{$pkg}{version} = $eumm_ver;
341 elsif( defined $mod_ver ) {
343 $interesting_modules->{$pkg}{version} = $mod_ver;
346 elsif ( $known_failed_loads->{$pkg} ) {
347 $abs_unix_path = $known_failed_loads->{$pkg};
348 $interesting_modules->{$pkg}{version} = '!! LOAD FAIL !!';
351 if ($abs_unix_path) {
352 my ($marker, $initial_inc_idx);
354 my $current_inc_idx = module_found_at_inc_index($pkg, \@INC);
355 my $p = subpath_of_known_path( $abs_unix_path );
358 defined $current_inc_idx
362 abs_unix_path($INC[$current_inc_idx]) eq $p->{abs_unix_path}
364 $marker = $p->{marker};
366 elsif (defined ( $initial_inc_idx = module_found_at_inc_index($pkg, \@initial_INC) ) ) {
367 $marker = "\$INC[$initial_inc_idx]";
370 # we are only interested if there was a declared version already above
371 # OR if the module came from somewhere other than skip_unversioned_modules
376 $interesting_modules->{$pkg}
378 !$p->{skip_unversioned_modules}
381 $interesting_modules->{$pkg}{source_marker} = $marker;
382 $seen_markers->{$marker} = 1;
385 # at this point only fill in the path (md5 calc) IFF it is interesting
387 $interesting_modules->{$pkg}{abs_unix_path} = $abs_unix_path
388 if $interesting_modules->{$pkg};
394 # compress identical versions sourced from ./blib, ./lib, ./t and ./xt
395 # as close to the root of a namespace as we can
396 purge_identically_versioned_submodules_with_markers([ map {
397 ( $_->{skip_unversioned_modules} && $_->{marker} ) || ()
398 } values %$known_paths ]);
400 ok 1, (scalar keys %$interesting_modules) . " distinctly versioned modules found";
402 # do not announce anything under ci - we are watching for STDERR silence
403 exit 0 if DBICTest::RunMode->is_ci;
406 # diag the result out
407 my $max_ver_len = max map
409 ( 'xxx.yyyzzz_bbb', map { $_->{version} || '' } values %$interesting_modules )
411 my $max_marker_len = max map { length $_ } ( '$INC[999]', keys %$seen_markers );
415 List of loadable modules within both the core and *OPTIONAL* dependency chains
416 present on this system (modules sourced from ./blib, ./lib, ./t, and ./xt
417 with versions identical to their parent namespace were omitted for brevity)
419 *** Note that *MANY* of these modules will *NEVER* be loaded ***
420 *** during normal operation of DBIx::Class ***
423 # pre-assemble everything and print it in one shot
424 # makes it less likely for parallel test execution to insert bogus lines
425 my $final_out = "\n$discl\n";
427 $final_out .= "\@INC at startup (does not reflect manipulation at runtime):\n";
430 for (0.. $#initial_INC) {
432 my $shortname = shorten_fn( $initial_INC[$_] );
434 # when *to* print a line of INC
436 ! $ENV{AUTOMATED_TESTING}
440 $seen_markers->{"\$INC[$_]"}
444 ! File::Spec->file_name_is_absolute($shortname)
447 $final_out .= sprintf ( "% 3s: %s\n",
452 elsif(! $in_inc_skip++) {
453 $final_out .= " ...\n";
459 if (my @seen_known_paths = grep { $known_paths->{$_} } keys %$seen_markers) {
461 $final_out .= join "\n", 'Sourcing markers:', (map
464 $max_marker_len => $_->{marker},
465 ($_->{config_key} ? "\$Config{$_->{config_key}}" : "$_->{rel_path}/" )
469 !!$b->{config_key} cmp !!$a->{config_key}
471 ( $a->{marker}||'') cmp ($b->{marker}||'')
473 @{$known_paths}{@seen_known_paths}
478 $final_out .= "=============================\n";
480 $final_out .= join "\n", (map
483 $max_marker_len => $interesting_modules->{$_}{source_marker} || '',
484 $max_ver_len => ( defined $interesting_modules->{$_}{version}
485 ? $interesting_modules->{$_}{version}
489 ($interesting_modules->{$_}{abs_unix_path}
490 ? " [ MD5: @{[ get_md5( $interesting_modules->{$_}{abs_unix_path} ) ]} ]"
491 : "! -f \$INC{'@{[ module_notional_filename($_) ]}'}"
494 sort { lc($a) cmp lc($b) } keys %$interesting_modules
497 $final_out .= "=============================\n$discl\n\n";
505 sub say_err { print STDERR "\n", @_, "\n\n" };
507 # do !!!NOT!!! use Module::Runtime's require_module - it breaks CORE::require
508 sub try_module_require {
509 # trap deprecation warnings and whatnot
510 local $SIG{__WARN__} = sub {};
512 eval "require $_[0]";
519 ( -e $_[0] or File::Spec->file_name_is_absolute($_[0]) )
522 # File::Spec's rel2abs does not resolve symlinks
523 # we *need* to look at the filesystem to be sure
524 my $abs_fn = abs_path($_[0]);
526 if ( $^O eq 'MSWin32' and $abs_fn ) {
528 # sometimes we can get a short/longname mix, normalize everything to longnames
529 $abs_fn = Win32::GetLongPathName($abs_fn);
531 # Fixup (native) slashes in Config not matching (unixy) slashes in INC
541 my $abs_fn = abs_unix_path($fn);
543 if (my $p = subpath_of_known_path( $fn ) ) {
544 $abs_fn =~ s| (?<! / ) $|/|x
547 if ($p->{rel_path}) {
548 $abs_fn =~ s!\Q$p->{abs_unix_path}!$p->{rel_path}!
551 elsif ($p->{config_key}) {
552 $abs_fn =~ s!\Q$p->{abs_unix_path}!<<$p->{marker}>>!
554 $seen_markers->{$p->{marker}} = 1
560 # we got so far - not a known path
561 # return the unixified version it if was absolute, leave as-is otherwise
562 my $rv = ( $abs_fn and File::Spec->file_name_is_absolute( $fn ) )
567 $rv = "( ! -e ) $rv" unless -e $rv;
572 sub subpath_of_known_path {
573 my $abs_fn = abs_unix_path( $_[0] )
578 length( $b->{abs_unix_path} ) <=> length( $a->{abs_unix_path} )
580 ( $a->{match_order} || 0 ) <=> ( $b->{match_order} || 0 )
584 # run through the matcher twice - first always append a /
586 # important to avoid false positives
587 for my $suff ( '/', '' ) {
588 return { %$p } if 0 == index( $abs_fn, "$p->{abs_unix_path}$suff" );
593 sub module_found_at_inc_index {
594 my ($mod, $inc_dirs) = @_;
596 return undef unless @$inc_dirs;
598 my $fn = module_notional_filename($mod);
600 for my $i ( 0 .. $#$inc_dirs ) {
602 # searching from here on out won't mean anything
603 # FIXME - there is actually a way to interrogate this safely, but
604 # that's a fight for another day
605 return undef if length ref $inc_dirs->[$i];
610 -f "$inc_dirs->[$i]/$fn"
612 -r "$inc_dirs->[$i]/$fn"
621 sub purge_identically_versioned_submodules_with_markers {
624 return unless @$markers;
626 for my $mod ( sort { length($b) <=> length($a) } keys %$interesting_modules ) {
628 next unless defined $interesting_modules->{$mod}{version};
630 my $marker = $interesting_modules->{$mod}{source_marker}
633 next unless grep { $marker eq $_ } @$markers;
637 while ( $parent =~ s/ :: (?: . (?! :: ) )+ $ //x ) {
638 $interesting_modules->{$parent}
640 ($interesting_modules->{$parent}{version}||'') eq $interesting_modules->{$mod}{version}
642 ($interesting_modules->{$parent}{source_marker}||'') eq $interesting_modules->{$mod}{source_marker}
644 delete $interesting_modules->{$mod}
651 sub module_notional_filename {
652 (my $fn = $_[0] . '.pm') =~ s|::|/|g;
657 # we already checked for -r/-f, just bail if can't open
658 open my $fh, '<:raw', $_[0] or return '';
659 Digest::MD5->new->addfile($fh)->hexdigest;