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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
#!/usr/bin/perl -w
use Test::More;
use strict;
BEGIN {
if ($^O eq 'MSWin32' || $^O eq 'VMS') {
plan skip_all => "Not portable on Win32 or VMS\n";
}
else {
plan tests => 33;
}
use_ok ("Pod::Usage");
}
sub getoutput
{
my ($code) = @_;
my $pid = open(TEST_IN, "-|");
unless(defined $pid) {
die "Cannot fork: $!";
}
if($pid) {
# parent
my @out = <TEST_IN>;
close(TEST_IN);
my $exit = $?>>8;
s/^/#/ for @out;
local $" = "";
print "#EXIT=$exit OUTPUT=+++#@out#+++\n";
return($exit, join("",@out));
}
# child
open(STDERR, ">&STDOUT");
Test::More->builder->no_ending(1);
&$code;
print "--NORMAL-RETURN--\n";
exit 0;
}
sub compare
{
my ($left,$right) = @_;
$left =~ s/^#\s+/#/gm;
$right =~ s/^#\s+/#/gm;
$left =~ s/\s+/ /gm;
$right =~ s/\s+/ /gm;
$left eq $right;
}
SKIP: {
if('Pod::Usage'->isa('Pod::Text') && $Pod::Text::VERSION < 2.18) {
skip("Formatting with Pod::Text $Pod::Text::VERSION not reliable", 33);
}
my ($exit, $text) = getoutput( sub { pod2usage() } );
is ($exit, 2, "Exit status pod2usage ()");
ok (compare ($text, <<'EOT'), "Output test pod2usage ()");
#Usage:
# frobnicate [ -r | --recursive ] [ -f | --force ] file ...
#
EOT
($exit, $text) = getoutput( sub { pod2usage(
-message => 'You naughty person, what did you say?',
-verbose => 1 ) });
is ($exit, 1, "Exit status pod2usage (-message => '...', -verbose => 1)");
ok (compare ($text, <<'EOT'), "Output test pod2usage (-message => '...', -verbose => 1)") or diag("Got:\n$text\n");
#You naughty person, what did you say?
# Usage:
# frobnicate [ -r | --recursive ] [ -f | --force ] file ...
#
# Options:
# -r | --recursive
# Run recursively.
#
# -f | --force
# Just do it!
#
# -n number
# Specify number of frobs, default is 42.
#
EOT
($exit, $text) = getoutput( sub { pod2usage(
-verbose => 2, -exit => 42 ) } );
is ($exit, 42, "Exit status pod2usage (-verbose => 2, -exit => 42)");
ok (compare ($text, <<'EOT'), "Output test pod2usage (-verbose => 2, -exit => 42)");
#NAME
# frobnicate - do what I mean
#
# SYNOPSIS
# frobnicate [ -r | --recursive ] [ -f | --force ] file ...
#
# DESCRIPTION
# frobnicate does foo and bar and what not.
#
# OPTIONS
# -r | --recursive
# Run recursively.
#
# -f | --force
# Just do it!
#
# -n number
# Specify number of frobs, default is 42.
#
EOT
($exit, $text) = getoutput( sub { pod2usage(0) } );
is ($exit, 0, "Exit status pod2usage (0)");
ok (compare ($text, <<'EOT'), "Output test pod2usage (0)");
#Usage:
# frobnicate [ -r | --recursive ] [ -f | --force ] file ...
#
# Options:
# -r | --recursive
# Run recursively.
#
# -f | --force
# Just do it!
#
# -n number
# Specify number of frobs, default is 42.
#
EOT
($exit, $text) = getoutput( sub { pod2usage(42) } );
is ($exit, 42, "Exit status pod2usage (42)");
ok (compare ($text, <<'EOT'), "Output test pod2usage (42)");
#Usage:
# frobnicate [ -r | --recursive ] [ -f | --force ] file ...
#
EOT
($exit, $text) = getoutput( sub { pod2usage(-verbose => 0, -exit => 'NOEXIT') } );
is ($exit, 0, "Exit status pod2usage (-verbose => 0, -exit => 'NOEXIT')");
ok (compare ($text, <<'EOT'), "Output test pod2usage (-verbose => 0, -exit => 'NOEXIT')");
#Usage:
# frobnicate [ -r | --recursive ] [ -f | --force ] file ...
#
# --NORMAL-RETURN--
EOT
($exit, $text) = getoutput( sub { pod2usage(-verbose => 99, -sections => 'DESCRIPTION') } );
is ($exit, 1, "Exit status pod2usage (-verbose => 99, -sections => 'DESCRIPTION')");
ok (compare ($text, <<'EOT'), "Output test pod2usage (-verbose => 99, -sections => 'DESCRIPTION')");
#Description:
# frobnicate does foo and bar and what not.
#
EOT
# does the __DATA__ work ok as input
my (@blib, $test_script, $pod_file1, , $pod_file2);
if (!$ENV{PERL_CORE}) {
@blib = '-Mblib';
}
$test_script = File::Spec->catfile(qw(t pod p2u_data.pl));
$pod_file1 = File::Spec->catfile(qw(t pod usage.pod));
$pod_file2 = File::Spec->catfile(qw(t pod usage2.pod));
($exit, $text) = getoutput( sub { system($^X, @blib, $test_script); exit($? >> 8); } );
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 17, "Exit status pod2usage (-verbose => 2, -input => \*DATA)");
ok (compare ($text, <<'EOT'), "Output test pod2usage (-verbose => 2, -input => \*DATA)") or diag "Got:\n$text\n";
#NAME
# Test
#
#SYNOPSIS
# perl podusagetest.pl
#
#DESCRIPTION
# This is a test.
#
EOT
# test that SYNOPSIS and USAGE are printed
($exit, $text) = getoutput( sub { pod2usage(-input => $pod_file1,
-exitval => 0, -verbose => 0); });
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with USAGE");
ok (compare ($text, <<'EOT'), "Output test pod2usage with USAGE") or diag "Got:\n$text\n";
#Usage:
# This is a test for CPAN#33020
#
#Usage:
# And this will be also printed.
#
EOT
# test that SYNOPSIS and USAGE are printed with options
($exit, $text) = getoutput( sub { pod2usage(-input => $pod_file1,
-exitval => 0, -verbose => 1); });
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with USAGE and verbose=1");
ok (compare ($text, <<'EOT'), "Output test pod2usage with USAGE and verbose=1") or diag "Got:\n$text\n";
#Usage:
# This is a test for CPAN#33020
#
#Usage:
# And this will be also printed.
#
#Options:
# And this with verbose == 1
#
EOT
# test that only USAGE is printed when requested
($exit, $text) = getoutput( sub { pod2usage(-input => $pod_file1,
-exitval => 0, -verbose => 99, -sections => 'USAGE'); });
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with USAGE and verbose=99");
ok (compare ($text, <<'EOT'), "Output test pod2usage with USAGE and verbose=99") or diag "Got:\n$text\n";
#Usage:
# This is a test for CPAN#33020
#
EOT
# test with self
my $src = File::Spec->catfile(qw(lib Pod Usage.pm));
($exit, $text) = getoutput( sub { pod2usage( -input => $src,
-exitval => 0, -verbose => 0) } );
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with self");
ok (compare ($text, <<'EOT'), "Output test pod2usage with self") or diag "Got:\n$text\n";
#Usage:
# use Pod::Usage
#
# my $message_text = "This text precedes the usage message.";
# my $exit_status = 2; ## The exit status to use
# my $verbose_level = 0; ## The verbose level to use
# my $filehandle = \*STDERR; ## The filehandle to write to
#
# pod2usage($message_text);
#
# pod2usage($exit_status);
#
# pod2usage( { -message => $message_text ,
# -exitval => $exit_status ,
# -verbose => $verbose_level,
# -output => $filehandle } );
#
# pod2usage( -msg => $message_text ,
# -exitval => $exit_status ,
# -verbose => $verbose_level,
# -output => $filehandle );
#
# pod2usage( -verbose => 2,
# -noperldoc => 1 );
#
# pod2usage( -verbose => 2,
# -perlcmd => $path_to_perl,
# -perldoc => $path_to_perldoc,
# -perldocopt => $perldoc_options );
#
EOT
# verify that sections are correctly found after nested headings
($exit, $text) = getoutput( sub { pod2usage(-input => $pod_file2,
-exitval => 0, -verbose => 99,
-sections => [qw(BugHeader BugHeader/.*')]) });
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with nested headings");
ok (compare ($text, <<'EOT'), "Output test pod2usage with nested headings") or diag "Got:\n$text\n";
#BugHeader:
# Some text
#
# BugHeader2:
# More
# Still More
#
EOT
# Verify that =over =back work OK
($exit, $text) = getoutput( sub {
pod2usage(-input => $pod_file2,
-exitval => 0, -verbose => 99, -sections => 'BugHeader/BugHeader2') } );
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with over/back");
ok (compare ($text, <<'EOT'), "Output test pod2usage with over/back") or diag "Got:\n$text\n";
# BugHeader2:
# More
# Still More
#
EOT
# new array API for -sections
($exit, $text) = getoutput( sub {
pod2usage(-input => $pod_file2,
-exitval => 0, -verbose => 99, -sections => [qw(Heading-1/!.+ Heading-2/.+)]) } );
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
is ($exit, 0, "Exit status pod2usage with -sections => []");
ok (compare ($text, <<'EOT'), "Output test pod2usage with -sections => []") or diag "Got:\n$text\n";
#Heading-1:
# One
# Two
#
# Heading-2.2:
# More text.
#
EOT
# allow subheadings in OPTIONS and ARGUMENTS
($exit, $text) = getoutput( sub {
pod2usage(-input => $pod_file2,
-exitval => 0, -verbose => 1) } );
$text =~ s{#Using.*/blib.*\n}{}; # older blib's emit something to STDERR
$text =~ s{[*](destination|files)[*]}{$1}g; # strip * chars
is ($exit, 0, "Exit status pod2usage with subheadings in OPTIONS");
ok (compare ($text, <<'EOT'), "Output test pod2usage with subheadings in OPTIONS") or diag "Got:\n$text\n";
#Options and Arguments:
# Arguments:
# The required arguments (which typically follow any options on the
# command line) are:
#
# destination
# files
#
# Options:
# Options may be abbreviated. Options which take values may be separated
# from the values by whitespace or the "=" character.
#
EOT
} # end SKIP
__END__
=head1 NAME
frobnicate - do what I mean
=head1 SYNOPSIS
B<frobnicate> S<[ B<-r> | B<--recursive> ]> S<[ B<-f> | B<--force> ]>
file ...
=head1 DESCRIPTION
B<frobnicate> does foo and bar and what not.
=head1 OPTIONS
=over 4
=item B<-r> | B<--recursive>
Run recursively.
=item B<-f> | B<--force>
Just do it!
=item B<-n> number
Specify number of frobs, default is 42.
=back
=cut
|