1#!/usr/bin/perl 2# 3# Test Perl code for strict, warnings, and syntax. 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, 2018-2019 Russ Allbery <eagle@eyrie.org> 10# Copyright 2013-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 33use 5.008; 34use strict; 35use warnings; 36 37use lib 't/lib'; 38 39use Test::RRA qw(skip_unless_automated use_prereq); 40 41use File::Spec; 42 43# Skip for normal user installs since this doesn't affect functionality. 44skip_unless_automated('Strictness tests'); 45 46# Load prerequisite modules. At least 0.25 is needed to recognize that having 47# use 5.012 or later automatically implies use strict. 48use_prereq('Test::Strict', '0.25'); 49 50# Directories to exclude from checks. 51my %EXCLUDE = map { $_ => 1 } qw(.git blib); 52 53# Determine whether we want to check the given file or top-level directory. 54# Assume that the only interesting files at the top level are directories or 55# files ending in *.PL. 56# 57# $file - Name of the file or directory 58# 59# Returns: 1 if it should be checked, undef otherwise. 60sub should_check { 61 my ($file) = @_; 62 return if $EXCLUDE{$file}; 63 return 1 if -d $file; 64 return 1 if $file =~ m{ [.] PL \z }xms; 65 return; 66} 67 68# Test::Strict (as of 0.47) doesn't have a way of excluding whole directories 69# from all_perl_files_ok and doesn't exclude .git, which results in false 70# positives if there are Perl files unpacked under .git (which is often the 71# case when using dgit). We therefore can't just point it at the root of the 72# module distribution and instead have to manually construct a list of 73# interesting files. 74opendir(my $rootdir, File::Spec->curdir) 75 or die "$0: cannot open current directory: $!\n"; 76my @files = File::Spec->no_upwards(readdir($rootdir)); 77closedir($rootdir) or die "$0: cannot close current directory: $!\n"; 78my @to_check = grep { should_check($_) } @files; 79 80# Test the files and top-level directories we found, including checking for 81# use warnings. 82$Test::Strict::TEST_WARNINGS = 1; 83all_perl_files_ok(@to_check); 84 85# Hack to suppress "used only once" warnings. 86END { $Test::Strict::TEST_WARNINGS = 0 } 87