]> Sergey Matveev's repositories - public-inbox.git/blobdiff - t/httpd-corner.t
No ext_urls
[public-inbox.git] / t / httpd-corner.t
index cb813897c025d6eca82d2da81ede68fc8ce64903..7600c2b955f27b067d29328d3843832920b56506 100644 (file)
@@ -1,30 +1,27 @@
-# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
+#!perl -w
+# Copyright (C) all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 # note: our HTTP server should be standalone and capable of running
 # generic PSGI/Plack apps.
-use strict;
-use warnings;
-use Test::More;
+use strict; use v5.10.1; use PublicInbox::TestCommon;
 use Time::HiRes qw(gettimeofday tv_interval);
-use PublicInbox::Spawn qw(which spawn);
-use PublicInbox::TestCommon;
+use PublicInbox::Spawn qw(spawn popen_rd);
 require_mods(qw(Plack::Util Plack::Builder HTTP::Date HTTP::Status));
-use Digest::SHA qw(sha1_hex);
-use IO::Socket;
+use PublicInbox::SHA qw(sha1_hex);
+use IO::Handle ();
 use IO::Socket::UNIX;
 use Fcntl qw(:seek);
 use Socket qw(IPPROTO_TCP TCP_NODELAY SOL_SOCKET);
 use POSIX qw(mkfifo);
+use Carp ();
 my ($tmpdir, $for_destroy) = tmpdir();
 my $fifo = "$tmpdir/fifo";
 ok(defined mkfifo($fifo, 0777), 'created FIFO');
 my $err = "$tmpdir/stderr.log";
 my $out = "$tmpdir/stdout.log";
 my $psgi = "./t/httpd-corner.psgi";
-my $sock = tcp_server() or die;
-
-# make sure stdin is not a pipe for lsof test to check for leaking pipes
-open(STDIN, '<', '/dev/null') or die 'no /dev/null: $!';
+my $sock = tcp_server();
+my @zmods = qw(PublicInbox::GzipFilter IO::Uncompress::Gunzip);
 
 # Make sure we don't clobber socket options set by systemd or similar
 # using socket activation:
@@ -40,7 +37,7 @@ if ($^O eq 'linux') {
        }
 } elsif ($^O eq 'freebsd' && system('kldstat -m accf_data >/dev/null') == 0) {
        require PublicInbox::Daemon;
-       my $var = PublicInbox::Daemon::SO_ACCEPTFILTER();
+       my $var = $PublicInbox::Daemon::SO_ACCEPTFILTER;
        $accf_arg = pack('a16a240', 'dataready', '');
        setsockopt($sock, SOL_SOCKET, $var, $accf_arg) or die "setsockopt: $!";
 }
@@ -50,22 +47,47 @@ sub unix_server ($) {
                Listen => 1024,
                Type => Socket::SOCK_STREAM(),
                Local => $_[0],
-       );
+       ) or BAIL_OUT "bind + listen $_[0]: $!";
        $s->blocking(0);
        $s;
 }
 
 my $upath = "$tmpdir/s";
 my $unix = unix_server($upath);
-ok($unix, 'UNIX socket created');
+my $alt = tcp_server();
 my $td;
 my $spawn_httpd = sub {
        my (@args) = @_;
-       my $cmd = [ '-httpd', @args, "--stdout=$out", "--stderr=$err", $psgi ];
-       $td = start_script($cmd, undef, { 3 => $sock, 4 => $unix });
+       my $x = tcp_host_port($alt);
+       my $cmd = [ '-httpd', @args, "--stdout=$out", "--stderr=$err", $psgi,
+               '-l', "http://$x/?psgi=t/alt.psgi,env.PI_CONFIG=/path/to/alt".
+                       ",err=$tmpdir/alt.err" ];
+       my $env = { PI_CONFIG => '/dev/null' };
+       $td = start_script($cmd, $env, { 3 => $sock, 4 => $unix, 5 => $alt });
 };
 
 $spawn_httpd->();
+{
+       my $conn = conn_for($alt, 'alt PSGI path');
+       $conn->write("GET / HTTP/1.0\r\n\r\n");
+       $conn->read(my $buf, 4096);
+       like($buf, qr!^/path/to/alt\z!sm,
+               'alt.psgi loaded on alt socket with correct env');
+
+       $conn = conn_for($sock, 'default PSGI path');
+       $conn->write("GET /PI_CONFIG HTTP/1.0\r\n\r\n");
+       $conn->read($buf, 4096);
+       like($buf, qr!^/dev/null\z!sm,
+               'default PSGI on original socket');
+       my $log = capture("$tmpdir/alt.err");
+       ok(grep(/ALT/, @$log), 'alt psgi.errors written to');
+       $log = capture($err);
+       ok(!grep(/ALT/, @$log), 'STDERR not written to');
+       is(unlink($err, "$tmpdir/alt.err"), 2, 'unlinked stderr and alt.err');
+
+       $td->kill('USR1'); # trigger reopen_logs
+}
+
 if ('test worker death') {
        my $conn = conn_for($sock, 'killed worker');
        $conn->write("GET /pid HTTP/1.1\r\nHost:example.com\r\n\r\n");
@@ -87,7 +109,16 @@ if ('test worker death') {
        like($body, qr/\A[0-9]+\z/, '/pid response');
        isnt($body, $pid, 'respawned worker');
 }
-
+{ # check on prior USR1 signal
+       ok(-e $err, 'stderr recreated after USR1');
+       ok(-e "$tmpdir/alt.err", 'alt.err recreated after USR1');
+}
+{
+       my $conn = conn_for($sock, 'Header spaces bogus');
+       $conn->write("GET /empty HTTP/1.1\r\nSpaced-Out : 3\r\n\r\n");
+       $conn->read(my $buf, 4096);
+       like($buf, qr!\AHTTP/1\.[0-9] 400 !, 'got 400 response on bad request');
+}
 {
        my $conn = conn_for($sock, 'streaming callback');
        $conn->write("GET /callback HTTP/1.0\r\n\r\n");
@@ -120,40 +151,84 @@ if ('test worker death') {
        is(scalar(grep(/CLOSE FAIL/, @$after)), 1, 'body->close not called');
 }
 
-SKIP: {
+sub check_400 {
+       my ($conn) = @_;
+       my $r = $conn->read(my $buf, 8192);
+       # ECONNRESET and $r==0 are both observed on FreeBSD 11.2
+       if (!defined($r)) {
+               ok($!{ECONNRESET}, 'ECONNRESET on read (BSD sometimes)');
+       } elsif ($r > 0) {
+               like($buf, qr!\AHTTP/1\.\d 400 !, 'got 400 response');
+       } else {
+               is($r, 0, 'got EOF (BSD sometimes)');
+       }
+       close($conn); # ensure we don't get SIGPIPE later
+}
+
+{
+       local $SIG{PIPE} = 'IGNORE';
        my $conn = conn_for($sock, 'excessive header');
-       $SIG{PIPE} = 'IGNORE';
        $conn->write("GET /callback HTTP/1.0\r\n");
        foreach my $i (1..500000) {
                last unless $conn->write("X-xxxxxJunk-$i: omg\r\n");
        }
        ok(!$conn->write("\r\n"), 'broken request');
-       ok($conn->read(my $buf, 8192), 'read response');
-       my ($head, $body) = split(/\r\n\r\n/, $buf);
-       like($head, qr/\b400\b/, 'got 400 response');
+       check_400($conn);
 }
 
 {
        my $conn = conn_for($sock, 'excessive body Content-Length');
-       $SIG{PIPE} = 'IGNORE';
        my $n = (10 * 1024 * 1024) + 1;
        $conn->write("PUT /sha1 HTTP/1.0\r\nContent-Length: $n\r\n\r\n");
-       ok($conn->read(my $buf, 8192), 'read response');
+       my $r = $conn->read(my $buf, 8192);
+       ok($r > 0, 'read response');
        my ($head, $body) = split(/\r\n\r\n/, $buf);
        like($head, qr/\b413\b/, 'got 413 response');
 }
 
 {
        my $conn = conn_for($sock, 'excessive body chunked');
-       $SIG{PIPE} = 'IGNORE';
        my $n = (10 * 1024 * 1024) + 1;
        $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding: chunked\r\n");
        $conn->write("\r\n".sprintf("%x\r\n", $n));
-       ok($conn->read(my $buf, 8192), 'read response');
+       my $r = $conn->read(my $buf, 8192);
+       ok($r > 0, 'read response');
        my ($head, $body) = split(/\r\n\r\n/, $buf);
        like($head, qr/\b413\b/, 'got 413 response');
 }
 
+{
+       my $conn = conn_for($sock, '1.1 Transfer-Encoding bogus');
+       $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding: bogus\r\n\r\n");
+       $conn->read(my $buf, 4096);
+       like($buf, qr!\AHTTP/1\.[0-9] 400 !, 'got 400 response on bogus TE');
+}
+{
+       my $conn = conn_for($sock, '1.1 Content-Length bogus');
+       $conn->write("PUT /sha1 HTTP/1.1\r\nContent-Length: 3.3\r\n\r\n");
+       $conn->read(my $buf, 4096);
+       like($buf, qr!\AHTTP/1\.[0-9] 400 !, 'got 400 response on bad length');
+}
+
+{
+       my $req = "PUT /sha1 HTTP/1.1\r\nContent-Length: 3\r\n" .
+                       "Content-Length: 3\r\n\r\n";
+       # this is stricter than it needs to be.  Due to the way
+       # Plack::HTTPParser, PSGI specs, and how hash tables work in common
+       # languages; it's not possible to tell the difference between folded
+       # and intentionally bad commas (e.g. "Content-Length: 3, 3")
+       if (0) {
+               require Plack::HTTPParser; # XS or pure Perl
+               require Data::Dumper;
+               Plack::HTTPParser::parse_http_request($req, my $env = {});
+               diag Data::Dumper::Dumper($env); # "Content-Length: 3, 3"
+       }
+       my $conn = conn_for($sock, '1.1 Content-Length dupe');
+       $conn->write($req);
+       $conn->read(my $buf, 4096);
+       like($buf, qr!\AHTTP/1\.[0-9] 400 !, 'got 400 response on dupe length');
+}
+
 {
        my $conn = conn_for($sock, 'chunk with pipeline');
        my $n = 10;
@@ -175,7 +250,7 @@ SKIP: {
        ok($u, 'unix socket connected');
        $u->write("GET /host-port HTTP/1.0\r\n\r\n");
        $u->read(my $buf, 4096);
-       like($buf, qr!\r\n\r\n127\.0\.0\.1:0\z!,
+       like($buf, qr!\r\n\r\n127\.0\.0\.1 0\z!,
                'set REMOTE_ADDR and REMOTE_PORT for Unix socket');
 }
 
@@ -192,8 +267,8 @@ sub conn_for {
        $conn->write("GET /host-port HTTP/1.0\r\n\r\n");
        $conn->read(my $buf, 4096);
        my ($head, $body) = split(/\r\n\r\n/, $buf);
-       my ($addr, $port) = split(/:/, $body);
-       is($addr, $conn->sockhost, 'host matches addr');
+       my ($addr, $port) = split(/ /, $body);
+       is($addr, (tcp_host_port($conn))[0], 'host matches addr');
        is($port, $conn->sockport, 'port matches');
 }
 
@@ -245,13 +320,15 @@ sub conn_for {
        $spawn_httpd->('-W0');
 }
 
-sub delay { select(undef, undef, undef, shift || rand(0.02)) }
+sub delay { tick(shift || rand(0.02)) }
 
 my $str = 'abcdefghijklmnopqrstuvwxyz';
 my $len = length $str;
 is($len, 26, 'got the alphabet');
 my $check_self = sub {
        my ($conn) = @_;
+       vec(my $rbits = '', fileno($conn), 1) = 1;
+       select($rbits, undef, undef, 30) or Carp::confess('timed out');
        $conn->read(my $buf, 4096);
        my ($head, $body) = split(/\r\n\r\n/, $buf, 2);
        like($head, qr/\r\nContent-Length: 40\r\n/s, 'got expected length');
@@ -259,12 +336,12 @@ my $check_self = sub {
 };
 
 SKIP: {
-       which('curl') or skip('curl(1) missing', 4);
-       my $base = 'http://' . $sock->sockhost . ':' . $sock->sockport;
+       my $curl = require_cmd('curl', 1) or skip('curl(1) missing', 4);
+       my $base = 'http://'.tcp_host_port($sock);
        my $url = "$base/sha1";
        my ($r, $w);
        pipe($r, $w) or die "pipe: $!";
-       my $cmd = [qw(curl --tcp-nodelay --no-buffer -T- -HExpect: -sS), $url];
+       my $cmd = [$curl, qw(--tcp-nodelay -T- -HExpect: -gsSN), $url];
        open my $cout, '+>', undef or die;
        open my $cerr, '>', undef or die;
        my $rdr = { 0 => $r, 1 => $cout, 2 => $cerr };
@@ -281,7 +358,7 @@ SKIP: {
        seek($cout, 0, SEEK_SET);
        is(<$cout>, sha1_hex($str), 'read expected body');
 
-       open my $fh, '-|', qw(curl -sS), "$base/async-big" or die $!;
+       my $fh = popen_rd([$curl, '-gsS', "$base/async-big"]);
        my $n = 0;
        my $non_zero = 0;
        while (1) {
@@ -289,9 +366,31 @@ SKIP: {
                $n += $r;
                $buf =~ /\A\0+\z/ or $non_zero++;
        }
-       close $fh or die "curl errored out \$?=$?";
+       close $fh or die "close curl pipe: $!";
+       is($?, 0, 'curl succesful');
        is($n, 30 * 1024 * 1024, 'got expected output from curl');
        is($non_zero, 0, 'read all zeros');
+
+       require_mods(@zmods, 4);
+       my $buf = xqx([$curl, '-gsS', "$base/psgi-return-gzip"]);
+       is($?, 0, 'curl succesful');
+       IO::Uncompress::Gunzip::gunzip(\$buf => \(my $out));
+       is($out, "hello world\n");
+       my $curl_rdr = { 2 => \(my $curl_err = '') };
+       $buf = xqx([$curl, qw(-gsSv --compressed),
+                       "$base/psgi-return-compressible"], undef, $curl_rdr);
+       is($?, 0, 'curl --compressed successful');
+       is($buf, "goodbye world\n", 'gzipped response as expected');
+       like($curl_err, qr/\bContent-Encoding: gzip\b/,
+               'curl got gzipped response');
+}
+
+{
+       my $conn = conn_for($sock, 'psgi_return ENOENT');
+       print $conn "GET /psgi-return-enoent HTTP/1.1\r\n\r\n" or die;
+       my $buf = '';
+       sysread($conn, $buf, 16384, length($buf)) until $buf =~ /\r\n\r\n/;
+       like($buf, qr!HTTP/1\.[01] 500\b!, 'got 500 error on ENOENT');
 }
 
 {
@@ -329,17 +428,20 @@ SKIP: {
 
 {
        my $conn = conn_for($sock, 'graceful termination during slow request');
-       $conn->write("PUT /sha1 HTTP/1.0\r\n");
-       delay();
-       $conn->write("Content-Length: $len\r\n");
-       delay();
-       $conn->write("\r\n");
-       is($td->kill, 1, 'started graceful shutdown');
-       delay();
+       $conn->write("PUT /sha1 HTTP/1.0\r\nContent-Length: $len\r\n\r\n");
+
+       # XXX ugh, want a reliable and non-intrusive way to detect
+       # that the server has started buffering our partial request so we
+       # can reliably test graceful termination.  Maybe making this and
+       # similar tests dependent on Linux strace is a possibility?
+       delay(0.1);
+
+       is($td->kill, 1, 'start graceful shutdown');
        my $n = 0;
        foreach my $c ('a'..'z') {
                $n += $conn->write($c);
        }
+       ok(kill(0, $td->{pid}), 'graceful shutdown did not kill httpd');
        is($n, $len, 'wrote alphabet');
        $check_self->($conn);
        $td->join;
@@ -360,10 +462,7 @@ SKIP: {
        ok($!, 'got error set in $!');
        is($w, undef, 'write error happened');
        ok($n > 0, 'was able to write');
-       my $r = $conn->read(my $buf, 66666);
-       ok($r > 0, 'got non-empty response');
-       like($buf, qr!HTTP/1\.\d 400 !, 'got 400 response');
-
+       check_400($conn);
        $conn = conn_for($sock, '1.1 chunk trailer excessive');
        $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding:chunked\r\n\r\n");
        is($conn->syswrite("1\r\na"), 4, 'wrote first header + chunk');
@@ -374,9 +473,7 @@ SKIP: {
        }
        ok($!, 'got error set in $!');
        ok($n > 0, 'wrote part of chunk end (\r)');
-       $r = $conn->read($buf, 66666);
-       ok($r > 0, 'got non-empty response');
-       like($buf, qr!HTTP/1\.\d 400 !, 'got 400 response');
+       check_400($conn);
 }
 
 {
@@ -494,7 +591,7 @@ SKIP: {
 }
 
 {
-       my $conn = conn_for($sock, '1.1 Connnection: close');
+       my $conn = conn_for($sock, '1.1 Connection: close');
        $conn->write("PUT /sha1 HTTP/1.1\r\nConnection:close\r\n");
        delay();
        $conn->write("Content-Length: $len\r\n\r\n$str");
@@ -535,19 +632,22 @@ SKIP: {
 SKIP: {
        skip 'SO_ACCEPTFILTER is FreeBSD-only', 1 if $^O ne 'freebsd';
        skip 'accf_data not loaded: kldload accf_data' if !defined $accf_arg;
-       my $var = PublicInbox::Daemon::SO_ACCEPTFILTER();
+       my $var = $PublicInbox::Daemon::SO_ACCEPTFILTER;
        defined(my $x = getsockopt($sock, SOL_SOCKET, $var)) or die;
        is($x, $accf_arg, 'SO_ACCEPTFILTER unchanged if previously set');
 };
 
 SKIP: {
        skip 'only testing lsof(8) output on Linux', 1 if $^O ne 'linux';
-       skip 'no lsof in PATH', 1 unless which('lsof');
-       my @lsof = `lsof -p $td->{pid}`;
-       is_deeply([grep(/\bdeleted\b/, @lsof)], [], 'no lingering deleted inputs');
+       my $lsof = require_cmd('lsof', 1) or skip 'no lsof in PATH', 1;
+       my $null_in = '';
+       my $rdr = { 2 => \(my $null_err), 0 => \$null_in };
+       my @lsof = xqx([$lsof, '-p', $td->{pid}], undef, $rdr);
+       my $d = [ grep(/\(deleted\)/, @lsof) ];
+       is_deeply($d, [], 'no lingering deleted inputs') or diag explain($d);
 
        # filter out pipes inherited from the parent
-       my @this = `lsof -p $$`;
+       my @this = xqx([$lsof, '-p', $$], undef, $rdr);
        my $bad;
        my $extract_inodes = sub {
                map {;
@@ -564,6 +664,36 @@ SKIP: {
        is_deeply([], [keys %child], 'no extra pipes with -W0');
 };
 
+# ensure compatibility with other PSGI servers
+SKIP: {
+       require_mods(@zmods, qw(Plack::Test HTTP::Request::Common), 3);
+       use_ok 'HTTP::Request::Common';
+       use_ok 'Plack::Test';
+       STDERR->flush;
+       open my $olderr, '>&', \*STDERR or die "dup stderr: $!";
+       open my $tmperr, '+>', undef or die;
+       open STDERR, '>&', $tmperr or die;
+       STDERR->autoflush(1);
+       my $app = require $psgi;
+       test_psgi($app, sub {
+               my ($cb) = @_;
+               my $req = GET('http://example.com/psgi-return-gzip');
+               my $res = $cb->($req);
+               my $buf = $res->content;
+               IO::Uncompress::Gunzip::gunzip(\$buf => \(my $out));
+               is($out, "hello world\n", 'got expected output');
+
+               $req = GET('http://example.com/psgi-return-enoent');
+               $res = $cb->($req);
+               is($res->code, 500, 'got error on ENOENT');
+               seek($tmperr, 0, SEEK_SET) or die;
+               my $errbuf = do { local $/; <$tmperr> };
+               like($errbuf, qr/this-better-not-exist/,
+                       'error logged about missing command');
+       });
+       open STDERR, '>&', $olderr or die "restore stderr: $!";
+}
+
 done_testing();
 
 sub capture {