-# Copyright (C) 2015-2021 all contributors <meta@public-inbox.org>
+# Copyright (C) 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 strict;
use parent qw(Exporter);
use v5.10.1;
-use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD :seek);
+use Fcntl qw(F_SETFD :seek);
use POSIX qw(dup2);
use IO::Socket::INET;
use File::Spec;
our @EXPORT;
my $lei_loud = $ENV{TEST_LEI_ERR_LOUD};
+my $tail_cmd = $ENV{TAIL};
our ($lei_opt, $lei_out, $lei_err, $lei_cwdfh);
+
+$_ = File::Spec->rel2abs($_) for (grep(!m!^/!, @INC));
+
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_cmd is_xdeeply);
+ test_httpd xbail require_cmd is_xdeeply tail_f
+ ignore_inline_c_missing);
require Test::More;
my @methods = grep(!/\W/, @Test::More::EXPORT);
eval(join('', map { "*$_=\\&Test::More::$_;" } @methods));
}
sub require_cmd ($;$) {
- my ($cmd, $maybe) = @_;
+ my ($cmd, $nr) = @_;
require PublicInbox::Spawn;
- my $bin = PublicInbox::Spawn::which($cmd);
+ state %CACHE;
+ my $bin = $CACHE{$cmd} //= PublicInbox::Spawn::which($cmd);
return $bin if $bin;
- $maybe ? 0 : plan(skip_all => "$cmd missing from PATH for $0");
+ return plan(skip_all => "$cmd missing from PATH for $0") if !$nr;
+ defined(wantarray) ? undef : skip("$cmd missing, skipping $nr tests")
}
-sub have_xapian_compact () {
- require_cmd($ENV{XAPIAN_COMPACT} || 'xapian-compact', 1);
+sub have_xapian_compact (;$) {
+ require_cmd($ENV{XAPIAN_COMPACT} || 'xapian-compact', @_ ? $_[0] : ());
}
sub require_git ($;$) {
- my ($req, $maybe) = @_;
- my ($req_maj, $req_min, $req_sub) = split(/\./, $req);
- my ($cur_maj, $cur_min, $cur_sub) = (xqx([qw(git --version)])
- =~ /version (\d+)\.(\d+)(?:\.(\d+))?/);
+ my ($req, $nr) = @_;
+ state ($cur_int, $cur_ver);
+ $cur_int //= do {
+ chomp($cur_ver = xqx([qw(git --version)]));
+ my @v = ($cur_ver =~ /version (\d+)\.(\d+)(?:\.(\d+))?/);
+ ($v[0] << 24) | ($v[1] << 16) | ($v[2] // 0);
+ };
+ my ($req_maj, $req_min, $req_sub) = split(/\./, $req);
my $req_int = ($req_maj << 24) | ($req_min << 16) | ($req_sub // 0);
- my $cur_int = ($cur_maj << 24) | ($cur_min << 16) | ($cur_sub // 0);
- if ($cur_int < $req_int) {
- return 0 if $maybe;
- plan skip_all =>
- "git $req+ required, have $cur_maj.$cur_min.$cur_sub";
- }
- 1;
+
+ return 1 if $cur_int >= $req_int;
+ return plan skip_all => "git $req+ required, have $cur_ver" if !$nr;
+ defined(wantarray) ? undef :
+ skip("git $req+ required (have $cur_ver), skipping $nr tests")
}
+my %IPv6_VERSION = (
+ 'Net::NNTP' => 3.00,
+ 'Mail::IMAPClient' => 3.40,
+ 'HTTP::Tiny' => 0.042,
+);
+
sub require_mods {
my @mods = @_;
my $maybe = pop @mods if $mods[-1] =~ /\A[0-9]+\z/;
push @mods, qw(Parse::RecDescent DBD::SQLite
Email::Address::XS||Mail::Address);
next;
- } elsif ($mod eq '-nntpd') {
+ } elsif ($mod eq '-nntpd' || $mod eq 'v2') {
push @mods, qw(DBD::SQLite);
next;
}
!eval{ IO::Socket::SSL->VERSION(2.007); 1 }) {
push @need, $@;
}
+ if (defined(my $v = $IPv6_VERSION{$mod})) {
+ $ENV{TEST_IPV4_ONLY} = 1 if !eval { $mod->VERSION($v) };
+ }
}
return unless @need;
my $m = join(', ', @need)." missing for $0";
my ($cmd, $env, $opt) = @_;
my ($key, @argv) = @$cmd;
my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 1;
+ $run_mode = 0 if $key eq '-clone'; # relies on SIGCHLD + waitpid(-1)
my $sub = $run_mode == 0 ? undef : key2sub($key);
my $fhref = [];
my $spawn_opt = {};
+ my @tail_paths;
for my $fd (0..2) {
my $redir = $opt->{$fd};
my $ref = ref($redir);
if ($ref eq 'SCALAR') {
- open my $fh, '+>', undef or die "open: $!";
+ my $fh;
+ if ($tail_cmd && $ENV{TAIL_ALL} && $fd > 0) {
+ require File::Temp;
+ $fh = File::Temp->new("fd.$fd-XXXX", TMPDIR=>1);
+ push @tail_paths, $fh->filename;
+ } else {
+ open $fh, '+>', undef;
+ }
+ $fh or xbail $!;
$fhref->[$fd] = $fh;
$spawn_opt->{$fd} = $fh;
next if $fd > 0;
die "unable to deal with $ref $redir";
}
}
+ my $tail = @tail_paths ? tail_f(@tail_paths) : undef;
if ($key =~ /-(index|convert|extindex|convert|xcpdb)\z/) {
unshift @argv, '--no-fsync';
}
umask($umask);
}
+ { local $?; undef $tail };
# slurp the redirects back into user-supplied strings
for my $fd (1..2) {
my $fh = $fhref->[$fd] or next;
1;
}
-sub wait_for_tail ($;$) {
+sub wait_for_tail {
my ($tail_pid, $want) = @_;
- my $wait = 2;
+ my $wait = 2; # "tail -F" sleeps 1.0s at-a-time w/o inotify/kevent
if ($^O eq 'linux') { # GNU tail may use inotify
state $tail_has_inotify;
- return tick if $want < 0 && $tail_has_inotify;
- my $end = time + $wait;
+ return tick if !$want && $tail_has_inotify; # before TERM
+ my $end = time + $wait; # wait for startup:
my @ino;
do {
@ino = grep {
- readlink($_) =~ /\binotify\b/
+ (readlink($_) // '') =~ /\binotify\b/
} glob("/proc/$tail_pid/fd/*");
} while (!@ino && time <= $end and tick);
return if !@ino;
wantarray ? split(/^/m, $out) : $out;
}
+sub tail_f (@) {
+ $tail_cmd or return; # "tail -F" or "tail -f"
+ for (@_) { open(my $fh, '>>', $_) or die $! };
+ my $cmd = [ split(/ /, $tail_cmd), @_ ];
+ require PublicInbox::Spawn;
+ my $pid = PublicInbox::Spawn::spawn($cmd, undef, { 1 => 2 });
+ wait_for_tail($pid, scalar @_);
+ require PublicInbox::AutoReap;
+ PublicInbox::AutoReap->new($pid, \&wait_for_tail);
+}
+
sub start_script {
my ($cmd, $env, $opt) = @_;
my ($key, @argv) = @$cmd;
my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 2;
my $sub = $run_mode == 0 ? undef : key2sub($key);
- my $tail_pid;
- if (my $tail_cmd = $ENV{TAIL}) {
+ my $tail;
+ if ($tail_cmd) {
my @paths;
for (@argv) {
next unless /\A--std(?:err|out)=(.+)\z/;
}
}
}
- if (@paths) {
- $tail_pid = fork // die "fork: $!";
- if ($tail_pid == 0) {
- # make sure files exist, first
- open my $fh, '>>', $_ for @paths;
- open(STDOUT, '>&STDERR') or die "1>&2: $!";
- exec(split(' ', $tail_cmd), @paths);
- die "$tail_cmd failed: $!";
- }
- wait_for_tail($tail_pid, scalar @paths);
- }
+ $tail = tail_f(@paths);
}
my $pid = fork // die "fork: $!\n";
if ($pid == 0) {
eval { PublicInbox::DS->Reset };
+ for (@{delete($opt->{-CLOFORK}) // []}) {
+ close($_) or die "close $!";
+ }
# pretend to be systemd (cf. sd_listen_fds(3))
# 3 == SD_LISTEN_FDS_START
my $fd;
- for ($fd = 0; 1; $fd++) {
- my $s = $opt->{$fd};
- last if $fd >= 3 && !defined($s);
- next unless $s;
- my $fl = fcntl($s, F_GETFD, 0);
- if (($fl & FD_CLOEXEC) != FD_CLOEXEC) {
- warn "got FD:".fileno($s)." w/o CLOEXEC\n";
+ for ($fd = 0; $fd < 3 || defined($opt->{$fd}); $fd++) {
+ my $io = $opt->{$fd} // next;
+ my $old = fileno($io);
+ if ($old == $fd) {
+ fcntl($io, F_SETFD, 0) // die "F_SETFD: $!";
+ } else {
+ dup2($old, $fd) // die "dup2($old, $fd): $!";
}
- fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
- dup2(fileno($s), $fd) or die "dup2 failed: $!\n";
}
%ENV = (%ENV, %$env) if $env;
my $fds = $fd - 3;
$ENV{LISTEN_PID} = $$;
$ENV{LISTEN_FDS} = $fds;
}
+ if ($opt->{-C}) { chdir($opt->{-C}) or die "chdir: $!" }
$0 = join(' ', @$cmd);
if ($sub) {
eval { PublicInbox::DS->Reset };
die "FAIL: ",join(' ', $key, @argv), ": $!\n";
}
}
- PublicInboxTestProcess->new($pid, $tail_pid);
+ require PublicInbox::AutoReap;
+ my $td = PublicInbox::AutoReap->new($pid);
+ $td->{-extra} = $tail;
+ $td;
}
# favor lei() or lei_ok() over $lei for new code
$ok;
}
+sub ignore_inline_c_missing {
+ $_[0] = join('', grep(/\S/, grep(!/compilation aborted/,
+ grep(!/\bInline\b/, split(/^/m, $_[0])))));
+}
+
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_git(2.6, 1);
my $mods = $test_opt->{mods} // [ 'lei' ];
require_mods(@$mods, 2);
+
+ # set PERL_INLINE_DIRECTORY before clobbering XDG_CACHE_HOME
+ require PublicInbox::Spawn;
require PublicInbox::Config;
require File::Path;
+
local %ENV = %ENV;
delete $ENV{XDG_DATA_HOME};
delete $ENV{XDG_CONFIG_HOME};
+ delete $ENV{XDG_CACHE_HOME};
$ENV{GIT_COMMITTER_EMAIL} = 'lei@example.com';
$ENV{GIT_COMMITTER_NAME} = 'lei user';
+ $ENV{LANG} = $ENV{LC_ALL} = 'C';
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 };
+ state $lei_daemon = PublicInbox::Spawn->can('send_cmd4') || do {
+ require PublicInbox::Syscall;
+ PublicInbox::Syscall->can('send_cmd4');
+ } || eval { require Socket::MsgHdr; 1 };
unless ($lei_daemon) {
skip('Inline::C unconfigured/missing '.
'(mkdir -p ~/.cache/public-inbox/inline-c) OR Socket::MsgHdr missing',
my %opt = @_;
require PublicInbox::Lock;
require PublicInbox::InboxWritable;
+ require PublicInbox::Import;
my ($base) = ($0 =~ m!\b([^/]+)\.[^\.]+\z!);
- my $dir = "t/data-gen/$base.$ident";
+ my ($db) = (PublicInbox::Import::default_branch() =~ m!([^/]+)\z!);
+ my $dir = "t/data-gen/$base.$ident-$db";
my $new = !-d $dir;
if ($new) {
mkdir $dir; # may race
$ibx;
}
-sub test_httpd ($$;$) {
- my ($env, $client, $skip) = @_;
- for (qw(PI_CONFIG TMPDIR)) {
- $env->{$_} or BAIL_OUT "$_ unset";
- }
+sub test_httpd ($$;$$) {
+ my ($env, $client, $skip, $cb) = @_;
+ my ($tmpdir, $for_destroy);
+ $env->{TMPDIR} //= do {
+ ($tmpdir, $for_destroy) = tmpdir();
+ $tmpdir;
+ };
+ for (qw(PI_CONFIG)) { $env->{$_} or BAIL_OUT "$_ unset" }
SKIP: {
- require_mods(qw(Plack::Test::ExternalServer), $skip // 1);
+ require_mods(qw(Plack::Test::ExternalServer LWP::UserAgent),
+ $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);
+ my $ua = LWP::UserAgent->new;
+ $ua->max_redirect(0);
+ Plack::Test::ExternalServer::test_psgi(client => $client,
+ ua => $ua);
+ $cb->() if $cb;
$td->join('TERM');
open my $fh, '<', $err or BAIL_OUT $!;
my $e = do { local $/; <$fh> };
};
-package PublicInboxTestProcess;
-use strict;
-
-# prevent new threads from inheriting these objects
-sub CLONE_SKIP { 1 }
-
-sub new {
- my ($klass, $pid, $tail_pid) = @_;
- bless { pid => $pid, tail_pid => $tail_pid, owner => $$ }, $klass;
-}
-
-sub kill {
- my ($self, $sig) = @_;
- CORE::kill($sig // 'TERM', $self->{pid});
-}
-
-sub join {
- my ($self, $sig) = @_;
- my $pid = delete $self->{pid} or return;
- CORE::kill($sig, $pid) if defined $sig;
- my $ret = waitpid($pid, 0) // die "waitpid($pid): $!";
- $ret == $pid or die "waitpid($pid) != $ret";
-}
-
-sub DESTROY {
- my ($self) = @_;
- return if $self->{owner} != $$;
- if (my $tail_pid = delete $self->{tail_pid}) {
- PublicInbox::TestCommon::wait_for_tail($tail_pid, -1);
- CORE::kill('TERM', $tail_pid);
- }
- $self->join('TERM');
-}
-
package PublicInbox::TestCommon::InboxWakeup;
use strict;
sub on_inbox_unlock { ${$_[0]}->($_[1]) }