X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FTestCommon.pm;h=9e15239465aabe05728603b3db8869f48f128b7c;hb=0c385e6500f26babc47a0768b730ea38e290a5f5;hp=d4117b6cb298bf1eee6daba9b4d9e55d80747f12;hpb=84f60edcc873d55c949d2ea7eccca6f46bcb5400;p=public-inbox.git diff --git a/lib/PublicInbox/TestCommon.pm b/lib/PublicInbox/TestCommon.pm index d4117b6c..9e152394 100644 --- a/lib/PublicInbox/TestCommon.pm +++ b/lib/PublicInbox/TestCommon.pm @@ -11,12 +11,14 @@ use POSIX qw(dup2); use IO::Socket::INET; 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); + test_httpd xbail require_cmd is_xdeeply); require Test::More; my @methods = grep(!/\W/, @Test::More::EXPORT); eval(join('', map { "*$_=\\&Test::More::$_;" } @methods)); @@ -24,6 +26,8 @@ BEGIN { push @EXPORT, @methods; } +sub xbail (@) { BAIL_OUT join(' ', map { ref() ? (explain($_)) : ($_) } @_) } + sub eml_load ($) { my ($path, $cb) = @_; open(my $fh, '<', $path) or die "open $path: $!"; @@ -37,7 +41,7 @@ sub tmpdir (;$) { 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); } @@ -83,6 +87,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); @@ -104,20 +120,29 @@ sub require_mods { 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' + $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)) { @@ -131,6 +156,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 @@ -278,6 +304,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: $!"; @@ -290,7 +320,16 @@ sub run_script ($;$$) { 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; } @@ -298,6 +337,7 @@ sub run_script ($;$$) { # 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 $/; @@ -439,13 +479,6 @@ 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) = @_; @@ -455,43 +488,56 @@ 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 !) { fail "lei_err=$lei_err"; } else { - state $loud = $ENV{TEST_LEI_ERR_LOUD}; - diag "lei_err=$lei_err" if $loud; + 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]} : @_; - for (@msg) { - s!\A([a-z0-9]+://)[^/]+/!$1\$HOST_PORT/! || - s!$tmpdir\b/(?:[^/]+/)?!\$TMPDIR/!; + 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 $lei_err; + ok(lei(@_), "lei @msg". ($msg ? " ($$msg)" : '')) or + diag "\$?=$? err=$lei_err"; } 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 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); require PublicInbox::Config; + require File::Path; local %ENV = %ENV; delete $ENV{XDG_DATA_HOME}; delete $ENV{XDG_CONFIG_HOME}; @@ -502,55 +548,56 @@ SKIP: { 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 + 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; - $daemon_xrd = "$home/xdg_run"; - mkdir($daemon_xrd, 0700) or BAIL_OUT "mkdir: $!"; + 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->(); - lei_ok(qw(daemon-pid), \"daemon-pid after $t"); - chomp($daemon_pid = $lei_out); - if ($daemon_pid) { + 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) { + 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"); - } 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"); + 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 @@ -576,7 +623,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;