tests/perl/critic-t

   1 #!/usr/bin/perl
   2 #
   3 # Check for perlcritic errors in included Perl scripts.
   4 #
   5 # The canonical version of this file is maintained in the rra-c-util package,
   6 # which can be found at <https://www.eyrie.org/~eagle/software/rra-c-util/>.
   7 #
   8 # Written by Russ Allbery <eagle@eyrie.org>
   9 # Copyright 2016, 2019 Russ Allbery <eagle@eyrie.org>
  10 # Copyright 2012-2014
  11 #     The Board of Trustees of the Leland Stanford Junior University
  12 #
  13 # Permission is hereby granted, free of charge, to any person obtaining a
  14 # copy of this software and associated documentation files (the "Software"),
  15 # to deal in the Software without restriction, including without limitation
  16 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
  17 # and/or sell copies of the Software, and to permit persons to whom the
  18 # Software is furnished to do so, subject to the following conditions:
  19 #
  20 # The above copyright notice and this permission notice shall be included in
  21 # all copies or substantial portions of the Software.
  22 #
  23 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  24 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  25 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  26 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  27 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  28 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  29 # DEALINGS IN THE SOFTWARE.
  30 #
  31 # SPDX-License-Identifier: MIT
  32
  33 use 5.008;
  34 use strict;
  35 use warnings;
  36
  37 use lib "$ENV{C_TAP_SOURCE}/tap/perl";
  38
  39 use Test::RRA qw(skip_unless_author use_prereq);
  40 use Test::RRA::Automake qw(automake_setup perl_dirs test_file_path);
  41 use Test::RRA::Config qw(@CRITIC_IGNORE);
  42
  43 use File::Spec;
  44 use Test::More;
  45
  46 # Skip tests unless we're running author tests since this test is too
  47 # sensitive to the exact version of Perl::Critic to be generally useful.
  48 skip_unless_author('Coding style tests');
  49
  50 # Set up Automake testing.
  51 automake_setup();
  52
  53 # Load prerequisite modules.
  54 use_prereq('Test::Perl::Critic');
  55
  56 # Due to an annoying bug in Perl::Tidy 20130922, we cannot run tests if the
  57 # source directory is read-only.  It unconditionally tries to create a log
  58 # file in the current directory and fails to run any checks if it cannot.
  59 if (!-w File::Spec->curdir()) {
  60     plan skip_all => 'Perl::Tidy needs writable source directory';
  61 }
  62
  63 # Force the embedded Perl::Tidy check to use the correct configuration.
  64 local $ENV{PERLTIDY} = test_file_path('data/perltidyrc');
  65
  66 # Import the configuration file.
  67 Test::Perl::Critic->import(-profile => test_file_path('data/perlcriticrc'));
  68
  69 # Finally, run the actual tests.
  70 all_critic_ok(perl_dirs({ skip => [@CRITIC_IGNORE] }));
  71
  72 # On Debian with perltidy 20130922-1, a perltidy.LOG file gets left behind
  73 # in the current directory.  Remove it if it exists.
  74 unlink('perltidy.LOG');