git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v3 2/2] rebase-interactive: warn if commit is dropped with `rebase --edit-todo'

From
Alban Gruin <alban.gruin@gmail.com>
Date
Dec 2, 2019, 23:47 UTC
Message-ID
<20191202234759.26201-3-alban.gruin@gmail.com>
In-Reply-To
<20191202234759.26201-1-alban.gruin@gmail.com>

When set to "warn" or "error", `rebase.missingCommitsCheck' would make `rebase -i' warn if the user removed commits from the todo list to prevent mistakes. Unfortunately, `rebase --edit-todo' and `rebase --continue' don't take it into account.

This adds the ability for `rebase --edit-todo' and `rebase --continue' to check if commits were dropped by the user. As both edit_todo_list() and complete_action() parse the todo list and check for dropped commits, the code doing so in the latter is removed to reduce duplication. `edit_todo_list_advice' is removed from sequencer.c as it is no longer used there.

This changes when a backup of the todo list is made. Until now, it was saved only before the initial edit. Now, it is always performed before the todo list is edited. Without this, sequencer_continue() (`rebase --continue') could only compare the current todo list against the original, unedited list. Before this change, this file was only used by edit_todo_list() and `rebase -p' to create the backup before the initial edit, and check_todo_list_from_file(), only used by `rebase -p' to check for dropped commits after its own initial edit.

Three tests are added to t3404. The tests for `rebase.missingCommitsCheck = warn' and `rebase.missingCommitsCheck = error' have a similar structure. First, we start a rebase with an incorrect command on the first line. Then, we edit the todo list, removing the first and the last lines. This demonstrates that `--edit-todo' notices dropped commits, but not when the command is incorrect. Then, we restore the original todo list, and edit it to remove the last line. This demonstrates that if we add a commit after the initial edit, then remove it, `--edit-todo' will notice that it has been dropped. Then, the actual rebase takes place. In the third test, it is also checked that `--continue' will refuse to resume the rebase if commits were dropped.

Signed-off-by: Alban Gruin <alban.gruin@gmail.com>
---
 rebase-interactive.c          | 22 ++++++----
 sequencer.c                   | 24 +++++-----
 t/t3404-rebase-interactive.sh | 83 +++++++++++++++++++++++++++++++++++
 3 files changed, 110 insertions(+), 19 deletions(-)
diff --git a/rebase-interactive.c b/rebase-interactive.c
index ad5dd49c31..80b6a2e7a6 100644
--- a/rebase-interactive.c
+++ b/rebase-interactive.c
@@ -97,7 +97,8 @@ int edit_todo_list(struct repository *r, struct todo_list *todo_list,
 		   struct todo_list *new_todo, const char *shortrevisions,
 		   const char *shortonto, unsigned flags)
 {
-	const char *todo_file = rebase_path_todo();
+	const char *todo_file = rebase_path_todo(),
+		*todo_backup = rebase_path_todo_backup();
 	unsigned initial = shortrevisions && shortonto;
 
 	/* If the user is editing the todo list, we first try to parse
@@ -110,9 +111,9 @@ int edit_todo_list(struct repository *r, struct todo_list *todo_list,
 				    -1, flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP))
 		return error_errno(_("could not write '%s'"), todo_file);
 
-	if (initial && copy_file(rebase_path_todo_backup(), todo_file, 0666))
-		return error(_("could not copy '%s' to '%s'."), todo_file,
-			     rebase_path_todo_backup());
+	unlink(todo_backup);
+	if (copy_file(todo_backup, todo_file, 0666))
+		return error(_("could not copy '%s' to '%s'."), todo_file, todo_backup);
 
 	if (launch_sequence_editor(todo_file, &new_todo->buf, NULL))
 		return -2;
@@ -121,10 +122,13 @@ int edit_todo_list(struct repository *r, struct todo_list *todo_list,
 	if (initial && new_todo->buf.len == 0)
 		return -3;
 
-	/* For the initial edit, the todo list gets parsed in
-	 * complete_action(). */
-	if (!initial)
-		return todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);
+	if (todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo)) {
+		fprintf(stderr, _(edit_todo_list_advice));
+		return -4;
+	}
+
+	if (todo_list_check(todo_list, new_todo))
+		return -4;
 
 	return 0;
 }
@@ -189,6 +193,8 @@ int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo)
 		"the level of warnings.\n"
 		"The possible behaviours are: ignore, warn, error.\n\n"));
 
+	fprintf(stderr, _(edit_todo_list_advice));
+
 leave_check:
 	clear_commit_seen(&commit_seen);
 	return res;
diff --git a/sequencer.c b/sequencer.c
index 181bb35f5f..75d5ad0496 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -4271,8 +4271,20 @@ int sequencer_continue(struct repository *r, struct replay_opts *opts)
 	if (read_populate_opts(opts))
 		return -1;
 	if (is_rebase_i(opts)) {
+		struct todo_list backup = TODO_LIST_INIT;
+
 		if ((res = read_populate_todo(r, &todo_list, opts)))
 			goto release_todo_list;
+
+		if (strbuf_read_file(&backup.buf, rebase_path_todo_backup(), 0) > 0) {
+			todo_list_parse_insn_buffer(r, backup.buf.buf, &backup);
+			res = todo_list_check(&backup, &todo_list);
+			todo_list_release(&backup);
+
+			if (res)
+				goto release_todo_list;
+		}
+
 		if (commit_staged_changes(r, opts, &todo_list))
 			return -1;
 	} else if (!file_exists(get_todo_path(opts)))
@@ -4986,12 +4998,6 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 	return res;
 }
 
-static const char edit_todo_list_advice[] =
-N_("You can fix this with 'git rebase --edit-todo' "
-"and then run 'git rebase --continue'.\n"
-"Or you can abort the rebase with 'git rebase"
-" --abort'.\n");
-
 /* skip picking commits whose parents are unchanged */
 static int skip_unnecessary_picks(struct repository *r,
 				  struct todo_list *todo_list,
@@ -5089,11 +5095,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		todo_list_release(&new_todo);
 
 		return error(_("nothing to do"));
-	}
-
-	if (todo_list_parse_insn_buffer(r, new_todo.buf.buf, &new_todo) ||
-	    todo_list_check(todo_list, &new_todo)) {
-		fprintf(stderr, _(edit_todo_list_advice));
+	} else if (res == -4) {
 		checkout_onto(r, opts, onto_name, &onto->object.oid, orig_head);
 		todo_list_release(&new_todo);
 
diff --git a/t/t3404-rebase-interactive.sh b/t/t3404-rebase-interactive.sh
index 29a35840ed..9051c1e11d 100755
--- a/t/t3404-rebase-interactive.sh
+++ b/t/t3404-rebase-interactive.sh
@@ -1343,6 +1343,89 @@ test_expect_success 'rebase -i respects rebase.missingCommitsCheck = error' '
 	test B = $(git cat-file commit HEAD^ | sed -ne \$p)
 '
 
+test_expect_success 'rebase --edit-todo respects rebase.missingCommitsCheck = ignore' '
+	test_config rebase.missingCommitsCheck ignore &&
+	rebase_setup_and_clean missing-commit &&
+	set_fake_editor &&
+	FAKE_LINES="break 1 2 3 4 5" git rebase -i --root &&
+	FAKE_LINES="1 2 3 4" git rebase --edit-todo 2>actual &&
+	git rebase --continue 2>actual &&
+	test D = $(git cat-file commit HEAD | sed -ne \$p) &&
+	test_i18ngrep \
+		"Successfully rebased and updated refs/heads/missing-commit" \
+		actual
+'
+
+test_expect_success 'rebase --edit-todo respects rebase.missingCommitsCheck = warn' '
+	cat >expect <<-EOF &&
+	error: invalid line 1: badcmd $(git rev-list --pretty=oneline --abbrev-commit -1 master~4)
+	Warning: some commits may have been dropped accidentally.
+	Dropped commits (newer to older):
+	 - $(git rev-list --pretty=oneline --abbrev-commit -1 master)
+	To avoid this message, use "drop" to explicitly remove a commit.
+	EOF
+	tail -n4 expect >expect.2 &&
+	test_config rebase.missingCommitsCheck warn &&
+	rebase_setup_and_clean missing-commit &&
+	set_fake_editor &&
+	test_must_fail env FAKE_LINES="bad 1 2 3 4 5" \
+		git rebase -i --root &&
+	cp .git/rebase-merge/git-rebase-todo.backup orig &&
+	FAKE_LINES="2 3 4" git rebase --edit-todo 2>actual.2 &&
+	head -n5 actual.2 >actual &&
+	test_i18ncmp expect actual &&
+	cp orig .git/rebase-merge/git-rebase-todo &&
+	FAKE_LINES="1 2 3 4" git rebase --edit-todo 2>actual.2 &&
+	head -n4 actual.2 >actual &&
+	test_i18ncmp expect.2 actual &&
+	git rebase --continue 2>actual &&
+	test D = $(git cat-file commit HEAD | sed -ne \$p) &&
+	test_i18ngrep \
+		"Successfully rebased and updated refs/heads/missing-commit" \
+		actual
+'
+
+test_expect_success 'rebase --edit-todo respects rebase.missingCommitsCheck = error' '
+	cat >expect <<-EOF &&
+	error: invalid line 1: badcmd $(git rev-list --pretty=oneline --abbrev-commit -1 master~4)
+	Warning: some commits may have been dropped accidentally.
+	Dropped commits (newer to older):
+	 - $(git rev-list --pretty=oneline --abbrev-commit -1 master)
+	To avoid this message, use "drop" to explicitly remove a commit.
+
+	Use '\''git config rebase.missingCommitsCheck'\'' to change the level of warnings.
+	The possible behaviours are: ignore, warn, error.
+
+	You can fix this with '\''git rebase --edit-todo'\'' and then run '\''git rebase --continue'\''.
+	Or you can abort the rebase with '\''git rebase --abort'\''.
+	EOF
+	tail -n10 expect >expect.2 &&
+	test_config rebase.missingCommitsCheck error &&
+	rebase_setup_and_clean missing-commit &&
+	set_fake_editor &&
+	test_must_fail env FAKE_LINES="bad 1 2 3 4 5" \
+		git rebase -i --root &&
+	cp .git/rebase-merge/git-rebase-todo.backup orig &&
+	test_must_fail env FAKE_LINES="2 3 4" \
+		git rebase --edit-todo 2>actual &&
+	test_i18ncmp expect actual &&
+	test_must_fail git rebase --continue 2>actual &&
+	test_i18ncmp expect actual &&
+	cp orig .git/rebase-merge/git-rebase-todo &&
+	test_must_fail env FAKE_LINES="1 2 3 4" \
+		git rebase --edit-todo 2>actual &&
+	test_i18ncmp expect.2 actual &&
+	test_must_fail git rebase --continue 2>actual &&
+	test_i18ncmp expect.2 actual &&
+	cp orig .git/rebase-merge/git-rebase-todo &&
+	FAKE_LINES="1 2 3 4 drop 5" git rebase --edit-todo &&
+	git rebase --continue 2>actual &&
+	test D = $(git cat-file commit HEAD | sed -ne \$p) &&
+	test_i18ngrep \
+		"Successfully rebased and updated refs/heads/missing-commit" \
+		actual
+'
+
 test_expect_success 'respects rebase.abbreviateCommands with fixup, squash and exec' '
 	rebase_setup_and_clean abbrevcmd &&
 	test_commit "first" file1.txt "first line" first &&

-- 
2.24.0
Previous: Johannes SchindelinNext: Junio C Hamano
Message 32 of 57 in “rebase -i: extend rebase.missingCommitsCheck to `--edit-todo' and co.”
  1. 0/9 rebase -i: extend rebase.missingCommitsCheck to `--edit-todo' and co.Alban Gruin, Jul 17, 2019
  2. 1/9 t3404: demonstrate that --edit-todo does not check for dropped commitsAlban Gruin, Jul 17, 2019
  3. Junio C HamanoJul 18, 2019
  4. Alban GruinJul 19, 2019
  5. Junio C HamanoJul 19, 2019
  6. 2/9 t3429: demonstrate that rebase exec does not check for dropped commitsAlban Gruin, Jul 17, 2019
  7. 3/9 sequencer: update `total_nr' when adding an item to a todo listAlban Gruin, Jul 17, 2019
  8. Junio C HamanoJul 18, 2019
  9. Alban GruinJul 19, 2019
  10. 4/9 sequencer: update `done_nr' when skipping commands in a todo listAlban Gruin, Jul 17, 2019
  11. Junio C HamanoJul 18, 2019
  12. Alban GruinJul 19, 2019
  13. 5/9 sequencer: move the code writing total_nr on the disk to a new functionAlban Gruin, Jul 17, 2019
  14. Junio C HamanoJul 18, 2019
  15. Alban GruinJul 19, 2019
  16. 6/9 sequencer: add a parameter to sequencer_continue() to accept a todo listAlban Gruin, Jul 17, 2019
  17. 7/9 rebase-interactive: todo_list_check() also uses the done listAlban Gruin, Jul 17, 2019
  18. 8/9 rebase-interactive: warn if commit is dropped with --edit-todoAlban Gruin, Jul 17, 2019
  19. 9/9 sequencer: have read_populate_todo() check for dropped commitsAlban Gruin, Jul 17, 2019
  20. Phillip WoodJul 24, 2019
  21. Johannes SchindelinJul 25, 2019
  22. Alban GruinJul 25, 2019
  23. Phillip WoodJul 29, 2019
  24. Alban GruinSep 24, 2019
  25. 0/2 rebase -i: extend rebase.missingCommitsCheck to `--edit-todo'Alban Gruin, Nov 4, 2019
  26. 1/2 t3404: demonstrate that --edit-todo does not check for dropped commitsAlban Gruin, Nov 4, 2019
  27. 2/2 rebase-interactive: warn if commit is dropped with --edit-todoAlban Gruin, Nov 4, 2019
  28. Phillip WoodNov 5, 2019
  29. 0/2 rebase -i: extend rebase.missingCommitsCheckAlban Gruin, Dec 2, 2019
  30. 1/2 sequencer: move check_todo_list_from_file() to rebase-interactive.cAlban Gruin, Dec 2, 2019
  31. Johannes SchindelinDec 6, 2019
  32. 2/2 rebase-interactive: warn if commit is dropped with `rebase --edit-todo'Alban Gruin, Dec 2, 2019
  33. Junio C HamanoDec 4, 2019
  34. Phillip WoodDec 9, 2019
  35. Alban GruinJan 9, 2020
  36. Phillip WoodJan 10, 2020
  37. Alban GruinJan 10, 2020
  38. Phillip WoodJan 11, 2020
  39. Phillip WoodDec 9, 2019
  40. Junio C HamanoDec 4, 2019
  41. Alban GruinDec 5, 2019
  42. Phillip WoodDec 6, 2019
  43. Johannes SchindelinDec 6, 2019
  44. 0/2 rebase -i: extend rebase.missingCommitsCheckAlban Gruin, Jan 11, 2020
  45. 1/2 sequencer: move check_todo_list_from_file() to rebase-interactive.cAlban Gruin, Jan 11, 2020
  46. 2/2 rebase-interactive: warn if commit is dropped with `rebase --edit-todo'Alban Gruin, Jan 11, 2020
  47. Phillip WoodJan 19, 2020
  48. Alban GruinJan 25, 2020
  49. 0/2 rebase -i: extend rebase.missingCommitsCheckAlban Gruin, Jan 25, 2020
  50. 1/2 sequencer: move check_todo_list_from_file() to rebase-interactive.cAlban Gruin, Jan 25, 2020
  51. 2/2 rebase-interactive: warn if commit is dropped with `rebase --edit-todo'Alban Gruin, Jan 25, 2020
  52. Johannes SchindelinJan 26, 2020
  53. Alban GruinJan 27, 2020
  54. Johannes SchindelinJan 28, 2020
  55. 0/2 rebase -i: extend rebase.missingCommitsCheckAlban Gruin, Jan 28, 2020
  56. 1/2 sequencer: move check_todo_list_from_file() to rebase-interactive.cAlban Gruin, Jan 28, 2020
  57. 2/2 rebase-interactive: warn if commit is dropped with `rebase --edit-todo'Alban Gruin, Jan 28, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.