1 # Helper functions used by interactive rebase tests.
3 # After setting the fake editor with this function, you can
5 # - override the commit message with $FAKE_COMMIT_MESSAGE
6 # - amend the commit message with $FAKE_COMMIT_AMEND
7 # - copy the original commit message to a file with $FAKE_MESSAGE_COPY
8 # - check that non-commit messages have a certain line count with $EXPECT_COUNT
9 # - check the commit count in the commit message header with $EXPECT_HEADER_COUNT
10 # - rewrite a rebase -i script as directed by $FAKE_LINES.
11 # $FAKE_LINES consists of a sequence of words separated by spaces.
12 # The following word combinations are possible:
14 # "<lineno>" -- add a "pick" line with the SHA1 taken from the
17 # "<cmd> <lineno>" -- add a line with the specified command
18 # ("pick", "squash", "fixup", "edit", "reword" or "drop") and the
19 # SHA1 taken from the specified line.
21 # "exec_cmd_with_args" -- add an "exec cmd with args" line.
23 # "#" -- Add a comment line.
25 # ">" -- Add a blank line.
28 write_script fake-editor.sh <<-\EOF
31 test -z "$EXPECT_HEADER_COUNT" ||
32 test "$EXPECT_HEADER_COUNT" = "$(sed -n '1s/^# This is a combination of \(.*\) commits\./\1/p' < "$1")" ||
34 test -z "$FAKE_COMMIT_MESSAGE" || echo "$FAKE_COMMIT_MESSAGE" > "$1"
35 test -z "$FAKE_COMMIT_AMEND" || echo "$FAKE_COMMIT_AMEND" >> "$1"
36 test -z "$FAKE_MESSAGE_COPY" || cat "$1" >"$FAKE_MESSAGE_COPY"
40 test -z "$EXPECT_COUNT" ||
41 test "$EXPECT_COUNT" = $(sed -e '/^#/d' -e '/^$/d' < "$1" | wc -l) ||
43 test -z "$FAKE_LINES" && exit
44 grep -v '^#' < "$1" > "$1".tmp
46 echo 'rebase -i script before editing:'
49 for line in $FAKE_LINES; do
51 pick|p|squash|s|fixup|f|edit|e|reword|r|drop|d|label|l|reset|r|merge|m)
54 echo "$line" | sed 's/_/ /g' >> "$1";;
56 action=$(echo "$line" | sed 's/_/ /g');;
58 echo '# comment' >> "$1";;
64 test \& != "$action" || action=pick
65 echo "$action XXXXXXX False commit" >> "$1"
68 sed -n "${line}s/^[a-z][a-z]*/$action/p" < "$1".tmp >> "$1"
72 echo 'rebase -i script after editing:'
76 test_set_editor "$(pwd)/fake-editor.sh"
79 # After set_cat_todo_editor, rebase -i will write the todo list (ignoring
80 # blank lines and comments) to stdout, and exit failure (so you should run
81 # it with test_must_fail). This can be used to verify the expected user
82 # experience, for todo list changes that do not affect the outcome of
83 # rebase; or as an extra check in addition to checking the outcome.
85 set_cat_todo_editor () {
86 write_script fake-editor.sh <<-\EOF
90 test_set_editor "$(pwd)/fake-editor.sh"
93 # checks that the revisions in "$2" represent a linear range with the
95 test_linear_range () {
96 revlist_merges=$(git rev-list --merges "$2") &&
97 test -z "$revlist_merges" &&
99 set -- $(git log --reverse --format=%s "$2")
100 test "$expected" = "$*"
104 test_might_fail git rebase --abort &&
110 git cherry-pick -n "$2" &&
111 git commit -m "$1" &&
116 git revert -n "$2" &&
117 git commit -m "$1" &&
122 git commit --allow-empty -m "$1" &&
126 # Call this (inside test_expect_success) at the end of a test file to
127 # check that no tests have changed editor related environment
128 # variables or config settings
129 test_editor_unchanged () {
130 # We're only interested in exported variables hence 'sh -c'
131 sh -c 'cat >actual <<-EOF
133 FAKE_COMMIT_AMEND=$FAKE_COMMIT_AMEND
134 FAKE_COMMIT_MESSAGE=$FAKE_COMMIT_MESSAGE
135 FAKE_LINES=$FAKE_LINES
136 GIT_EDITOR=$GIT_EDITOR
137 GIT_SEQUENCE_EDITOR=$GIT_SEQUENCE_EDITOR
138 core.editor=$(git config core.editor)
139 sequence.editor=$(git config sequence.editor)
151 test_cmp expect actual