t/50-cgi: encode special chars in file names
[perl/plp/.git] / t / 50-cgi.t
index d30bff2411fb5128561bff228e0a6d619a654e1d..0f3eeaf4e5f8582fd53b6795bd1fe7459028995f 100644 (file)
@@ -2,217 +2,198 @@ use strict;
 use warnings;
 
 use Cwd;
+use File::Basename qw( dirname );
 use File::Spec;
 use Test::More;
+use PLP::Functions qw( DecodeURI );
+
+eval {
+       require Test::LongString;
+       Test::LongString->import(max => 128);
+
+       no warnings 'redefine';  # override module to not escape newlines
+       my $formatter = *Test::LongString::_display;
+       my $parent = \&{$formatter};
+       *{$formatter} = sub {
+               my $s = &{$parent};
+               $s =~ s/\Q\x{0a}/\n              /g;  # revert newline quoting
+               return $s;
+       };
+} or *is_string = \&is;  # fallback to ugly unformatted is()
 
 eval { require PerlIO::scalar };
 plan skip_all => "PerlIO required (perl 5.8) to test PLP" if $@;
 
-plan tests => 20;
+plan tests => 24;
 
 require_ok('PLP::Backend::CGI') or BAIL_OUT();
 
 $PLP::use_cache = 0 if $PLP::use_cache;
 #TODO: caching on (change file names)
 
-my $base = Cwd::abs_path(File::Spec->tmpdir || File::Spec->curdir);
--w $base or BAIL_OUT("$base not writable");
-my $testfile = 'testfile.plp';
-not -f "$base/$testfile" or BAIL_OUT("$testfile exists");
-
+chdir File::Spec->catdir(dirname($0), '50-cgi')
+       or BAIL_OUT('cannot change to test directory ./50-cgi/');
+my $ORGDIR = Cwd::getcwd();
 open ORGOUT, '>&', *STDOUT;
 
 sub plp_is {
-       my ($test, $plp, $expect) = @_;
-       chomp $expect;
+       my ($test, $src, $expect, $env, $in) = @_;
        local $Test::Builder::Level = $Test::Builder::Level + 1;
 
-       if (defined $plp) {
-               eval {
-                       open my $testfh, '>', "$base/$testfile" or die $!;
-                       print {$testfh} $plp or die $!;
-                       close $testfh or die $!;
-               };
-               not $@ or fail("write $testfile"), diag("    Error: $@"), return;
+       %ENV = (
+               REQUEST_METHOD => 'GET',
+               REQUEST_URI => "/$src/test/123",
+               QUERY_STRING => 'test=1&test=2',
+               GATEWAY_INTERFACE => 'CGI/1.1',
+               
+               SCRIPT_NAME => '/plp.cgi',
+               SCRIPT_FILENAME => "$ORGDIR/plp.cgi",
+               PATH_INFO => "/$src/test/123",
+               PATH_TRANSLATED => "$ORGDIR/$src/test/123",
+               DOCUMENT_ROOT => $ORGDIR,
+               
+               $env ? %{$env} : (),
+       ); # Apache/2.2.4 CGI environment
+
+       if (defined $in) {
+               $ENV{CONTENT_LENGTH} = length $in;
+               $ENV{CONTENT_TYPE} = 'application/x-www-form-urlencoded';
+               close STDIN;
+               open STDIN, '<', $in;
        }
 
        close STDOUT;
        open STDOUT, '>', \my $output;  # STDOUT buffered to scalar
        select STDOUT;  # output before start() (which selects PLPOUT)
        eval {
-               local $SIG{__WARN__} = sub { print $_[0] }; # enables warnings
+               local $SIG{__WARN__} = sub {
+                       # include warnings in stdout (but modified to distinguish)
+                       my $msg = shift;
+                       my $eol = $msg =~ s/(\s*\z)// && $1;
+                       print "<warning>$msg</warning>$eol"
+               };
                PLP::everything();
        };
+       my $failure = $@;
        select ORGOUT;  # return to original STDOUT
 
-       not $@ or fail($test), diag("    Error: $@"), return;
+       if ($failure) {
+               fail($test);
+               diag("    Error: $failure");
+               return;
+       }
        $output =~ s{((?:.+\n)*)}{ join "", sort split /(?<=\n)/, $1 }e; # order headers
-       is($output, $expect, $test);
+       is_string($output, $expect, $test);
 }
 
-%ENV = (
-       REQUEST_METHOD => 'GET',
-       REQUEST_URI => "/$testfile/test/123",
-       QUERY_STRING => 'test=1&test=2',
-       GATEWAY_INTERFACE => 'CGI/1.1',
-       
-       SCRIPT_NAME => '/plp.cgi',
-       SCRIPT_FILENAME => "$base/plp.cgi",
-       PATH_INFO => "/$testfile/test/123",
-       PATH_TRANSLATED => "$base/$testfile/test/123",
-       DOCUMENT_ROOT => $base,
-); # Apache/2.2.4 CGI environment
+sub getwarning {
+       # captures the first warning produced by the given code string
+       my ($code, $line, $file) = @_;
 
-my $HEAD = <<EOT;  # common header output
-Content-Type: text/html
-X-PLP-Version: $PLP::VERSION
-EOT
+       local $SIG{__WARN__} = sub { die @_ };
+       # warnings module runs at BEGIN, so we need to use icky expression evals
+       eval qq(# line $line "$file"\n$code; return);
+       my $res = $@;
+       chomp $res;
+       return $res;
+}
 
-plp_is('print', '0<: print print 2 :>3', "$HEAD\n0213");
+sub plp_ok {
+       my ($file, %replace) = @_;
 
-plp_is('exit', '1<:exit:>not <(reached)>', "$HEAD\n1");
+       (my $name = $file) =~ s/[.][^.]+$//;
+       $file = "$name.html";
+       my $infile = delete $replace{-input} // "$name.plp";
+       my $addin = -e "$name.txt" && "$name.txt";
+       $name =~ s/^(\d*)-// and $name .= " ($1)";
+       DecodeURI($name);
 
-plp_is('<:=', '1<:=$foo=2:>3<:= $foo', "$HEAD\n1232");
+       my $out = eval {
+               local $/ = undef;  # slurp
+               open my $fh, '<', $file or die "$!\n";
+               return readline $fh;
+       };
+       if (not defined $out) {
+               fail($name);
+               diag("error reading output from $file: $@");
+               return;
+       }
 
-plp_is('%get', '<: print $get{test} if defined $get{test} and not exists $get{test2}', "$HEAD\n2\n");
+       my $env = delete $replace{-env};
+       $replace{HEAD} //= "Content-Type: text/html\nX-PLP-Version: $PLP::VERSION\n";
+       $replace{VERSION        } //= $PLP::VERSION;
+       $replace{SCRIPT_NAME    } //= $infile;
+       $replace{SCRIPT_FILENAME} //= "$ORGDIR/$infile";
 
-plp_is('%get array', '<:= @{$get{q/@test/}}', "$HEAD\n12\n");
+       chomp $out;
+       $out =~ s/\$$_/$replace{$_}/g for keys %replace;
+       $out =~ s{
+               <eval \s+ line="([^"]*)"> (.*?) </eval>
+       }{ getwarning($2, $1, $infile) }msxge;
 
-plp_is('%header',
-       '<: $headers{_test}=2; print $header{x_PLP_version}; BEGIN { $header{"-tesT"}=1 }',
-       "-tesT: 2\n$HEAD\n$PLP::VERSION"
-);
+       plp_is($name, $infile, $out, $env, $addin);
+}
 
-plp_is('%header repetition', '.<: BEGIN{$header{A}="1\n2"} $header{A}=3', <<TEST);
-A: 1
-A: 2
-$HEAD
-.<table border=1 class="PLPerror"><tr><td><b>Debug information:</b><br>Can't set headers after sending them at testfile.plp line 1.
-(Output started at testfile.plp line 1.)
-</td></tr></table>
-TEST
+# 0*: permission checks using generated dummy files
+SKIP:
+for my $file (glob '0*.html') {
+       $file =~ s/[.]html$/.plp/;
+       my ($mode) = $file =~ /^..-(\d*)\b/;
+       eval {
+               if ($mode eq 404) {
+                       return 1;  # do not create
+               }
 
-#TODO: %post
-#TODO: %fields
-#TODO: %cookie
+               # prepare input
+               open my $out, '>', $file or die "cannot generate source file ($!)\n";
+               print {$out} 'ok';
 
-plp_is('PLP_END', '<: PLP_END{print 1}; PLP_END{print 2}; print 3', "$HEAD\n321");
+               if ($mode eq 403) {
+                       chmod 0244, $file or die "cannot change permissions ($!)\n";
+               }
 
-plp_is('no warnings by default', '<: ignoreme :>ok', "$HEAD\nok");
+               return -e $file;
+       } or chomp $@, skip("$file: $@", 1);  # ignore generation failure
 
-rename "$base/$testfile", "$base/$testfile.inc";
-plp_is('include', "<($testfile.inc)> <: include '$testfile.inc'", "$HEAD\nok ok");
-unlink "$base/$testfile.inc";
+       plp_ok($file);
+       eval { unlink $file };  # clean up
+}
 
-plp_is('fatal error', "runtime\n<: syntax(error :>\nruntime", <<TEST);
-$HEAD
-<table border=1 class="PLPerror"><tr><td><b>Debug information:</b><br>syntax error at $testfile line 2, at EOF
-  (Might be a runaway multi-line \cq\cq string starting on line 1)
-</td></tr></table>
-TEST
+# 1*-2*: generic tests with standard environment
+plp_ok($_) for glob '[12]*.html';
 
+# 3*: error tests depending on warning message
 SKIP: {
+       my @inctests = glob '3*.html';
 
-my $INCFILE = File::Spec->rel2abs("$base/missinginclude");
-if (open my $dummy, "<", $INCFILE) {  # like PLP::source will
-       fail("file missinginclude shouldn't exist");
-       skip("missinginclude tests", 2);
-}
-my $INCWARN = qq{Can't open "$INCFILE" ($!)};
-
-plp_is('warnings', split /\n\n/, <<TEST, 2);
-1<: use warnings :>
-2<: 42 :>
-3<: warn "warning" :>
-4<: include "missinginclude" :>
-5<(missinginclude)>
-6
-
-$HEAD
-Useless use of a constant in void context at $testfile line 2.
-1
-2
-3warning at $testfile line 3.
-
-4<table border=1 class="PLPerror"><tr><td><b>Debug information:</b><br>$INCWARN at $testfile line 4.
-</td></tr></table>
-5<table border=1 class="PLPerror"><tr><td><b>Debug information:</b><br>$INCWARN at $testfile line 5.
-</td></tr></table>
-TEST
-
-plp_is('$PLP::ERROR',
-       '<: $PLP::ERROR = sub {print "Oh no: $_[0]"} :> <(missinginclude)>.',
-       qq{$HEAD\n Oh no: $INCWARN at $testfile line 1.\n\n}
-);
-
-plp_is('$PLP::DEBUG',
-       '<: $PLP::DEBUG = 2; delete $header{x_plp_version} :>1<(missinginclude)>2',
-       "Content-Type: text/plain\n\nContent-Type: text/html\n\n1"
-);
+       my $INCFILE = File::Spec->rel2abs("$ORGDIR/missinginclude");
+       if (open my $dummy, "<", $INCFILE) {  # like PLP::source will
+               fail("file missinginclude shouldn't exist");
+               skip("missinginclude tests (3*)", @inctests - 1);
+       }
+       my $INCWARN = qq{Can't open "$INCFILE" ($!)};
 
+       plp_ok($_, INCWARN => $INCWARN) for @inctests;
 }
 
-plp_is('utf8', '<: use open qw/:std :utf8/; print chr 191', <<TEST);
-Content-Type: text/html; charset=utf-8
-X-PLP-Version: $PLP::VERSION
-
-\302\277
-TEST
-
-my @envtest = (
-       'ok <:=$ENV{SCRIPT_NAME}:> <:=$ENV{SCRIPT_FILENAME}',
-       "$HEAD\nok /$testfile $base/$testfile"
-);
+# 4*-7*: apache environment (default)
+plp_ok($_) for glob '[4-7]*.html';
 
-plp_is('%ENV (on apache)', @envtest);
-
-SKIP: {
-chmod 0244, $testfile or skip("changed permissions", 1);
-plp_is('permission denied', undef, <<TEST);
-Content-Type: text/html
-PLP: Can't read: $base/$testfile (/$testfile/test/123)
-Status: 403
-
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
-<html><head>
-<title>403 Forbidden</title>
-</head></body>
-<h1>Forbidden</h1>
-You don't have permission to access /$testfile/test/123 on this server.<p>
-<hr>
-</body></html>
-TEST
-chmod 0644, $testfile;
-}
+#TODO: %fields
+#TODO: %cookie
 
-$ENV{PATH_TRANSLATED} = "$base/missinginclude/test/123";
-plp_is('not found', undef, <<TEST);
-Content-Type: text/html
-PLP: Not found: $base/missinginclude/test/123 (/$testfile/test/123)
-Status: 404
-
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
-<html><head>
-<title>404 Not Found</title>
-</head></body>
-<h1>Not Found</h1>
-The requested URL /$testfile/test/123 was not found on this server.<p>
-<hr>
-</body></html>
-TEST
-
-%ENV = (
+# 8*: lighttpd environment
+plp_ok($_, -env => {
+       # lighttpd/1.4.7 CGI environment
        REQUEST_METHOD => 'GET',
-       REQUEST_URI => "/$testfile/test/123",
+       REQUEST_URI => "/$_/test/123",
        QUERY_STRING => 'test=1&test=2',
        GATEWAY_INTERFACE => 'CGI/1.1',
        
-       SCRIPT_NAME => "/$testfile", #XXX: .plp?
-       SCRIPT_FILENAME => "$base/$testfile",
+       SCRIPT_NAME => "/$_", #XXX: .plp?
+       SCRIPT_FILENAME => "$ORGDIR/$_",
        PATH_INFO => '/test/123',
-); # lighttpd/1.4.7 CGI environment
-
-plp_is('%ENV on lighttpd', @envtest);
-
-unlink "$base/$testfile";
+       PATH_TRANSLATED => undef,
+       DOCUMENT_ROOT => undef,
+}) for glob '8*.plp';