Linux maintainer tooling and workflows
 help / color / mirror / Atom feed
From: Christian Brauner <brauner@kernel.org>
To: "Kernel.org Tools" <tools@kernel.org>
Cc: "Christian Brauner (Amutable)" <brauner@kernel.org>,
	 Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Subject: [PATCH b4 v2 30/44] tests: cover the review send's post-send bookkeeping
Date: Fri, 31 Jul 2026 23:59:11 +0200	[thread overview]
Message-ID: <20260731-work-b4-editor-branch-guard-v2-30-243fd19d322d@kernel.org> (raw)
In-Reply-To: <20260731-work-b4-editor-branch-guard-v2-0-243fd19d322d@kernel.org>

A tracking write that does not land is reported, a bookkeeping failure
never reads as "Send failed", and a dry run records nothing.

Signed-off-by: Christian Brauner (Amutable) <brauner@kernel.org>
---
 src/tests/test_tui_review.py | 100 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)

diff --git a/src/tests/test_tui_review.py b/src/tests/test_tui_review.py
index 3d78ec3..ec7e9e5 100644
--- a/src/tests/test_tui_review.py
+++ b/src/tests/test_tui_review.py
@@ -691,6 +691,106 @@ class TestBranchRestore:
         assert app.branch_checked_out is False
 
 
+class TestSendBookkeeping:
+    """Everything after the SMTP handoff is bookkeeping, and bookkeeping must
+    never be able to claim the send failed."""
+
+    async def _send(
+        self, gitdir: str, change_id: str, dryrun: bool = False, **patches: Any
+    ) -> Tuple[List[str], bool]:
+        """Drive action_send with a staged review and a send that succeeds.
+
+        *patches* are extra mock.patch.object() keyword targets on the app.
+        Returns (notification texts, app still running).
+        """
+        import contextlib
+
+        branch, _shas = _create_review_branch_with_patches(
+            gitdir, change_id, ['patch 1']
+        )
+        session = _build_session(gitdir, branch)
+        session['email_dryrun'] = dryrun
+        app = ReviewApp(session)
+        my_email = str(session['usercfg']['email'])
+
+        async with app.run_test(size=(120, 30)) as pilot:
+            await pilot.pause()
+            app._patches[0]['reviews'] = {
+                my_email: {
+                    'reply': 'Looks good.',
+                    'trailers': ['Reviewed-by: Me <me@example.com>'],
+                    'patch-state': 'done',
+                }
+            }
+            with contextlib.ExitStack() as stack:
+                stack.enter_context(
+                    mock.patch.object(app, 'suspend', lambda: contextlib.nullcontext())
+                )
+
+                # SendScreen is a confirmation dialog; answer yes for it.
+                def _confirm(screen: Any, callback: Any = None) -> None:
+                    assert callback is not None
+                    callback(True)
+
+                stack.enter_context(mock.patch.object(app, 'push_screen', _confirm))
+                stack.enter_context(mock.patch('b4.get_smtp', return_value=(None, 'm')))
+                stack.enter_context(
+                    mock.patch('b4.send_mail', return_value=0 if dryrun else 1)
+                )
+                stack.enter_context(
+                    mock.patch('b4.review_tui._review_app.mark_outgoing_seen')
+                )
+                stack.enter_context(mock.patch.object(app, '_mark_patches_answered'))
+                for name, kwargs in patches.items():
+                    stack.enter_context(mock.patch.object(app, name, **kwargs))
+                notified = stack.enter_context(mock.patch.object(app, 'notify'))
+                app.action_send()
+                await pilot.pause()
+            texts = [str(call.args[0]) for call in notified.call_args_list]
+            return texts, app.is_running
+
+    @pytest.mark.asyncio
+    async def test_unwritable_tracking_is_reported_but_not_as_a_send_failure(
+        self, gitdir: str
+    ) -> None:
+        """save_tracking_ref() returns False rather than raising, so this used
+        to pass unnoticed -- and the next session would offer the same reviews
+        as unsent, inviting the maintainer to send them twice."""
+        texts, running = await self._send(
+            gitdir, 'send-notracking', _save_tracking={'return_value': False}
+        )
+        assert running
+        assert any('Sent 1 review email' in t for t in texts)
+        assert not any('Send failed' in t for t in texts)
+        assert any('could not record it' in t for t in texts)
+
+    @pytest.mark.asyncio
+    async def test_raising_bookkeeping_is_not_a_send_failure(self, gitdir: str) -> None:
+        """The mail is on the list by then; reporting 'Send failed' would tell
+        the maintainer to send it again."""
+        texts, running = await self._send(
+            gitdir,
+            'send-bookkeeping-boom',
+            _mark_patches_answered={
+                'side_effect': OSError(28, 'No space left on device')
+            },
+        )
+        assert running
+        assert any('Sent 1 review email' in t for t in texts)
+        assert not any('Send failed' in t for t in texts)
+        assert any('No space left on device' in t for t in texts)
+
+    @pytest.mark.asyncio
+    async def test_a_dry_run_is_not_recorded_as_sent(self, gitdir: str) -> None:
+        """--email-dry-run logs the mail and stops there.  Stamping
+        sent-revision on it would make the next real session treat these
+        reviews as already sent and offer none of them."""
+        texts, running = await self._send(gitdir, 'send-dryrun', dryrun=True)
+        assert running
+        assert any('Dry-run' in t for t in texts)
+        assert not any('Sent 0 review email' in t for t in texts)
+
+
 class TestSessionRestorePoint:
     """_prepare_review_session() records where HEAD has to go back to."""
 

-- 
2.53.0


  parent reply	other threads:[~2026-07-31 21:59 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-31 21:58 [PATCH b4 v2 00/44] Stop the editor branch guard from eating review replies Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 01/44] review-tui: mark all outgoing mail as read, not just " Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 02/44] tests: cover the shared outgoing-seen helper Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 03/44] review: close the messages database when auto-marking fails Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 04/44] review: use the same busy timeout for both review databases Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 05/44] review: drop the unused return value from set_flags_bulk() Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 06/44] review: don't let archiving a series raise Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 07/44] tests: cover an unwritable series archive Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 08/44] review-tui: keep post-send bookkeeping out of the send error path Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 09/44] tests: cover the thank-you send's post-send bookkeeping Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 10/44] review-tui: say which way a take did not reach 'accepted' Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 11/44] tests: cover the take statuses in the thank-and-archive chain Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 12/44] review-tui: use the shared helper to delete a review branch Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 13/44] ty: check reachability in the repository the commit landed in Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 14/44] tests: cover the publish check using the repository it is given Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 15/44] edit_in_editor: make the branch guard opt-in Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 16/44] tests: cover the opt-in branch guard in edit_in_editor Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 17/44] edit_in_editor: work in the tree the caller names Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 18/44] tests: cover edit_in_editor working in the caller's tree Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 19/44] ty: edit the thank-you review in the tree it was pointed at Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 20/44] tests: cover the ty review editing in the named tree Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 21/44] tui: route editor launches through one non-fatal helper Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 22/44] tests: cover an editor failure leaving the review TUI standing Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 23/44] review-tui: only put back a branch b4 checked out itself Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 24/44] tests: cover the review TUI's branch-restore guard Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 25/44] review-tui: put HEAD back where it was when it was not on a branch Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 26/44] tests: cover the restore from a detached HEAD Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 27/44] tests: pin the default branch in the queue-delivery fixture Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 28/44] ty: an unknown remote tip is undetermined, not unpublished Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 29/44] review-tui: keep post-send bookkeeping out of the review send error path Christian Brauner
2026-07-31 21:59 ` Christian Brauner [this message]
2026-07-31 21:59 ` [PATCH b4 v2 31/44] review: close the tracking database when archiving fails Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 32/44] review: clean up a review branch that cannot be finished Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 33/44] tests: cover create_review_branch cleaning up a half-built branch Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 34/44] review-tui: put the branch back after a revision upgrade Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 35/44] tests: cover the revision upgrade's branch handling Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 36/44] review-tui: restore the original branch however the tracking loop ends Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 37/44] review-tui: do not let a failed tracking load skip the branch restore Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 38/44] tests: cover the tracking TUI restoring the branch on the way out Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 39/44] review-tui: close the tracking database when the status sync fails Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 40/44] tests: cover the status sync closing its database Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 41/44] review-tui: catch the exit a failed checkout reports itself with Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 42/44] tests: cover a failed checkout leaving the tracking list standing Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 43/44] review-tui: put the user back when the branch they are on is deleted Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 44/44] tests: cover the branch delete leaving the worktree on a branch Christian Brauner
2026-08-03 14:59 ` [PATCH b4 v2 00/44] Stop the editor branch guard from eating review replies Konstantin Ryabitsev

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260731-work-b4-editor-branch-guard-v2-30-243fd19d322d@kernel.org \
    --to=brauner@kernel.org \
    --cc=konstantin@linuxfoundation.org \
    --cc=tools@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox