]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/TestCommon.pm
lei convert: mail format conversion sub-command
[public-inbox.git] / lib / PublicInbox / TestCommon.pm
index 299b9c6a830833966df288687270d27ae95e1b49..3eb08e9f9f55ee954776b3a7570cf3c9c5a6a7c3 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2015-2021 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
@@ -9,9 +9,20 @@ 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 eml_load tick
-       have_xapian_compact);
+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
+               tcp_host_port test_lei lei lei_ok
+               $lei $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) = @_;
@@ -31,25 +42,43 @@ 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,
-       ) or Test::More::BAIL_OUT("failed to create TCP server: $!");
+       );
+       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 $addr = $dest->sockhost . ':' . $dest->sockport;
-       my $s = IO::Socket::INET->new(
+       my $addr = tcp_host_port($dest);
+       my $s = ref($dest)->new(
                Proto => 'tcp',
                Type => Socket::SOCK_STREAM(),
                PeerAddr => $addr,
                %opt,
-       ) or Test::More::BAIL_OUT("failed to connect to $addr: $!");
+       ) or BAIL_OUT "failed to connect to $addr: $!";
        $s->autoflush(1);
        $s;
 }
@@ -64,8 +93,8 @@ sub require_git ($;$) {
        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.$cur_sub");
+               plan skip_all =>
+                       "git $req+ required, have $cur_maj.$cur_min.$cur_sub";
        }
        1;
 }
@@ -75,6 +104,10 @@ sub require_mods {
        my $maybe = pop @mods if $mods[-1] =~ /\A[0-9]+\z/;
        my @need;
        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()) {
@@ -109,8 +142,8 @@ sub require_mods {
        }
        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 ($) {
@@ -131,9 +164,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;
 }
@@ -164,7 +197,7 @@ sub run_script_exit {
        die RUN_SCRIPT_EXIT;
 }
 
-my %cached_scripts;
+our %cached_scripts;
 sub key2sub ($) {
        my ($key) = @_;
        $cached_scripts{$key} //= do {
@@ -238,14 +271,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:
@@ -257,6 +292,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
@@ -318,6 +354,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) = @_;
@@ -351,7 +392,7 @@ sub start_script {
                        }
                }
                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;
@@ -362,7 +403,7 @@ sub start_script {
                        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))
@@ -404,6 +445,150 @@ sub have_xapian_compact () {
        PublicInbox::Spawn::which($ENV{XAPIAN_COMPACT} || 'xapian-compact');
 }
 
+our ($err_skip, $lei_opt, $lei_out, $lei_err);
+our $lei = sub {
+       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 (@) { $lei->(@_) }
+
+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;
+       delete local $ENV{XDG_DATA_HOME};
+       delete local $ENV{XDG_CONFIG_HOME};
+       local $ENV{GIT_COMMITTER_EMAIL} = 'lei@example.com';
+       local $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->();
+               ok($lei->(qw(daemon-pid)), "daemon-pid after $t");
+               chomp($daemon_pid = $lei_out);
+               if ($daemon_pid) {
+                       ok(kill(0, $daemon_pid), "daemon running after $t");
+                       ok($lei->(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;
+};
+
 package PublicInboxTestProcess;
 use strict;
 
@@ -424,8 +609,7 @@ 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";
 }