t/03podcoverage.t

   1 use warnings;
   2 use strict;
   3
   4 use Test::More;
   5 use List::Util ();
   6 use lib qw(t/lib);
   7 use DBICTest;
   8
   9 # Don't run tests for installs
  10 unless ( DBICTest::AuthorCheck->is_author || $ENV{AUTOMATED_TESTING} || $ENV{RELEASE_TESTING} ) {
  11   plan( skip_all => "Author tests not required for installation" );
  12 }
  13
  14 require DBIx::Class;
  15 unless ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_podcoverage') ) {
  16   my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('test_podcoverage');
  17   $ENV{RELEASE_TESTING} || DBICTest::AuthorCheck->is_author
  18     ? die ("Failed to load release-testing module requirements: $missing")
  19     : plan skip_all => "Test needs: $missing"
  20 }
  21
  22 # Since this is about checking documentation, a little documentation
  23 # of what this is doing might be in order.
  24 # The exceptions structure below is a hash keyed by the module
  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
  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.
  35 my $exceptions = {
  36     'DBIx::Class' => {
  37         ignore => [qw/
  38             MODIFY_CODE_ATTRIBUTES
  39             component_base_class
  40             mk_classdata
  41             mk_classaccessor
  42         /]
  43     },
  44     'DBIx::Class::Row' => {
  45         ignore => [qw/
  46             MULTICREATE_DEBUG
  47         /],
  48     },
  49     'DBIx::Class::FilterColumn' => {
  50         ignore => [qw/
  51             new
  52             update
  53             store_column
  54             get_column
  55             get_columns
  56         /],
  57     },
  58     'DBIx::Class::ResultSource' => {
  59         ignore => [qw/
  60             compare_relationship_keys
  61             pk_depends_on
  62             resolve_condition
  63             resolve_join
  64             resolve_prefetch
  65         /],
  66     },
  67     'DBIx::Class::ResultSourceHandle' => {
  68         ignore => [qw/
  69             schema
  70             source_moniker
  71         /],
  72     },
  73     'DBIx::Class::Storage' => {
  74         ignore => [qw/
  75             schema
  76             cursor
  77         /]
  78     },
  79     'DBIx::Class::Schema' => {
  80         ignore => [qw/
  81             setup_connection_class
  82         /]
  83     },
  84
  85     'DBIx::Class::Schema::Versioned' => {
  86         ignore => [ qw/
  87             connection
  88         /]
  89     },
  90
  91     'DBIx::Class::Storage::DBI::Replicated*'        => {
  92         ignore => [ qw/
  93             connect_call_do_sql
  94             disconnect_call_do_sql
  95         /]
  96     },
  97
  98     'DBIx::Class::Admin::*'                         => { skip => 1 },
  99     'DBIx::Class::ClassResolver::PassThrough'       => { skip => 1 },
 100     'DBIx::Class::Componentised'                    => { skip => 1 },
 101     'DBIx::Class::Relationship::*'                  => { skip => 1 },
 102     'DBIx::Class::ResultSetProxy'                   => { skip => 1 },
 103     'DBIx::Class::ResultSourceProxy'                => { skip => 1 },
 104     'DBIx::Class::Storage::Statistics'              => { skip => 1 },
 105     'DBIx::Class::Storage::DBI::Replicated::Types'  => { skip => 1 },
 106
 107 # test some specific components whose parents are exempt below
 108     'DBIx::Class::Relationship::Base'               => {},
 109
 110 # internals
 111     'DBIx::Class::SQLAHacks*'                       => { skip => 1 },
 112     'DBIx::Class::Storage::DBI*'                    => { skip => 1 },
 113     'SQL::Translator::*'                            => { skip => 1 },
 114
 115 # deprecated / backcompat stuff
 116     'DBIx::Class::CDBICompat*'                      => { skip => 1 },
 117     'DBIx::Class::ResultSetManager'                 => { skip => 1 },
 118     'DBIx::Class::DB'                               => { skip => 1 },
 119
 120 # skipped because the synopsis covers it clearly
 121     'DBIx::Class::InflateColumn::File'              => { skip => 1 },
 122 };
 123
 124 my $ex_lookup = {};
 125 for my $string (keys %$exceptions) {
 126   my $ex = $exceptions->{$string};
 127   $string =~ s/\*/'.*?'/ge;
 128   my $re = qr/^$string$/;
 129   $ex_lookup->{$re} = $ex;
 130 }
 131
 132 my @modules = sort { $a cmp $b } (Test::Pod::Coverage::all_modules());
 133
 134 foreach my $module (@modules) {
 135   SKIP: {
 136
 137     my ($match) = List::Util::first
 138       { $module =~ $_ }
 139       (sort { length $b <=> length $a || $b cmp $a } (keys %$ex_lookup) )
 140     ;
 141
 142     my $ex = $ex_lookup->{$match} if $match;
 143
 144     skip ("$module exempt", 1) if ($ex->{skip});
 145
 146     # build parms up from ignore list
 147     my $parms = {};
 148     $parms->{trustme} =
 149       [ map { qr/^$_$/ } @{ $ex->{ignore} } ]
 150         if exists($ex->{ignore});
 151
 152     # run the test with the potentially modified parm set
 153     Test::Pod::Coverage::pod_coverage_ok($module, $parms, "$module POD coverage");
 154   }
 155 }
 156
 157 done_testing;