]> Sergey Matveev's repositories - public-inbox.git/blobdiff - t/httpd-corner.t
daemon: provide TCP_DEFER_ACCEPT for Perl <5.14
[public-inbox.git] / t / httpd-corner.t
index 5834c1bd68fd7e2aea6616609a80673090fab55e..1f2bb53f7b932afacaedf22fca57ee871335d973 100644 (file)
-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2019 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 Rack apps.
+# generic PSGI/Plack apps.
 use strict;
 use warnings;
 use Test::More;
-
-foreach my $mod (qw(Plack::Util Plack::Request Plack::Builder Danga::Socket
-                       HTTP::Parser::XS HTTP::Date HTTP::Status)) {
-       eval "require $mod";
-       plan skip_all => "$mod missing for httpd-corner.t" if $@;
-}
-
+use Time::HiRes qw(gettimeofday tv_interval);
+use PublicInbox::Spawn qw(which spawn);
+use PublicInbox::TestCommon;
+require_mods(qw(Plack::Util Plack::Builder HTTP::Date HTTP::Status));
 use Digest::SHA qw(sha1_hex);
-use File::Temp qw/tempdir/;
-use Cwd qw/getcwd/;
 use IO::Socket;
-use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
-use Socket qw(SO_KEEPALIVE IPPROTO_TCP TCP_NODELAY);
-my $tmpdir = tempdir(CLEANUP => 1);
+use IO::Socket::UNIX;
+use Fcntl qw(:seek);
+use Socket qw(IPPROTO_TCP TCP_NODELAY SOL_SOCKET);
+use POSIX qw(mkfifo);
+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 = getcwd()."/t/httpd-corner.psgi";
-my %opts = (
-       LocalAddr => '127.0.0.1',
-       ReuseAddr => 1,
-       Proto => 'tcp',
-       Type => SOCK_STREAM,
-       Listen => 1024,
-);
-my $sock = IO::Socket::INET->new(%opts);
-my $pid;
-END { kill 'TERM', $pid if defined $pid };
+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: $!';
+
+# Make sure we don't clobber socket options set by systemd or similar
+# using socket activation:
+my ($defer_accept_val, $accf_arg, $TCP_DEFER_ACCEPT);
+if ($^O eq 'linux') {
+       $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) {
+               die "unexpected TCP_DEFER_ACCEPT value: $defer_accept_val";
+       }
+} elsif ($^O eq 'freebsd' && system('kldstat -m accf_data >/dev/null') == 0) {
+       require PublicInbox::Daemon;
+       my $var = PublicInbox::Daemon::SO_ACCEPTFILTER();
+       $accf_arg = pack('a16a240', 'dataready', '');
+       setsockopt($sock, SOL_SOCKET, $var, $accf_arg) or die "setsockopt: $!";
+}
+
+sub unix_server ($) {
+       my $s = IO::Socket::UNIX->new(
+               Listen => 1024,
+               Type => Socket::SOCK_STREAM(),
+               Local => $_[0],
+       );
+       $s->blocking(0);
+       $s;
+}
+
+my $upath = "$tmpdir/s";
+my $unix = unix_server($upath);
+ok($unix, 'UNIX socket created');
+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 });
+};
+
+$spawn_httpd->();
+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");
+       my $pid;
+       while (defined(my $line = $conn->getline)) {
+               next unless $line eq "\r\n";
+               chomp($pid = $conn->getline);
+               last;
+       }
+       like($pid, qr/\A[0-9]+\z/, '/pid response');
+       is(kill('KILL', $pid), 1, 'killed worker');
+       is($conn->getline, undef, 'worker died and EOF-ed client');
+
+       $conn = conn_for($sock, 'respawned worker');
+       $conn->write("GET /pid HTTP/1.0\r\n\r\n");
+       ok($conn->read(my $buf, 8192), 'read response');
+       my ($head, $body) = split(/\r\n\r\n/, $buf);
+       chomp($body);
+       like($body, qr/\A[0-9]+\z/, '/pid response');
+       isnt($body, $pid, 'respawned worker');
+}
+
+{
+       my $conn = conn_for($sock, 'streaming callback');
+       $conn->write("GET /callback HTTP/1.0\r\n\r\n");
+       ok($conn->read(my $buf, 8192), 'read response');
+       my ($head, $body) = split(/\r\n\r\n/, $buf);
+       is($body, "hello world\n", 'callback body matches expected');
+}
+
+{
+       my $conn = conn_for($sock, 'getline-die');
+       $conn->write("GET /getline-die HTTP/1.1\r\nHost: example.com\r\n\r\n");
+       ok($conn->read(my $buf, 8192), 'read some response');
+       like($buf, qr!HTTP/1\.1 200\b[^\r]*\r\n!, 'got some sort of header');
+       is($conn->read(my $nil, 8192), 0, 'read EOF');
+       $conn = undef;
+       my $after = capture($err);
+       is(scalar(grep(/GETLINE FAIL/, @$after)), 1, 'failure logged');
+       is(scalar(grep(/CLOSE FAIL/, @$after)), 1, 'body->close not called');
+}
+
 {
-       ok($sock, 'sock created');
-       $! = 0;
-       my $fl = fcntl($sock, F_GETFD, 0);
-       ok(! $!, 'no error from fcntl(F_GETFD)');
-       is($fl, FD_CLOEXEC, 'cloexec set by default (Perl behavior)');
-       $pid = fork;
-       if ($pid == 0) {
-               use POSIX qw(dup2);
-               # pretend to be systemd
-               fcntl($sock, F_SETFD, $fl &= ~FD_CLOEXEC);
-               dup2(fileno($sock), 3) or die "dup2 failed: $!\n";
-               $ENV{LISTEN_PID} = $$;
-               $ENV{LISTEN_FDS} = 1;
-               exec $httpd, '-W0', "--stdout=$out", "--stderr=$err", $psgi;
-               die "FAIL: $!\n";
+       my $conn = conn_for($sock, 'close-die');
+       $conn->write("GET /close-die HTTP/1.1\r\nHost: example.com\r\n\r\n");
+       ok($conn->read(my $buf, 8192), 'read some response');
+       like($buf, qr!HTTP/1\.1 200\b[^\r]*\r\n!, 'got some sort of header');
+       is($conn->read(my $nil, 8192), 0, 'read EOF');
+       $conn = undef;
+       my $after = capture($err);
+       is(scalar(grep(/GETLINE FAIL/, @$after)), 0, 'getline not failed');
+       is(scalar(grep(/CLOSE FAIL/, @$after)), 1, 'body->close not called');
+}
+
+SKIP: {
+       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(defined $pid, 'forked httpd process successfully');
-       $! = 0;
-       fcntl($sock, F_SETFD, $fl |= FD_CLOEXEC);
-       ok(! $!, 'no error from fcntl(F_SETFD)');
+       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');
+}
+
+{
+       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 ($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 ($head, $body) = split(/\r\n\r\n/, $buf);
+       like($head, qr/\b413\b/, 'got 413 response');
+}
+
+{
+       my $conn = conn_for($sock, 'chunk with pipeline');
+       my $n = 10;
+       my $payload = 'b'x$n;
+       $conn->write("PUT /sha1 HTTP/1.1\r\nTransfer-Encoding: chunked\r\n");
+       $conn->write("\r\n".sprintf("%x\r\n", $n));
+       $conn->write($payload . "\r\n0\r\n\r\nGET /empty HTTP/1.0\r\n\r\n");
+       $conn->read(my $buf, 4096);
+       my $lim = 0;
+       $lim++ while ($conn->read($buf, 4096, length($buf)) && $lim < 9);
+       my $exp = sha1_hex($payload);
+       like($buf, qr!\r\n\r\n${exp}HTTP/1\.0 200 OK\r\n!s,
+               'chunk parser can handled pipelined requests');
+}
+
+# Unix domain sockets
+{
+       my $u = IO::Socket::UNIX->new(Type => SOCK_STREAM, Peer => $upath);
+       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!,
+               'set REMOTE_ADDR and REMOTE_PORT for Unix socket');
 }
 
 sub conn_for {
-       my ($sock, $msg) = @_;
-       my $conn = IO::Socket::INET->new(
-                               PeerAddr => $sock->sockhost,
-                               PeerPort => $sock->sockport,
-                               Proto => 'tcp',
-                               Type => SOCK_STREAM);
+       my ($dest, $msg) = @_;
+       my $conn = tcp_connect($dest);
        ok($conn, "connected for $msg");
-       $conn->autoflush(1);
        setsockopt($conn, IPPROTO_TCP, TCP_NODELAY, 1);
        return $conn;
 }
 
+{
+       my $conn = conn_for($sock, 'host-port');
+       $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');
+       is($port, $conn->sockport, 'port matches');
+}
+
+# graceful termination
+{
+       my $conn = conn_for($sock, 'graceful termination via slow header');
+       $conn->write("GET /slow-header HTTP/1.0\r\n" .
+                       "X-Check-Fifo: $fifo\r\n\r\n");
+       open my $f, '>', $fifo or die "open $fifo: $!\n";
+       $f->autoflush(1);
+       ok(print($f "hello\n"), 'wrote something to fifo');
+       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');
+       $td->join;
+       is($?, 0, 'no error');
+       $spawn_httpd->('-W0');
+}
+
+{
+       my $conn = conn_for($sock, 'graceful termination via slow-body');
+       $conn->write("GET /slow-body HTTP/1.0\r\n" .
+                       "X-Check-Fifo: $fifo\r\n\r\n");
+       open my $f, '>', $fifo or die "open $fifo: $!\n";
+       $f->autoflush(1);
+       my $buf;
+       $conn->sysread($buf, 8192);
+       like($buf, qr!\AHTTP/1\.[01] 200 OK!, 'got 200 for slow-body');
+       like($buf, qr!\r\n\r\n!, 'finished HTTP response header');
+
+       foreach my $c ('a'..'c') {
+               $c .= "\n";
+               ok(print($f $c), 'wrote line to fifo');
+               $conn->sysread($buf, 8192);
+               is($buf, $c, 'got trickle for reading');
+       }
+       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');
+       $td->join;
+       is($?, 0, 'no error');
+       $spawn_httpd->('-W0');
+}
+
 sub delay { select(undef, undef, undef, shift || rand(0.02)) }
 
 my $str = 'abcdefghijklmnopqrstuvwxyz';
@@ -82,6 +258,42 @@ my $check_self = sub {
        is($body, sha1_hex($str), 'read expected body');
 };
 
+SKIP: {
+       which('curl') or skip('curl(1) missing', 4);
+       my $base = 'http://' . $sock->sockhost . ':' . $sock->sockport;
+       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];
+       open my $cout, '+>', undef or die;
+       open my $cerr, '>', undef or die;
+       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') {
+               print $w $c or die "failed to write to curl: $!";
+               delay();
+       }
+       close $w or die "close write pipe: $!";
+       waitpid($pid, 0);
+       is($?, 0, 'curl exited successfully');
+       is(-s $cerr, 0, 'no errors from curl');
+       $cout->seek(0, SEEK_SET);
+       is(<$cout>, sha1_hex($str), 'read expected body');
+
+       open my $fh, '-|', qw(curl -sS), "$base/async-big" or die $!;
+       my $n = 0;
+       my $non_zero = 0;
+       while (1) {
+               my $r = sysread($fh, my $buf, 4096) or last;
+               $n += $r;
+               $buf =~ /\A\0+\z/ or $non_zero++;
+       }
+       close $fh or die "curl errored out \$?=$?";
+       is($n, 30 * 1024 * 1024, 'got expected output from curl');
+       is($non_zero, 0, 'read all zeros');
+}
+
 {
        my $conn = conn_for($sock, '1.1 pipeline together');
        $conn->write("PUT /sha1 HTTP/1.1\r\nUser-agent: hello\r\n\r\n" .
@@ -103,6 +315,38 @@ my $check_self = sub {
        }
 }
 
+{
+       my $conn = conn_for($sock, 'no TCP_CORK on empty body');
+       $conn->write("GET /empty HTTP/1.1\r\nHost:example.com\r\n\r\n");
+       my $buf = '';
+       my $t0 = [ gettimeofday ];
+       until ($buf =~ /\r\n\r\n/s) {
+               $conn->sysread($buf, 4096, length($buf));
+       }
+       my $elapsed = tv_interval($t0, [ gettimeofday ]);
+       ok($elapsed < 0.190, 'no 200ms TCP cork delay on empty body');
+}
+
+{
+       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();
+       my $n = 0;
+       foreach my $c ('a'..'z') {
+               $n += $conn->write($c);
+       }
+       is($n, $len, 'wrote alphabet');
+       $check_self->($conn);
+       $td->join;
+       is($?, 0, 'no error');
+       $spawn_httpd->('-W0');
+}
+
 # various DoS attacks against the chunk parser:
 {
        local $SIG{PIPE} = 'IGNORE';
@@ -281,6 +525,54 @@ my $check_self = sub {
        is($body, sha1_hex(''), 'read expected body #2');
 }
 
+SKIP: {
+       skip 'TCP_DEFER_ACCEPT is Linux-only', 1 if $^O ne 'linux';
+       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');
+};
+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();
+       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');
+
+       # filter out pipes inherited from the parent
+       my @this = `lsof -p $$`;
+       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');
+};
+
 done_testing();
 
+sub capture {
+       my ($f) = @_;
+       open my $fh, '+<', $f or die "failed to open $f: $!\n";
+       local $/ = "\n";
+       my @r = <$fh>;
+       truncate($fh, 0) or die "truncate failed on $f: $!\n";
+       \@r
+}
+
 1;