xt/podcoverage.t

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