-# Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2015-2021 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# internal APIs used only for tests
use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD :seek);
use POSIX qw(dup2);
use IO::Socket::INET;
-our @EXPORT = qw(tmpdir tcp_server tcp_connect require_git require_mods
- run_script start_script key2sub xsys xqx eml_load tick
- have_xapian_compact);
+use File::Spec;
+our @EXPORT;
+my $lei_loud = $ENV{TEST_LEI_ERR_LOUD};
+our ($lei_opt, $lei_out, $lei_err, $lei_cwdfh);
+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 create_inbox
+ tcp_host_port test_lei lei lei_ok $lei_out $lei_err $lei_opt
+ test_httpd xbail);
+ require Test::More;
+ my @methods = grep(!/\W/, @Test::More::EXPORT);
+ eval(join('', map { "*$_=\\&Test::More::$_;" } @methods));
+ die $@ if $@;
+ push @EXPORT, @methods;
+}
+
+sub xbail (@) { BAIL_OUT join(' ', map { ref() ? (explain($_)) : ($_) } @_) }
sub eml_load ($) {
my ($path, $cb) = @_;
unless (defined $base) {
($base) = ($0 =~ m!\b([^/]+)\.[^\.]+\z!);
}
- my $tmpdir = File::Temp->newdir("pi-$base-$$-XXXXXX", TMPDIR => 1);
+ my $tmpdir = File::Temp->newdir("pi-$base-$$-XXXX", TMPDIR => 1);
($tmpdir->dirname, $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 Test::More::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,
%opt,
- ) or Test::More::BAIL_OUT("failed to connect to $addr: $!");
+ ) or BAIL_OUT "failed to connect to $addr: $!";
$s->autoflush(1);
$s;
}
my $cur_int = ($cur_maj << 24) | ($cur_min << 16) | ($cur_sub // 0);
if ($cur_int < $req_int) {
return 0 if $maybe;
- Test::More::plan(skip_all =>
- "git $req+ required, have $cur_maj.$cur_min.$cur_sub");
+ plan skip_all =>
+ "git $req+ required, have $cur_maj.$cur_min.$cur_sub";
}
1;
}
my $maybe = pop @mods if $mods[-1] =~ /\A[0-9]+\z/;
my @need;
while (my $mod = shift(@mods)) {
+ if ($mod eq 'lei') {
+ require_git(2.6, $maybe ? $maybe : ());
+ push @mods, qw(DBD::SQLite Search::Xapian);
+ $mod = 'json'; # fall-through
+ }
+ if ($mod eq 'json') {
+ $mod = 'Cpanel::JSON::XS||JSON::MaybeXS||JSON||JSON::PP'
+ } elsif ($mod eq '-httpd') {
+ push @mods, qw(Plack::Builder Plack::Util);
+ next;
+ } elsif ($mod eq '-imapd') {
+ push @mods, qw(Parse::RecDescent DBD::SQLite
+ Email::Address::XS||Mail::Address);
+ next;
+ } elsif ($mod eq '-nntpd') {
+ push @mods, qw(DBD::SQLite);
+ next;
+ }
if ($mod eq 'Search::Xapian') {
if (eval { require PublicInbox::Search } &&
PublicInbox::Search::load_xapian()) {
next;
}
- } elsif ($mod eq 'Search::Xapian::WritableDatabase') {
- if (eval { require PublicInbox::SearchIdx } &&
- PublicInbox::SearchIdx::load_xapian_writable()){
- next;
- }
} elsif (index($mod, '||') >= 0) { # "Foo||Bar"
my $ok;
for my $m (split(/\Q||\E/, $mod)) {
}
return unless @need;
my $m = join(', ', @need)." missing for $0";
- Test::More::skip($m, $maybe) if $maybe;
- Test::More::plan(skip_all => $m)
+ skip($m, $maybe) if $maybe;
+ plan(skip_all => $m)
}
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) = @_;
for (my $fd = 0; $fd <= $#io_mode; $fd++) {
my $fh = $fhref->[$fd] or next;
my ($oldfh, $mode) = @{$io_mode[$fd]};
- open my $orig, $mode, $oldfh or die "$$oldfh $mode stash: $!";
+ open my $orig, $mode, $oldfh or die "$oldfh $mode stash: $!";
$orig_io->[$fd] = $orig;
- open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
+ open $oldfh, $mode, $fh or die "$oldfh $mode redirect: $!";
}
$orig_io;
}
die RUN_SCRIPT_EXIT;
}
-my %cached_scripts;
+our %cached_scripts;
sub key2sub ($) {
my ($key) = @_;
$cached_scripts{$key} //= do {
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;
my $cmd = [ key2script($key), @argv ];
+ if (my $d = $opt->{'-C'}) {
+ $cmd->[0] = File::Spec->rel2abs($cmd->[0]);
+ $spawn_opt->{'-C'} = $d;
+ }
my $pid = PublicInbox::Spawn::spawn($cmd, $env, $spawn_opt);
if (defined $pid) {
- my $r = waitpid($pid, 0);
- defined($r) or die "waitpid: $!";
+ my $r = waitpid($pid, 0) // die "waitpid: $!";
$r == $pid or die "waitpid: expected $pid, got $r";
}
} else { # localize and run everything in the same process:
local %SIG = %SIG;
local $0 = join(' ', @$cmd);
my $orig_io = _prepare_redirects($fhref);
+ my $cwdfh = $lei_cwdfh;
+ if (my $d = $opt->{'-C'}) {
+ unless ($cwdfh) {
+ opendir $cwdfh, '.' or die "opendir .: $!";
+ }
+ chdir $d or die "chdir $d: $!";
+ }
_run_sub($sub, $key, \@argv);
+ eval { PublicInbox::Inbox::cleanup_task() };
+ die "fchdir(restore): $!" if $cwdfh && !chdir($cwdfh);
_undo_redirects($orig_io);
+ select STDOUT;
}
# slurp the redirects back into user-supplied strings
for my $fd (1..2) {
my $fh = $fhref->[$fd] or next;
+ next unless -f $fh;
seek($fh, 0, SEEK_SET) or die "seek: $!";
my $redir = $opt->{$fd};
local $/;
$? >> 8
}
+sub xsys_e { # like "/bin/sh -e"
+ xsys(@_) == 0 or
+ BAIL_OUT (ref $_[0] ? "@{$_[0]}" : "@_"). " failed \$?=$?"
+}
+
# like `backtick` or qx{} op, but uses spawn() for env/rdr + vfork
sub xqx {
my ($cmd, $env, $rdr) = @_;
}
}
if (@paths) {
- defined($tail_pid = fork) or die "fork: $!\n";
+ $tail_pid = fork // die "fork: $!";
if ($tail_pid == 0) {
# make sure files exist, first
open my $fh, '>>', $_ for @paths;
wait_for_tail($tail_pid, scalar @paths);
}
}
- defined(my $pid = fork) or die "fork: $!\n";
+ my $pid = fork // die "fork: $!\n";
if ($pid == 0) {
eval { PublicInbox::DS->Reset };
# pretend to be systemd (cf. sd_listen_fds(3))
PublicInbox::Spawn::which($ENV{XAPIAN_COMPACT} || 'xapian-compact');
}
+# favor lei() or lei_ok() over $lei for new code
+sub lei (@) {
+ my ($cmd, $env, $xopt) = @_;
+ $lei_out = $lei_err = '';
+ if (!ref($cmd)) {
+ ($env, $xopt) = grep { (!defined) || ref } @_;
+ $cmd = [ grep { defined && !ref } @_ ];
+ }
+ my $res = run_script(['lei', @$cmd], $env, $xopt // $lei_opt);
+ if ($lei_err ne '') {
+ if ($lei_err =~ /Use of uninitialized/ ||
+ $lei_err =~ m!\bArgument .*? isn't numeric in !) {
+ fail "lei_err=$lei_err";
+ } else {
+ diag "lei_err=$lei_err" if $lei_loud;
+ }
+ }
+ $res;
+};
+
+sub lei_ok (@) {
+ state $PWD = $ENV{PWD} // Cwd::getcwd();
+ 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]} : @_;
+ if (!$lei_loud) {
+ for (@msg) {
+ s!\A([a-z0-9]+://)[^/]+/!$1\$HOST_PORT/!;
+ s!$tmpdir\b/(?:[^/]+/)?!\$TMPDIR/!g;
+ s!\Q$PWD\E\b!\$PWD!g;
+ }
+ }
+ ok(lei(@_), "lei @msg". ($msg ? " ($$msg)" : '')) or
+ diag "\$?=$? err=$lei_err";
+}
+
+sub json_utf8 () {
+ state $x = ref(PublicInbox::Config->json)->new->utf8->canonical;
+}
+
+sub test_lei {
+SKIP: {
+ my ($cb) = pop @_;
+ my $test_opt = shift // {};
+ local $lei_cwdfh;
+ opendir $lei_cwdfh, '.' or xbail "opendir .: $!";
+ 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;
+ require File::Path;
+ 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 };
+ # 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, $daemon_xrd);
+ my $tmpdir = $test_opt->{tmpdir};
+ File::Path::mkpath($tmpdir) if (defined $tmpdir && !-d $tmpdir);
+ ($tmpdir, $for_destroy) = tmpdir unless $tmpdir;
+ state $persist_xrd = $ENV{TEST_LEI_DAEMON_PERSIST_DIR};
+ 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;
+ my $persist;
+ if ($persist_xrd && !$test_opt->{daemon_only}) {
+ $persist = $daemon_xrd = $persist_xrd;
+ } else {
+ $daemon_xrd = "$home/xdg_run";
+ mkdir($daemon_xrd, 0700) or BAIL_OUT "mkdir: $!";
+ }
+ local $ENV{XDG_RUNTIME_DIR} = $daemon_xrd;
+ $cb->();
+ unless ($persist) {
+ lei_ok(qw(daemon-pid), \"daemon-pid after $t");
+ chomp($daemon_pid = $lei_out);
+ if (!$daemon_pid) {
+ fail("daemon not running after $t");
+ skip 'daemon died unexpectedly', 2;
+ }
+ ok(kill(0, $daemon_pid), "daemon running after $t");
+ lei_ok(qw(daemon-kill), \"daemon-kill 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;
+ local $ENV{XDG_RUNTIME_DIR} = '/dev/null';
+ $cb->();
+ }
+ if ($daemon_pid) {
+ for (0..10) {
+ kill(0, $daemon_pid) or last;
+ tick;
+ }
+ ok(!kill(0, $daemon_pid), "$t daemon stopped after oneshot");
+ my $f = "$daemon_xrd/lei/errors.log";
+ open my $fh, '<', $f or BAIL_OUT "$f: $!";
+ my @l = <$fh>;
+ is_deeply(\@l, [],
+ "$t daemon XDG_RUNTIME_DIR/lei/errors.log empty");
+ }
+}; # SKIP if missing git 2.6+ || Xapian || SQLite || json
+} # /test_lei
+
+# 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/home2";
+ my $pi_config = "$test_home/.public-inbox/config";
+ my $stamp = "$test_home/setup-stamp";
+ my @ret = ($test_home, $pi_config);
+ return @ret if -f $stamp;
+
+ require PublicInbox::Lock;
+ my $lk = bless { lock_path => "$test_home/setup.lock" },
+ 'PublicInbox::Lock';
+ my $end = $lk->lock_for_scope;
+ return @ret if -f $stamp;
+
+ local $ENV{PI_CONFIG} = $pi_config;
+ for my $V (1, 2) {
+ 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');
+ for (@eml) {
+ next if $_ eq 't/psgi_v2-old.eml'; # dup mid
+ $im->add(eml_load($_)) or BAIL_OUT "v$V add $_";
+ $seen++;
+ }
+ $im->done;
+ });
+ $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;
my ($self, $sig) = @_;
my $pid = delete $self->{pid} or return;
CORE::kill($sig, $pid) if defined $sig;
- my $ret = waitpid($pid, 0);
- defined($ret) or die "waitpid($pid): $!";
+ my $ret = waitpid($pid, 0) // die "waitpid($pid): $!";
$ret == $pid or die "waitpid($pid) != $ret";
}