1#!/usr/bin/perl 2# 3# Check the SYNOPSIS section of the documentation for syntax errors. 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 2019, 2021 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.010; 34use strict; 35use warnings; 36 37use lib 't/lib'; 38 39use Test::RRA qw(skip_unless_automated use_prereq); 40 41use File::Spec; 42use Test::More; 43 44# Skip for normal user installs since this doesn't affect functionality. 45skip_unless_automated('Synopsis syntax tests'); 46 47# Load prerequisite modules. 48use_prereq('Perl::Critic::Utils'); 49use_prereq('Test::Synopsis'); 50 51# Helper function that checks to see if a given path starts with blib/script. 52# This is written a bit weirdly so that it's portable to Windows and VMS. 53# 54# $path - Path to a file 55# 56# Returns: True if the file doesn't start with blib/script, false otherwise. 57sub in_blib_script { 58 my ($path) = @_; 59 my ($volume, $dir, $file) = File::Spec->splitpath($path); 60 my @dir = File::Spec->splitdir($dir); 61 return (scalar(@dir) < 2 || $dir[0] ne 'blib' || $dir[1] ne 'script'); 62} 63 64# The default Test::Synopsis all_synopsis_ok() function requires that the 65# module be in a lib directory. Use Perl::Critic::Utils to find the modules 66# in blib, or lib if it doesn't exist. However, strip out anything in 67# blib/script, since scripts use a different SYNOPSIS syntax. 68my @files = Perl::Critic::Utils::all_perl_files('blib'); 69@files = grep { in_blib_script($_) } @files; 70if (!@files) { 71 @files = Perl::Critic::Utils::all_perl_files('lib'); 72} 73plan tests => scalar @files; 74 75# Run the actual tests. 76for my $file (@files) { 77 synopsis_ok($file); 78} 79