t/pod/testp2pt.pl

   1 package TestPodIncPlainText;
   2
   3 BEGIN {
   4    use File::Basename;
   5    use File::Spec;
   6    use Cwd qw(abs_path);
   7    push @INC, '..';
   8    my $THISDIR = abs_path(dirname $0);
   9    unshift @INC, $THISDIR;
  10    require "testcmp.pl";
  11    import TestCompare;
  12    my $PARENTDIR = dirname $THISDIR;
  13    push @INC, map { File::Spec->catfile($_, 'lib') } ($PARENTDIR, $THISDIR);
  14 }
  15
  16 #use strict;
  17 #use diagnostics;
  18 use Carp;
  19 use Exporter;
  20 #use File::Compare;
  21 #use Cwd qw(abs_path);
  22
  23 use vars qw($MYPKG @EXPORT @ISA);
  24 $MYPKG = eval { (caller)[0] };
  25 @EXPORT = qw(&testpodplaintext);
  26 BEGIN {
  27     if ( $] >= 5.005_58 ) {
  28        require Pod::Text;
  29        @ISA = qw( Pod::Text );
  30     }
  31     else {
  32        require Pod::PlainText;
  33        @ISA = qw( Pod::PlainText );
  34     }
  35     require VMS::Filespec if $^O eq 'VMS';
  36 }
  37
  38 ## Hardcode settings for TERMCAP and COLUMNS so we can try to get
  39 ## reproducible results between environments
  40 @ENV{qw(TERMCAP COLUMNS)} = ('co=76:do=^J', 76);
  41
  42 sub catfile(@) { File::Spec->catfile(@_); }
  43
  44 my $INSTDIR = abs_path(dirname $0);
  45 if ($^O eq 'VMS') { # clean up directory spec
  46     $INSTDIR = VMS::Filespec::unixpath($INSTDIR);
  47     $INSTDIR =~ s#/$##;
  48     $INSTDIR =~ s#/000000/#/#;
  49 }
  50 # cut 't/pod' from path (cut 't:pod:' on Mac OS)
  51 $INSTDIR = (dirname $INSTDIR) if (basename($INSTDIR) eq 'pod');
  52 $INSTDIR = (dirname $INSTDIR) if (basename($INSTDIR) eq 't');
  53
  54 my @PODINCDIRS = ( catfile($INSTDIR, 'lib', 'Pod'),
  55                    catfile($INSTDIR, 'scripts'),
  56                    catfile($INSTDIR, 'pod'),
  57                    catfile($INSTDIR, 't', 'pod')
  58                  );
  59 print "PODINCDIRS = ",join(', ',@PODINCDIRS),"\n";
  60
  61 ## Find the path to the file to =include
  62 sub findinclude {
  63     my $self    = shift;
  64     my $incname = shift;
  65
  66     ## See if its already found w/out any "searching;
  67     return  $incname if (-r $incname);
  68
  69     ## Need to search for it. Look in the following directories ...
  70     ##   1. the directory containing this pod file
  71     my $thispoddir = dirname $self->input_file;
  72     ##   2. the parent directory of the above
  73     my $parentdir  = dirname $thispoddir;
  74     my @podincdirs = ($thispoddir, $parentdir, @PODINCDIRS);
  75
  76     for (@podincdirs) {
  77        my $incfile = catfile($_, $incname);
  78        return $incfile  if (-r $incfile);
  79     }
  80     warn("*** Can't find =include file $incname in @podincdirs\n");
  81     return "";
  82 }
  83
  84 sub command {
  85     my $self = shift;
  86     my ($cmd, $text, $line_num, $pod_para)  = @_;
  87     $cmd     = ''  unless (defined $cmd);
  88     local $_ = $text || '';
  89     my $out_fh  = $self->output_handle;
  90
  91     ## Defer to the superclass for everything except '=include'
  92     return  $self->SUPER::command(@_) unless ($cmd eq "include");
  93
  94     ## We have an '=include' command
  95     my $incdebug = 1; ## debugging
  96     my @incargs = split;
  97     if (@incargs == 0) {
  98         warn("*** No filename given for '=include'\n");
  99         return;
 100     }
 101     my $incfile  = $self->findinclude(shift @incargs)  or  return;
 102     my $incbase  = basename $incfile;
 103     print $out_fh "###### begin =include $incbase #####\n"  if ($incdebug);
 104     $self->parse_from_file( {-cutting => 1}, $incfile );
 105     print $out_fh "###### end =include $incbase #####\n"    if ($incdebug);
 106 }
 107
 108 sub begin_input {
 109    $_[0]->{_INFILE} = VMS::Filespec::unixify($_[0]->{_INFILE}) if $^O eq 'VMS';
 110 }
 111
 112 sub podinc2plaintext( $ $ ) {
 113     my ($infile, $outfile) = @_;
 114     local $_;
 115     my $text_parser = $MYPKG->new(quotes => "`'");
 116     $text_parser->parse_from_file($infile, $outfile);
 117 }
 118
 119 sub testpodinc2plaintext( @ ) {
 120    my %args = @_;
 121    my $infile  = $args{'-In'}  || croak "No input file given!";
 122    my $outfile = $args{'-Out'} || croak "No output file given!";
 123    my $cmpfile = $args{'-Cmp'} || croak "No compare-result file given!";
 124
 125    my $different = '';
 126    my $testname = basename $cmpfile, '.t', '.xr';
 127
 128    unless (-e $cmpfile) {
 129       my $msg = "*** Can't find comparison file $cmpfile for testing $infile";
 130       warn  "$msg\n";
 131       return  $msg;
 132    }
 133
 134    print "# Running testpodinc2plaintext for '$testname'...\n";
 135    ## Compare the output against the expected result
 136    podinc2plaintext($infile, $outfile);
 137    if ( testcmp($outfile, $cmpfile) ) {
 138        $different = "$outfile is different from $cmpfile";
 139    }
 140    else {
 141        unlink($outfile);
 142    }
 143    return  $different;
 144 }
 145
 146 sub testpodplaintext( @ ) {
 147    my %opts = (ref $_[0] eq 'HASH') ? %{shift()} : ();
 148    my @testpods = @_;
 149    my ($testname, $testdir) = ("", "");
 150    my ($podfile, $cmpfile) = ("", "");
 151    my ($outfile, $errfile) = ("", "");
 152    my $passes = 0;
 153    my $failed = 0;
 154    local $_;
 155
 156    print "1..", scalar @testpods, "\n"  unless ($opts{'-xrgen'});
 157
 158    for $podfile (@testpods) {
 159       ($testname, $_) = fileparse($podfile);
 160       $testdir ||=  $_;
 161       $testname  =~ s/\..*$//;
 162       $cmpfile   =  $testdir . $testname . '.xr';
 163       $outfile   =  $testdir . $testname . '.OUT';
 164
 165       if ($opts{'-xrgen'}) {
 166           if ($opts{'-force'} or ! -e $cmpfile) {
 167              ## Create the comparison file
 168              print "# Creating expected result for \"$testname\"" .
 169                    " pod2plaintext test ...\n";
 170              podinc2plaintext($podfile, $cmpfile);
 171           }
 172           else {
 173              print "# File $cmpfile already exists" .
 174                    " (use '-force' to regenerate it).\n";
 175           }
 176           next;
 177       }
 178
 179       my $failmsg = testpodinc2plaintext
 180                         -In  => $podfile,
 181                         -Out => $outfile,
 182                         -Cmp => $cmpfile;
 183       if ($failmsg) {
 184           ++$failed;
 185           print "#\tFAILED. ($failmsg)\n";
 186           print "not ok ", $failed+$passes, "\n";
 187       }
 188       else {
 189           ++$passes;
 190           unlink($outfile);
 191           print "#\tPASSED.\n";
 192           print "ok ", $failed+$passes, "\n";
 193       }
 194    }
 195    return  $passes;
 196 }
 197
 198 1;