]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/TestCommon.pm
extindex: add some validation and config knobs for WWW
[public-inbox.git] / lib / PublicInbox / TestCommon.pm
index bb2cd7e6629c5938a0ebf56d690a1cb17db5b843..0d15514e2cb6f2859ab2296515fa82d9e05d2574 100644 (file)
@@ -9,12 +9,14 @@ use v5.10.1;
 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD :seek);
 use POSIX qw(dup2);
 use IO::Socket::INET;
+use File::Spec;
 our @EXPORT;
 BEGIN {
        @EXPORT = qw(tmpdir tcp_server tcp_connect require_git require_mods
                run_script start_script key2sub xsys xsys_e xqx eml_load tick
-               have_xapian_compact json_utf8 setup_public_inboxes
-               test_lei $lei $lei_out $lei_err $lei_opt);
+               have_xapian_compact json_utf8 setup_public_inboxes create_inbox
+               tcp_host_port test_lei lei lei_ok $lei_out $lei_err $lei_opt
+               test_httpd);
        require Test::More;
        my @methods = grep(!/\W/, @Test::More::EXPORT);
        eval(join('', map { "*$_=\\&Test::More::$_;" } @methods));
@@ -40,20 +42,38 @@ sub tmpdir (;$) {
 }
 
 sub tcp_server () {
-       IO::Socket::INET->new(
-               LocalAddr => '127.0.0.1',
+       my %opt = (
                ReuseAddr => 1,
                Proto => 'tcp',
                Type => Socket::SOCK_STREAM(),
                Listen => 1024,
                Blocking => 0,
-       ) or BAIL_OUT "failed to create TCP server: $!";
+       );
+       eval {
+               die 'IPv4-only' if $ENV{TEST_IPV4_ONLY};
+               require IO::Socket::INET6;
+               IO::Socket::INET6->new(%opt, LocalAddr => '[::1]')
+       } || eval {
+               die 'IPv6-only' if $ENV{TEST_IPV6_ONLY};
+               IO::Socket::INET->new(%opt, LocalAddr => '127.0.0.1')
+       } || BAIL_OUT "failed to create TCP server: $! ($@)";
+}
+
+sub tcp_host_port ($) {
+       my ($s) = @_;
+       my ($h, $p) = ($s->sockhost, $s->sockport);
+       my $ipv4 = $s->sockdomain == Socket::AF_INET();
+       if (wantarray) {
+               $ipv4 ? ($h, $p) : ("[$h]", $p);
+       } else {
+               $ipv4 ? "$h:$p" : "[$h]:$p";
+       }
 }
 
 sub tcp_connect {
        my ($dest, %opt) = @_;
-       my $addr = $dest->sockhost . ':' . $dest->sockport;
-       my $s = IO::Socket::INET->new(
+       my $addr = tcp_host_port($dest);
+       my $s = ref($dest)->new(
                Proto => 'tcp',
                Type => Socket::SOCK_STREAM(),
                PeerAddr => $addr,
@@ -135,8 +155,8 @@ sub key2script ($) {
        'blib/script/'.$key;
 }
 
-my @io_mode = ([ *STDIN{IO}, '<&' ], [ *STDOUT{IO}, '>&' ],
-               [ *STDERR{IO}, '>&' ]);
+my @io_mode = ([ *STDIN{IO}, '+<&' ], [ *STDOUT{IO}, '+>&' ],
+               [ *STDERR{IO}, '+>&' ]);
 
 sub _prepare_redirects ($) {
        my ($fhref) = @_;
@@ -251,6 +271,9 @@ sub run_script ($;$$) {
                        die "unable to deal with $ref $redir";
                }
        }
+       if ($key =~ /-(index|convert|extindex|convert|xcpdb)\z/) {
+               unshift @argv, '--no-fsync';
+       }
        if ($run_mode == 0) {
                # spawn an independent new process, like real-world use cases:
                require PublicInbox::Spawn;
@@ -423,7 +446,8 @@ sub have_xapian_compact () {
 }
 
 our ($err_skip, $lei_opt, $lei_out, $lei_err);
-our $lei = sub {
+# favor lei() or lei_ok() over $lei for new code
+sub lei (@) {
        my ($cmd, $env, $xopt) = @_;
        $lei_out = $lei_err = '';
        if (!ref($cmd)) {
@@ -436,6 +460,18 @@ our $lei = sub {
        $res;
 };
 
+sub lei_ok (@) {
+       my $msg = ref($_[-1]) eq 'SCALAR' ? pop(@_) : undef;
+       my $tmpdir = quotemeta(File::Spec->tmpdir);
+       # filter out anything that looks like a path name for consistent logs
+       my @msg = ref($_[0]) eq 'ARRAY' ? @{$_[0]} : @_;
+       for (@msg) {
+               s!\A([a-z0-9]+://)[^/]+/!$1\$HOST_PORT/! ||
+                       s!$tmpdir\b/(?:[^/]+/)?!\$TMPDIR/!;
+       }
+       ok(lei(@_), "lei @msg". ($msg ? " ($$msg)" : '')) or diag $lei_err;
+}
+
 sub json_utf8 () {
        state $x = ref(PublicInbox::Config->json)->new->utf8->canonical;
 }
@@ -444,25 +480,29 @@ sub test_lei {
 SKIP: {
        my ($cb) = pop @_;
        my $test_opt = shift // {};
-       require_git(2.6) or skip('git 2.6+ required for lei test', 2);
+       require_git(2.6, 1) or skip('git 2.6+ required for lei test', 2);
        require_mods(qw(json DBD::SQLite Search::Xapian), 2);
        require PublicInbox::Config;
-       delete local $ENV{XDG_DATA_HOME};
-       delete local $ENV{XDG_CONFIG_HOME};
-       local $ENV{GIT_COMMITTER_EMAIL} = 'lei@example.com';
-       local $ENV{GIT_COMMITTER_NAME} = 'lei user';
+       local %ENV = %ENV;
+       delete $ENV{XDG_DATA_HOME};
+       delete $ENV{XDG_CONFIG_HOME};
+       $ENV{GIT_COMMITTER_EMAIL} = 'lei@example.com';
+       $ENV{GIT_COMMITTER_NAME} = 'lei user';
        my (undef, $fn, $lineno) = caller(0);
        my $t = "$fn:$lineno";
        require PublicInbox::Spawn;
        state $lei_daemon = PublicInbox::Spawn->can('send_cmd4') ||
                                eval { require Socket::MsgHdr; 1 };
-       $lei_opt = { 1 => \$lei_out, 2 => \$lei_err };
-       my $daemon_pid;
-       my ($tmpdir, $for_destroy) = tmpdir();
-       SKIP: {
-               skip <<'EOM', 1 unless $lei_daemon;
+       # XXX fix and move this inside daemon-only before 1.7 release
+       skip <<'EOM', 1 unless $lei_daemon;
 Socket::MsgHdr missing or Inline::C is unconfigured/missing
 EOM
+       $lei_opt = { 1 => \$lei_out, 2 => \$lei_err };
+       my ($daemon_pid, $for_destroy);
+       my $tmpdir = $test_opt->{tmpdir};
+       ($tmpdir, $for_destroy) = tmpdir unless $tmpdir;
+       SKIP: {
+               skip 'TEST_LEI_ONESHOT set', 1 if $ENV{TEST_LEI_ONESHOT};
                my $home = "$tmpdir/lei-daemon";
                mkdir($home, 0700) or BAIL_OUT "mkdir: $!";
                local $ENV{HOME} = $home;
@@ -470,23 +510,25 @@ EOM
                mkdir($xrd, 0700) or BAIL_OUT "mkdir: $!";
                local $ENV{XDG_RUNTIME_DIR} = $xrd;
                $cb->();
-               ok($lei->(qw(daemon-pid)), "daemon-pid after $t");
+               lei_ok(qw(daemon-pid), \"daemon-pid after $t");
                chomp($daemon_pid = $lei_out);
                if ($daemon_pid) {
                        ok(kill(0, $daemon_pid), "daemon running after $t");
-                       ok($lei->(qw(daemon-kill)), "daemon-kill after $t");
+                       lei_ok(qw(daemon-kill), \"daemon-kill after $t");
                } else {
                        fail("daemon not running after $t");
                }
        }; # SKIP for lei_daemon
        unless ($test_opt->{daemon_only}) {
+               $ENV{TEST_LEI_DAEMON_ONLY} and
+                       skip 'TEST_LEI_DAEMON_ONLY set', 1;
                require_ok 'PublicInbox::LEI';
                my $home = "$tmpdir/lei-oneshot";
                mkdir($home, 0700) or BAIL_OUT "mkdir: $!";
                local $ENV{HOME} = $home;
                # force sun_path[108] overflow:
                my $xrd = "$home/1shot-test".('.sun_path' x 108);
-               local $err_skip = qr!\Q$xrd!; # for $lei->() filtering
+               local $err_skip = qr!\Q$xrd!; # for lei() filtering
                local $ENV{XDG_RUNTIME_DIR} = $xrd;
                $cb->();
        }
@@ -503,7 +545,7 @@ EOM
 # returns the pathname to a ~/.public-inbox/config in scalar context,
 # ($test_home, $pi_config_pathname) in list context
 sub setup_public_inboxes () {
-       my $test_home = "t/home1";
+       my $test_home = "t/home2";
        my $pi_config = "$test_home/.public-inbox/config";
        my $stamp = "$test_home/setup-stamp";
        my @ret = ($test_home, $pi_config);
@@ -515,18 +557,20 @@ sub setup_public_inboxes () {
        my $end = $lk->lock_for_scope;
        return @ret if -f $stamp;
 
-       require PublicInbox::InboxWritable;
        local $ENV{PI_CONFIG} = $pi_config;
        for my $V (1, 2) {
-               run_script([qw(-init), "-V$V", "t$V",
-                               '--newsgroup', "t.$V",
+               run_script([qw(-init --skip-docdata), "-V$V",
+                               '--newsgroup', "t.v$V", "t$V",
                                "$test_home/t$V", "http://example.com/t$V",
                                "t$V\@example.com" ]) or BAIL_OUT "init v$V";
        }
+       require PublicInbox::Config;
+       require PublicInbox::InboxWritable;
        my $cfg = PublicInbox::Config->new;
        my $seen = 0;
        $cfg->each_inbox(sub {
                my ($ibx) = @_;
+               $ibx->{-no_fsync} = 1;
                my $im = PublicInbox::InboxWritable->new($ibx)->importer(0);
                my $V = $ibx->version;
                my @eml = (glob('t/*.eml'), 't/data/0001.patch');
@@ -536,16 +580,88 @@ sub setup_public_inboxes () {
                        $seen++;
                }
                $im->done;
-               if ($V == 1) {
-                       run_script(['-index', $ibx->{inboxdir}]) or
-                               BAIL_OUT 'index v1';
-               }
        });
        $seen or BAIL_OUT 'no imports';
        open my $fh, '>', $stamp or BAIL_OUT "open $stamp: $!";
        @ret;
+}
+
+sub create_inbox ($$;@) {
+       my $ident = shift;
+       my $cb = pop;
+       my %opt = @_;
+       require PublicInbox::Lock;
+       require PublicInbox::InboxWritable;
+       my ($base) = ($0 =~ m!\b([^/]+)\.[^\.]+\z!);
+       my $dir = "t/data-gen/$base.$ident";
+       my $new = !-d $dir;
+       if ($new) {
+               mkdir $dir; # may race
+               -d $dir or BAIL_OUT "$dir could not be created: $!";
+       }
+       my $lk = bless { lock_path => "$dir/creat.lock" }, 'PublicInbox::Lock';
+       $opt{inboxdir} = File::Spec->rel2abs($dir);
+       $opt{name} //= $ident;
+       my $scope = $lk->lock_for_scope;
+       my $pre_cb = delete $opt{pre_cb};
+       $pre_cb->($dir) if $pre_cb && $new;
+       $opt{-no_fsync} = 1;
+       my $no_gc = delete $opt{-no_gc};
+       my $tmpdir = delete $opt{tmpdir};
+       my $addr = $opt{address} // [];
+       $opt{-primary_address} //= $addr->[0] // "$ident\@example.com";
+       my $parallel = delete($opt{importer_parallel}) // 0;
+       my $creat_opt = { nproc => delete($opt{nproc}) // 1 };
+       my $ibx = PublicInbox::InboxWritable->new({ %opt }, $creat_opt);
+       if (!-f "$dir/creat.stamp") {
+               my $im = $ibx->importer($parallel);
+               $cb->($im, $ibx);
+               $im->done if $im;
+               unless ($no_gc) {
+                       my @to_gc = $ibx->version == 1 ? ($ibx->{inboxdir}) :
+                                       glob("$ibx->{inboxdir}/git/*.git");
+                       for my $dir (@to_gc) {
+                               xsys_e([ qw(git gc -q) ], { GIT_DIR => $dir });
+                       }
+               }
+               open my $s, '>', "$dir/creat.stamp" or
+                       BAIL_OUT "error creating $dir/creat.stamp: $!";
+       }
+       if ($tmpdir) {
+               undef $ibx;
+               xsys([qw(/bin/cp -Rp), $dir, $tmpdir]) == 0 or
+                       BAIL_OUT "cp $dir $tmpdir";
+               $opt{inboxdir} = $tmpdir;
+               $ibx = PublicInbox::InboxWritable->new(\%opt);
+       }
+       $ibx;
+}
+
+sub test_httpd ($$;$) {
+       my ($env, $client, $skip) = @_;
+       for (qw(PI_CONFIG TMPDIR)) {
+               $env->{$_} or BAIL_OUT "$_ unset";
+       }
+       SKIP: {
+               require_mods(qw(Plack::Test::ExternalServer), $skip // 1);
+               my $sock = tcp_server() or die;
+               my ($out, $err) = map { "$env->{TMPDIR}/std$_.log" } qw(out err);
+               my $cmd = [ qw(-httpd -W0), "--stdout=$out", "--stderr=$err" ];
+               my $td = start_script($cmd, $env, { 3 => $sock });
+               my ($h, $p) = tcp_host_port($sock);
+               local $ENV{PLACK_TEST_EXTERNALSERVER_URI} = "http://$h:$p";
+               Plack::Test::ExternalServer::test_psgi(client => $client);
+               $td->join('TERM');
+               open my $fh, '<', $err or BAIL_OUT $!;
+               my $e = do { local $/; <$fh> };
+               if ($e =~ s/^Plack::Middleware::ReverseProxy missing,\n//gms) {
+                       $e =~ s/^URL generation for redirects .*\n//gms;
+               }
+               is($e, '', 'no errors');
+       }
 };
 
+
 package PublicInboxTestProcess;
 use strict;