5b147d431498074c0bb5bd023cd0cf8b6402567a
[dbsrgits/DBIx-Class.git] / t / 55namespaces_cleaned.t
1 BEGIN {
2   if ($] < 5.010) {
3
4     # Pre-5.10 perls pollute %INC on unsuccesfull module
5     # require, making it appear as if the module is already
6     # loaded on subsequent require()s
7     # Can't seem to find the exact RT/perldelta entry
8     #
9     # The reason we can't just use a sane, clean loader, is because
10     # if a Module require()s another module the %INC will still
11     # get filled with crap and we are back to square one. A global
12     # fix is really the only way for this test, as we try to load
13     # each available module separately, and have no control (nor
14     # knowledge) over their common dependencies.
15     #
16     # we want to do this here, in the very beginning, before even
17     # warnings/strict are loaded
18
19     unshift @INC, 't/lib';
20     require DBICTest::Util::OverrideRequire;
21
22     DBICTest::Util::OverrideRequire::override_global_require( sub {
23       my $res = eval { $_[0]->() };
24       if ($@ ne '') {
25         delete $INC{$_[1]};
26         die $@;
27       }
28       return $res;
29     } );
30   }
31 }
32
33 use strict;
34 use warnings;
35
36 use Test::More;
37
38 use lib 't/lib';
39 use DBICTest;
40
41 use File::Find;
42 use File::Spec;
43 use B qw/svref_2object/;
44 use Package::Stash;
45
46 # makes sure we can load at least something
47 use DBIx::Class;
48 use DBIx::Class::Carp;
49
50 my @modules = grep {
51   my ($mod) = $_ =~ /(.+)/;
52
53   # not all modules are loadable at all times
54   do {
55     # trap deprecation warnings and whatnot
56     local $SIG{__WARN__} = sub {};
57     eval "require $mod";
58   } ? $mod : do {
59     SKIP: { skip "Failed require of $mod: " . ($@ =~ /^(.+?)$/m)[0], 1 };
60     (); # empty RV for @modules
61   };
62
63 } find_modules();
64
65 # have an exception table for old and/or weird code we are not sure
66 # we *want* to clean in the first place
67 my $skip_idx = { map { $_ => 1 } (
68   (grep { /^DBIx::Class::CDBICompat/ } @modules), # too crufty to touch
69   'SQL::Translator::Producer::DBIx::Class::File', # ditto
70
71   # not sure how to handle type libraries
72   'DBIx::Class::Storage::DBI::Replicated::Types',
73   'DBIx::Class::Admin::Types',
74
75   # G::L::D is unclean, but we never inherit from it
76   'DBIx::Class::Admin::Descriptive',
77   'DBIx::Class::Admin::Usage',
78
79   # this subclass is expected to inherit whatever crap comes
80   # from the parent
81   'DBIx::Class::ResultSet::Pager',
82
83   # utility classes, not part of the inheritance chain
84   'DBIx::Class::ResultSource::RowParser::Util',
85   'DBIx::Class::_Util',
86 ) };
87
88 my $has_cmop = eval { require Class::MOP };
89
90 # can't use Class::Inspector for the mundane parts as it does not
91 # distinguish imports from anything else, what a crock of...
92 # Class::MOP is not always available either - hence just do it ourselves
93
94 my $seen; #inheritance means we will see the same method multiple times
95
96 for my $mod (@modules) {
97   SKIP: {
98     skip "$mod exempt from namespace checks",1 if $skip_idx->{$mod};
99
100     my %all_method_like = (map
101       { %{Package::Stash->new($_)->get_all_symbols('CODE')} }
102       (reverse @{mro::get_linear_isa($mod)})
103     );
104
105     my %parents = map { $_ => 1 } @{mro::get_linear_isa($mod)};
106
107     my %roles;
108     if ($has_cmop and my $mc = Class::MOP::class_of($mod)) {
109       if ($mc->can('calculate_all_roles_with_inheritance')) {
110         $roles{$_->name} = 1 for ($mc->calculate_all_roles_with_inheritance);
111       }
112     }
113
114     for my $name (keys %all_method_like) {
115
116       next if ( DBIx::Class::_ENV_::BROKEN_NAMESPACE_CLEAN and $name =~ /^carp(?:_unique|_once)?$/ );
117
118       # overload is a funky thing - it is not cleaned, and its imports are named funny
119       next if $name =~ /^\(/;
120
121       my $gv = svref_2object($all_method_like{$name})->GV;
122       my $origin = $gv->STASH->NAME;
123
124       is ($gv->NAME, $name, "Properly named $name method at $origin" . ($origin eq $mod
125         ? ''
126         : " (inherited by $mod)"
127       ));
128
129       next if $seen->{"${origin}:${name}"}++;
130
131       if ($origin eq $mod) {
132         pass ("$name is a native $mod method");
133       }
134       elsif ($roles{$origin}) {
135         pass ("${mod}::${name} came from consumption of role $origin");
136       }
137       elsif ($parents{$origin}) {
138         pass ("${mod}::${name} came from proper parent-class $origin");
139       }
140       else {
141         my $via;
142         for (reverse @{mro::get_linear_isa($mod)} ) {
143           if ( ($_->can($name)||'') eq $all_method_like{$name} ) {
144             $via = $_;
145             last;
146           }
147         }
148         fail ("${mod}::${name} appears to have entered inheritance chain by import into "
149             . ($via || 'UNKNOWN')
150         );
151       }
152     }
153
154     next if DBIx::Class::_ENV_::BROKEN_NAMESPACE_CLEAN;
155
156     # some common import names (these should never ever be methods)
157     for my $f (qw/carp carp_once carp_unique croak confess cluck try catch finally/) {
158       if ($mod->can($f)) {
159         my $via;
160         for (reverse @{mro::get_linear_isa($mod)} ) {
161           if ( ($_->can($f)||'') eq $all_method_like{$f} ) {
162             $via = $_;
163             last;
164           }
165         }
166         fail ("Import $f leaked into method list of ${mod}, appears to have entered inheritance chain at "
167             . ($via || 'UNKNOWN')
168         );
169       }
170       else {
171         pass ("Import $f not leaked into method list of $mod");
172       }
173     }
174   }
175 }
176
177 sub find_modules {
178   my @modules;
179
180   find({
181     wanted => sub {
182       -f $_ or return;
183       s/\.pm$// or return;
184       s/^ (?: lib | blib . (?:lib|arch) ) . //x;
185       push @modules, join ('::', File::Spec->splitdir($_));
186     },
187     no_chdir => 1,
188   }, (-e 'blib' ? 'blib' : 'lib') );
189
190   return sort @modules;
191 }
192
193 done_testing;