X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=t%2Fimapd.t;h=cc87a127851a0d025cd0beebda9657ff4676c102;hb=b2b1006759730507731fcd3fc3e0de68239e3b92;hp=f28a663bf9dacbb9622120b8647eab5ae64b7dba;hpb=90f11ce471c53365a77896c847d0a39b0995b5b5;p=public-inbox.git diff --git a/t/imapd.t b/t/imapd.t index f28a663b..cc87a127 100644 --- a/t/imapd.t +++ b/t/imapd.t @@ -1,18 +1,33 @@ #!perl -w # Copyright (C) 2020 all contributors # License: AGPL-3.0+ +# end-to-end IMAP tests, see unit tests in t/imap.t, too use strict; use Test::More; +use Time::HiRes (); use PublicInbox::TestCommon; -require_mods(qw(DBD::SQLite Mail::IMAPClient)); -my $level = '-Lbasic'; +use PublicInbox::Config; +use PublicInbox::Spawn qw(which); +require_mods(qw(DBD::SQLite Mail::IMAPClient Mail::IMAPClient::BodyStructure + Email::Address::XS||Mail::Address Parse::RecDescent)); +my $imap_client = 'Mail::IMAPClient'; +my $can_compress = $imap_client->can('compress'); +if ($can_compress) { # hope this gets fixed upstream, soon + require PublicInbox::IMAPClient; + $imap_client = 'PublicInbox::IMAPClient'; +} + +require_ok 'PublicInbox::IMAP'; +my $first_range = '0'; + +my $level = 'basic'; SKIP: { require_mods('Search::Xapian', 1); - $level = '-Lmedium'; + $level = 'medium'; }; my @V = (1); -#push(@V, 2) if require_git('2.6', 1); +push(@V, 2) if require_git('2.6', 1); my ($tmpdir, $for_destroy) = tmpdir(); my $home = "$tmpdir/home"; @@ -24,7 +39,7 @@ for my $V (@V) { my $url = "http://example.com/i$V"; my $inboxdir = "$tmpdir/$name"; my $folder = "inbox.i$V"; - my $cmd = ['-init', "-V$V", $level, $name, $inboxdir, $url, $addr]; + my $cmd = ['-init', "-V$V", "-L$level", $name, $inboxdir, $url, $addr]; run_script($cmd) or BAIL_OUT("init $name"); xsys(qw(git config), "--file=$ENV{HOME}/.public-inbox/config", "publicinbox.$name.newsgroup", $folder) == 0 or @@ -52,7 +67,7 @@ my %mic_opt = ( Port => $sock->sockport, Uid => 1, ); -my $mic = Mail::IMAPClient->new(%mic_opt); +my $mic = $imap_client->new(%mic_opt); my $pre_login_capa = $mic->capability; is(grep(/\AAUTH=ANONYMOUS\z/, @$pre_login_capa), 1, 'AUTH=ANONYMOUS advertised pre-login'); @@ -66,7 +81,7 @@ ok(join("\n", @$pre_login_capa) ne join("\n", @$post_login_capa), $mic_opt{Authmechanism} = 'ANONYMOUS'; $mic_opt{Authcallback} = sub { '' }; -$mic = Mail::IMAPClient->new(%mic_opt); +$mic = $imap_client->new(%mic_opt); ok($mic && $mic->login && $mic->IsAuthenticated, 'AUTHENTICATE ANONYMOUS'); my $post_auth_anon_capa = $mic->capability; is_deeply($post_auth_anon_capa, $post_login_capa, @@ -76,8 +91,26 @@ ok(!$mic->examine('foo') && ($e = $@), 'EXAMINE non-existent'); like($e, qr/\bNO\b/, 'got a NO on EXAMINE for non-existent'); ok(!$mic->select('foo') && ($e = $@), 'EXAMINE non-existent'); like($e, qr/\bNO\b/, 'got a NO on EXAMINE for non-existent'); -ok($mic->select('inbox.i1'), 'SELECT succeeds'); -ok($mic->examine('inbox.i1'), 'EXAMINE succeeds'); +my $mailbox1 = "inbox.i1.$first_range"; +ok($mic->select('inbox.i1'), 'SELECT on parent succeeds'); +ok($mic->select($mailbox1), 'SELECT succeeds'); +ok($mic->examine($mailbox1), 'EXAMINE succeeds'); +my @raw = $mic->status($mailbox1, qw(Messages uidnext uidvalidity)); +is(scalar(@raw), 2, 'got status response'); +like($raw[0], qr/\A\*\x20STATUS\x20inbox\.i1\.$first_range\x20 + \(MESSAGES\x20\d+\x20UIDNEXT\x20\d+\x20UIDVALIDITY\x20\d+\)\r\n/sx); +like($raw[1], qr/\A\S+ OK /, 'finished status response'); + +my @orig_list = @raw = $mic->list; +like($raw[0], qr/^\* LIST \(.*?\) "\." INBOX/, + 'got an inbox'); +like($raw[-1], qr/^\S+ OK /, 'response ended with OK'); +is(scalar(@raw), scalar(@V) * 2 + 2, 'default LIST response'); +@raw = $mic->list('', 'inbox.i1'); +is(scalar(@raw), 2, 'limited LIST response'); +like($raw[0], qr/^\* LIST \(.*?\) "\." INBOX/, + 'got an inbox.i1'); +like($raw[-1], qr/^\S+ OK /, 'response ended with OK'); my $ret = $mic->search('all') or BAIL_OUT "SEARCH FAIL $@"; is_deeply($ret, [ 1 ], 'search all works'); @@ -88,7 +121,49 @@ is_deeply($ret, [ 1 ], 'search UID 1:1 works'); $ret = $mic->search('uid 1:*') or BAIL_OUT "SEARCH FAIL $@"; is_deeply($ret, [ 1 ], 'search UID 1:* works'); +SKIP: { + skip 'Xapian missing', 7 if $level eq 'basic'; + my $x = $mic->search(qw(smaller 99999)); + is_deeply($x, [1], 'SMALLER works with Xapian (hit)'); + $x = $mic->search(qw(smaller 9)); + is_deeply($x, [], 'SMALLER works with Xapian (miss)'); + + $x = $mic->search(qw(larger 99999)); + is_deeply($x, [], 'LARGER works with Xapian (miss)'); + $x = $mic->search(qw(larger 9)); + is_deeply($x, [1], 'LARGER works with Xapian (hit)'); + + $x = $mic->search(qw(HEADER Message-ID testmessage@example.com)); + is_deeply($x, [1], 'HEADER Message-ID works'); + $x = $mic->search(qw(HEADER Message-ID miss)); + is_deeply($x, [], 'HEADER Message-ID can miss'); + + my @q = qw[OR HEADER Message-ID testmessage@example.com + (OR FROM Ryan (OR TO Joe CC Scott))]; + $x = $mic->search(join(' ', @q)); + is_deeply($x, [1], 'nested query works'); +} + is_deeply(scalar $mic->flags('1'), [], '->flags works'); +{ + # RFC 3501 section 6.4.8 states: + # Also note that a UID range of 559:* always includes the + # UID of the last message in the mailbox, even if 559 is + # higher than any assigned UID value. + my $exp = $mic->fetch_hash(1, 'UID'); + $ret = $mic->fetch_hash('559:*', 'UID'); + is_deeply($ret, $exp, 'beginning range too big'); + { + my @w; # Mail::IMAPClient hits a warning via overload + local $SIG{__WARN__} = sub { push @w, @_ }; + $ret = $mic->fetch_hash(my $r = '559:558', 'UID'); + is_deeply($ret, {}, "out-of-range UID FETCH $r"); + @w = grep(!/\boverload\.pm\b/, @w); + is_deeply(\@w, [], 'no unexpected warning'); + } + $ret = $mic->fetch_hash(my $r = '558:559', 'UID'); + is_deeply($ret, {}, "out-of-range UID FETCH $r"); +} for my $r ('1:*', '1') { $ret = $mic->fetch_hash($r, 'RFC822') or BAIL_OUT "FETCH $@"; @@ -122,22 +197,287 @@ for my $r ('1:*', '1') { $ret = $mic->fetch_hash($r, 'FLAGS') or BAIL_OUT "FETCH $@"; is_deeply($ret->{1}->{FLAGS}, '', 'no flags'); + + $ret = $mic->fetch_hash($r, 'BODY[1]') or BAIL_OUT "FETCH $@"; + like($ret->{1}->{'BODY[1]'}, qr/\AThis is a test message/, 'BODY[1]'); + + $ret = $mic->fetch_hash($r, 'BODY[1]<1>') or BAIL_OUT "FETCH $@"; + like($ret->{1}->{'BODY[1]<1>'}, qr/\Ahis is a test message/, + 'BODY[1]<1>'); + + $ret = $mic->fetch_hash($r, 'BODY[1]<2.3>') or BAIL_OUT "FETCH $@"; + is($ret->{1}->{'BODY[1]<2>'}, "is ", 'BODY[1]<2.3>'); + $ret = $mic->bodypart_string($r, 1, 3, 2) or + BAIL_OUT "bodypart_string $@"; + is($ret, "is ", 'bodypart string'); + + $ret = $mic->fetch_hash($r, 'BODY[HEADER.FIELDS.NOT (Message-ID)]') + or BAIL_OUT "FETCH $@"; + $ret = $ret->{1}->{'BODY[HEADER.FIELDS.NOT (MESSAGE-ID)]'}; + unlike($ret, qr/message-id/i, 'Message-ID excluded'); + like($ret, qr/\r\n\r\n\z/s, 'got header end'); + + $ret = $mic->fetch_hash($r, 'BODY[HEADER.FIELDS (Message-ID)]') + or BAIL_OUT "FETCH $@"; + is($ret->{1}->{'BODY[HEADER.FIELDS (MESSAGE-ID)]'}, + 'Message-ID: '."\r\n\r\n", + 'got only Message-ID'); + + my $bs = $mic->get_bodystructure($r) or BAIL_OUT("bodystructure: $@"); + ok($bs, 'got a bodystructure'); + is(lc($bs->bodytype), 'text', '->bodytype'); + is(lc($bs->bodyenc), '8bit', '->bodyenc'); +} +ok($mic->has_capability('COMPRESS') || + $mic->has_capability('COMPRESS=DEFLATE'), 'deflate cap'); +SKIP: { + skip 'Mail::IMAPClient too old for ->compress', 2 if !$can_compress; + my $c = $imap_client->new(%mic_opt); + ok($c && $c->compress, 'compress enabled'); + ok($c->examine($mailbox1), 'EXAMINE succeeds after COMPRESS'); + $ret = $c->search('uid 1:*') or BAIL_OUT "SEARCH FAIL $@"; + is_deeply($ret, [ 1 ], 'search UID 1:* works after compression'); } -# Mail::IMAPClient ->compress creates cyclic reference: -# https://rt.cpan.org/Ticket/Display.html?id=132654 -my $compress_logout = sub { - my ($c) = @_; - ok($c->logout, 'logout ok after ->compress'); - # all documented in Mail::IMAPClient manpage: - for (qw(Readmoremethod Readmethod Prewritemethod)) { - $c->$_(undef); - } -}; +ok($mic->logout, 'logout works'); + +my $have_inotify = eval { require Linux::Inotify2; 1 }; + +my $pi_config = PublicInbox::Config->new; +$pi_config->each_inbox(sub { + my ($ibx) = @_; + my $env = { ORIGINAL_RECIPIENT => $ibx->{-primary_address} }; + my $name = $ibx->{name}; + my $ng = $ibx->{newsgroup}; + my $mic = $imap_client->new(%mic_opt); + ok($mic && $mic->login && $mic->IsAuthenticated, "authed $name"); + my $mb = "$ng.$first_range"; + my $uidnext = $mic->uidnext($mb); # we'll fetch BODYSTRUCTURE on this + ok($uidnext, 'got uidnext for later fetch'); + ok($mic->has_capability('IDLE'), "IDLE capa $name"); + ok(!$mic->idle, "IDLE fails w/o SELECT/EXAMINE $name"); + ok($mic->examine($mb), "EXAMINE $ng succeeds"); + ok(my $idle_tag = $mic->idle, "IDLE succeeds on $ng"); + + open(my $fh, '<', 't/data/message_embed.eml') or BAIL_OUT("open: $!"); + run_script(['-mda', '--no-precheck'], $env, { 0 => $fh }) or + BAIL_OUT('-mda delivery'); + my $t0 = Time::HiRes::time(); + ok(my @res = $mic->idle_data(11), "IDLE succeeds on $ng"); + is(grep(/\A\* [0-9] EXISTS\b/, @res), 1, 'got EXISTS message'); + ok((Time::HiRes::time() - $t0) < 10, 'IDLE client notified'); -is_deeply([$mic->has_capability('COMPRESS')], ['DEFLATE'], 'deflate cap'); -ok($mic->compress, 'compress enabled'); -$compress_logout->($mic); + my (@ino_info, $ino_fdinfo); + SKIP: { + skip 'no inotify support', 1 unless $have_inotify; + skip 'missing /proc/$PID/fd', 1 if !-d "/proc/$td->{pid}/fd"; + my @ino = grep { + readlink($_) =~ /\binotify\b/ + } glob("/proc/$td->{pid}/fd/*"); + is(scalar(@ino), 1, 'only one inotify FD'); + my $ino_fd = (split('/', $ino[0]))[-1]; + $ino_fdinfo = "/proc/$td->{pid}/fdinfo/$ino_fd"; + if (open my $fh, '<', $ino_fdinfo) { + local $/ = "\n"; + @ino_info = grep(/^inotify wd:/, <$fh>); + ok(scalar(@ino_info), 'inotify has watches'); + } else { + skip "$ino_fdinfo missing: $!", 1; + } + }; + + # ensure IDLE persists across HUP, w/o extra watches or FDs + $td->kill('HUP') or BAIL_OUT "failed to kill -imapd: $!"; + SKIP: { + skip 'no inotify fdinfo (or support)', 2 if !@ino_info; + my (@tmp, %prev); + local $/ = "\n"; + my $end = time + 5; + until (time > $end) { + select undef, undef, undef, 0.01; + open my $fh, '<', $ino_fdinfo or + BAIL_OUT "$ino_fdinfo: $!"; + %prev = map { $_ => 1 } @ino_info; + @tmp = grep(/^inotify wd:/, <$fh>); + if (scalar(@tmp) == scalar(@ino_info)) { + delete @prev{@tmp}; + last if scalar(keys(%prev)) == @ino_info; + } + } + is(scalar @tmp, scalar @ino_info, + 'old inotify watches replaced'); + is(scalar keys %prev, scalar @ino_info, + 'no previous watches overlap'); + }; + + open($fh, '<', 't/data/0001.patch') or BAIL_OUT("open: $!"); + run_script(['-mda', '--no-precheck'], $env, { 0 => $fh }) or + BAIL_OUT('-mda delivery'); + $t0 = Time::HiRes::time(); + ok(@res = $mic->idle_data(11), "IDLE succeeds on $ng after HUP"); + is(grep(/\A\* [0-9] EXISTS\b/, @res), 1, 'got EXISTS message'); + ok((Time::HiRes::time() - $t0) < 10, 'IDLE client notified'); + ok($mic->done($idle_tag), 'IDLE DONE'); + my $bs = $mic->get_bodystructure($uidnext); + ok($bs, 'BODYSTRUCTURE ok for deeply nested'); + $ret = $mic->fetch_hash($uidnext, 'BODY') or BAIL_OUT "FETCH $@"; + ok($ret->{$uidnext}->{BODY}, 'got something in BODY'); + + # this matches dovecot behavior + $ret = $mic->fetch_hash($uidnext, 'BODY[1]') or BAIL_OUT "FETCH $@"; + is($ret->{$uidnext}->{'BODY[1]'}, + "testing embedded message harder\r\n", 'BODY[1]'); + $ret = $mic->fetch_hash($uidnext, 'BODY[2]') or BAIL_OUT "FETCH $@"; + like($ret->{$uidnext}->{'BODY[2]'}, + qr/\ADate: Sat, 18 Apr 2020 22:20:20 /, 'BODY[2]'); + + $ret = $mic->fetch_hash($uidnext, 'BODY[2.1.1]') or BAIL_OUT "FETCH $@"; + is($ret->{$uidnext}->{'BODY[2.1.1]'}, + "testing embedded message\r\n", 'BODY[2.1.1]'); + + $ret = $mic->fetch_hash($uidnext, 'BODY[2.1.2]') or BAIL_OUT "FETCH $@"; + like($ret->{$uidnext}->{'BODY[2.1.2]'}, qr/\AFrom: /, + 'BODY[2.1.2] tip matched'); + like($ret->{$uidnext}->{'BODY[2.1.2]'}, + # trailing CRLF may vary depending on MIME parser + qr/done_testing;(?:\r\n){1,2}\z/, + 'BODY[2.1.2] tail matched'); + + $ret = $mic->fetch_hash("1:$uidnext", 'BODY[2.HEADER]') or + BAIL_OUT "2.HEADER $@"; + like($ret->{$uidnext}->{'BODY[2.HEADER]'}, + qr/\ADate: Sat, 18 Apr 2020 22:20:20 /, + '2.HEADER of message/rfc822'); + + $ret = $mic->fetch_hash($uidnext, 'BODY[2.MIME]') or + BAIL_OUT "2.MIME $@"; + is($ret->{$uidnext}->{'BODY[2.MIME]'}, <search('SENTON' => '18-Apr-2020'); + is_deeply(\@hits, [ $uidnext ], 'search with date condition works'); + ok($mic->examine($ng), 'EXAMINE on dummy'); + @hits = $mic->search('SENTSINCE' => '18-Apr-2020'); + is_deeply(\@hits, [], 'search on dummy with condition works'); + ok(!$mic->search('SENTSINCE' => '18-Abr-2020'), 'bad month fails'); +}); # each_inbox + +# message sequence numbers :< +is($mic->Uid(0), 0, 'disable UID on '.ref($mic)); +ok($mic->reconnect, 'reconnected'); +$ret = $mic->fetch_hash('1,2:3', 'RFC822') or BAIL_OUT "FETCH $@"; +is(scalar keys %$ret, 3, 'got all 3 messages with comma-separated sequence'); +$ret = $mic->fetch_hash('1:*', 'RFC822') or BAIL_OUT "FETCH $@"; +is(scalar keys %$ret, 3, 'got all 3 messages'); + +SKIP: { + # do any clients use non-UID IMAP SEARCH? + skip 'Xapian missing', 2 if $level eq 'basic'; + my $x = $mic->search('all'); + is_deeply($x, [1, 2, 3], 'MSN SEARCH works before rm'); + $x = $mic->search(qw(header subject embedded)); + is_deeply($x, [2], 'MSN SEARCH on Subject works before rm'); +} + +{ + my $rdr = { 0 => \($ret->{1}->{RFC822}) }; + my $env = { HOME => $ENV{HOME} }; + my @cmd = qw(-learn rm --all); + run_script(\@cmd, $env, $rdr) or BAIL_OUT('-learn rm'); +} + +SKIP: { + # do any clients use non-UID IMAP SEARCH? We only ensure + # MSN "SEARCH" can return a result which can be retrieved + # via MSN "FETCH" + skip 'Xapian missing', 3 if $level eq 'basic'; + my $x = $mic->search(qw(header subject embedded)); + is(scalar(@$x), 1, 'MSN SEARCH on Subject works after rm'); + $x = $mic->message_string($x->[0]); + is($x, $ret->{2}->{RFC822}, 'message 2 unchanged'); + $x = $mic->search(qw(text embedded)); + is(scalar(@$x), 1, 'MSN SEARCH on TEXT works after rm'); +} + +# FIXME? no EXPUNGE response, yet +my $r2 = $mic->fetch_hash('1:*', 'BODY.PEEK[]') or BAIL_OUT "FETCH $@"; +is(scalar keys %$r2, 2, 'did not get all 3 messages'); +is($r2->{2}->{'BODY[]'}, $ret->{2}->{RFC822}, 'message 2 unchanged'); +is($r2->{3}->{'BODY[]'}, $ret->{3}->{RFC822}, 'message 3 unchanged'); +$r2 = $mic->fetch_hash(2, 'BODY.PEEK[HEADER.FIELDS (message-id)]') + or BAIL_OUT "FETCH $@"; +is($r2->{2}->{'BODY[HEADER.FIELDS (MESSAGE-ID)]'}, + 'Message-ID: <20200418222508.GA13918@dcvr>'."\r\n\r\n", + 'BODY.PEEK[HEADER.FIELDS ...] drops .PEEK'); + +{ + my @new_list = $mic->list; + # tag differs in [-1] + like($orig_list[-1], qr/\A\S+ OK List done\r\n/, 'orig LIST'); + like($new_list[-1], qr/\A\S+ OK List done\r\n/, 'new LIST'); + pop @new_list; + pop @orig_list; + # TODO: not sure if sort order matters, imapd_refresh_finalize + # doesn't sort, hopefully clients don't care... + @new_list = sort @new_list; + @orig_list = sort @orig_list; + is_deeply(\@new_list, \@orig_list, 'LIST identical'); +} +ok($mic->close, 'CLOSE works'); +ok(!$mic->close, 'CLOSE not idempotent'); +ok($mic->logout, 'logged out'); + +{ + my $c = tcp_connect($sock); + $c->autoflush(1); + like(<$c>, qr/\* OK/, 'got a greeting'); + print $c "\r\n"; + like(<$c>, qr/\A\* BAD Error in IMAP command/, 'empty line'); + print $c "tagonly\r\n"; + like(<$c>, qr/\Atagonly BAD Error in IMAP command/, 'tag-only line'); +} + +{ + use_ok 'PublicInbox::WatchMaildir'; + use_ok 'PublicInbox::InboxIdle'; + my $home = "$tmpdir/watch_home"; + mkdir $home or BAIL_OUT $!; + mkdir "$home/.public-inbox" or BAIL_OUT $!; + local $ENV{HOME} = $home; + my $name = 'watchimap'; + my $addr = "i1\@example.com"; + my $url = "http://example.com/i1"; + my $inboxdir = "$tmpdir/watchimap"; + my $cmd = ['-init', '-V2', '-Lbasic', $name, $inboxdir, $url, $addr]; + my ($ihost, $iport) = ($sock->sockhost, $sock->sockport); + my $imapurl = "imap://$ihost:$iport/inbox.i1.0"; + run_script($cmd) or BAIL_OUT("init $name"); + xsys(qw(git config), "--file=$home/.public-inbox/config", + "publicinbox.$name.watch", + $imapurl) == 0 or BAIL_OUT "git config $?"; + my $cfg = PublicInbox::Config->new; + PublicInbox::DS->Reset; + my $ii = PublicInbox::InboxIdle->new($cfg); + my $cb = sub { PublicInbox::DS->SetPostLoopCallback(sub {}) }; + my $obj = bless \$cb, 'PublicInbox::TestCommon::InboxWakeup'; + $cfg->each_inbox(sub { $_[0]->subscribe_unlock('ident', $obj) }); + open my $err, '+>', undef or BAIL_OUT $!; + my $w = start_script(['-watch'], undef, { 2 => $err }); + PublicInbox::DS->EventLoop; + diag 'inbox unlocked'; + $w->kill; + $w->join; + is($?, 0, 'no error in exited -watch process'); + $cfg->each_inbox(sub { shift->unsubscribe_unlock('ident') }); + $ii->close; + PublicInbox::DS->Reset; + seek($err, 0, 0); + my @err = grep(!/^I:/, <$err>); + is(@err, 0, 'no warnings/errors from -watch'.join(' ', @err)); +} $td->kill; $td->join; @@ -145,5 +485,6 @@ is($?, 0, 'no error in exited process'); open my $fh, '<', $err or BAIL_OUT("open $err failed: $!"); my $eout = do { local $/; <$fh> }; unlike($eout, qr/wide/i, 'no Wide character warnings'); +unlike($eout, qr/uninitialized/i, 'no uninitialized warnings'); done_testing;