1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# vim: sw=4 : ts=4 : et
use strict;
use warnings;
use Test::More;
use IO::Scalar;
use File::Find;
plan skip_all => 'set TEST_POD to enable this test'
unless $ENV{TEST_POD};
# both are in standard distribution, but just in case...
eval {
require Pod::Simple::SimpleTree;
require Test::Differences;
};
plan skip_all => 'Pod::Simple::SimpleTree and Test::Differences required to run these tests'
if $@;
Test::Differences->import();
sub check_munindoc
{
# skip SVN stuff, and directories. neither contains any POD.
if ( -d and m{\.svn}) {
$File::Find::prune = 1;
return;
}
return if -d;
my $plugin = $File::Find::name;
my @sections = (
'NAME',
'APPLICABLE SYSTEMS',
'CONFIGURATION',
'INTERPRETATION',
(m{snmp__} ? 'MIB INFORMATION' : ()),
'MAGIC MARKERS',
'BUGS',
'VERSION',
'AUTHOR',
'LICENSE',
);
my $root = Pod::Simple::SimpleTree->new->parse_file($plugin)->root;
# FIXME: check for POD errors?
my @headings;
foreach my $section (@$root) {
# ignore any inapplicable headings
next unless 'ARRAY' eq ref $section;
next unless $section->[0] eq 'head1';
next unless grep { $_ eq $section->[2] } @sections;
push @headings, $section->[2];
}
eq_or_diff(\@headings, \@sections, "$plugin - All POD sections exist");
# additional tests?
}
# find_pod_files doesn't work because (a) they don't end in .p[lm], (b) their
# shebang file is "broken" and (c) some plugins aren't even perl (shock! horror!).
find({
wanted => \&check_munindoc,
no_chdir => 1,
}, glob('node.d*/'));
|
