X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=t%2Fhttpd-corner.t;h=0a613a9e095565a5b4fa75fda023436532e200b6;hp=cc36c7e10c87fc90d4477d2c59b1f3340caeb4ad;hb=refs%2Fheads%2Fmaster;hpb=64f3a6aded930c82e35a466b2dad58299d29ee6e diff --git a/t/httpd-corner.t b/t/httpd-corner.t index cc36c7e1..7600c2b9 100644 --- a/t/httpd-corner.t +++ b/t/httpd-corner.t @@ -1,44 +1,35 @@ -# Copyright (C) 2016-2019 all contributors +#!perl -w +# Copyright (C) all contributors # License: AGPL-3.0+ # 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); - -foreach my $mod (qw(Plack::Util Plack::Builder HTTP::Date HTTP::Status)) { - eval "require $mod"; - plan skip_all => "$mod missing for httpd-corner.t" if $@; -} - -use Digest::SHA qw(sha1_hex); -use File::Temp qw/tempdir/; -use IO::Socket; +use PublicInbox::Spawn qw(spawn popen_rd); +require_mods(qw(Plack::Util Plack::Builder HTTP::Date HTTP::Status)); +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); -require './t/common.perl'; -my $tmpdir = tempdir('httpd-corner-XXXXXX', TMPDIR => 1, CLEANUP => 1); +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 $httpd = 'blib/script/public-inbox-httpd'; 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: -my ($defer_accept_val, $accf_arg); +my ($defer_accept_val, $accf_arg, $TCP_DEFER_ACCEPT); if ($^O eq 'linux') { - setsockopt($sock, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT(), 5) or die; - my $x = getsockopt($sock, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT()); + $TCP_DEFER_ACCEPT = eval { Socket::TCP_DEFER_ACCEPT() } // 9; + setsockopt($sock, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 5) or die; + my $x = getsockopt($sock, IPPROTO_TCP, $TCP_DEFER_ACCEPT); defined $x or die "getsockopt: $!"; $defer_accept_val = unpack('i', $x); if ($defer_accept_val <= 0) { @@ -46,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: $!"; } @@ -56,24 +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 $pid; -END { kill 'TERM', $pid if defined $pid }; +my $alt = tcp_server(); +my $td; my $spawn_httpd = sub { my (@args) = @_; - my $cmd = [ $httpd, @args, "--stdout=$out", "--stderr=$err", $psgi ]; - $pid = spawn_listener(undef, $cmd, [ $sock, $unix ]); - ok(defined $pid, 'forked httpd process successfully'); + 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"); @@ -95,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"); @@ -128,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; @@ -183,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'); } @@ -200,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'); } @@ -213,16 +280,14 @@ sub conn_for { open my $f, '>', $fifo or die "open $fifo: $!\n"; $f->autoflush(1); ok(print($f "hello\n"), 'wrote something to fifo'); - my $kpid = $pid; - $pid = undef; - is(kill('TERM', $kpid), 1, 'started graceful shutdown'); + is($td->kill, 1, 'started graceful shutdown'); ok(print($f "world\n"), 'wrote else to fifo'); close $f or die "close fifo: $!\n"; $conn->read(my $buf, 8192); my ($head, $body) = split(/\r\n\r\n/, $buf, 2); like($head, qr!\AHTTP/1\.[01] 200 OK!, 'got 200 for slow-header'); is($body, "hello\nworld\n", 'read expected body'); - is(waitpid($kpid, 0), $kpid, 'reaped httpd'); + $td->join; is($?, 0, 'no error'); $spawn_httpd->('-W0'); } @@ -244,26 +309,26 @@ sub conn_for { $conn->sysread($buf, 8192); is($buf, $c, 'got trickle for reading'); } - my $kpid = $pid; - $pid = undef; - is(kill('TERM', $kpid), 1, 'started graceful shutdown'); + is($td->kill, 1, 'started graceful shutdown'); ok(print($f "world\n"), 'wrote else to fifo'); close $f or die "close fifo: $!\n"; $conn->sysread($buf, 8192); is($buf, "world\n", 'read expected body'); is($conn->sysread($buf, 8192), 0, 'got EOF from server'); - is(waitpid($kpid, 0), $kpid, 'reaped httpd'); + $td->join; is($?, 0, 'no error'); $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'); @@ -271,15 +336,15 @@ 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 => fileno($r), 1 => fileno($cout), 2 => fileno($cerr) }; + my $rdr = { 0 => $r, 1 => $cout, 2 => $cerr }; my $pid = spawn($cmd, undef, $rdr); close $r or die "close read pipe: $!"; foreach my $c ('a'..'z') { @@ -290,10 +355,10 @@ SKIP: { waitpid($pid, 0); is($?, 0, 'curl exited successfully'); is(-s $cerr, 0, 'no errors from curl'); - $cout->seek(0, SEEK_SET); + 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) { @@ -301,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'); } { @@ -341,22 +428,23 @@ 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"); - my $kpid = $pid; - $pid = undef; - is(kill('TERM', $kpid), 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); - is(waitpid($kpid, 0), $kpid, 'reaped httpd'); + $td->join; is($?, 0, 'no error'); $spawn_httpd->('-W0'); } @@ -374,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'); @@ -388,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); } { @@ -508,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"); @@ -541,7 +624,7 @@ SKIP: { SKIP: { skip 'TCP_DEFER_ACCEPT is Linux-only', 1 if $^O ne 'linux'; - my $var = Socket::TCP_DEFER_ACCEPT(); + my $var = $TCP_DEFER_ACCEPT; defined(my $x = getsockopt($sock, IPPROTO_TCP, $var)) or die; is(unpack('i', $x), $defer_accept_val, 'TCP_DEFER_ACCEPT unchanged if previously set'); @@ -549,18 +632,68 @@ 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 $pid`; - is_deeply([grep(/\bdeleted\b/, @lsof)], [], 'no lingering deleted inputs'); - is_deeply([grep(/\bpipe\b/, @lsof)], [], 'no extra pipes with -W0'); + 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 = xqx([$lsof, '-p', $$], undef, $rdr); + my $bad; + my $extract_inodes = sub { + map {; + my @f = split(' ', $_); + my $inode = $f[-2]; + $bad = $_ if $inode !~ /\A[0-9]+\z/; + $inode => 1; + } grep (/\bpipe\b/, @_); + }; + my %child = $extract_inodes->(@lsof); + my %parent = $extract_inodes->(@this); + skip("inode not in expected format: $bad", 1) if defined($bad); + delete @child{(keys %parent)}; + 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 {