Trap erroneous warnings
[dbsrgits/DBIx-Class.git] / t / 03podcoverage.t
CommitLineData
dc4600b2 1use warnings;
2use strict;
3
0fe5201a 4use Test::More;
32978f6e 5use List::Util ();
dc4600b2 6use lib qw(t/lib);
7use DBICTest;
0fe5201a 8
dc4600b2 9# Don't run tests for installs
10unless ( DBICTest::AuthorCheck->is_author || $ENV{AUTOMATED_TESTING} || $ENV{RELEASE_TESTING} ) {
11 plan( skip_all => "Author tests not required for installation" );
12}
0fe5201a 13
a109c954 14require DBIx::Class;
15unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
16 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
0647e0cc 17 $ENV{RELEASE_TESTING} || DBICTest::AuthorCheck->is_author
18 ? die ("Failed to load release-testing module requirements: $missing")
a109c954 19 : plan skip_all => "Test needs: $missing"
dc4600b2 20}
7eb4ecc8 21
9b83fccd 22# Since this is about checking documentation, a little documentation
32978f6e 23# of what this is doing might be in order.
9b83fccd 24# The exceptions structure below is a hash keyed by the module
32978f6e 25# name. Any * in a name is treated like a wildcard and will behave
26# as expected. Modules are matched by longest string first, so
27# A::B::C will match even if there is A::B*
28
29# The value for each is a hash, which contains one or more
9b83fccd 30# (although currently more than one makes no sense) of the following
31# things:-
32# skip => a true value means this module is not checked
33# ignore => array ref containing list of methods which
34# do not need to be documented.
7eb4ecc8 35my $exceptions = {
36 'DBIx::Class' => {
517ba890 37 ignore => [qw/
38 MODIFY_CODE_ATTRIBUTES
39 component_base_class
40 mk_classdata
41 mk_classaccessor
42 /]
b20edc27 43 },
0c62fa59 44 'DBIx::Class::Row' => {
517ba890 45 ignore => [qw/
46 MULTICREATE_DEBUG
47 /],
0c62fa59 48 },
bc984450 49 'DBIx::Class::ResultSource' => {
50 ignore => [qw/
517ba890 51 compare_relationship_keys
52 pk_depends_on
53 resolve_condition
54 resolve_join
55 resolve_prefetch
56 /],
57 },
58 'DBIx::Class::ResultSourceHandle' => {
59 ignore => [qw/
60 schema
61 source_moniker
bc984450 62 /],
63 },
b20edc27 64 'DBIx::Class::Storage' => {
517ba890 65 ignore => [qw/
66 schema
67 cursor
68 /]
7eb4ecc8 69 },
249963d4 70 'DBIx::Class::Schema' => {
517ba890 71 ignore => [qw/
72 setup_connection_class
73 /]
249963d4 74 },
32978f6e 75
76 'DBIx::Class::Schema::Versioned' => {
77 ignore => [ qw/
78 connection
517ba890 79 /]
00c937a2 80 },
737416a4 81
5f6a861d 82 'DBIx::Class::Storage::DBI::Replicated*' => {
83 ignore => [ qw/
84 connect_call_do_sql
85 disconnect_call_do_sql
86 /]
87 },
88
97f9f16e 89 'DBIx::Class::Admin::*' => { skip => 1 },
32978f6e 90 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
91 'DBIx::Class::Componentised' => { skip => 1 },
92 'DBIx::Class::Relationship::*' => { skip => 1 },
93 'DBIx::Class::ResultSetProxy' => { skip => 1 },
94 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
95 'DBIx::Class::Storage::Statistics' => { skip => 1 },
eb7afcab 96 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
737416a4 97
32978f6e 98# test some specific components whose parents are exempt below
32978f6e 99 'DBIx::Class::Relationship::Base' => {},
737416a4 100
32978f6e 101# internals
102 'DBIx::Class::SQLAHacks*' => { skip => 1 },
103 'DBIx::Class::Storage::DBI*' => { skip => 1 },
104 'SQL::Translator::*' => { skip => 1 },
737416a4 105
32978f6e 106# deprecated / backcompat stuff
107 'DBIx::Class::CDBICompat*' => { skip => 1 },
108 'DBIx::Class::ResultSetManager' => { skip => 1 },
109 'DBIx::Class::DB' => { skip => 1 },
737416a4 110
32978f6e 111# skipped because the synopsis covers it clearly
112 'DBIx::Class::InflateColumn::File' => { skip => 1 },
7eb4ecc8 113};
114
32978f6e 115my $ex_lookup = {};
116for my $string (keys %$exceptions) {
117 my $ex = $exceptions->{$string};
118 $string =~ s/\*/'.*?'/ge;
119 my $re = qr/^$string$/;
120 $ex_lookup->{$re} = $ex;
121}
122
123my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
124
7eb4ecc8 125foreach my $module (@modules) {
32978f6e 126 SKIP: {
127
128 my ($match) = List::Util::first
129 { $module =~ $_ }
130 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
131 ;
132
133 my $ex = $ex_lookup->{$match} if $match;
134
135 skip ("$module exempt", 1) if ($ex->{skip});
136
137 # build parms up from ignore list
138 my $parms = {};
139 $parms->{trustme} =
140 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
141 if exists($ex->{ignore});
142
143 # run the test with the potentially modified parm set
a109c954 144 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
32978f6e 145 }
7eb4ecc8 146}
32978f6e 147
148done_testing;