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 .generated_pod);
   7 use DBICTest;
   8 use namespace::clean;
   9
  10 require DBIx::Class;
  11 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
  12   my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
  13   $ENV{RELEASE_TESTING}
  14     ? die ("Failed to load release-testing module requirements: $missing")
  15     : plan skip_all => "Test needs: $missing"
  16 }
  17
  18 # Since this is about checking documentation, a little documentation
  19 # of what this is doing might be in order.
  20 # The exceptions structure below is a hash keyed by the module
  21 # name. Any * in a name is treated like a wildcard and will behave
  22 # as expected. Modules are matched by longest string first, so
  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
  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.
  31 my $exceptions = {
  32     'DBIx::Class' => {
  33         ignore => [qw/
  34             MODIFY_CODE_ATTRIBUTES
  35             component_base_class
  36             mk_classdata
  37             mk_classaccessor
  38         /]
  39     },
  40     'DBIx::Class::Carp' => {
  41         ignore => [qw/
  42             unimport
  43         /]
  44     },
  45     'DBIx::Class::Row' => {
  46         ignore => [qw/
  47             MULTICREATE_DEBUG
  48         /],
  49     },
  50     'DBIx::Class::Storage::TxnScopeGuard' => {
  51         ignore => [qw/
  52             IS_BROKEN_PERL
  53         /],
  54     },
  55     'DBIx::Class::FilterColumn' => {
  56         ignore => [qw/
  57             new
  58             update
  59             store_column
  60             get_column
  61             get_columns
  62         /],
  63     },
  64     'DBIx::Class::ResultSource' => {
  65         ignore => [qw/
  66             compare_relationship_keys
  67             pk_depends_on
  68             resolve_condition
  69             resolve_join
  70             resolve_prefetch
  71             STORABLE_freeze
  72             STORABLE_thaw
  73         /],
  74     },
  75     'DBIx::Class::ResultSet' => {
  76         ignore => [qw/
  77             STORABLE_freeze
  78             STORABLE_thaw
  79         /],
  80     },
  81     'DBIx::Class::ResultSourceHandle' => {
  82         ignore => [qw/
  83             schema
  84             source_moniker
  85         /],
  86     },
  87     'DBIx::Class::Storage' => {
  88         ignore => [qw/
  89             schema
  90             cursor
  91         /]
  92     },
  93     'DBIx::Class::Schema' => {
  94         ignore => [qw/
  95             setup_connection_class
  96         /]
  97     },
  98
  99     'DBIx::Class::Schema::Versioned' => {
 100         ignore => [ qw/
 101             connection
 102         /]
 103     },
 104
 105     'DBIx::Class::Admin'        => {
 106         ignore => [ qw/
 107             BUILD
 108         /]
 109      },
 110
 111     'DBIx::Class::Storage::DBI::Replicated*'        => {
 112         ignore => [ qw/
 113             connect_call_do_sql
 114             disconnect_call_do_sql
 115         /]
 116     },
 117
 118     'DBIx::Class::Admin::*'                         => { skip => 1 },
 119     'DBIx::Class::ClassResolver::PassThrough'       => { skip => 1 },
 120     'DBIx::Class::Componentised'                    => { skip => 1 },
 121     'DBIx::Class::AccessorGroup'                    => { skip => 1 },
 122     'DBIx::Class::Relationship::*'                  => { skip => 1 },
 123     'DBIx::Class::ResultSetProxy'                   => { skip => 1 },
 124     'DBIx::Class::ResultSourceProxy'                => { skip => 1 },
 125     'DBIx::Class::ResultSource::*'                  => { skip => 1 },
 126     'DBIx::Class::Storage::Statistics'              => { skip => 1 },
 127     'DBIx::Class::Storage::DBI::Replicated::Types'  => { skip => 1 },
 128     'DBIx::Class::GlobalDestruction'                => { skip => 1 },
 129     'DBIx::Class::Storage::BlockRunner'             => { skip => 1 }, # temporary
 130
 131 # test some specific components whose parents are exempt below
 132     'DBIx::Class::Relationship::Base'               => {},
 133     'DBIx::Class::SQLMaker::LimitDialects'          => {},
 134
 135 # internals
 136     'DBIx::Class::SQLMaker*'                        => { skip => 1 },
 137     'DBIx::Class::SQLAHacks*'                       => { skip => 1 },
 138     'DBIx::Class::Storage::DBI*'                    => { skip => 1 },
 139     'SQL::Translator::*'                            => { skip => 1 },
 140
 141 # deprecated / backcompat stuff
 142     'DBIx::Class::Serialize::Storable'              => { skip => 1 },
 143     'DBIx::Class::CDBICompat*'                      => { skip => 1 },
 144     'DBIx::Class::ResultSetManager'                 => { skip => 1 },
 145     'DBIx::Class::DB'                               => { skip => 1 },
 146
 147 # skipped because the synopsis covers it clearly
 148     'DBIx::Class::InflateColumn::File'              => { skip => 1 },
 149
 150 # internal subclass, nothing to POD
 151     'DBIx::Class::ResultSet::Pager'                 => { skip => 1 },
 152 };
 153
 154 my $ex_lookup = {};
 155 for 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
 162 my @modules = sort { $a cmp $b } Test::Pod::Coverage::all_modules('lib');
 163
 164 foreach my $module (@modules) {
 165   SKIP: {
 166
 167     my ($match) =
 168       first { $module =~ $_ }
 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
 183     Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
 184   }
 185 }
 186
 187 done_testing;