]> Sergey Matveev's repositories - public-inbox.git/blob - t/init.t
init: allow arbitrary key-values via -c KEY=VALUE
[public-inbox.git] / t / init.t
1 # Copyright (C) 2014-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 use strict;
4 use warnings;
5 use Test::More;
6 use PublicInbox::Config;
7 use PublicInbox::TestCommon;
8 use PublicInbox::Admin;
9 use File::Basename;
10 my ($tmpdir, $for_destroy) = tmpdir();
11 sub quiet_fail {
12         my ($cmd, $msg) = @_;
13         my $err = '';
14         ok(!run_script($cmd, undef, { 2 => \$err, 1 => \$err }), $msg);
15 }
16
17 {
18         local $ENV{PI_DIR} = "$tmpdir/.public-inbox/";
19         my $cfgfile = "$ENV{PI_DIR}/config";
20         my $cmd = [ '-init', 'blist', "$tmpdir/blist",
21                    qw(http://example.com/blist blist@example.com) ];
22         ok(run_script($cmd), 'public-inbox-init OK');
23
24         is(read_indexlevel('blist'), '', 'indexlevel unset by default');
25
26         ok(-e $cfgfile, "config exists, now");
27         ok(run_script($cmd), 'public-inbox-init OK (idempotent)');
28
29         chmod 0666, $cfgfile or die "chmod failed: $!";
30         $cmd = [ '-init', 'clist', "$tmpdir/clist",
31                    qw(http://example.com/clist clist@example.com)];
32         ok(run_script($cmd), 'public-inbox-init clist OK');
33         is((stat($cfgfile))[2] & 07777, 0666, "permissions preserved");
34
35         $cmd = [ '-init', 'clist', '-V2', "$tmpdir/clist",
36                    qw(http://example.com/clist clist@example.com) ];
37         quiet_fail($cmd, 'attempting to init V2 from V1 fails');
38         ok(!-e "$cfgfile.lock", 'no lock leftover after init');
39
40         open my $lock, '+>', "$cfgfile.lock" or die;
41         $cmd = [ '-init', 'lock', "$tmpdir/lock",
42                 qw(http://example.com/lock lock@example.com) ];
43         ok(-e "$cfgfile.lock", 'lock exists');
44
45         # this calls exit():
46         my $err = '';
47         ok(!run_script($cmd, undef, {2 => \$err}), 'lock init failed');
48         is($? >> 8, 255, 'got expected exit code on lock failure');
49         ok(unlink("$cfgfile.lock"),
50                 '-init did not unlink lock on failure');
51
52         my @init_args = ('i', "$tmpdir/i",
53                    qw(http://example.com/i i@example.com));
54         $cmd = [ qw(-init -c .bogus=val), @init_args ];
55         quiet_fail($cmd, 'invalid -c KEY=VALUE fails');
56         $cmd = [ qw(-init -c .bogus=val), @init_args ];
57         quiet_fail($cmd, '-c KEY-only fails');
58         $cmd = [ qw(-init -c address=clist@example.com), @init_args ];
59         quiet_fail($cmd, '-c address=CONFLICTING-VALUE fails');
60
61         $cmd = [ qw(-init -c no=problem -c no=problemo), @init_args ];
62         ok(run_script($cmd), '-c KEY=VALUE runs');
63         my $env = { GIT_CONFIG => "$ENV{PI_DIR}/config" };
64         chomp(my @v = xqx([qw(git config --get-all publicinbox.i.no)], $env));
65         is_deeply(\@v, [ qw(problem problemo) ]) or xbail(\@v);
66
67         ok(run_script($cmd), '-c KEY=VALUE runs idempotently');
68         chomp(my @v2 = xqx([qw(git config --get-all publicinbox.i.no)], $env));
69         is_deeply(\@v, \@v2, 'nothing repeated') or xbail(\@v2);
70
71         ok(run_script([@$cmd, '-c', 'no=more']), '-c KEY=VALUE addendum');
72         chomp(@v = xqx([qw(git config --get-all publicinbox.i.no)], $env));
73         is_deeply(\@v, [ qw(problem problemo more) ]) or xbail(\@v);
74
75
76         ok(run_script([@$cmd, '-c', 'no=problem']), '-c KEY=VALUE repeated');
77         chomp(@v = xqx([qw(git config --get-all publicinbox.i.no)], $env));
78         is_deeply(\@v, [ qw(problem problemo more) ]) or xbail(\@v);
79
80         ok(run_script([@$cmd, '-c', 'address=j@example.com']),
81                 '-c KEY=VALUE address');
82         chomp(@v = xqx([qw(git config --get-all publicinbox.i.address)], $env));
83         is_deeply(\@v, [ qw(i@example.com j@example.com) ],
84                 'extra address added via -c KEY=VALUE');
85 }
86 {
87         my $env = { PI_DIR => "$tmpdir/.public-inbox/" };
88         my $rdr = { 2 => \(my $err = '') };
89         my $cmd = [ '-init', 'alist', "$tmpdir/a\nlist",
90                    qw(http://example.com/alist alist@example.com) ];
91         ok(!run_script($cmd, $env, $rdr),
92                 'public-inbox-init rejects LF in inboxdir');
93         like($err, qr/`\\n' not allowed in `/s, 'reported \\n');
94         is_deeply([glob("$tmpdir/.public-inbox/pi-init-*")], [],
95                 'no junk files left behind');
96
97         # "git init" does this, too
98         $cmd = [ '-init', 'deep-non-existent', "$tmpdir/a/b/c/d",
99                    qw(http://example.com/abcd abcd@example.com) ];
100         $err = '';
101         ok(run_script($cmd, $env, $rdr), 'initializes non-existent hierarchy');
102         ok(-d "$tmpdir/a/b/c/d", 'directory created');
103         open my $fh, '>', "$tmpdir/d" or BAIL_OUT "open: $!";
104         close $fh;
105         $cmd = [ '-init', 'd-f-conflict', "$tmpdir/d/f/conflict",
106                    qw(http://example.com/conflict onflict@example.com) ];
107         ok(!run_script($cmd, $env, $rdr), 'fails on D/F conflict');
108 }
109
110 SKIP: {
111         require_mods(qw(DBD::SQLite Search::Xapian), 2);
112         require_git(2.6, 1) or skip "git 2.6+ required", 2;
113         use_ok 'PublicInbox::Msgmap';
114         local $ENV{PI_DIR} = "$tmpdir/.public-inbox/";
115         local $ENV{PI_EMERGENCY} = "$tmpdir/.public-inbox/emergency";
116         my $cfgfile = "$ENV{PI_DIR}/config";
117         my $cmd = [ '-init', '-V2', 'v2list', "$tmpdir/v2list",
118                    qw(http://example.com/v2list v2list@example.com) ];
119         ok(run_script($cmd), 'public-inbox-init -V2 OK');
120         ok(-d "$tmpdir/v2list", 'v2list directory exists');
121         ok(-f "$tmpdir/v2list/msgmap.sqlite3", 'msgmap exists');
122         ok(-d "$tmpdir/v2list/all.git", 'catch-all.git directory exists');
123         $cmd = [ '-init', 'v2list', "$tmpdir/v2list",
124                    qw(http://example.com/v2list v2list@example.com) ];
125         ok(run_script($cmd), 'public-inbox-init is idempotent');
126         ok(! -d "$tmpdir/public-inbox" && !-d "$tmpdir/objects",
127                 'idempotent invocation w/o -V2 does not make inbox v1');
128         is(read_indexlevel('v2list'), '', 'indexlevel unset by default');
129
130         $cmd = [ '-init', 'v2list', "-V1", "$tmpdir/v2list",
131                    qw(http://example.com/v2list v2list@example.com) ];
132         quiet_fail($cmd, 'initializing V2 as V1 fails');
133
134         foreach my $lvl (qw(medium basic)) {
135                 my $dir = "$tmpdir/v2$lvl";
136                 $cmd = [ '-init', "v2$lvl", '-V2', '-L', $lvl,
137                         $dir, "http://example.com/v2$lvl",
138                         "v2$lvl\@example.com" ];
139                 ok(run_script($cmd), "-init -L $lvl");
140                 is(read_indexlevel("v2$lvl"), $lvl, "indexlevel set to '$lvl'");
141                 my $ibx = PublicInbox::Inbox->new({ inboxdir => $dir });
142                 is(PublicInbox::Admin::detect_indexlevel($ibx), $lvl,
143                         'detected expected level w/o config');
144                 ok(!$ibx->{-skip_docdata}, 'docdata written by default');
145         }
146         for my $v (1, 2) {
147                 my $name = "v$v-skip-docdata";
148                 my $dir = "$tmpdir/$name";
149                 $cmd = [ '-init', $name, "-V$v", '--skip-docdata',
150                         $dir, "http://example.com/$name",
151                         "$name\@example.com" ];
152                 ok(run_script($cmd), "-init -V$v --skip-docdata");
153                 my $ibx = PublicInbox::Inbox->new({ inboxdir => $dir });
154                 is(PublicInbox::Admin::detect_indexlevel($ibx), 'full',
155                         "detected default indexlevel -V$v");
156                 ok($ibx->{-skip_docdata}, "docdata skip set -V$v");
157                 ok($ibx->search->has_threadid, 'has_threadid flag set on new inbox');
158         }
159
160         # loop for idempotency
161         for (1..2) {
162                 $cmd = [ '-init', '-V2', '-S1', 'skip1', "$tmpdir/skip1",
163                            qw(http://example.com/skip1 skip1@example.com) ];
164                 ok(run_script($cmd), "--skip-epoch 1");
165                 my $gits = [ glob("$tmpdir/skip1/git/*.git") ];
166                 is_deeply($gits, ["$tmpdir/skip1/git/1.git"], 'skip OK');
167         }
168
169         $cmd = [ '-init', '-V2', '--skip-epoch=2', 'skip2', "$tmpdir/skip2",
170                    qw(http://example.com/skip2 skip2@example.com) ];
171         ok(run_script($cmd), "--skip-epoch 2");
172         my $gits = [ glob("$tmpdir/skip2/git/*.git") ];
173         is_deeply($gits, ["$tmpdir/skip2/git/2.git"], 'skipping 2 works, too');
174
175         xsys(qw(git config), "--file=$ENV{PI_DIR}/config",
176                         'publicinboxmda.spamcheck', 'none') == 0 or
177                         BAIL_OUT "git config $?";
178         my $addr = 'skip3@example.com';
179         $cmd = [ qw(-init -V2 -Lbasic --skip-artnum=12 skip3), "$tmpdir/skip3",
180                    qw(http://example.com/skip3), $addr ];
181         ok(run_script($cmd), '--skip-artnum -V2');
182         my $env = { ORIGINAL_RECIPIENT => $addr };
183         my $mid = 'skip-artnum@example.com';
184         my $msg = "Message-ID: <$mid>\n\n";
185         my $rdr = { 0 => \$msg, 2 => \(my $err = '')  };
186         ok(run_script([qw(-mda --no-precheck)], $env, $rdr), 'deliver V1');
187         diag "err=$err" if $err;
188         my $mm = PublicInbox::Msgmap->new_file("$tmpdir/skip3/msgmap.sqlite3");
189         my $n = $mm->num_for($mid);
190         is($n, 13, 'V2 NNTP article numbers skipped via --skip-artnum');
191
192         $addr = 'skip4@example.com';
193         $env = { ORIGINAL_RECIPIENT => $addr };
194         $cmd = [ qw(-init -V1 --skip-artnum 12 -Lmedium skip4), "$tmpdir/skip4",
195                    qw(http://example.com/skip4), $addr ];
196         ok(run_script($cmd), '--skip-artnum -V1');
197         $err = '';
198         ok(run_script([qw(-mda --no-precheck)], $env, $rdr), 'deliver V1');
199         diag "err=$err" if $err;
200         $mm = PublicInbox::Msgmap->new("$tmpdir/skip4");
201         $n = $mm->num_for($mid);
202         is($n, 13, 'V1 NNTP article numbers skipped via --skip-artnum');
203 }
204
205 done_testing();
206
207 sub read_indexlevel {
208         my ($inbox) = @_;
209         my $cmd = [ qw(git config), "publicinbox.$inbox.indexlevel" ];
210         my $env = { GIT_CONFIG => "$ENV{PI_DIR}/config" };
211         chomp(my $lvl = xqx($cmd, $env));
212         $lvl;
213 }