[2/4] branch: check for bisects and rebases

Commit Message

Derrick Stolee June 8, 2022, 8:09 p.m. UTC

From: Derrick Stolee <[e-mail]>

The branch_checked_out() helper was added by the previous change, but it
used an over-simplified view to check if a branch is checked out. It
only focused on the HEAD symref, but ignored whether a bisect or rebase
was happening.

Teach branch_checked_out() to check for these things, and also add tests
to ensure that we do not lose this functionality in the future.

Now that this test coverage exists, we can safely refactor
validate_new_branchname() to use branch_checked_out().

Note that we need to prepend "refs/heads/" to the 'state.branch' after
calling wt_status_check_*(). We also need to duplicate wt->path so the
value is not freed at the end of the call.

Signed-off-by: Derrick Stolee <[e-mail]>
---
 branch.c                  | 35 +++++++++++++++++++++++++++--------
 t/t2407-worktree-heads.sh | 29 +++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+), 8 deletions(-)

Comments

Junio C Hamano June 8, 2022, 10:03 p.m. UTC | #1

"Derrick Stolee via GitGitGadget" <[e-mail]> writes:

> diff --git a/t/t2407-worktree-heads.sh b/t/t2407-worktree-heads.sh
> index dd905dc1a5c..12faca7f655 100755
> --- a/t/t2407-worktree-heads.sh
> +++ b/t/t2407-worktree-heads.sh
> @@ -21,4 +21,33 @@ test_expect_success 'refuse to overwrite: checked out in worktree' '
>  	done
>  '
>  
> +test_expect_success 'refuse to overwrite: worktree in bisect' '
> +	test_when_finished test_might_fail git -C wt-4 bisect reset &&
> +
> +	(
> +		git -C wt-4 bisect start &&
> +		git -C wt-4 bisect bad HEAD &&
> +		git -C wt-4 bisect good HEAD~3
> +	) &&
> +
> +	test_must_fail git branch -f wt-4 HEAD 2>err &&
> +	grep "cannot force update the branch '\''wt-4'\'' checked out at" err
> +'
> +
> +. "$TEST_DIRECTORY"/lib-rebase.sh
> +
> +test_expect_success 'refuse to overwrite: worktree in rebase' '
> +	test_when_finished test_might_fail git -C wt-4 rebase --abort &&
> +
> +	(
> +		set_fake_editor &&
> +		FAKE_LINES="edit 1 2 3" \
> +			git -C wt-4 rebase -i HEAD~3 >rebase &&
> +		git -C wt-4 status
> +	) &&
> +
> +	test_must_fail git branch -f wt-4 HEAD 2>err &&
> +	grep "cannot force update the branch '\''wt-4'\'' checked out at" err
> +'
> +
>  test_done

Nice to see that each additional feature corresponds to each
additional test.

Thanks.

Patch

diff --git a/branch.c b/branch.c
index 061a11f3415..c0fe6ea0b65 100644
--- a/branch.c
+++ b/branch.c
@@ -385,6 +385,7 @@  static void prepare_checked_out_branches(void)
 	worktrees = get_worktrees();
 
 	while (worktrees[i]) {
+		struct wt_status_state state = { 0 };
 		struct worktree *wt = worktrees[i++];
 
 		if (wt->is_bare)
@@ -394,6 +395,29 @@  static void prepare_checked_out_branches(void)
 			strmap_put(&current_checked_out_branches,
 				   wt->head_ref,
 				   xstrdup(wt->path));
+
+		if (wt_status_check_rebase(wt, &state) &&
+		    (state.rebase_in_progress || state.rebase_interactive_in_progress) &&
+		    state.branch) {
+			struct strbuf ref = STRBUF_INIT;
+			strbuf_addf(&ref, "refs/heads/%s", state.branch);
+			strmap_put(&current_checked_out_branches,
+				   ref.buf,
+				   xstrdup(wt->path));
+			strbuf_release(&ref);
+		}
+		wt_status_state_free_buffers(&state);
+
+		if (wt_status_check_bisect(wt, &state) &&
+		    state.branch) {
+			struct strbuf ref = STRBUF_INIT;
+			strbuf_addf(&ref, "refs/heads/%s", state.branch);
+			strmap_put(&current_checked_out_branches,
+				   ref.buf,
+				   xstrdup(wt->path));
+			strbuf_release(&ref);
+		}
+		wt_status_state_free_buffers(&state);
 	}
 
 	free_worktrees(worktrees);
@@ -419,9 +443,7 @@  int branch_checked_out(const char *refname, char **path)
  */
 int validate_new_branchname(const char *name, struct strbuf *ref, int force)
 {
-	struct worktree **worktrees;
-	const struct worktree *wt;
-
+	char *path;
 	if (!validate_branchname(name, ref))
 		return 0;
 
@@ -429,13 +451,10 @@  int validate_new_branchname(const char *name, struct strbuf *ref, int force)
 		die(_("a branch named '%s' already exists"),
 		    ref->buf + strlen("refs/heads/"));
 
-	worktrees = get_worktrees();
-	wt = find_shared_symref(worktrees, "HEAD", ref->buf);
-	if (wt && !wt->is_bare)
+	if (branch_checked_out(ref->buf, &path))
 		die(_("cannot force update the branch '%s' "
 		      "checked out at '%s'"),
-		    ref->buf + strlen("refs/heads/"), wt->path);
-	free_worktrees(worktrees);
+		    ref->buf + strlen("refs/heads/"), path);
 
 	return 1;
 }
diff --git a/t/t2407-worktree-heads.sh b/t/t2407-worktree-heads.sh
index dd905dc1a5c..12faca7f655 100755
--- a/t/t2407-worktree-heads.sh
+++ b/t/t2407-worktree-heads.sh
@@ -21,4 +21,33 @@  test_expect_success 'refuse to overwrite: checked out in worktree' '
 	done
 '
 
+test_expect_success 'refuse to overwrite: worktree in bisect' '
+	test_when_finished test_might_fail git -C wt-4 bisect reset &&
+
+	(
+		git -C wt-4 bisect start &&
+		git -C wt-4 bisect bad HEAD &&
+		git -C wt-4 bisect good HEAD~3
+	) &&
+
+	test_must_fail git branch -f wt-4 HEAD 2>err &&
+	grep "cannot force update the branch '\''wt-4'\'' checked out at" err
+'
+
+. "$TEST_DIRECTORY"/lib-rebase.sh
+
+test_expect_success 'refuse to overwrite: worktree in rebase' '
+	test_when_finished test_might_fail git -C wt-4 rebase --abort &&
+
+	(
+		set_fake_editor &&
+		FAKE_LINES="edit 1 2 3" \
+			git -C wt-4 rebase -i HEAD~3 >rebase &&
+		git -C wt-4 status
+	) &&
+
+	test_must_fail git branch -f wt-4 HEAD 2>err &&
+	grep "cannot force update the branch '\''wt-4'\'' checked out at" err
+'
+
 test_done