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 16/44] tests: cover the opt-in branch guard in edit_in_editor
Date: Fri, 31 Jul 2026 23:58:57 +0200	[thread overview]
Message-ID: <20260731-work-b4-editor-branch-guard-v2-16-243fd19d322d@kernel.org> (raw)
In-Reply-To: <20260731-work-b4-editor-branch-guard-v2-0-243fd19d322d@kernel.org>

A caller that does not opt in keeps its text across a branch switch.
One that does is refused and the text is kept in a temporary file.

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

diff --git a/src/tests/test___init__.py b/src/tests/test___init__.py
index b02ed12..d9addac 100644
--- a/src/tests/test___init__.py
+++ b/src/tests/test___init__.py
@@ -1234,3 +1234,67 @@ def test_git_run_command_log_fixup_looks_past_option_prefix(gitdir: str) -> None
     assert out.startswith('commit '), out
     sha = out.split('\n', 1)[0].split()[1]
     assert len(sha) == 40, f'log abbreviated the sha despite the fixup: {sha}'
+
+
+def _fake_editor(tmp_path: pathlib.Path, body: str) -> str:
+    """A stand-in $EDITOR that runs *body* and leaves the buffer alone."""
+    script = tmp_path / 'fake-editor.sh'
+    script.write_text(f'#!/bin/sh\n{body}\n')
+    script.chmod(0o755)
+    return str(script)
+
+
+def test_edit_in_editor_without_guard_survives_branch_switch(
+    gitdir: str, tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Callers that write to an explicit ref get their text back even if HEAD
+    moved while the editor was open.
+
+    The review TUI stores replies on the review branch and reads the patch it
+    is replying to by SHA, so a branch switch -- its own, or the user's in
+    another terminal sharing the worktree -- is none of its business."""
+    monkeypatch.setenv(
+        'GIT_EDITOR', _fake_editor(tmp_path, f'git -C "{gitdir}" checkout -q -b side')
+    )
+    assert b4.edit_in_editor(b'my reply\n', filehint='reply.eml') == b'my reply\n'
+    assert b4.git_get_current_branch(gitdir) == 'side'
+
+
+def test_edit_in_editor_guard_refuses_branch_switch(
+    gitdir: str, tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """A caller that opts in is refused when HEAD has moved on, and its text
+    is preserved in a temporary file."""
+    monkeypatch.setenv(
+        'GIT_EDITOR', _fake_editor(tmp_path, f'git -C "{gitdir}" checkout -q -b side')
+    )
+    with pytest.raises(RuntimeError, match='Branch changed during file editing') as ex:
+        b4.edit_in_editor(b'my cover\n', guard_branch=True)
+
+    saved = pathlib.Path(str(ex.value).split(' saved at ')[-1])
+    try:
+        assert saved.read_bytes() == b'my cover\n'
+    finally:
+        saved.unlink()
+
+
+def test_edit_in_editor_guard_covers_a_detached_head(
+    gitdir: str, tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Starting detached is still a starting point worth guarding.
+
+    'b4 trailers -u' does not require a prep branch, so it can run with HEAD
+    detached and rewrite whatever branch is current when it applies."""
+    ecode, out = b4.git_run_command(gitdir, ['checkout', '-q', '--detach'])
+    assert ecode == 0, out
+    monkeypatch.setenv(
+        'GIT_EDITOR', _fake_editor(tmp_path, f'git -C "{gitdir}" checkout -q -b side')
+    )
+    with pytest.raises(RuntimeError, match='Branch changed during file editing') as ex:
+        b4.edit_in_editor(b'my trailers\n', guard_branch=True)
+
+    saved = pathlib.Path(str(ex.value).split(' saved at ')[-1])
+    try:
+        assert saved.read_bytes() == b'my trailers\n'
+    finally:
+        saved.unlink()

-- 
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 ` Christian Brauner [this message]
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 ` [PATCH b4 v2 30/44] tests: cover the review send's post-send bookkeeping Christian Brauner
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-16-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