mirror of
https://github.com/git/git
synced 2024-10-28 19:25:47 +00:00
098aa86762
In addition to making git_path() aware of certain file names that need
to be handled differently e.g. when running in worktrees, the commit
557bd833bb (git_path(): be aware of file relocation in $GIT_DIR,
2014-11-30) also snuck in a new option for `git rev-parse`:
`--git-path`.
On the face of it, there is no obvious bug in that commit's diff: it
faithfully calls git_path() on the argument and prints it out, i.e. `git
rev-parse --git-path <filename>` has the same precise behavior as
calling `git_path("<filename>")` in C.
The problem lies deeper, much deeper. In hindsight (which is always
unfair), implementing the .git/ directory discovery in
`setup_git_directory()` by changing the working directory may have
allowed us to avoid passing around a struct that contains information
about the current repository, but it bought us many, many problems.
In this case, when being called in a subdirectory, `git rev-parse`
changes the working directory to the top-level directory before calling
`git_path()`. In the new working directory, the result is correct. But
in the working directory of the calling script, it is incorrect.
Example: when calling `git rev-parse --git-path HEAD` in, say, the
Documentation/ subdirectory of Git's own source code, the string
`.git/HEAD` is printed.
Side note: that bug is hidden when running in a subdirectory of a
worktree that was added by the `git worktree` command: in that case, the
(correct) absolute path of the `HEAD` file is printed.
In the interest of time, this patch does not go the "correct" route to
introduce a struct with repository information (and removing global
state in the process), instead this patch chooses to detect when the
command was called in a subdirectory and forces the result to be an
absolute path.
While at it, we are also fixing the output of --git-common-dir and
--shared-index-path.
Lastly, please note that we reuse the same strbuf for all of the
relative_path() calls; this avoids frequent allocation (and duplicated
code), and it does not risk memory leaks, for two reasons: 1) the
cmd_rev_parse() function does not return anywhere between the use of
the new strbuf instance and its final release, and 2) git-rev-parse is
one of these "one-shot" programs in Git, i.e. it exits after running
for a very short time, meaning that all allocated memory is released
with the exit() call anyway.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
118 lines
3 KiB
Bash
Executable file
118 lines
3 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
test_description='test git rev-parse'
|
|
. ./test-lib.sh
|
|
|
|
# usage: [options] label is-bare is-inside-git is-inside-work prefix git-dir
|
|
test_rev_parse () {
|
|
d=
|
|
bare=
|
|
gitdir=
|
|
while :
|
|
do
|
|
case "$1" in
|
|
-C) d="$2"; shift; shift ;;
|
|
-b) case "$2" in
|
|
[tfu]*) bare="$2"; shift; shift ;;
|
|
*) error "test_rev_parse: bogus core.bare value '$2'" ;;
|
|
esac ;;
|
|
-g) gitdir="$2"; shift; shift ;;
|
|
-*) error "test_rev_parse: unrecognized option '$1'" ;;
|
|
*) break ;;
|
|
esac
|
|
done
|
|
|
|
name=$1
|
|
shift
|
|
|
|
for o in --is-bare-repository \
|
|
--is-inside-git-dir \
|
|
--is-inside-work-tree \
|
|
--show-prefix \
|
|
--git-dir
|
|
do
|
|
test $# -eq 0 && break
|
|
expect="$1"
|
|
test_expect_success "$name: $o" '
|
|
if test -n "$gitdir"
|
|
then
|
|
test_when_finished "unset GIT_DIR" &&
|
|
GIT_DIR="$gitdir" &&
|
|
export GIT_DIR
|
|
fi &&
|
|
|
|
case "$bare" in
|
|
t*) test_config ${d:+-C} ${d:+"$d"} core.bare true ;;
|
|
f*) test_config ${d:+-C} ${d:+"$d"} core.bare false ;;
|
|
u*) test_unconfig ${d:+-C} ${d:+"$d"} core.bare ;;
|
|
esac &&
|
|
|
|
echo "$expect" >expect &&
|
|
git ${d:+-C} ${d:+"$d"} rev-parse $o >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
shift
|
|
done
|
|
}
|
|
|
|
ROOT=$(pwd)
|
|
|
|
test_expect_success 'setup' '
|
|
mkdir -p sub/dir work &&
|
|
cp -R .git repo.git
|
|
'
|
|
|
|
test_rev_parse toplevel false false true '' .git
|
|
|
|
test_rev_parse -C .git .git/ false true false '' .
|
|
test_rev_parse -C .git/objects .git/objects/ false true false '' "$ROOT/.git"
|
|
|
|
test_rev_parse -C sub/dir subdirectory false false true sub/dir/ "$ROOT/.git"
|
|
|
|
test_rev_parse -b t 'core.bare = true' true false false
|
|
|
|
test_rev_parse -b u 'core.bare undefined' false false true
|
|
|
|
|
|
test_rev_parse -C work -g ../.git -b f 'GIT_DIR=../.git, core.bare = false' false false true ''
|
|
|
|
test_rev_parse -C work -g ../.git -b t 'GIT_DIR=../.git, core.bare = true' true false false ''
|
|
|
|
test_rev_parse -C work -g ../.git -b u 'GIT_DIR=../.git, core.bare undefined' false false true ''
|
|
|
|
|
|
test_rev_parse -C work -g ../repo.git -b f 'GIT_DIR=../repo.git, core.bare = false' false false true ''
|
|
|
|
test_rev_parse -C work -g ../repo.git -b t 'GIT_DIR=../repo.git, core.bare = true' true false false ''
|
|
|
|
test_rev_parse -C work -g ../repo.git -b u 'GIT_DIR=../repo.git, core.bare undefined' false false true ''
|
|
|
|
test_expect_success 'git-common-dir from worktree root' '
|
|
echo .git >expect &&
|
|
git rev-parse --git-common-dir >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'git-common-dir inside sub-dir' '
|
|
mkdir -p path/to/child &&
|
|
test_when_finished "rm -rf path" &&
|
|
echo "$(git -C path/to/child rev-parse --show-cdup).git" >expect &&
|
|
git -C path/to/child rev-parse --git-common-dir >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'git-path from worktree root' '
|
|
echo .git/objects >expect &&
|
|
git rev-parse --git-path objects >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'git-path inside sub-dir' '
|
|
mkdir -p path/to/child &&
|
|
test_when_finished "rm -rf path" &&
|
|
echo "$(git -C path/to/child rev-parse --show-cdup).git/objects" >expect &&
|
|
git -C path/to/child rev-parse --git-path objects >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_done
|