X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FTestCommon.pm;h=ecf7a261b6f485447dce78ca6f10fd74660f4201;hb=d323a16ced5e3a77136a1ebca4a2f7d5678121c4;hp=d506e4b5b5b8d0591ae1dbaf13f7ee9fbe344db2;hpb=3d82121341db207f9bcd8dabf42394f3f45f8379;p=public-inbox.git diff --git a/lib/PublicInbox/TestCommon.pm b/lib/PublicInbox/TestCommon.pm index d506e4b5..ecf7a261 100644 --- a/lib/PublicInbox/TestCommon.pm +++ b/lib/PublicInbox/TestCommon.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2015-2021 all contributors +# Copyright (C) all contributors # License: AGPL-3.0+ # internal APIs used only for tests @@ -12,12 +12,15 @@ 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); 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); + 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)); @@ -25,7 +28,7 @@ BEGIN { push @EXPORT, @methods; } -sub xbail (@) { BAIL_OUT join(' ', map { ref ? (explain($_)) : ($_) } @_) } +sub xbail (@) { BAIL_OUT join(' ', map { ref() ? (explain($_)) : ($_) } @_) } sub eml_load ($) { my ($path, $cb) = @_; @@ -86,6 +89,18 @@ sub tcp_connect { $s; } +sub require_cmd ($;$) { + my ($cmd, $maybe) = @_; + require PublicInbox::Spawn; + my $bin = PublicInbox::Spawn::which($cmd); + return $bin if $bin; + $maybe ? 0 : plan(skip_all => "$cmd missing from PATH for $0"); +} + +sub have_xapian_compact () { + require_cmd($ENV{XAPIAN_COMPACT} || 'xapian-compact', 1); +} + sub require_git ($;$) { my ($req, $maybe) = @_; my ($req_maj, $req_min, $req_sub) = split(/\./, $req); @@ -143,6 +158,7 @@ sub require_mods { eval "require $mod"; } if ($@) { + diag "require $mod: $@" if $mod =~ /Gcf2/; push @need, $mod; } elsif ($mod eq 'IO::Socket::SSL' && # old versions of IO::Socket::SSL aren't supported @@ -266,11 +282,20 @@ sub run_script ($;$$) { 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; @@ -283,6 +308,7 @@ sub run_script ($;$$) { 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'; } @@ -290,6 +316,10 @@ sub run_script ($;$$) { # 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) // die "waitpid: $!"; @@ -298,19 +328,32 @@ sub run_script ($;$$) { } else { # localize and run everything in the same process: # note: "local *STDIN = *STDIN;" and so forth did not work in # old versions of perl + my $umask = umask; local %ENV = $env ? (%ENV, %$env) : %ENV; - local %SIG = %SIG; + local @SIG{keys %SIG} = map { undef } values %SIG; + local $SIG{FPE} = 'IGNORE'; # Perl default 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; + umask($umask); } + { local $?; undef $tail }; # 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 $/; @@ -325,17 +368,17 @@ sub tick (;$) { 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; @@ -380,13 +423,24 @@ sub xqx { 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/; @@ -404,17 +458,7 @@ sub start_script { } } } - 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) { @@ -439,6 +483,7 @@ sub start_script { $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 }; @@ -449,16 +494,12 @@ sub start_script { die "FAIL: ",join(' ', $key, @argv), ": $!\n"; } } - PublicInboxTestProcess->new($pid, $tail_pid); + require PublicInbox::AutoReap; + my $td = PublicInbox::AutoReap->new($pid); + $td->{-extra} = $tail; + $td; } -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) = @_; @@ -468,8 +509,6 @@ sub lei (@) { $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))); if ($lei_err ne '') { if ($lei_err =~ /Use of uninitialized/ || $lei_err =~ m!\bArgument .*? isn't numeric in !) { @@ -502,34 +541,60 @@ sub json_utf8 () { state $x = ref(PublicInbox::Config->json)->new->utf8->canonical; } +sub is_xdeeply ($$$) { + my ($x, $y, $desc) = @_; + my $ok = is_deeply($x, $y, $desc); + diag explain([$x, '!=', $y]) if !$ok; + $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_mods(qw(json DBD::SQLite Search::Xapian), 2); + 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 }; - # 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 + 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', + 1); + } $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}; + $ENV{TEST_LEI_ONESHOT} and + xbail 'TEST_LEI_ONESHOT no longer supported'; my $home = "$tmpdir/lei-daemon"; mkdir($home, 0700) or BAIL_OUT "mkdir: $!"; local $ENV{HOME} = $home; @@ -542,7 +607,10 @@ EOM } local $ENV{XDG_RUNTIME_DIR} = $daemon_xrd; $cb->(); - unless ($persist) { + if ($persist) { # remove before ~/.local gets removed + File::Path::rmtree([glob("$home/*")]); + File::Path::rmtree("$home/.config"); + } else { lei_ok(qw(daemon-pid), \"daemon-pid after $t"); chomp($daemon_pid = $lei_out); if (!$daemon_pid) { @@ -553,29 +621,16 @@ EOM 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; - # 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"); + ok(!kill(0, $daemon_pid), "$t daemon stopped"); my $f = "$daemon_xrd/lei/errors.log"; open my $fh, '<', $f or BAIL_OUT "$f: $!"; my @l = <$fh>; - is_deeply(\@l, [], + is_xdeeply(\@l, [], "$t daemon XDG_RUNTIME_DIR/lei/errors.log empty"); } }; # SKIP if missing git 2.6+ || Xapian || SQLite || json @@ -601,7 +656,8 @@ sub setup_public_inboxes () { 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"; + "t$V\@example.com" ]) or xbail "init v$V"; + unlink "$test_home/t$V/description" or xbail "unlink $!"; } require PublicInbox::Config; require PublicInbox::InboxWritable; @@ -631,8 +687,10 @@ sub create_inbox ($$;@) { 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 @@ -701,40 +759,6 @@ sub test_httpd ($$;$) { }; -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]) }