edit: new tool to perform edits

This wrapper around V2Writable->replace provides a user-interface
for editing messages as single-message mboxes (or the raw text
via $EDITOR).

1 files changed, 178 insertions, 0 deletions

diff --git a/t/edit.t b/t/edit.t
new file mode 100644
index 00000000..61e90f2f
--- /dev/null
+++ b/t/edit.t
@@ -0,0 +1,178 @@
+# Copyright (C) 2019 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# edit frontend behavior test (t/replace.t for backend)
+use strict;
+use warnings;
+use Test::More;
+use File::Temp qw/tempdir/;
+require './t/common.perl';
+require_git(2.6);
+require PublicInbox::Inbox;
+require PublicInbox::InboxWritable;
+require PublicInbox::Config;
+use PublicInbox::MID qw(mid_clean);
+
+my @mods = qw(IPC::Run DBI DBD::SQLite);
+foreach my $mod (@mods) {
+        eval "require $mod";
+        plan skip_all => "missing $mod for $0" if $@;
+};
+IPC::Run->import(qw(run));
+
+my $cmd_pfx = 'blib/script/public-inbox';
+my $tmpdir = tempdir('pi-edit-XXXXXX', TMPDIR => 1, CLEANUP => 1);
+my $mainrepo = "$tmpdir/v2";
+my $ibx = PublicInbox::Inbox->new({
+        mainrepo => $mainrepo,
+        name => 'test-v2edit',
+        version => 2,
+        -primary_address => 'test@example.com',
+        indexlevel => 'basic',
+});
+$ibx = PublicInbox::InboxWritable->new($ibx, {nproc=>1});
+my $cfgfile = "$tmpdir/config";
+local $ENV{PI_CONFIG} = $cfgfile;
+my $file = 't/data/0001.patch';
+open my $fh, '<', $file or die "open: $!";
+my $raw = do { local $/; <$fh> };
+my $im = $ibx->importer(0);
+my $mime = PublicInbox::MIME->new($raw);
+my $mid = mid_clean($mime->header('Message-Id'));
+ok($im->add($mime), 'add message to be edited');
+$im->done;
+my ($in, $out, $err, $cmd, $cur, $t);
+my $__git_dir = "--git-dir=$ibx->{mainrepo}/git/0.git";
+
+$t = '-F FILE'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/boolean prefix/bool pfx/'";
+        $cmd = [ "$cmd_pfx-edit", "-F$file", $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t edit OK");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        like($cur->header('Subject'), qr/bool pfx/, "$t message edited");
+        like($out, qr/[a-f0-9]{40}/, "$t shows commit on success");
+}
+
+$t = '-m MESSAGE_ID'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/bool pfx/boolean prefix/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t edit OK");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        like($cur->header('Subject'), qr/boolean prefix/, "$t message edited");
+        like($out, qr/[a-f0-9]{40}/, "$t shows commit on success");
+}
+
+$t = 'no-op -m MESSAGE_ID'; {
+        $in = $out = $err = '';
+        my $before = `git $__git_dir rev-parse HEAD`;
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/bool pfx/boolean prefix/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t succeeds");
+        my $prev = $cur;
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        is_deeply($cur, $prev, "$t makes no change");
+        like($cur->header('Subject'), qr/boolean prefix/,
+                "$t does not change message");
+        like($out, qr/NONE/, 'noop shows NONE');
+        my $after = `git $__git_dir rev-parse HEAD`;
+        is($after, $before, 'git head unchanged');
+}
+
+$t = '-m MESSAGE_ID can change Received: headers'; {
+        $in = $out = $err = '';
+        my $before = `git $__git_dir rev-parse HEAD`;
+        local $ENV{MAIL_EDITOR} =
+                        "$^X -i -p -e 's/^Subject:.*/Received: x\\n\$&/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t succeeds");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        like($cur->header('Subject'), qr/boolean prefix/,
+                "$t does not change Subject");
+        is($cur->header('Received'), 'x', 'added Received header');
+}
+
+$t = '-m miss'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/boolean/FAIL/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid-miss", $mainrepo ];
+        ok(!run($cmd, \$in, \$out, \$err), "$t fails on invalid MID");
+        like($err, qr/No message found/, "$t shows error");
+}
+
+$t = 'non-interactive editor failure'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 'END { exit 1 }'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(!run($cmd, \$in, \$out, \$err), "$t detected");
+        like($err, qr/END \{ exit 1 \}' failed:/, "$t shows error");
+}
+
+$t = 'mailEditor set in config'; {
+        $in = $out = $err = '';
+        my $rc = system(qw(git config), "--file=$cfgfile",
+                        'publicinbox.maileditor',
+                        "$^X -i -p -e 's/boolean prefix/bool pfx/'");
+        is($rc, 0, 'set publicinbox.mailEditor');
+        local $ENV{MAIL_EDITOR};
+        local $ENV{GIT_EDITOR} = 'echo should not run';
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t edited message");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        like($cur->header('Subject'), qr/bool pfx/, "$t message edited");
+        unlike($out, qr/should not run/, 'did not run GIT_EDITOR');
+}
+
+$t = '--raw and mbox escaping'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/^\$/\\nFrom not mbox\\n/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", '--raw', $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t succeeds");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        like($cur->body, qr/^From not mbox/sm, 'put "From " line into body');
+
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/^>From not/\$& an/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t succeeds with mbox escaping");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        like($cur->body, qr/^From not an mbox/sm,
+                'changed "From " line unescaped');
+
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/^From not an mbox\\n//s'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", '--raw', $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t succeeds again");
+        $cur = PublicInbox::MIME->new($ibx->msg_by_mid($mid));
+        unlike($cur->body, qr/^From not an mbox/sm, "$t restored body");
+}
+
+$t = 'reuse Message-ID'; {
+        my @warn;
+        local $SIG{__WARN__} = sub { push @warn, @_ };
+        ok($im->add($mime), "$t and re-add");
+        $im->done;
+        like($warn[0], qr/reused for mismatched content/, "$t got warning");
+}
+
+$t = 'edit ambiguous Message-ID with -m'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/bool pfx/boolean prefix/'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", $mainrepo ];
+        ok(!run($cmd, \$in, \$out, \$err), "$t fails w/o --force");
+        like($err, qr/Multiple messages with different content found matching/,
+                "$t shows matches");
+        like($err, qr/GIT_DIR=.*git show/is, "$t shows git commands");
+}
+
+$t .= ' and --force'; {
+        $in = $out = $err = '';
+        local $ENV{MAIL_EDITOR} = "$^X -i -p -e 's/^Subject:.*/Subject:x/i'";
+        $cmd = [ "$cmd_pfx-edit", "-m$mid", '--force', $mainrepo ];
+        ok(run($cmd, \$in, \$out, \$err), "$t succeeds");
+        like($err, qr/Will edit all of them/, "$t notes all will be edited");
+        my @dump = `git $__git_dir cat-file --batch --batch-all-objects`;
+        chomp @dump;
+        is_deeply([grep(/^Subject:/i, @dump)], [qw(Subject:x Subject:x)],
+                "$t edited both messages");
+}
+
+done_testing();