Fix incorrect handling of $? in travis preconf script
[dbsrgits/DBIx-Class.git] / xt / podcoverage.t
CommitLineData
dc4600b2 1use warnings;
2use strict;
3
0fe5201a 4use Test::More;
6298a324 5use List::Util 'first';
47589465 6use lib qw(t/lib .generated_pod);
dc4600b2 7use DBICTest;
6298a324 8use namespace::clean;
0fe5201a 9
a109c954 10require DBIx::Class;
11unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
12 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
20884f55 13 $ENV{RELEASE_TESTING}
a109c954 14 ? die ("Failed to load release-testing module requirements: $missing")
15 : plan skip_all => "Test needs: $missing"
dc4600b2 16}
7eb4ecc8 17
9b83fccd 18# Since this is about checking documentation, a little documentation
32978f6e 19# of what this is doing might be in order.
9b83fccd 20# The exceptions structure below is a hash keyed by the module
32978f6e 21# name. Any * in a name is treated like a wildcard and will behave
8c96bbc2 22# as expected. Modules are matched by longest string first, so
32978f6e 23# A::B::C will match even if there is A::B*
24
25# The value for each is a hash, which contains one or more
9b83fccd 26# (although currently more than one makes no sense) of the following
27# things:-
28# skip => a true value means this module is not checked
29# ignore => array ref containing list of methods which
30# do not need to be documented.
7eb4ecc8 31my $exceptions = {
32 'DBIx::Class' => {
517ba890 33 ignore => [qw/
34 MODIFY_CODE_ATTRIBUTES
35 component_base_class
36 mk_classdata
37 mk_classaccessor
38 /]
b20edc27 39 },
70c28808 40 'DBIx::Class::Carp' => {
41 ignore => [qw/
42 unimport
43 /]
44 },
0c62fa59 45 'DBIx::Class::Row' => {
517ba890 46 ignore => [qw/
47 MULTICREATE_DEBUG
48 /],
0c62fa59 49 },
1f870d5a 50 'DBIx::Class::Storage::TxnScopeGuard' => {
51 ignore => [qw/
52 IS_BROKEN_PERL
53 /],
54 },
cde96798 55 'DBIx::Class::FilterColumn' => {
56 ignore => [qw/
57 new
58 update
491c8ff9 59 store_column
60 get_column
61 get_columns
cde96798 62 /],
63 },
bc984450 64 'DBIx::Class::ResultSource' => {
65 ignore => [qw/
517ba890 66 compare_relationship_keys
67 pk_depends_on
68 resolve_condition
69 resolve_join
70 resolve_prefetch
50261284 71 STORABLE_freeze
72 STORABLE_thaw
517ba890 73 /],
74 },
0b66414b 75 'DBIx::Class::ResultSet' => {
76 ignore => [qw/
77 STORABLE_freeze
78 STORABLE_thaw
79 /],
80 },
517ba890 81 'DBIx::Class::ResultSourceHandle' => {
82 ignore => [qw/
83 schema
84 source_moniker
bc984450 85 /],
86 },
b20edc27 87 'DBIx::Class::Storage' => {
517ba890 88 ignore => [qw/
89 schema
90 cursor
91 /]
7eb4ecc8 92 },
249963d4 93 'DBIx::Class::Schema' => {
517ba890 94 ignore => [qw/
95 setup_connection_class
96 /]
249963d4 97 },
32978f6e 98
99 'DBIx::Class::Schema::Versioned' => {
100 ignore => [ qw/
101 connection
517ba890 102 /]
00c937a2 103 },
737416a4 104
8c96bbc2 105 'DBIx::Class::Admin' => {
106 ignore => [ qw/
107 BUILD
108 /]
109 },
110
5f6a861d 111 'DBIx::Class::Storage::DBI::Replicated*' => {
112 ignore => [ qw/
113 connect_call_do_sql
114 disconnect_call_do_sql
115 /]
116 },
117
97f9f16e 118 'DBIx::Class::Admin::*' => { skip => 1 },
32978f6e 119 'DBIx::Class::ClassResolver::PassThrough' => { skip => 1 },
120 'DBIx::Class::Componentised' => { skip => 1 },
db29433c 121 'DBIx::Class::AccessorGroup' => { skip => 1 },
32978f6e 122 'DBIx::Class::Relationship::*' => { skip => 1 },
123 'DBIx::Class::ResultSetProxy' => { skip => 1 },
124 'DBIx::Class::ResultSourceProxy' => { skip => 1 },
9550c834 125 'DBIx::Class::ResultSource::*' => { skip => 1 },
32978f6e 126 'DBIx::Class::Storage::Statistics' => { skip => 1 },
eb7afcab 127 'DBIx::Class::Storage::DBI::Replicated::Types' => { skip => 1 },
a4367b26 128 'DBIx::Class::GlobalDestruction' => { skip => 1 },
9345b14c 129 'DBIx::Class::Storage::BlockRunner' => { skip => 1 }, # temporary
737416a4 130
32978f6e 131# test some specific components whose parents are exempt below
32978f6e 132 'DBIx::Class::Relationship::Base' => {},
d5dedbd6 133 'DBIx::Class::SQLMaker::LimitDialects' => {},
737416a4 134
32978f6e 135# internals
d5dedbd6 136 'DBIx::Class::SQLMaker*' => { skip => 1 },
9fc20b28 137 'DBIx::Class::SQLAHacks*' => { skip => 1 },
32978f6e 138 'DBIx::Class::Storage::DBI*' => { skip => 1 },
139 'SQL::Translator::*' => { skip => 1 },
737416a4 140
32978f6e 141# deprecated / backcompat stuff
1b6fe47d 142 'DBIx::Class::Serialize::Storable' => { skip => 1 },
32978f6e 143 'DBIx::Class::CDBICompat*' => { skip => 1 },
144 'DBIx::Class::ResultSetManager' => { skip => 1 },
145 'DBIx::Class::DB' => { skip => 1 },
737416a4 146
32978f6e 147# skipped because the synopsis covers it clearly
148 'DBIx::Class::InflateColumn::File' => { skip => 1 },
cd122820 149
150# internal subclass, nothing to POD
151 'DBIx::Class::ResultSet::Pager' => { skip => 1 },
7eb4ecc8 152};
153
32978f6e 154my $ex_lookup = {};
155for my $string (keys %$exceptions) {
156 my $ex = $exceptions->{$string};
157 $string =~ s/\*/'.*?'/ge;
158 my $re = qr/^$string$/;
159 $ex_lookup->{$re} = $ex;
160}
161
47589465 162my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
32978f6e 163
7eb4ecc8 164foreach my $module (@modules) {
32978f6e 165 SKIP: {
166
6298a324 167 my ($match) =
168 first { $module =~ $_ }
32978f6e 169 (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
170 ;
171
172 my $ex = $ex_lookup->{$match} if $match;
173
174 skip ("$module exempt", 1) if ($ex->{skip});
175
176 # build parms up from ignore list
177 my $parms = {};
178 $parms->{trustme} =
179 [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
180 if exists($ex->{ignore});
181
182 # run the test with the potentially modified parm set
a109c954 183 Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
32978f6e 184 }
7eb4ecc8 185}
32978f6e 186
187done_testing;