threads / patch / 11212

patchInteractive editor tests for commit-msg hook

Subject: [PATCH] Interactive editor tests for commit-msg hook

## tl;dr

4 messages between Dec 9, 2007 and Dec 10, 2007. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

Wincent Colaiuta· Dec 9, 2007, 12:52 UTC · lore

Supplement the existing tests for the commit-msg hook (which all use "git commit -m") with tests which use an interactive editor (no -m switch) to ensure that all code paths get tested.

Signed-off-by: Wincent Colaiuta <win@wincent.com>
---

I didn't add similar tests for the pre-commit hook because I don't think that's an interesting code path; we don't care about the commit message in that case, only whether the commit is allowed to proceed or not.

 t/t7504-commit-msg-hook.sh |   72 ++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 72 insertions(+), 0 deletions(-)

Show changes to t/t7504-commit-msg-hook.sh +72 −0

diff --git a/t/t7504-commit-msg-hook.sh b/t/t7504-commit-msg-hook.sh
index 17aad7c..e154bab 100755
--- a/t/t7504-commit-msg-hook.sh
+++ b/t/t7504-commit-msg-hook.sh
@@ -9,11 +9,33 @@ test_expect_success "with no hook" \
 	 git add file &&
 	 git commit -m 'first'"
 
+# set up fake editor for interactive editing
+cat > fake-editor <<'EOF'
+#!/bin/sh
+cp FAKE_MSG "$1"
+exit 0
+EOF
+chmod +x fake-editor
+FAKE_EDITOR="$(pwd)/fake-editor"
+export FAKE_EDITOR
+
+test_expect_success "with no hook (editor)" \
+	"echo 'more foo' >> file &&
+	 git add file &&
+	 echo 'more foo' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit"
+
 test_expect_success "--no-verify with no hook" \
 	"echo 'bar' > file &&
 	 git add file &&
 	 git commit --no-verify -m 'bar'"
 
+test_expect_success "--no-verify with no hook (editor)" \
+	"echo 'more bar' > file &&
+	 git add file &&
+	 echo 'more bar' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify"
+
 # now install hook that always succeeds
 HOOKDIR="$(git rev-parse --git-dir)/hooks"
 HOOK="$HOOKDIR/commit-msg"
@@ -29,11 +51,23 @@ test_expect_success "with succeeding hook" \
 	 git add file &&
 	 git commit -m 'more'"
 
+test_expect_success "with succeeding hook (editor)" \
+	"echo 'more more' >> file &&
+	 git add file &&
+	 echo 'more more' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit"
+
 test_expect_success "--no-verify with succeeding hook" \
 	"echo 'even more' >> file &&
 	 git add file &&
 	 git commit --no-verify -m 'even more'"
 
+test_expect_success "--no-verify with succeeding hook (editor)" \
+	"echo 'even more more' >> file &&
+	 git add file &&
+	 echo 'even more more' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify"
+
 # now a hook that fails
 cat > "$HOOK" <<EOF
 #!/bin/sh
@@ -45,22 +79,46 @@ test_expect_failure "with failing hook" \
 	 git add file &&
 	 git commit -m 'another'"
 
+test_expect_failure "with failing hook (editor)" \
+	"echo 'more another' >> file &&
+	 git add file &&
+	 echo 'more another' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit"
+
 test_expect_success "--no-verify with failing hook" \
 	"echo 'stuff' >> file &&
 	 git add file &&
 	 git commit --no-verify -m 'stuff'"
 
+test_expect_success "--no-verify with failing hook (editor)" \
+	"echo 'more stuff' >> file &&
+	 git add file &&
+	 echo 'more stuff' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify"
+
 chmod -x "$HOOK"
 test_expect_success "with non-executable hook" \
 	"echo 'content' >> file &&
 	 git add file &&
 	 git commit -m 'content'"
 
+test_expect_success "with non-executable hook (editor)" \
+	"echo 'content again' >> file &&
+	 git add file &&
+	 echo 'content again' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit -m 'content again'"
+
 test_expect_success "--no-verify with non-executable hook" \
 	"echo 'more content' >> file &&
 	 git add file &&
 	 git commit --no-verify -m 'more content'"
 
+test_expect_success "--no-verify with non-executable hook (editor)" \
+	"echo 'even more content' >> file &&
+	 git add file &&
+	 echo 'even more content' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify"
+
 # now a hook that edits the commit message
 cat > "$HOOK" <<'EOF'
 #!/bin/sh
@@ -79,10 +137,24 @@ test_expect_success "hook edits commit message" \
 	 git commit -m 'additional' &&
 	 commit_msg_is 'new message'"
 
+test_expect_success "hook edits commit message (editor)" \
+	"echo 'additional content' >> file &&
+	 git add file &&
+	 echo 'additional content' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit &&
+	 commit_msg_is 'new message'"
+
 test_expect_success "hook doesn't edit commit message" \
 	"echo 'plus' >> file &&
 	 git add file &&
 	 git commit --no-verify -m 'plus' &&
 	 commit_msg_is 'plus'"
 
+test_expect_success "hook doesn't edit commit message (editor)" \
+	"echo 'more plus' >> file &&
+	 git add file &&
+	 echo 'more plus' > FAKE_MSG &&
+	 GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify &&
+	 commit_msg_is 'more plus'"
+
 test_done

-- 
1.5.3.7.1116.gf11de

Junio C Hamano· Dec 10, 2007, 03:42 UTC · re: Wincent Colaiuta · lore

Re: [PATCH] Interactive editor tests for commit-msg hook

Wincent Colaiuta <win@wincent.com> writes:

> I didn't add similar tests for the pre-commit hook because I don't
> think that's an interesting code path; we don't care about the commit
> message in that case, only whether the commit is allowed to proceed or
> not.

Sensible.

Show 9 quoted lines

> +# set up fake editor for interactive editing
> +cat > fake-editor <<'EOF'
> +#!/bin/sh
> +cp FAKE_MSG "$1"
> +exit 0
> +EOF
> +chmod +x fake-editor
> +FAKE_EDITOR="$(pwd)/fake-editor"
> +export FAKE_EDITOR

Hmm.  Why "export"?

Show 6 quoted lines

> +test_expect_success "with no hook (editor)" \
> +	"echo 'more foo' >> file &&
> +	 git add file &&
> +	 echo 'more foo' > FAKE_MSG &&
> +	 GIT_EDITOR="$FAKE_EDITOR" git commit"
> +

I initially was going to say "this is just a style thing", but I really want our tests to read uniformly like this:

        test_expect_success 'without hook (editor)' '

                echo more foo >>file &&
                git add file &&
                echo more foo >FAKE_MSG &&
                GIT_EDITOR="$FAKE_EDITOR" git commit

 * Use single quotes around test unless there is a compelling reason not
   to;

 * The opening single quote of the test body on the same line as
   expect-success; the end quote at column 1 on a line on its own.

Notice a bug in your version? Dq around $FAKE_EDITOR is stripped away and it is harder to spot it because the script does not follow that style.

Wincent Colaiuta· Dec 10, 2007, 07:32 UTC · re: Junio C Hamano · lore

Re: [PATCH] Interactive editor tests for commit-msg hook

El 10/12/2007, a las 4:42, Junio C Hamano escribió:

Show 11 quoted lines

>> +# set up fake editor for interactive editing
>> +cat > fake-editor <<'EOF'
>> +#!/bin/sh
>> +cp FAKE_MSG "$1"
>> +exit 0
>> +EOF
>> +chmod +x fake-editor
>> +FAKE_EDITOR="$(pwd)/fake-editor"
>> +export FAKE_EDITOR
>
> Hmm.  Why "export"?

Because I'd seen it in other tests (eg. t3404-rebase-interactive.sh), so I just copied the style. If it's not necessary though we can lose it.

> I initially was going to say "this is just a style thing", but I  
> really
> want our tests to read uniformly like this:

Ok, fixed up version will follow in a couple of minutes.

Cheers, Wincent

Wincent Colaiuta· Dec 10, 2007, 07:33 UTC · re: Junio C Hamano · lore

[PATCH 7/7] Interactive editor tests for commit-msg hook

Supplement the existing tests for the commit-msg hook (which all use "git commit -m") with tests which use an interactive editor (no -m switch) to ensure that all code paths get tested.

At the same time the quoting of some of the existing tests is changed to conform to Junio's recommendations for test style (single quotes used around the test unless there is a compelling reason not to, and the opening quote on the same line as the test_expect and the closing quote in column 1).

Signed-off-by: Wincent Colaiuta <win@wincent.com>
---
 t/t7504-commit-msg-hook.sh |  218 +++++++++++++++++++++++++++++++++++---------
 1 files changed, 175 insertions(+), 43 deletions(-)

Show changes to t/t7504-commit-msg-hook.sh +175 −43

diff --git a/t/t7504-commit-msg-hook.sh b/t/t7504-commit-msg-hook.sh
index 17aad7c..751b113 100755
--- a/t/t7504-commit-msg-hook.sh
+++ b/t/t7504-commit-msg-hook.sh
@@ -4,15 +4,49 @@ test_description='commit-msg hook'
 
 . ./test-lib.sh
 
-test_expect_success "with no hook" \
-	"echo 'foo' > file &&
-	 git add file &&
-	 git commit -m 'first'"
+test_expect_success 'with no hook' '
 
-test_expect_success "--no-verify with no hook" \
-	"echo 'bar' > file &&
-	 git add file &&
-	 git commit --no-verify -m 'bar'"
+	echo "foo" > file &&
+	git add file &&
+	git commit -m "first"
+
+'
+
+# set up fake editor for interactive editing
+cat > fake-editor <<'EOF'
+#!/bin/sh
+cp FAKE_MSG "$1"
+exit 0
+EOF
+chmod +x fake-editor
+FAKE_EDITOR="$(pwd)/fake-editor"
+export FAKE_EDITOR
+
+test_expect_success 'with no hook (editor)' '
+
+	echo "more foo" >> file &&
+	git add file &&
+	echo "more foo" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit
+
+'
+
+test_expect_success '--no-verify with no hook' '
+
+	echo "bar" > file &&
+	git add file &&
+	git commit --no-verify -m "bar"
+
+'
+
+test_expect_success '--no-verify with no hook (editor)' '
+
+	echo "more bar" > file &&
+	git add file &&
+	echo "more bar" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify
+
+'
 
 # now install hook that always succeeds
 HOOKDIR="$(git rev-parse --git-dir)/hooks"
@@ -24,15 +58,39 @@ exit 0
 EOF
 chmod +x "$HOOK"
 
-test_expect_success "with succeeding hook" \
-	"echo 'more' >> file &&
-	 git add file &&
-	 git commit -m 'more'"
+test_expect_success 'with succeeding hook' '
 
-test_expect_success "--no-verify with succeeding hook" \
-	"echo 'even more' >> file &&
-	 git add file &&
-	 git commit --no-verify -m 'even more'"
+	echo "more" >> file &&
+	git add file &&
+	git commit -m "more"
+
+'
+
+test_expect_success 'with succeeding hook (editor)' '
+
+	echo "more more" >> file &&
+	git add file &&
+	echo "more more" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit
+
+'
+
+test_expect_success '--no-verify with succeeding hook' '
+
+	echo "even more" >> file &&
+	git add file &&
+	git commit --no-verify -m "even more"
+
+'
+
+test_expect_success '--no-verify with succeeding hook (editor)' '
+
+	echo "even more more" >> file &&
+	git add file &&
+	echo "even more more" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify
+
+'
 
 # now a hook that fails
 cat > "$HOOK" <<EOF
@@ -40,26 +98,74 @@ cat > "$HOOK" <<EOF
 exit 1
 EOF
 
-test_expect_failure "with failing hook" \
-	"echo 'another' >> file &&
-	 git add file &&
-	 git commit -m 'another'"
+test_expect_failure 'with failing hook' '
+
+	echo "another" >> file &&
+	git add file &&
+	git commit -m "another"
+
+'
+
+test_expect_failure 'with failing hook (editor)' '
+
+	echo "more another" >> file &&
+	git add file &&
+	echo "more another" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit
 
-test_expect_success "--no-verify with failing hook" \
-	"echo 'stuff' >> file &&
-	 git add file &&
-	 git commit --no-verify -m 'stuff'"
+'
+
+test_expect_success '--no-verify with failing hook' '
+
+	echo "stuff" >> file &&
+	git add file &&
+	git commit --no-verify -m "stuff"
+
+'
+
+test_expect_success '--no-verify with failing hook (editor)' '
+
+	echo "more stuff" >> file &&
+	git add file &&
+	echo "more stuff" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify
+
+'
 
 chmod -x "$HOOK"
-test_expect_success "with non-executable hook" \
-	"echo 'content' >> file &&
-	 git add file &&
-	 git commit -m 'content'"
+test_expect_success 'with non-executable hook' '
+
+	echo "content" >> file &&
+	git add file &&
+	git commit -m "content"
+
+'
+
+test_expect_success 'with non-executable hook (editor)' '
+
+	echo "content again" >> file &&
+	git add file &&
+	echo "content again" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit -m "content again"
+
+'
+
+test_expect_success '--no-verify with non-executable hook' '
+
+	echo "more content" >> file &&
+	git add file &&
+	git commit --no-verify -m "more content"
+
+'
 
-test_expect_success "--no-verify with non-executable hook" \
-	"echo 'more content' >> file &&
-	 git add file &&
-	 git commit --no-verify -m 'more content'"
+test_expect_success '--no-verify with non-executable hook (editor)' '
+
+	echo "even more content" >> file &&
+	git add file &&
+	echo "even more content" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify
+
+'
 
 # now a hook that edits the commit message
 cat > "$HOOK" <<'EOF'
@@ -73,16 +179,42 @@ commit_msg_is () {
 	test "`git log --pretty=format:%s%b -1`" = "$1"
 }
 
-test_expect_success "hook edits commit message" \
-	"echo 'additional' >> file &&
-	 git add file &&
-	 git commit -m 'additional' &&
-	 commit_msg_is 'new message'"
-
-test_expect_success "hook doesn't edit commit message" \
-	"echo 'plus' >> file &&
-	 git add file &&
-	 git commit --no-verify -m 'plus' &&
-	 commit_msg_is 'plus'"
+test_expect_success 'hook edits commit message' '
+
+	echo "additional" >> file &&
+	git add file &&
+	git commit -m "additional" &&
+	commit_msg_is "new message"
+
+'
+
+test_expect_success 'hook edits commit message (editor)' '
+
+	echo "additional content" >> file &&
+	git add file &&
+	echo "additional content" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit &&
+	commit_msg_is "new message"
+
+'
+
+test_expect_success "hook doesn't edit commit message" '
+
+	echo "plus" >> file &&
+	git add file &&
+	git commit --no-verify -m "plus" &&
+	commit_msg_is "plus"
+
+'
+
+test_expect_success "hook doesn't edit commit message (editor)" '
+
+	echo "more plus" >> file &&
+	git add file &&
+	echo "more plus" > FAKE_MSG &&
+	GIT_EDITOR="$FAKE_EDITOR" git commit --no-verify &&
+	commit_msg_is "more plus"
+
+'
 
 test_done

-- 
1.5.3.7.1116.gf11de