X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FTestCommon.pm;h=77306a6ecfd6226c0458713b887cb9d5613312ac;hb=af9a34eba5696fc881d2d61864fa62220ccf8ba5;hp=b50871e8d9c65dd31105f8daa173aa020f4e8826;hpb=6e07def560b211d9a1a3221862e72b7aeb4a31b3;p=public-inbox.git diff --git a/lib/PublicInbox/TestCommon.pm b/lib/PublicInbox/TestCommon.pm index b50871e8..77306a6e 100644 --- a/lib/PublicInbox/TestCommon.pm +++ b/lib/PublicInbox/TestCommon.pm @@ -1,15 +1,34 @@ -# Copyright (C) 2015-2020 all contributors +# Copyright (C) 2015-2021 all contributors # License: AGPL-3.0+ # internal APIs used only for tests package PublicInbox::TestCommon; use strict; use parent qw(Exporter); +use v5.10.1; 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); +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 create_inbox + tcp_host_port test_lei lei lei_ok $lei_out $lei_err $lei_opt); + require Test::More; + my @methods = grep(!/\W/, @Test::More::EXPORT); + eval(join('', map { "*$_=\\&Test::More::$_;" } @methods)); + die $@ if $@; + push @EXPORT, @methods; +} + +sub eml_load ($) { + my ($path, $cb) = @_; + open(my $fh, '<', $path) or die "open $path: $!"; + require PublicInbox::Eml; + PublicInbox::Eml->new(\(do { local $/; <$fh> })); +} sub tmpdir (;$) { my ($base) = @_; @@ -22,39 +41,59 @@ 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, - ) + ); + 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 $s = IO::Socket::INET->new( + my $addr = tcp_host_port($dest); + my $s = ref($dest)->new( Proto => 'tcp', Type => Socket::SOCK_STREAM(), - PeerAddr => $dest->sockhost . ':' . $dest->sockport, + PeerAddr => $addr, %opt, - ); + ) or BAIL_OUT "failed to connect to $addr: $!"; $s->autoflush(1); $s; } sub require_git ($;$) { my ($req, $maybe) = @_; - my ($req_maj, $req_min) = split(/\./, $req); - my ($cur_maj, $cur_min) = (`git --version` =~ /version (\d+)\.(\d+)/); + 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_int = ($req_maj << 24) | ($req_min << 16); - my $cur_int = ($cur_maj << 24) | ($cur_min << 16); + 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; - Test::More::plan(skip_all => - "git $req+ required, have $cur_maj.$cur_min"); + plan skip_all => + "git $req+ required, have $cur_maj.$cur_min.$cur_sub"; } 1; } @@ -63,7 +102,11 @@ sub require_mods { my @mods = @_; my $maybe = pop @mods if $mods[-1] =~ /\A[0-9]+\z/; my @need; - for my $mod (@mods) { + while (my $mod = shift(@mods)) { + if ($mod eq 'json') { + $mod = 'Cpanel::JSON::XS||JSON::MaybeXS||'. + 'JSON||JSON::PP' + } if ($mod eq 'Search::Xapian') { if (eval { require PublicInbox::Search } && PublicInbox::Search::load_xapian()) { @@ -74,15 +117,32 @@ sub require_mods { PublicInbox::SearchIdx::load_xapian_writable()){ next; } + } elsif (index($mod, '||') >= 0) { # "Foo||Bar" + my $ok; + for my $m (split(/\Q||\E/, $mod)) { + eval "require $m"; + next if $@; + $ok = $m; + last; + } + next if $ok; } else { eval "require $mod"; } - push @need, $mod if $@; + if ($@) { + push @need, $mod; + } elsif ($mod eq 'IO::Socket::SSL' && + # old versions of IO::Socket::SSL aren't supported + # by libnet, at least: + # https://rt.cpan.org/Ticket/Display.html?id=100529 + !eval{ IO::Socket::SSL->VERSION(2.007); 1 }) { + push @need, $@; + } } 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 ($) { @@ -94,8 +154,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) = @_; @@ -103,9 +163,9 @@ sub _prepare_redirects ($) { 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; } @@ -131,12 +191,12 @@ sub _undo_redirects ($) { # The default is 2. our $run_script_exit_code; sub RUN_SCRIPT_EXIT () { "RUN_SCRIPT_EXIT\n" }; -sub run_script_exit (;$) { +sub run_script_exit { $run_script_exit_code = $_[0] // 0; die RUN_SCRIPT_EXIT; } -my %cached_scripts; +our %cached_scripts; sub key2sub ($) { my ($key) = @_; $cached_scripts{$key} //= do { @@ -153,7 +213,7 @@ package $pkg; use strict; use subs qw(exit); -*exit = *PublicInbox::TestCommon::run_script_exit; +*exit = \\&PublicInbox::TestCommon::run_script_exit; sub main { # the below "line" directive is a magic comment, see perlsyn(1) manpage # line 1 "$f" @@ -210,14 +270,16 @@ 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; my $cmd = [ key2script($key), @argv ]; 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: @@ -229,6 +291,7 @@ sub run_script ($;$$) { my $orig_io = _prepare_redirects($fhref); _run_sub($sub, $key, \@argv); _undo_redirects($orig_io); + select STDOUT; } # slurp the redirects back into user-supplied strings @@ -242,7 +305,39 @@ sub run_script ($;$$) { $? == 0; } -sub wait_for_tail () { sleep(2) } +sub tick (;$) { + my $tick = shift // 0.1; + select undef, undef, undef, $tick; + 1; +} + +sub wait_for_tail ($;$) { + my ($tail_pid, $want) = @_; + my $wait = 2; + 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; + my @ino; + do { + @ino = grep { + readlink($_) =~ /\binotify\b/ + } glob("/proc/$tail_pid/fd/*"); + } while (!@ino && time <= $end and tick); + return if !@ino; + $tail_has_inotify = 1; + $ino[0] =~ s!/fd/!/fdinfo/!; + my @info; + do { + if (open my $fh, '<', $ino[0]) { + local $/ = "\n"; + @info = grep(/^inotify wd:/, <$fh>); + } + } while (scalar(@info) < $want && time <= $end and tick); + } else { + sleep($wait); + } +} # like system() built-in, but uses spawn() for env/rdr + vfork sub xsys { @@ -258,6 +353,11 @@ sub xsys { $? >> 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) = @_; @@ -278,8 +378,20 @@ sub start_script { next unless /\A--std(?:err|out)=(.+)\z/; push @paths, $1; } + if ($opt) { + for (1, 2) { + my $f = $opt->{$_} or next; + if (!ref($f)) { + push @paths, $f; + } elsif (ref($f) eq 'GLOB' && $^O eq 'linux') { + my $fd = fileno($f); + my $f = readlink "/proc/$$/fd/$fd"; + push @paths, $f if -e $f; + } + } + } 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; @@ -287,11 +399,12 @@ sub start_script { exec(split(' ', $tail_cmd), @paths); die "$tail_cmd failed: $!"; } - wait_for_tail(); + 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)) # 3 == SD_LISTEN_FDS_START my $fd; @@ -314,6 +427,7 @@ sub start_script { } $0 = join(' ', @$cmd); if ($sub) { + eval { PublicInbox::DS->Reset }; _run_sub($sub, $key, \@argv); POSIX::_exit($? >> 8); } else { @@ -324,6 +438,204 @@ sub start_script { PublicInboxTestProcess->new($pid, $tail_pid); } +sub have_xapian_compact () { + require PublicInbox::Spawn; + # $ENV{XAPIAN_COMPACT} is used by PublicInbox/Xapcmd.pm, too + PublicInbox::Spawn::which($ENV{XAPIAN_COMPACT} || 'xapian-compact'); +} + +our ($err_skip, $lei_opt, $lei_out, $lei_err); +# 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); + $err_skip and + $lei_err = join('', grep(!/$err_skip/, split(/^/m, $lei_err))); + $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; +} + +sub test_lei { +SKIP: { + my ($cb) = pop @_; + my $test_opt = shift // {}; + 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; + 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); + 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; + my $xrd = "$home/xdg_run"; + mkdir($xrd, 0700) or BAIL_OUT "mkdir: $!"; + local $ENV{XDG_RUNTIME_DIR} = $xrd; + $cb->(); + 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"); + 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 $ENV{XDG_RUNTIME_DIR} = $xrd; + $cb->(); + } + if ($daemon_pid) { + for (0..10) { + kill(0, $daemon_pid) or last; + tick; + } + ok(!kill(0, $daemon_pid), "$t daemon stopped after oneshot"); + } +}; # 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), "-V$V", "t$V", + '--newsgroup', "t.v$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) = @_; + 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; + 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"; + unless (-d $dir) { + 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; + $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); + my $scope = $lk->lock_for_scope; + 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; +} + package PublicInboxTestProcess; use strict; @@ -344,19 +656,22 @@ sub join { 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"; } sub DESTROY { my ($self) = @_; return if $self->{owner} != $$; - if (my $tail = delete $self->{tail_pid}) { - PublicInbox::TestCommon::wait_for_tail(); - CORE::kill('TERM', $tail); + 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]) } + 1;