post-checkout hook, tests, and docs

Updated post-checkout hook to take a flag specifying whether the checkout is
a branch checkout or a file checkout (from the index).

Signed-off-by: Josh England <jjengla@sandia.gov>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Josh England 2007-09-26 15:31:01 -06:00 committed by Junio C Hamano
parent 2a858ee951
commit 1abbe475ff
3 changed files with 100 additions and 0 deletions

View File

@ -87,6 +87,20 @@ parameter, and is invoked after a commit is made.
This hook is meant primarily for notification, and cannot affect
the outcome of `git-commit`.
post-checkout
-----------
This hook is invoked when a `git-checkout` is run after having updated the
worktree. The hook is given three parameters: the ref of the previous HEAD,
the ref of the new HEAD (which may or may not have changed), and a flag
indicating whether the checkout was a branch checkout (changing branches,
flag=1) or a file checkout (retrieving a file from the index, flag=0).
This hook cannot affect the outcome of `git-checkout`.
This hook can be used to perform repository validity checks, auto-display
differences from the previous HEAD if different, or set working dir metadata
properties.
post-merge
-----------

View File

@ -137,6 +137,13 @@ Did you intend to checkout '$@' which can not be resolved as commit?"
git ls-files --error-unmatch -- "$@" >/dev/null || exit
git ls-files -- "$@" |
git checkout-index -f -u --stdin
# Run a post-checkout hook -- the HEAD does not change so the
# current HEAD is passed in for both args
if test -x "$GIT_DIR"/hooks/post-checkout; then
"$GIT_DIR"/hooks/post-checkout $old $old 0
fi
exit $?
else
# Make sure we did not fall back on $arg^{tree} codepath
@ -284,3 +291,8 @@ if [ "$?" -eq 0 ]; then
else
exit 1
fi
# Run a post-checkout hook
if test -x "$GIT_DIR"/hooks/post-checkout; then
"$GIT_DIR"/hooks/post-checkout $old $new 1
fi

74
t/t5403-post-checkout-hook.sh Executable file
View File

@ -0,0 +1,74 @@
#!/bin/sh
#
# Copyright (c) 2006 Josh England
#
test_description='Test the post-checkout hook.'
. ./test-lib.sh
test_expect_success setup '
echo Data for commit0. >a &&
echo Data for commit0. >b &&
git update-index --add a &&
git update-index --add b &&
tree0=$(git write-tree) &&
commit0=$(echo setup | git commit-tree $tree0) &&
git update-ref refs/heads/master $commit0 &&
git-clone ./. clone1 &&
git-clone ./. clone2 &&
GIT_DIR=clone2/.git git branch -a new2 &&
echo Data for commit1. >clone2/b &&
GIT_DIR=clone2/.git git add clone2/b &&
GIT_DIR=clone2/.git git commit -m new2
'
for clone in 1 2; do
cat >clone${clone}/.git/hooks/post-checkout <<'EOF'
#!/bin/sh
echo $@ > $GIT_DIR/post-checkout.args
EOF
chmod u+x clone${clone}/.git/hooks/post-checkout
done
test_expect_success 'post-checkout runs as expected ' '
GIT_DIR=clone1/.git git checkout master &&
test -e clone1/.git/post-checkout.args
'
test_expect_success 'post-checkout receives the right arguments with HEAD unchanged ' '
old=$(awk "{print \$1}" clone1/.git/post-checkout.args) &&
new=$(awk "{print \$2}" clone1/.git/post-checkout.args) &&
flag=$(awk "{print \$3}" clone1/.git/post-checkout.args) &&
test $old = $new -a $flag == 1
'
test_expect_success 'post-checkout runs as expected ' '
GIT_DIR=clone1/.git git checkout master &&
test -e clone1/.git/post-checkout.args
'
test_expect_success 'post-checkout args are correct with git checkout -b ' '
GIT_DIR=clone1/.git git checkout -b new1 &&
old=$(awk "{print \$1}" clone1/.git/post-checkout.args) &&
new=$(awk "{print \$2}" clone1/.git/post-checkout.args) &&
flag=$(awk "{print \$3}" clone1/.git/post-checkout.args) &&
test $old = $new -a $flag == 1
'
test_expect_success 'post-checkout receives the right args with HEAD changed ' '
GIT_DIR=clone2/.git git checkout new2 &&
old=$(awk "{print \$1}" clone2/.git/post-checkout.args) &&
new=$(awk "{print \$2}" clone2/.git/post-checkout.args) &&
flag=$(awk "{print \$3}" clone2/.git/post-checkout.args) &&
test $old != $new -a $flag == 1
'
test_expect_success 'post-checkout receives the right args when not switching branches ' '
GIT_DIR=clone2/.git git checkout master b &&
old=$(awk "{print \$1}" clone2/.git/post-checkout.args) &&
new=$(awk "{print \$2}" clone2/.git/post-checkout.args) &&
flag=$(awk "{print \$3}" clone2/.git/post-checkout.args) &&
test $old == $new -a $flag == 0
'
test_done