mirror of
https://github.com/git/git
synced 2024-07-17 11:07:55 +00:00
ed773a18c6
Much like with attributes files, sometimes programs would like to know the location of configuration files at the global or system levels. However, it isn't always clear where these may live, especially for the system file, which may have been hard-coded at compile time or computed dynamically based on the runtime prefix. Since other parties cannot intuitively know how Git was compiled and where it looks for these files, help them by providing variables that can be queried. Because we have multiple paths for global config values, print them in order from highest to lowest priority, and be sure to split on newlines so that "git var -l" produces two entries for the global value. However, be careful not to split all values on newlines, since our editor values could well contain such characters, and we don't want to split them in such a case. Note in the documentation that some values may contain multiple paths and that callers should be prepared for that fact. This helps people write code that will continue to work in the event we allow multiple items elsewhere in the future. Signed-off-by: brian m. carlson <bk2204@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
272 lines
7.5 KiB
Bash
Executable file
272 lines
7.5 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
test_description='basic sanity checks for git var'
|
|
|
|
TEST_PASSES_SANITIZE_LEAK=true
|
|
. ./test-lib.sh
|
|
|
|
sane_unset_all_editors () {
|
|
sane_unset GIT_EDITOR &&
|
|
sane_unset VISUAL &&
|
|
sane_unset EDITOR
|
|
}
|
|
|
|
test_expect_success 'get GIT_AUTHOR_IDENT' '
|
|
test_tick &&
|
|
echo "$GIT_AUTHOR_NAME <$GIT_AUTHOR_EMAIL> $GIT_AUTHOR_DATE" >expect &&
|
|
git var GIT_AUTHOR_IDENT >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'get GIT_COMMITTER_IDENT' '
|
|
test_tick &&
|
|
echo "$GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL> $GIT_COMMITTER_DATE" >expect &&
|
|
git var GIT_COMMITTER_IDENT >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success !FAIL_PREREQS,!AUTOIDENT 'requested identities are strict' '
|
|
(
|
|
sane_unset GIT_COMMITTER_NAME &&
|
|
sane_unset GIT_COMMITTER_EMAIL &&
|
|
test_must_fail git var GIT_COMMITTER_IDENT
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_DEFAULT_BRANCH without configuration' '
|
|
(
|
|
sane_unset GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME &&
|
|
git init defbranch &&
|
|
git -C defbranch symbolic-ref --short HEAD >expect &&
|
|
git var GIT_DEFAULT_BRANCH >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_DEFAULT_BRANCH with configuration' '
|
|
test_config init.defaultbranch foo &&
|
|
(
|
|
sane_unset GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME &&
|
|
echo foo >expect &&
|
|
git var GIT_DEFAULT_BRANCH >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_EDITOR without configuration' '
|
|
(
|
|
sane_unset_all_editors &&
|
|
test_expect_code 1 git var GIT_EDITOR >out &&
|
|
test_must_be_empty out
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_EDITOR with configuration' '
|
|
test_config core.editor foo &&
|
|
(
|
|
sane_unset_all_editors &&
|
|
echo foo >expect &&
|
|
git var GIT_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_EDITOR with environment variable GIT_EDITOR' '
|
|
(
|
|
sane_unset_all_editors &&
|
|
echo bar >expect &&
|
|
GIT_EDITOR=bar git var GIT_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_EDITOR with environment variable EDITOR' '
|
|
(
|
|
sane_unset_all_editors &&
|
|
echo bar >expect &&
|
|
EDITOR=bar git var GIT_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_EDITOR with configuration and environment variable GIT_EDITOR' '
|
|
test_config core.editor foo &&
|
|
(
|
|
sane_unset_all_editors &&
|
|
echo bar >expect &&
|
|
GIT_EDITOR=bar git var GIT_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_EDITOR with configuration and environment variable EDITOR' '
|
|
test_config core.editor foo &&
|
|
(
|
|
sane_unset_all_editors &&
|
|
echo foo >expect &&
|
|
EDITOR=bar git var GIT_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_SEQUENCE_EDITOR without configuration' '
|
|
(
|
|
sane_unset GIT_SEQUENCE_EDITOR &&
|
|
git var GIT_EDITOR >expect &&
|
|
git var GIT_SEQUENCE_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_SEQUENCE_EDITOR with configuration' '
|
|
test_config sequence.editor foo &&
|
|
(
|
|
sane_unset GIT_SEQUENCE_EDITOR &&
|
|
echo foo >expect &&
|
|
git var GIT_SEQUENCE_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_SEQUENCE_EDITOR with environment variable' '
|
|
(
|
|
sane_unset GIT_SEQUENCE_EDITOR &&
|
|
echo bar >expect &&
|
|
GIT_SEQUENCE_EDITOR=bar git var GIT_SEQUENCE_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'get GIT_SEQUENCE_EDITOR with configuration and environment variable' '
|
|
test_config sequence.editor foo &&
|
|
(
|
|
sane_unset GIT_SEQUENCE_EDITOR &&
|
|
echo bar >expect &&
|
|
GIT_SEQUENCE_EDITOR=bar git var GIT_SEQUENCE_EDITOR >actual &&
|
|
test_cmp expect actual
|
|
)
|
|
'
|
|
|
|
test_expect_success POSIXPERM 'GIT_SHELL_PATH points to a valid executable' '
|
|
shellpath=$(git var GIT_SHELL_PATH) &&
|
|
test_path_is_executable "$shellpath"
|
|
'
|
|
|
|
# We know in this environment that our shell will be one of a few fixed values
|
|
# that all end in "sh".
|
|
test_expect_success MINGW 'GIT_SHELL_PATH points to a suitable shell' '
|
|
shellpath=$(git var GIT_SHELL_PATH) &&
|
|
case "$shellpath" in
|
|
*sh) ;;
|
|
*) return 1;;
|
|
esac
|
|
'
|
|
|
|
test_expect_success 'GIT_ATTR_SYSTEM produces expected output' '
|
|
test_must_fail env GIT_ATTR_NOSYSTEM=1 git var GIT_ATTR_SYSTEM &&
|
|
(
|
|
sane_unset GIT_ATTR_NOSYSTEM &&
|
|
systempath=$(git var GIT_ATTR_SYSTEM) &&
|
|
test "$systempath" != ""
|
|
)
|
|
'
|
|
|
|
test_expect_success 'GIT_ATTR_GLOBAL points to the correct location' '
|
|
TRASHDIR="$(test-tool path-utils normalize_path_copy "$(pwd)")" &&
|
|
globalpath=$(XDG_CONFIG_HOME="$TRASHDIR/.config" git var GIT_ATTR_GLOBAL) &&
|
|
test "$globalpath" = "$TRASHDIR/.config/git/attributes" &&
|
|
(
|
|
sane_unset XDG_CONFIG_HOME &&
|
|
globalpath=$(HOME="$TRASHDIR" git var GIT_ATTR_GLOBAL) &&
|
|
test "$globalpath" = "$TRASHDIR/.config/git/attributes"
|
|
)
|
|
'
|
|
|
|
test_expect_success 'GIT_CONFIG_SYSTEM points to the correct location' '
|
|
TRASHDIR="$(test-tool path-utils normalize_path_copy "$(pwd)")" &&
|
|
test_must_fail env GIT_CONFIG_NOSYSTEM=1 git var GIT_CONFIG_SYSTEM &&
|
|
(
|
|
sane_unset GIT_CONFIG_NOSYSTEM &&
|
|
systempath=$(git var GIT_CONFIG_SYSTEM) &&
|
|
test "$systempath" != "" &&
|
|
systempath=$(GIT_CONFIG_SYSTEM=/dev/null git var GIT_CONFIG_SYSTEM) &&
|
|
if test_have_prereq MINGW
|
|
then
|
|
test "$systempath" = "nul"
|
|
else
|
|
test "$systempath" = "/dev/null"
|
|
fi &&
|
|
systempath=$(GIT_CONFIG_SYSTEM="$TRASHDIR/gitconfig" git var GIT_CONFIG_SYSTEM) &&
|
|
test "$systempath" = "$TRASHDIR/gitconfig"
|
|
)
|
|
'
|
|
|
|
test_expect_success 'GIT_CONFIG_GLOBAL points to the correct location' '
|
|
TRASHDIR="$(test-tool path-utils normalize_path_copy "$(pwd)")" &&
|
|
HOME="$TRASHDIR" XDG_CONFIG_HOME="$TRASHDIR/foo" git var GIT_CONFIG_GLOBAL >actual &&
|
|
echo "$TRASHDIR/foo/git/config" >expected &&
|
|
echo "$TRASHDIR/.gitconfig" >>expected &&
|
|
test_cmp expected actual &&
|
|
(
|
|
sane_unset XDG_CONFIG_HOME &&
|
|
HOME="$TRASHDIR" git var GIT_CONFIG_GLOBAL >actual &&
|
|
echo "$TRASHDIR/.config/git/config" >expected &&
|
|
echo "$TRASHDIR/.gitconfig" >>expected &&
|
|
test_cmp expected actual &&
|
|
globalpath=$(GIT_CONFIG_GLOBAL=/dev/null git var GIT_CONFIG_GLOBAL) &&
|
|
if test_have_prereq MINGW
|
|
then
|
|
test "$globalpath" = "nul"
|
|
else
|
|
test "$globalpath" = "/dev/null"
|
|
fi &&
|
|
globalpath=$(GIT_CONFIG_GLOBAL="$TRASHDIR/gitconfig" git var GIT_CONFIG_GLOBAL) &&
|
|
test "$globalpath" = "$TRASHDIR/gitconfig"
|
|
)
|
|
'
|
|
|
|
# For git var -l, we check only a representative variable;
|
|
# testing the whole output would make our test too brittle with
|
|
# respect to unrelated changes in the test suite's environment.
|
|
test_expect_success 'git var -l lists variables' '
|
|
git var -l >actual &&
|
|
echo "$GIT_AUTHOR_NAME <$GIT_AUTHOR_EMAIL> $GIT_AUTHOR_DATE" >expect &&
|
|
sed -n s/GIT_AUTHOR_IDENT=//p <actual >actual.author &&
|
|
test_cmp expect actual.author
|
|
'
|
|
|
|
test_expect_success 'git var -l lists config' '
|
|
git var -l >actual &&
|
|
echo false >expect &&
|
|
sed -n s/core\\.bare=//p <actual >actual.bare &&
|
|
test_cmp expect actual.bare
|
|
'
|
|
|
|
test_expect_success 'git var -l lists multiple global configs' '
|
|
TRASHDIR="$(test-tool path-utils normalize_path_copy "$(pwd)")" &&
|
|
HOME="$TRASHDIR" XDG_CONFIG_HOME="$TRASHDIR/foo" git var -l >actual &&
|
|
grep "^GIT_CONFIG_GLOBAL=" actual >filtered &&
|
|
echo "GIT_CONFIG_GLOBAL=$TRASHDIR/foo/git/config" >expected &&
|
|
echo "GIT_CONFIG_GLOBAL=$TRASHDIR/.gitconfig" >>expected &&
|
|
test_cmp expected filtered
|
|
'
|
|
|
|
test_expect_success 'git var -l does not split multiline editors' '
|
|
(
|
|
GIT_EDITOR="!f() {
|
|
echo Hello!
|
|
}; f" &&
|
|
export GIT_EDITOR &&
|
|
echo "GIT_EDITOR=$GIT_EDITOR" >expected &&
|
|
git var -l >var &&
|
|
sed -n -e "/^GIT_EDITOR/,\$p" var | head -n 3 >actual &&
|
|
test_cmp expected actual
|
|
)
|
|
'
|
|
|
|
test_expect_success 'listing and asking for variables are exclusive' '
|
|
test_must_fail git var -l GIT_COMMITTER_IDENT
|
|
'
|
|
|
|
test_done
|