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 local @INC = ( 't/lib', @INC );
20 # Pre-5.10 perls pollute %INC on unsuccesfull module
21 # require, making it appear as if the module is already
22 # loaded on subsequent require()s
23 # Can't seem to find the exact RT/perldelta entry
25 # The reason we can't just use a sane, clean loader, is because
26 # if a Module require()s another module the %INC will still
27 # get filled with crap and we are back to square one. A global
28 # fix is really the only way for this test, as we try to load
29 # each available module separately, and have no control (nor
30 # knowledge) over their common dependencies.
32 # we want to do this here, in the very beginning, before even
33 # warnings/strict are loaded
35 require DBICTest::Util::OverrideRequire;
37 DBICTest::Util::OverrideRequire::override_global_require( sub {
38 my $res = eval { $_[0]->() };
48 require DBICTest::RunMode;
49 require DBICTest::Util;
55 use Test::More 'no_plan';
57 use File::Find 'find';
62 use ExtUtils::MakeMaker;
64 use DBIx::Class::Optional::Dependencies;
68 config_key => 'sitearch',
71 config_key => 'sitelib',
74 config_key => 'sitelib_stem',
78 config_key => 'siteprefix',
82 config_key => 'vendorarch',
85 config_key => 'vendorlib',
88 config_key => 'vendorlib_stem',
92 config_key => 'vendorprefix',
96 config_key => 'archlib',
99 config_key => 'privlib',
102 config_key => 'prefix',
106 rel_path => './blib/arch',
107 skip_unversioned_modules => 1,
110 rel_path => './blib/lib',
111 skip_unversioned_modules => 1,
118 skip_unversioned_modules => 1,
122 skip_unversioned_modules => 1,
126 skip_unversioned_modules => 1,
133 abs_unix_path => abs_unix_path (
134 eval { require File::HomeDir and File::HomeDir->my_home }
145 for my $k (keys %$known_paths) {
146 my $v = $known_paths->{$k};
148 # never use home as a found-in-dir marker - it is too broad
149 # HOME is only used by the shortener
150 $v->{marker} = $k unless $k eq 'HOME';
152 unless ( $v->{abs_unix_path} ) {
153 if ( $v->{rel_path} ) {
154 $v->{abs_unix_path} = abs_unix_path( $v->{rel_path} );
156 elsif ( $Config{ $v->{config_key} || '' } ) {
157 $v->{abs_unix_path} = abs_unix_path (
158 $Config{"$v->{config_key}exp"} || $Config{$v->{config_key}}
163 delete $known_paths->{$k} unless $v->{abs_unix_path} and -d $v->{abs_unix_path};
165 my $seen_markers = {};
167 # first run through lib/ and *try* to load anything we can find
168 # within our own project
173 $_ =~ m|lib/DBIx/Class/_TempExtlib| and return;
175 # can't just `require $fn`, as we need %INC to be
177 my ($mod) = $_ =~ /^ lib [\/\\] (.+) \.pm $/x
180 try_module_require(join ('::', File::Spec->splitdir($mod)) )
187 # now run through OptDeps and attempt loading everything else
189 # some things needs to be sorted before other things
190 # positive - load first
191 # negative - load last
193 # Make sure oracle is tried last - some clients (e.g. 10.2) have symbol
194 # clashes with libssl, and will segfault everything coming after them
195 "DBD::Oracle" => -999,
198 my @known_modules = sort
199 { ($load_weights->{$b}||0) <=> ($load_weights->{$a}||0) }
204 { keys %{ DBIx::Class::Optional::Dependencies->req_list_for($_) } }
206 # some DBDs are notoriously problematic to load
207 # hence only show stuff based on test_rdbms which will
208 # take into account necessary ENVs
209 { $_ !~ /^ (?: rdbms | dist )_ /x }
210 keys %{DBIx::Class::Optional::Dependencies->req_group_list}
213 try_module_require($_) for @known_modules;
215 my $has_versionpm = eval { require version };
218 # At this point we've loaded everything we ever could, but some modules
219 # (understandably) crapped out. For an even more thorough report, note
220 # everthing present in @INC we excplicitly know about (via OptDeps)
221 # *even though* it didn't load
222 my $known_failed_loads;
224 for my $mod (@known_modules) {
225 my $inc_key = module_notional_filename($mod);
226 next if defined $INC{$inc_key};
228 if (defined( my $idx = module_found_at_inc_index( $mod, \@INC ) ) ) {
229 $known_failed_loads->{$mod} = abs_unix_path( "$INC[$idx]/$inc_key" );
236 # This is a cool idea, but the line is too long even with shortening :(
238 #for my $i ( 1 .. $Config{config_argc} ) {
239 # my $conf_arg = $Config{"config_arg$i"};
243 # '=' . shorten_fn($1)
246 # $perl .= " $conf_arg";
249 my $interesting_modules = {
253 abs_unix_path => abs_unix_path($^X),
258 # drill through the *ENTIRE* symtable and build a map of interesting modules
259 DBICTest::Util::visit_namespaces( action => sub {
263 # keep going, but nothing to see here
264 return 1 if $pkg eq 'main';
266 # private - not interested, including no further descent
267 return 0 if $pkg =~ / (?: ^ | :: ) _ /x;
269 my $inc_key = module_notional_filename($pkg);
271 my $abs_unix_path = (
278 abs_unix_path($INC{$inc_key})
281 # handle versions first (not interested in synthetic classes)
283 defined ${"${pkg}::VERSION"}
285 ${"${pkg}::VERSION"} !~ /\Qset by base.pm/
288 # make sure a version can be extracted, be noisy when it doesn't work
289 # do this even if we are throwing away the result below in lieu of EUMM
290 my $mod_ver = eval { $pkg->VERSION };
295 "Calling `$pkg->VERSION` resulted in an exception, which should never "
296 . "happen - please file a bug with the distribution containing $pkg. "
297 . "Complete exception text below:\n\n$err"
300 elsif( ! defined $mod_ver or ! length $mod_ver ) {
301 my $ret = defined $mod_ver
302 ? "the empty string ''"
307 "Calling `$pkg->VERSION` returned $ret, even though \$${pkg}::VERSION "
308 . "is defined, which should never happen - please file a bug with the "
309 . "distribution containing $pkg."
318 defined ( my $eumm_ver = eval { MM->parse_version( $abs_unix_path ) } )
321 # can only run the check reliably if v.pm is there
327 $eumm_ver ne $mod_ver
330 ( eval { version->parse( do { (my $v = $eumm_ver) =~ s/_//g; $v } ) } || 0 )
332 ( eval { version->parse( do { (my $v = $mod_ver) =~ s/_//g; $v } ) } || 0 )
336 "Mismatch of versions '$mod_ver' and '$eumm_ver', obtained respectively "
337 . "via `$pkg->VERSION` and parsing the version out of @{[ shorten_fn( $abs_unix_path ) ]} "
338 . "with ExtUtils::MakeMaker\@@{[ ExtUtils::MakeMaker->VERSION ]}. "
339 . "This should never happen - please check whether this is still present "
340 . "in the latest version, and then file a bug with the distribution "
345 $interesting_modules->{$pkg}{version} = $eumm_ver;
347 elsif( defined $mod_ver ) {
349 $interesting_modules->{$pkg}{version} = $mod_ver;
352 elsif ( $known_failed_loads->{$pkg} ) {
353 $abs_unix_path = $known_failed_loads->{$pkg};
354 $interesting_modules->{$pkg}{version} = '!! LOAD FAIL !!';
357 if ($abs_unix_path) {
358 my ($marker, $initial_inc_idx);
360 my $current_inc_idx = module_found_at_inc_index($pkg, \@INC);
361 my $p = subpath_of_known_path( $abs_unix_path );
364 defined $current_inc_idx
368 abs_unix_path($INC[$current_inc_idx]) eq $p->{abs_unix_path}
370 $marker = $p->{marker};
372 elsif (defined ( $initial_inc_idx = module_found_at_inc_index($pkg, \@initial_INC) ) ) {
373 $marker = "\$INC[$initial_inc_idx]";
376 # we are only interested if there was a declared version already above
377 # OR if the module came from somewhere other than skip_unversioned_modules
382 $interesting_modules->{$pkg}
384 !$p->{skip_unversioned_modules}
387 $interesting_modules->{$pkg}{source_marker} = $marker;
388 $seen_markers->{$marker} = 1;
391 # at this point only fill in the path (md5 calc) IFF it is interesting
393 $interesting_modules->{$pkg}{abs_unix_path} = $abs_unix_path
394 if $interesting_modules->{$pkg};
400 # compress identical versions sourced from ./blib, ./lib, ./t and ./xt
401 # as close to the root of a namespace as we can
402 purge_identically_versioned_submodules_with_markers([ map {
403 ( $_->{skip_unversioned_modules} && $_->{marker} ) || ()
404 } values %$known_paths ]);
406 ok 1, (scalar keys %$interesting_modules) . " distinctly versioned modules found";
408 # do not announce anything under ci - we are watching for STDERR silence
409 exit 0 if DBICTest::RunMode->is_ci;
412 # diag the result out
413 my $max_ver_len = max map
415 ( 'xxx.yyyzzz_bbb', map { $_->{version} || '' } values %$interesting_modules )
417 my $max_marker_len = max map { length $_ } ( '$INC[999]', keys %$seen_markers );
421 List of loadable modules within both the core and *OPTIONAL* dependency chains
422 present on this system (modules sourced from ./blib, ./lib, ./t, and ./xt
423 with versions identical to their parent namespace were omitted for brevity)
425 *** Note that *MANY* of these modules will *NEVER* be loaded ***
426 *** during normal operation of DBIx::Class ***
429 # pre-assemble everything and print it in one shot
430 # makes it less likely for parallel test execution to insert bogus lines
431 my $final_out = "\n$discl\n";
433 $final_out .= "\@INC at startup (does not reflect manipulation at runtime):\n";
436 for (0.. $#initial_INC) {
438 my $shortname = shorten_fn( $initial_INC[$_] );
440 # when *to* print a line of INC
442 ! $ENV{AUTOMATED_TESTING}
446 $seen_markers->{"\$INC[$_]"}
450 ! File::Spec->file_name_is_absolute($shortname)
453 $final_out .= sprintf ( "% 3s: %s\n",
458 elsif(! $in_inc_skip++) {
459 $final_out .= " ...\n";
465 if (my @seen_known_paths = grep { $known_paths->{$_} } keys %$seen_markers) {
467 $final_out .= join "\n", 'Sourcing markers:', (map
470 $max_marker_len => $_->{marker},
471 ($_->{config_key} ? "\$Config{$_->{config_key}}" : "$_->{rel_path}/" )
475 !!$b->{config_key} cmp !!$a->{config_key}
477 ( $a->{marker}||'') cmp ($b->{marker}||'')
479 @{$known_paths}{@seen_known_paths}
484 $final_out .= "=============================\n";
486 $final_out .= join "\n", (map
489 $max_marker_len => $interesting_modules->{$_}{source_marker} || '',
490 $max_ver_len => ( defined $interesting_modules->{$_}{version}
491 ? $interesting_modules->{$_}{version}
495 ($interesting_modules->{$_}{abs_unix_path}
496 ? " [ MD5: @{[ get_md5( $interesting_modules->{$_}{abs_unix_path} ) ]} ]"
497 : "! -f \$INC{'@{[ module_notional_filename($_) ]}'}"
500 sort { lc($a) cmp lc($b) } keys %$interesting_modules
503 $final_out .= "=============================\n$discl\n\n";
507 # *very* large printouts may not finish flushing before the test exits
508 # injecting a <testname> ... ok in the middle of the diag
509 # http://www.cpantesters.org/cpan/report/fbdac74c-35ca-11e6-ab41-c893a58a4b8c
510 select( undef, undef, undef, 0.2 );
516 sub say_err { print STDERR "\n", @_, "\n\n" };
518 # do !!!NOT!!! use Module::Runtime's require_module - it breaks CORE::require
519 sub try_module_require {
520 # trap deprecation warnings and whatnot
521 local $SIG{__WARN__} = sub {};
523 eval "require $_[0]";
530 ( -e $_[0] or File::Spec->file_name_is_absolute($_[0]) )
533 # File::Spec's rel2abs does not resolve symlinks
534 # we *need* to look at the filesystem to be sure
535 my $abs_fn = abs_path($_[0]);
537 if ( $^O eq 'MSWin32' and $abs_fn ) {
539 # sometimes we can get a short/longname mix, normalize everything to longnames
540 $abs_fn = Win32::GetLongPathName($abs_fn);
542 # Fixup (native) slashes in Config not matching (unixy) slashes in INC
552 my $abs_fn = abs_unix_path($fn);
554 if (my $p = subpath_of_known_path( $fn ) ) {
555 $abs_fn =~ s| (?<! / ) $|/|x
558 if ($p->{rel_path}) {
559 $abs_fn =~ s!\Q$p->{abs_unix_path}!$p->{rel_path}!
562 elsif ($p->{config_key}) {
563 $abs_fn =~ s!\Q$p->{abs_unix_path}!<<$p->{marker}>>!
565 $seen_markers->{$p->{marker}} = 1
571 # we got so far - not a known path
572 # return the unixified version it if was absolute, leave as-is otherwise
573 my $rv = ( $abs_fn and File::Spec->file_name_is_absolute( $fn ) )
578 $rv = "( ! -e ) $rv" unless -e $rv;
583 sub subpath_of_known_path {
584 my $abs_fn = abs_unix_path( $_[0] )
589 length( $b->{abs_unix_path} ) <=> length( $a->{abs_unix_path} )
591 ( $a->{match_order} || 0 ) <=> ( $b->{match_order} || 0 )
595 # run through the matcher twice - first always append a /
597 # important to avoid false positives
598 for my $suff ( '/', '' ) {
599 return { %$p } if 0 == index( $abs_fn, "$p->{abs_unix_path}$suff" );
604 sub module_found_at_inc_index {
605 my ($mod, $inc_dirs) = @_;
607 return undef unless @$inc_dirs;
609 my $fn = module_notional_filename($mod);
611 # trust INC if it specifies an existing path
612 if( -f ( my $existing_path = abs_unix_path( $INC{$fn} ) ) ) {
613 for my $i ( 0 .. $#$inc_dirs ) {
615 # searching from here on out won't mean anything
616 # FIXME - there is actually a way to interrogate this safely, but
617 # that's a fight for another day
618 return undef if length ref $inc_dirs->[$i];
621 if 0 == index( $existing_path, abs_unix_path( $inc_dirs->[$i] ) . '/' );
625 for my $i ( 0 .. $#$inc_dirs ) {
630 -f "$inc_dirs->[$i]/$fn"
632 -r "$inc_dirs->[$i]/$fn"
641 sub purge_identically_versioned_submodules_with_markers {
644 return unless @$markers;
646 for my $mod ( sort { length($b) <=> length($a) } keys %$interesting_modules ) {
648 next unless defined $interesting_modules->{$mod}{version};
650 my $marker = $interesting_modules->{$mod}{source_marker}
653 next unless grep { $marker eq $_ } @$markers;
657 while ( $parent =~ s/ :: (?: . (?! :: ) )+ $ //x ) {
658 $interesting_modules->{$parent}
660 ($interesting_modules->{$parent}{version}||'') eq $interesting_modules->{$mod}{version}
662 ($interesting_modules->{$parent}{source_marker}||'') eq $interesting_modules->{$mod}{source_marker}
664 delete $interesting_modules->{$mod}
671 sub module_notional_filename {
672 (my $fn = $_[0] . '.pm') =~ s|::|/|g;
677 # we already checked for -r/-f, just bail if can't open
678 open my $fh, '<:raw', $_[0] or return '';
679 Digest::MD5->new->addfile($fh)->hexdigest;