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 2013-2014
10#     The Board of Trustees of the Leland Stanford Junior University
11#
12# Permission is hereby granted, free of charge, to any person obtaining a
13# copy of this software and associated documentation files (the "Software"),
14# to deal in the Software without restriction, including without limitation
15# the rights to use, copy, modify, merge, publish, distribute, sublicense,
16# and/or sell copies of the Software, and to permit persons to whom the
17# Software is furnished to do so, subject to the following conditions:
18#
19# The above copyright notice and this permission notice shall be included in
20# all copies or substantial portions of the Software.
21#
22# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
25# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28# DEALINGS IN THE SOFTWARE.
29#
30# SPDX-License-Identifier: MIT
31
32use 5.006;
33use strict;
34use warnings;
35
36use lib 't/lib';
37
38use File::Spec;
39use Test::More;
40use Test::RRA qw(skip_unless_automated use_prereq);
41
42# Skip for normal user installs since this doesn't affect functionality.
43skip_unless_automated('Synopsis syntax tests');
44
45# Load prerequisite modules.
46use_prereq('Perl::Critic::Utils');
47use_prereq('Test::Synopsis');
48
49# Helper function that checks to see if a given path starts with blib/script.
50# This is written a bit weirdly so that it's portable to Windows and VMS.
51#
52# $path - Path to a file
53#
54# Returns: True if the file doesn't start with blib/script, false otherwise.
55sub in_blib_script {
56    my ($path) = @_;
57    my ($volume, $dir, $file) = File::Spec->splitpath($path);
58    my @dir = File::Spec->splitdir($dir);
59    return (scalar(@dir) < 2 || $dir[0] ne 'blib' || $dir[1] ne 'script');
60}
61
62# The default Test::Synopsis all_synopsis_ok() function requires that the
63# module be in a lib directory.  Use Perl::Critic::Utils to find the modules
64# in blib, or lib if it doesn't exist.  However, strip out anything in
65# blib/script, since scripts use a different SYNOPSIS syntax.
66my @files = Perl::Critic::Utils::all_perl_files('blib');
67@files = grep { in_blib_script($_) } @files;
68if (!@files) {
69    @files = Perl::Critic::Utils::all_perl_files('lib');
70}
71plan tests => scalar @files;
72
73# Run the actual tests.
74for my $file (@files) {
75    synopsis_ok($file);
76}
77