]> Sergey Matveev's repositories - public-inbox.git/blob - t/imapd.t
imap: support IDLE
[public-inbox.git] / t / imapd.t
1 #!perl -w
2 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
3 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 use strict;
5 use Test::More;
6 use Time::HiRes ();
7 use PublicInbox::TestCommon;
8 use PublicInbox::Config;
9 require_mods(qw(DBD::SQLite Mail::IMAPClient Linux::Inotify2));
10 my $level = '-Lbasic';
11 SKIP: {
12         require_mods('Search::Xapian', 1);
13         $level = '-Lmedium';
14 };
15
16 my @V = (1);
17 push(@V, 2) if require_git('2.6', 1);
18
19 my ($tmpdir, $for_destroy) = tmpdir();
20 my $home = "$tmpdir/home";
21 local $ENV{HOME} = $home;
22
23 for my $V (@V) {
24         my $addr = "i$V\@example.com";
25         my $name = "i$V";
26         my $url = "http://example.com/i$V";
27         my $inboxdir = "$tmpdir/$name";
28         my $folder = "inbox.i$V";
29         my $cmd = ['-init', "-V$V", $level, $name, $inboxdir, $url, $addr];
30         run_script($cmd) or BAIL_OUT("init $name");
31         xsys(qw(git config), "--file=$ENV{HOME}/.public-inbox/config",
32                         "publicinbox.$name.newsgroup", $folder) == 0 or
33                         BAIL_OUT("setting newsgroup $V");
34         if ($V == 1) {
35                 xsys(qw(git config), "--file=$ENV{HOME}/.public-inbox/config",
36                         'publicinboxmda.spamcheck', 'none') == 0 or
37                         BAIL_OUT("config: $?");
38         }
39         open(my $fh, '<', 't/utf8.eml') or BAIL_OUT("open t/utf8.eml: $!");
40         my $env = { ORIGINAL_RECIPIENT => $addr };
41         run_script(['-mda', '--no-precheck'], $env, { 0 => $fh }) or
42                 BAIL_OUT('-mda delivery');
43         if ($V == 1) {
44                 run_script(['-index', $inboxdir]) or BAIL_OUT("index $?");
45         }
46 }
47 my $sock = tcp_server();
48 my $err = "$tmpdir/stderr.log";
49 my $out = "$tmpdir/stdout.log";
50 my $cmd = [ '-imapd', '-W0', "--stdout=$out", "--stderr=$err" ];
51 my $td = start_script($cmd, undef, { 3 => $sock }) or BAIL_OUT("-imapd: $?");
52 my %mic_opt = (
53         Server => $sock->sockhost,
54         Port => $sock->sockport,
55         Uid => 1,
56 );
57 my $mic = Mail::IMAPClient->new(%mic_opt);
58 my $pre_login_capa = $mic->capability;
59 is(grep(/\AAUTH=ANONYMOUS\z/, @$pre_login_capa), 1,
60         'AUTH=ANONYMOUS advertised pre-login');
61
62 $mic->User('lorelei');
63 $mic->Password('Hunter2');
64 ok($mic->login && $mic->IsAuthenticated, 'LOGIN works');
65 my $post_login_capa = $mic->capability;
66 ok(join("\n", @$pre_login_capa) ne join("\n", @$post_login_capa),
67         'got different capabilities post-login');
68
69 $mic_opt{Authmechanism} = 'ANONYMOUS';
70 $mic_opt{Authcallback} = sub { '' };
71 $mic = Mail::IMAPClient->new(%mic_opt);
72 ok($mic && $mic->login && $mic->IsAuthenticated, 'AUTHENTICATE ANONYMOUS');
73 my $post_auth_anon_capa = $mic->capability;
74 is_deeply($post_auth_anon_capa, $post_login_capa,
75         'auth anon has same capabilities');
76 my $e;
77 ok(!$mic->examine('foo') && ($e = $@), 'EXAMINE non-existent');
78 like($e, qr/\bNO\b/, 'got a NO on EXAMINE for non-existent');
79 ok(!$mic->select('foo') && ($e = $@), 'EXAMINE non-existent');
80 like($e, qr/\bNO\b/, 'got a NO on EXAMINE for non-existent');
81 ok($mic->select('inbox.i1'), 'SELECT succeeds');
82 ok($mic->examine('inbox.i1'), 'EXAMINE succeeds');
83
84 my $ret = $mic->search('all') or BAIL_OUT "SEARCH FAIL $@";
85 is_deeply($ret, [ 1 ], 'search all works');
86 $ret = $mic->search('uid 1') or BAIL_OUT "SEARCH FAIL $@";
87 is_deeply($ret, [ 1 ], 'search UID 1 works');
88 $ret = $mic->search('uid 1:1') or BAIL_OUT "SEARCH FAIL $@";
89 is_deeply($ret, [ 1 ], 'search UID 1:1 works');
90 $ret = $mic->search('uid 1:*') or BAIL_OUT "SEARCH FAIL $@";
91 is_deeply($ret, [ 1 ], 'search UID 1:* works');
92
93 is_deeply(scalar $mic->flags('1'), [], '->flags works');
94
95 for my $r ('1:*', '1') {
96         $ret = $mic->fetch_hash($r, 'RFC822') or BAIL_OUT "FETCH $@";
97         is_deeply([keys %$ret], [1]);
98         like($ret->{1}->{RFC822}, qr/\r\n\r\nThis is a test/, 'read full');
99
100         # ensure Mail::IMAPClient behaves
101         my $str = $mic->message_string($r) or BAIL_OUT "->message_string: $@";
102         is($str, $ret->{1}->{RFC822}, '->message_string works as expected');
103
104         my $sz = $mic->fetch_hash($r, 'RFC822.size') or BAIL_OUT "FETCH $@";
105         is($sz->{1}->{'RFC822.SIZE'}, length($ret->{1}->{RFC822}),
106                 'RFC822.SIZE');
107
108         $ret = $mic->fetch_hash($r, 'RFC822.HEADER') or BAIL_OUT "FETCH $@";
109         is_deeply([keys %$ret], [1]);
110         like($ret->{1}->{'RFC822.HEADER'},
111                 qr/^Message-ID: <testmessage\@example\.com>/ms, 'read header');
112
113         $ret = $mic->fetch_hash($r, 'INTERNALDATE') or BAIL_OUT "FETCH $@";
114         is($ret->{1}->{'INTERNALDATE'}, '01-Jan-1970 00:00:00 +0000',
115                 'internaldate matches');
116         ok(!$mic->fetch_hash($r, 'INFERNALDATE'), 'bogus attribute fails');
117
118         my $envelope = $mic->get_envelope($r) or BAIL_OUT("get_envelope: $@");
119         is($envelope->{bcc}, 'NIL', 'empty bcc');
120         is($envelope->{messageid}, '<testmessage@example.com>', 'messageid');
121         is(scalar @{$envelope->{to}}, 1, 'one {to} header');
122         # *sigh* too much to verify...
123         #use Data::Dumper; diag Dumper($envelope);
124
125         $ret = $mic->fetch_hash($r, 'FLAGS') or BAIL_OUT "FETCH $@";
126         is_deeply($ret->{1}->{FLAGS}, '', 'no flags');
127 }
128
129 # Mail::IMAPClient ->compress creates cyclic reference:
130 # https://rt.cpan.org/Ticket/Display.html?id=132654
131 my $compress_logout = sub {
132         my ($c) = @_;
133         ok($c->logout, 'logout ok after ->compress');
134         # all documented in Mail::IMAPClient manpage:
135         for (qw(Readmoremethod Readmethod Prewritemethod)) {
136                 $c->$_(undef);
137         }
138 };
139
140 is_deeply([$mic->has_capability('COMPRESS')], ['DEFLATE'], 'deflate cap');
141 ok($mic->compress, 'compress enabled');
142 $compress_logout->($mic);
143
144 my $pi_config = PublicInbox::Config->new;
145 $pi_config->each_inbox(sub {
146         my ($ibx) = @_;
147         my $name = $ibx->{name};
148         my $ng = $ibx->{newsgroup};
149         my $mic = Mail::IMAPClient->new(%mic_opt);
150         ok($mic && $mic->login && $mic->IsAuthenticated, "authed $name");
151         is_deeply([$mic->has_capability('IDLE')], ['IDLE'], "IDLE capa $name");
152         ok(!$mic->idle, "IDLE fails w/o SELECT/EXAMINE $name");
153         ok($mic->examine($ng), "EXAMINE $ng succeeds");
154         ok($mic->idle, "IDLE succeeds on $ng");
155
156         open(my $fh, '<', 't/data/message_embed.eml') or BAIL_OUT("open: $!");
157         my $env = { ORIGINAL_RECIPIENT => $ibx->{-primary_address} };
158         run_script(['-mda', '--no-precheck'], $env, { 0 => $fh }) or
159                 BAIL_OUT('-mda delivery');
160         my $t0 = Time::HiRes::time();
161         ok(my @res = $mic->idle_data(11), "IDLE succeeds on $ng");
162         ok(grep(/\A\* [0-9] EXISTS\b/, @res), 'got EXISTS message');
163         ok((Time::HiRes::time() - $t0) < 10, 'IDLE client notified');
164 });
165
166 $td->kill;
167 $td->join;
168 is($?, 0, 'no error in exited process');
169 open my $fh, '<', $err or BAIL_OUT("open $err failed: $!");
170 my $eout = do { local $/; <$fh> };
171 unlike($eout, qr/wide/i, 'no Wide character warnings');
172
173 done_testing;