X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=t%2Flei.t;h=b10c9b59c72b8e29570b63dbf5853463a2c55cb7;hp=ef820fe3f0d046769dfb86035b942519330bdf5c;hb=4eee5af6011cc8cdefb66c9729952c7eff5c0b0b;hpb=1a8441c1e5e468441e67bc7eec6771770e62af78 diff --git a/t/lei.t b/t/lei.t index ef820fe3..b10c9b59 100644 --- a/t/lei.t +++ b/t/lei.t @@ -1,321 +1,187 @@ #!perl -w # Copyright (C) 2020-2021 all contributors # License: AGPL-3.0+ -use strict; -use v5.10.1; -use Test::More; -use PublicInbox::TestCommon; -use PublicInbox::Config; +use strict; use v5.10.1; use PublicInbox::TestCommon; use File::Path qw(rmtree); -use Fcntl qw(SEEK_SET); -require_git 2.6; -require_mods(qw(json DBD::SQLite Search::Xapian)); -my $opt = { 1 => \(my $out = ''), 2 => \(my $err = '') }; -my ($home, $for_destroy) = tmpdir(); -my $err_filter; -my $lei = sub { - my ($cmd, $env, $xopt) = @_; - $out = $err = ''; - if (!ref($cmd)) { - ($env, $xopt) = grep { (!defined) || ref } @_; - $cmd = [ grep { defined && !ref } @_ ]; - } - my $res = run_script(['lei', @$cmd], $env, $xopt // $opt); - $err_filter and - $err = join('', grep(!/$err_filter/, split(/^/m, $err))); - $res; -}; -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'; -local $ENV{XDG_RUNTIME_DIR} = "$home/xdg_run"; -local $ENV{HOME} = $home; -local $ENV{FOO} = 'BAR'; -mkdir "$home/xdg_run", 0700 or BAIL_OUT "mkdir: $!"; -my $home_trash = [ "$home/.local", "$home/.config" ]; +# this only tests the basic help/config/init/completion bits of lei; +# actual functionality is tested in other t/lei-*.t tests +my $home; +my $home_trash = []; my $cleanup = sub { rmtree([@$home_trash, @_]) }; -my $config_file = "$home/.config/lei/config"; -my $store_dir = "$home/.local/share/lei"; my $test_help = sub { - ok(!$lei->(), 'no args fails'); + ok(!lei([]), 'no args fails'); is($? >> 8, 1, '$? is 1'); - is($out, '', 'nothing in stdout'); - like($err, qr/^usage:/sm, 'usage in stderr'); + is($lei_out, '', 'nothing in stdout'); + like($lei_err, qr/^usage:/sm, 'usage in stderr'); for my $arg (['-h'], ['--help'], ['help'], [qw(daemon-pid --help)]) { - ok($lei->($arg), "lei @$arg"); - like($out, qr/^usage:/sm, "usage in stdout (@$arg)"); - is($err, '', "nothing in stderr (@$arg)"); + lei_ok($arg); + like($lei_out, qr/^usage:/sm, "usage in stdout (@$arg)"); + is($lei_err, '', "nothing in stderr (@$arg)"); } for my $arg ([''], ['--halp'], ['halp'], [qw(daemon-pid --halp)]) { - ok(!$lei->($arg), "lei @$arg"); + ok(!lei($arg), "lei @$arg"); is($? >> 8, 1, '$? set correctly'); - isnt($err, '', 'something in stderr'); - is($out, '', 'nothing in stdout'); + isnt($lei_err, '', 'something in stderr'); + is($lei_out, '', 'nothing in stdout'); } - ok($lei->(qw(init -h)), 'init -h'); - like($out, qr! \Q$home\E/\.local/share/lei/store\b!, + lei_ok(qw(init -h)); + like($lei_out, qr! \Q$home\E/\.local/share/lei/store\b!, 'actual path shown in init -h'); - ok($lei->(qw(init -h), { XDG_DATA_HOME => '/XDH' }), - 'init with XDG_DATA_HOME'); - like($out, qr! /XDH/lei/store\b!, 'XDG_DATA_HOME in init -h'); - is($err, '', 'no errors from init -h'); + lei_ok(qw(init -h), { XDG_DATA_HOME => '/XDH' }, + \'init with XDG_DATA_HOME'); + like($lei_out, qr! /XDH/lei/store\b!, 'XDG_DATA_HOME in init -h'); + is($lei_err, '', 'no errors from init -h'); - ok($lei->(qw(config -h)), 'config-h'); - like($out, qr! \Q$home\E/\.config/lei/config\b!, + lei_ok(qw(config -h)); + like($lei_out, qr! \Q$home\E/\.config/lei/config\b!, 'actual path shown in config -h'); - ok($lei->(qw(config -h), { XDG_CONFIG_HOME => '/XDC' }), - 'config with XDG_CONFIG_HOME'); - like($out, qr! /XDC/lei/config\b!, 'XDG_CONFIG_HOME in config -h'); - is($err, '', 'no errors from config -h'); + lei_ok(qw(config -h), { XDG_CONFIG_HOME => '/XDC' }, + \'config with XDG_CONFIG_HOME'); + like($lei_out, qr! /XDC/lei/config\b!, 'XDG_CONFIG_HOME in config -h'); + is($lei_err, '', 'no errors from config -h'); }; my $ok_err_info = sub { my ($msg) = @_; - is(grep(!/^I:/, split(/^/, $err)), 0, $msg) or - diag "$msg: err=$err"; + is(grep(!/^#/, split(/^/, $lei_err)), 0, $msg) or + diag "$msg: err=$lei_err"; }; my $test_init = sub { $cleanup->(); - ok($lei->('init'), 'init w/o args'); + lei_ok('init', \'init w/o args'); $ok_err_info->('after init w/o args'); - ok($lei->('init'), 'idempotent init w/o args'); + lei_ok('init', \'idempotent init w/o args'); $ok_err_info->('after idempotent init w/o args'); - ok(!$lei->('init', "$home/x"), 'init conflict'); - is(grep(/^E:/, split(/^/, $err)), 1, 'got error on conflict'); + ok(!lei('init', "$home/x"), 'init conflict'); + is(grep(/^E:/, split(/^/, $lei_err)), 1, 'got error on conflict'); ok(!-e "$home/x", 'nothing created on conflict'); $cleanup->(); - ok($lei->('init', "$home/x"), 'init conflict resolved'); + lei_ok('init', "$home/x", \'init conflict resolved'); $ok_err_info->('init w/ arg'); - ok($lei->('init', "$home/x"), 'init idempotent w/ path'); + lei_ok('init', "$home/x", \'init idempotent w/ path'); $ok_err_info->('init idempotent w/ arg'); ok(-d "$home/x", 'created dir'); $cleanup->("$home/x"); - ok(!$lei->('init', "$home/x", "$home/2"), 'too many args fails'); - like($err, qr/too many/, 'noted excessive'); + ok(!lei('init', "$home/x", "$home/2"), 'too many args fails'); + like($lei_err, qr/too many/, 'noted excessive'); ok(!-e "$home/x", 'x not created on excessive'); for my $d (@$home_trash) { my $base = (split(m!/!, $d))[-1]; ok(!-d $d, "$base not created"); } - is($out, '', 'nothing in stdout on init failure'); + is($lei_out, '', 'nothing in stdout on init failure'); }; my $test_config = sub { $cleanup->(); - ok($lei->(qw(config a.b c)), 'config set var'); - is($out.$err, '', 'no output on var set'); - ok($lei->(qw(config -l)), 'config -l'); - is($err, '', 'no errors on listing'); - is($out, "a.b=c\n", 'got expected output'); - ok(!$lei->(qw(config -f), "$home/.config/f", qw(x.y z)), + lei_ok(qw(config a.b c), \'config set var'); + is($lei_out.$lei_err, '', 'no output on var set'); + lei_ok(qw(config -l), \'config -l'); + is($lei_err, '', 'no errors on listing'); + is($lei_out, "a.b=c\n", 'got expected output'); + ok(!lei(qw(config -f), "$home/.config/f", qw(x.y z)), 'config set var with -f fails'); - like($err, qr/not supported/, 'not supported noted'); + like($lei_err, qr/not supported/, 'not supported noted'); ok(!-f "$home/config/f", 'no file created'); + + lei_ok(qw(-c imap.debug config --bool imap.debug)); + is($lei_out, "true\n", "-c sets w/o value"); + lei_ok(qw(-c imap.debug=1 config --bool imap.debug)); + is($lei_out, "true\n", "-c coerces value"); + lei_ok(qw(-c imap.debug=tr00 config imap.debug)); + is($lei_out, "tr00\n", "-c string value passed as-is"); + lei_ok(qw(-c imap.debug=a -c imap.debug=b config --get-all imap.debug)); + is($lei_out, "a\nb\n", '-c and --get-all work together'); + + lei_ok([qw(config -e)], { VISUAL => 'cat', EDITOR => 'cat' }); + is($lei_out, "[a]\n\tb = c\n", '--edit works'); }; -my $setup_publicinboxes = sub { - state $done = ''; - return if $done eq $home; - use PublicInbox::InboxWritable; - for my $V (1, 2) { - run_script([qw(-init), "-V$V", "t$V", - '--newsgroup', "t.$V", - "$home/t$V", "http://example.com/t$V", - "t$V\@example.com" ]) or BAIL_OUT "init v$V"; +my $test_completion = sub { + lei_ok(qw(_complete lei), \'no errors on complete'); + my %out = map { $_ => 1 } split(/\s+/s, $lei_out); + ok($out{'q'}, "`lei q' offered as completion"); + ok($out{'add-external'}, "`lei add-external' offered as completion"); + + lei_ok(qw(_complete lei q), \'complete q (no args)'); + %out = map { $_ => 1 } split(/\s+/s, $lei_out); + for my $sw (qw(-f --format -o --output --mfolder --augment -a + --mua --no-local --local --verbose -v + --save --no-save --no-remote --remote --torsocks + --reverse -r )) { + ok($out{$sw}, "$sw offered as `lei q' completion"); } - 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'); - push(@eml, 't/data/0001.patch') if $V == 2; - 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'; + + lei_ok(qw(_complete lei q --form), \'complete q --format'); + is($lei_out, "--format\n", 'complete lei q --format'); + for my $sw (qw(-f --format)) { + lei_ok(qw(_complete lei q), $sw); + %out = map { $_ => 1 } split(/\s+/s, $lei_out); + for my $f (qw(mboxrd mboxcl2 mboxcl mboxo json jsonl + concatjson maildir)) { + ok($out{$f}, "got $sw $f as output format"); } - }); - $done = $home; - $seen || BAIL_OUT 'no imports'; + } + lei_ok(qw(_complete lei import)); + %out = map { $_ => 1 } split(/\s+/s, $lei_out); + for my $sw (qw(--no-kw --kw)) { + ok($out{$sw}, "$sw offered as `lei import' completion"); + } }; -my $test_external = sub { - $setup_publicinboxes->(); - $cleanup->(); - $lei->('ls-external'); - is($out.$err, '', 'ls-external no output, yet'); - ok(!-e $config_file && !-e $store_dir, - 'nothing created by ls-external'); - - my $cfg = PublicInbox::Config->new; - $cfg->each_inbox(sub { - my ($ibx) = @_; - ok($lei->(qw(add-external -q), $ibx->{inboxdir}), - 'added external'); - is($out.$err, '', 'no output'); - }); - ok(-s $config_file && -e $store_dir, - 'add-external created config + store'); - my $lcfg = PublicInbox::Config->new($config_file); - $cfg->each_inbox(sub { - my ($ibx) = @_; - is($lcfg->{"external.$ibx->{inboxdir}.boost"}, 0, - "configured boost on $ibx->{name}"); - }); - $lei->('ls-external'); - like($out, qr/boost=0\n/s, 'ls-external has output'); - - ok(!$lei->(qw(q s:prefix -o /dev/null -f maildir)), 'bad maildir'); - like($err, qr!/dev/null exists and is not a directory!, - 'error shown'); - is($? >> 8, 1, 'errored out with exit 1'); - - ok(!$lei->(qw(q s:prefix -f mboxcl2 -o), $home), 'bad mbox'); - like($err, qr!\Q$home\E exists and is not a writable file!, - 'error shown'); - is($? >> 8, 1, 'errored out with exit 1'); - - ok(!$lei->(qw(q s:prefix -o /dev/stdout -f Mbox2)), 'bad format'); - like($err, qr/bad mbox --format=mbox2/, 'error shown'); - is($? >> 8, 1, 'errored out with exit 1'); - - # note, on a Bourne shell users should be able to use either: - # s:"use boolean prefix" - # "s:use boolean prefix" - # or use single quotes, it should not matter. Users only need - # to know shell quoting rules, not Xapian quoting rules. - # No double-quoting should be imposed on users on the CLI - $lei->('q', 's:use boolean prefix'); - like($out, qr/search: use boolean prefix/, 'phrase search got result'); - require IO::Uncompress::Gunzip; - for my $sfx ('', '.gz') { - my $f = "$home/mbox$sfx"; - $lei->('q', '-o', "mboxcl2:$f", 's:use boolean prefix'); - my $cat = $sfx eq '' ? sub { - open my $mb, '<', $f or fail "no mbox: $!"; - <$mb> - } : sub { - my $z = IO::Uncompress::Gunzip->new($f, MultiStream=>1); - <$z>; - }; - my @s = grep(/^Subject:/, $cat->()); - is(scalar(@s), 1, "1 result in mbox$sfx"); - $lei->('q', '-a', '-o', "mboxcl2:$f", 's:see attachment'); - is($err, '', 'no errors from augment'); - @s = grep(/^Subject:/, my @wtf = $cat->()); - is(scalar(@s), 2, "2 results in mbox$sfx"); - - $lei->('q', '-a', '-o', "mboxcl2:$f", 's:nonexistent'); - is($err, '', "no errors on no results ($sfx)"); - - my @s2 = grep(/^Subject:/, $cat->()); - is_deeply(\@s2, \@s, - "same 2 old results w/ --augment and bad search $sfx"); - - $lei->('q', '-o', "mboxcl2:$f", 's:nonexistent'); - my @res = $cat->(); - is_deeply(\@res, [], "clobber w/o --augment $sfx"); +my $test_fail = sub { + lei('q', 'whatever', '-C', '/dev/null'); + is($? >> 8, 1, 'chdir at end fails to /dev/null'); + lei('-C', '/dev/null', 'q', 'whatever'); + is($? >> 8, 1, 'chdir at beginning fails to /dev/null'); + + lei_ok('q', "foo\n"); + like($lei_err, qr/trailing `\\n' removed/s, "noted `\\n' removal"); + + for my $lk (qw(ei inbox)) { + my $d = "$home/newline\n$lk"; + mkdir $d; + open my $fh, '>', "$d/$lk.lock" or BAIL_OUT "open $d/$lk.lock"; + for my $fl (qw(-I --only)) { + ok(!lei('q', $fl, $d, 'whatever'), + "newline $lk.lock fails with q $fl"); + like($lei_err, qr/`\\n' not allowed/, + "error noted with q $fl"); + } } - ok(!$lei->('q', '-o', "$home/mbox", 's:nope'), - 'fails if mbox format unspecified'); + lei_ok('sucks', \'yes, but hopefully less every day'); + like($lei_out, qr/loaded features/, 'loaded features shown'); +SKIP: { + skip 'no curl', 3 unless require_cmd('curl', 1); + lei(qw(q --only http://127.0.0.1:99999/bogus/ t:m)); + is($? >> 8, 3, 'got curl exit for bogus URL'); + lei(qw(q --only http://127.0.0.1:99999/bogus/ t:m -o), "$home/junk"); + is($? >> 8, 3, 'got curl exit for bogus URL with Maildir') or + diag $lei_err; + is($lei_out, '', 'no output'); +}; # /SKIP }; -my $test_lei_common = sub { +test_lei(sub { + $home = $ENV{HOME}; + $home_trash = [ "$home/.local", "$home/.config", "$home/junk" ]; $test_help->(); $test_config->(); $test_init->(); - $test_external->(); -}; - -if ($ENV{TEST_LEI_ONESHOT}) { - require_ok 'PublicInbox::LEI'; - # force sun_path[108] overflow, ($lei->() filters out this path) - my $xrd = "$home/1shot-test".('.sun_path' x 108); - local $ENV{XDG_RUNTIME_DIR} = $xrd; - $err_filter = qr!\Q$xrd!; - $test_lei_common->(); -} else { -SKIP: { # real socket - eval { require Socket::MsgHdr; 1 } // do { - require PublicInbox::Spawn; - PublicInbox::Spawn->can('send_cmd4'); - } // skip 'Socket::MsgHdr or Inline::C missing or unconfigured', 115; - local $ENV{XDG_RUNTIME_DIR} = "$home/xdg_run"; - my $sock = "$ENV{XDG_RUNTIME_DIR}/lei/5.seq.sock"; - my $err_log = "$ENV{XDG_RUNTIME_DIR}/lei/errors.log"; - - ok($lei->('daemon-pid'), 'daemon-pid'); - is($err, '', 'no error from daemon-pid'); - like($out, qr/\A[0-9]+\n\z/s, 'pid returned') or BAIL_OUT; - chomp(my $pid = $out); - ok(kill(0, $pid), 'pid is valid'); - ok(-S $sock, 'sock created'); - - $test_lei_common->(); - is(-s $err_log, 0, 'nothing in errors.log'); - open my $efh, '>>', $err_log or BAIL_OUT $!; - print $efh "phail\n" or BAIL_OUT $!; - close $efh or BAIL_OUT $!; - - ok($lei->('daemon-pid'), 'daemon-pid'); - chomp(my $pid_again = $out); - is($pid, $pid_again, 'daemon-pid idempotent'); - like($err, qr/phail/, 'got mock "phail" error previous run'); + $test_completion->(); + $test_fail->(); +}); - ok($lei->(qw(daemon-kill)), 'daemon-kill'); - is($out, '', 'no output from daemon-kill'); - is($err, '', 'no error from daemon-kill'); - for (0..100) { - kill(0, $pid) or last; - tick(); - } - ok(-S $sock, 'sock still exists'); - ok(!kill(0, $pid), 'pid gone after stop'); - - ok($lei->(qw(daemon-pid)), 'daemon-pid'); - chomp(my $new_pid = $out); - ok(kill(0, $new_pid), 'new pid is running'); - ok(-S $sock, 'sock still exists'); - - for my $sig (qw(-0 -CHLD)) { - ok($lei->('daemon-kill', $sig), "handles $sig"); - } - is($out.$err, '', 'no output on innocuous signals'); - ok($lei->('daemon-pid'), 'daemon-pid'); - chomp $out; - is($out, $new_pid, 'PID unchanged after -0/-CHLD'); - - if ('socket inaccessible') { - chmod 0000, $sock or BAIL_OUT "chmod 0000: $!"; - ok($lei->('help'), 'connect fail, one-shot fallback works'); - like($err, qr/\bconnect\(/, 'connect error noted'); - like($out, qr/^usage: /, 'help output works'); - chmod 0700, $sock or BAIL_OUT "chmod 0700: $!"; - } - unlink $sock or BAIL_OUT "unlink($sock) $!"; - for (0..100) { - kill('CHLD', $new_pid) or last; - tick(); - } - ok(!kill(0, $new_pid), 'daemon exits after unlink'); - # success over socket, can't test without -}; # SKIP -} # else +test_lei({ mods => [] }, sub { + lei_ok('sucks', \'no optional modules required'); +}); done_testing;