]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/TestCommon.pm
lei inspect: support NNTP URLs
[public-inbox.git] / lib / PublicInbox / TestCommon.pm
index b5d0b9f8f8619e413fd82f37ada97bbab87ae93d..9e15239465aabe05728603b3db8869f48f128b7c 100644 (file)
@@ -12,12 +12,13 @@ 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 xbail);
+               test_httpd xbail require_cmd is_xdeeply);
        require Test::More;
        my @methods = grep(!/\W/, @Test::More::EXPORT);
        eval(join('', map { "*$_=\\&Test::More::$_;" } @methods));
@@ -86,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);
@@ -143,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
@@ -306,14 +320,16 @@ sub run_script ($;$$) {
                local %SIG = %SIG;
                local $0 = join(' ', @$cmd);
                my $orig_io = _prepare_redirects($fhref);
-               my $cwdfh;
+               my $cwdfh = $lei_cwdfh;
                if (my $d = $opt->{'-C'}) {
-                       opendir $cwdfh, '.' or die "opendir .: $!";
+                       unless ($cwdfh) {
+                               opendir $cwdfh, '.' or die "opendir .: $!";
+                       }
                        chdir $d or die "chdir $d: $!";
                }
                _run_sub($sub, $key, \@argv);
                eval { PublicInbox::Inbox::cleanup_task() };
-               die "chdir(restore): $!" if $cwdfh && !chdir($cwdfh);
+               die "fchdir(restore): $!" if $cwdfh && !chdir($cwdfh);
                _undo_redirects($orig_io);
                select STDOUT;
        }
@@ -321,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 $/;
@@ -462,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 ($lei_opt, $lei_out, $lei_err);
 # favor lei() or lei_ok() over $lei for new code
 sub lei (@) {
        my ($cmd, $env, $xopt) = @_;
@@ -510,13 +520,24 @@ 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};
@@ -527,17 +548,20 @@ 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;
@@ -550,7 +574,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) {
@@ -561,26 +588,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;
-               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");
+               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
@@ -606,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;