t/codingstd/perlcritic.t

   1 #! perl
   2 # Copyright (C) 2008-2010, Parrot Foundation.
   3 # $Id$
   4
   5 =head1 NAME
   6
   7 t/codingstd/perlcritic.t - use perlcritic for perl coding stds.
   8
   9 =head1 SYNOPSIS
  10
  11  # test all files
  12  % prove t/codingstd/perlcritic.t
  13
  14  % perl t/codingstd/perlcritic.t [--theme=sometheme]
  15
  16  # test specific files
  17  % perl t/codingstd/perlcritic.t src/foo.pl lib/parrot/bar.pm
  18
  19 =head1 DESCRIPTION
  20
  21 By default, tests all perl source files for some very specific perl coding
  22 violations.
  23
  24 This test uses a standard perlcriticrc file, located in
  25 F<tools/dev/perlcritic.conf>
  26
  27 If you wish to run a specific policy, the easiest way to do so is to
  28 temporarily add a custom theme to the configuration file and then specify
  29 that on the command line to this script.
  30
  31 =cut
  32
  33 use strict;
  34 use warnings;
  35 use lib qw( lib ../lib ../../lib );
  36
  37 use File::Spec;
  38 use Getopt::Long;
  39 use Parrot::Config qw(%PConfig);
  40 use Parrot::Distribution;
  41 use Test::More;
  42
  43 # There's no point in continuing if we're missing some certain modules, or
  44 # if the developer doesn't want to.
  45
  46 if (exists $ENV{'PARROT_TEST_NO_PERLCRITIC'}) {
  47   give_up('absence of PARROT_TEST_NO_PERLCRITIC environment variable');
  48 }
  49
  50 eval { require Test::Perl::Critic };
  51 if ($@) {
  52   give_up('Test::Perl::Critic');
  53 }
  54
  55 my $minimum_version = 1.090;
  56 if ($Perl::Critic::VERSION < $minimum_version) {
  57   give_up("Perl::Critic version $minimum_version");
  58 }
  59
  60 my $theme = 'parrot';
  61 GetOptions(
  62     'theme=s'   => \$theme
  63 );
  64
  65 my $config = File::Spec->catfile( $PConfig{build_dir}, qw{tools dev perlcritic.conf} );
  66
  67 Test::Perl::Critic->import(
  68     -profile => $config,
  69     -theme   => $theme
  70 );
  71
  72 my $dist = Parrot::Distribution->new();
  73
  74 my @files;
  75 if ( !@ARGV ) {
  76
  77     # We want to skip any language's perl files except those which have declared
  78     # they wish to be tested.
  79     # As languages are leaving the Parrot repository, there are currently no
  80     # languages that want to be tested in the root 'make codetest'.
  81
  82     my $languages_dir = File::Spec->catdir( $PConfig{build_dir}, 'languages');
  83     my $filter_languages = qr/^\Q$languages_dir$PConfig{slash}\E(?!dummy)/x;
  84
  85     @files = grep {! m/$filter_languages/}
  86              map  { $_->path }
  87              grep { $_->read !~ m/use v6;/ }
  88              grep { $_->read !~ m/#! nqp/ }
  89              $dist->get_perl_language_files();
  90 }
  91 else {
  92     @files = <@ARGV>;
  93 }
  94
  95 plan(tests => scalar(@files));
  96 critic_ok($_) foreach @files;
  97
  98 sub give_up {
  99   my $excuse = shift;
 100   plan(skip_all => "$excuse required to criticize code.");
 101   exit;
 102 }
 103
 104 # Local Variables:
 105 #   mode: cperl
 106 #   cperl-indent-level: 4
 107 #   fill-column: 100
 108 # End:
 109 # vim: expandtab shiftwidth=4: