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 unless ( DBICTest::AuthorCheck->is_author || $ENV{AUTOMATED_TESTING} || $ENV{RELEASE_TESTING} ) {
  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::AuthorCheck->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::Row' => {
  46         ignore => [qw/
  47             MULTICREATE_DEBUG
  48         /],
  49     },
  50     'DBIx::Class::FilterColumn' => {
  51         ignore => [qw/
  52             new
  53             update
  54             store_column
  55             get_column
  56             get_columns
  57         /],
  58     },
  59     'DBIx::Class::ResultSource' => {
  60         ignore => [qw/
  61             compare_relationship_keys
  62             pk_depends_on
  63             resolve_condition
  64             resolve_join
  65             resolve_prefetch
  66         /],
  67     },
  68     'DBIx::Class::ResultSourceHandle' => {
  69         ignore => [qw/
  70             schema
  71             source_moniker
  72         /],
  73     },
  74     'DBIx::Class::Storage' => {
  75         ignore => [qw/
  76             schema
  77             cursor
  78         /]
  79     },
  80     'DBIx::Class::Schema' => {
  81         ignore => [qw/
  82             setup_connection_class
  83         /]
  84     },
  85
  86     'DBIx::Class::Schema::Versioned' => {
  87         ignore => [ qw/
  88             connection
  89         /]
  90     },
  91
  92     'DBIx::Class::Admin'        => {
  93         ignore => [ qw/
  94             BUILD
  95         /]
  96      },
  97
  98     'DBIx::Class::Storage::DBI::Replicated*'        => {
  99         ignore => [ qw/
 100             connect_call_do_sql
 101             disconnect_call_do_sql
 102         /]
 103     },
 104
 105     'DBIx::Class::Admin::*'                         => { skip => 1 },
 106     'DBIx::Class::ClassResolver::PassThrough'       => { skip => 1 },
 107     'DBIx::Class::Componentised'                    => { skip => 1 },
 108     'DBIx::Class::Relationship::*'                  => { skip => 1 },
 109     'DBIx::Class::ResultSetProxy'                   => { skip => 1 },
 110     'DBIx::Class::ResultSourceProxy'                => { skip => 1 },
 111     'DBIx::Class::Storage::Statistics'              => { skip => 1 },
 112     'DBIx::Class::Storage::DBI::Replicated::Types'  => { skip => 1 },
 113
 114 # test some specific components whose parents are exempt below
 115     'DBIx::Class::Relationship::Base'               => {},
 116     'DBIx::Class::SQLMaker::LimitDialects'          => {},
 117
 118 # internals
 119     'DBIx::Class::SQLMaker*'                        => { skip => 1 },
 120     'DBIx::Class::Storage::DBI*'                    => { skip => 1 },
 121     'SQL::Translator::*'                            => { skip => 1 },
 122
 123 # deprecated / backcompat stuff
 124     'DBIx::Class::CDBICompat*'                      => { skip => 1 },
 125     'DBIx::Class::ResultSetManager'                 => { skip => 1 },
 126     'DBIx::Class::DB'                               => { skip => 1 },
 127
 128 # skipped because the synopsis covers it clearly
 129     'DBIx::Class::InflateColumn::File'              => { skip => 1 },
 130 };
 131
 132 my $ex_lookup = {};
 133 for my $string (keys %$exceptions) {
 134   my $ex = $exceptions->{$string};
 135   $string =~ s/\*/'.*?'/ge;
 136   my $re = qr/^$string$/;
 137   $ex_lookup->{$re} = $ex;
 138 }
 139
 140 my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
 141
 142 foreach my $module (@modules) {
 143   SKIP: {
 144
 145     my ($match) =
 146       first { $module =~ $_ }
 147       (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
 148     ;
 149
 150     my $ex = $ex_lookup->{$match} if $match;
 151
 152     skip ("$module exempt", 1) if ($ex->{skip});
 153
 154     # build parms up from ignore list
 155     my $parms = {};
 156     $parms->{trustme} =
 157       [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
 158         if exists($ex->{ignore});
 159
 160     # run the test with the potentially modified parm set
 161     Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
 162   }
 163 }
 164
 165 done_testing;