git/t/t5801-remote-helpers.sh
Jeff King ffce821880 remote: always require at least one url in a remote
When we return a struct from remote_get(), the result _almost_ always
has at least one url. In remotes_remote_get_1(), we do this:

        if (name_given && !valid_remote(ret))
                add_url_alias(remote_state, ret, name);
        if (!valid_remote(ret))
                return NULL;

So if the remote doesn't have a url, we give it one based on the name
(this is how unconfigured urls are used as remotes). And if that doesn't
work, we return NULL.

But there's a catch: valid_remote() checks that we have at least one url
_unless_ the remote.*.vcs field is set. This comes from c578f51d52 (Add
a config option for remotes to specify a foreign vcs, 2009-11-18), and
the whole idea was to support remote helpers that don't have their own
url.

However, that mode has been broken since 25d5cc488a (Pass unknown
protocols to external protocol handlers, 2009-12-09)! That commit
unconditionally looks at the url in get_helper(), causing a segfault
with something like:

  git -c remote.foo.vcs=bar fetch foo

We could fix that now, of course. But given that it has been broken for
almost 15 years and nobody noticed, there's a better option. This weird
"there might not be a url" special case requires checks all over the
code base, and it's not clear if there are other similar segfaults
lurking. It would be nice if we could drop that special case.

So instead, let's let the "the remote name is the url" code kick in. If
you have "remote.foo.vcs", then your url (unless otherwise configured)
is "foo". This does have a visible effect compared to what 25d5cc488a
was trying to do. The idea back then is that for a remote without a url,
we'd run:

   # only one command-line option!
   git-remote-bar foo

whereas with our default url, now we'll run:

  git-remote-bar foo foo

Again, in practice nobody can be relying on this because it has been
segfaulting for 15 years. We should consider just removing this "vcs"
config option entirely, but that would be a user-visible breakage. So by
fixing it this way, we can keep things working that have been working,
and simplify away one special case inside our code.

This fixes the segfault from 25d5cc488a (demonstrated by the test), and
we can build further cleanups on top.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-06-14 09:34:38 -07:00

348 lines
8.4 KiB
Bash
Executable file

#!/bin/sh
#
# Copyright (c) 2010 Sverre Rabbelier
#
test_description='Test remote-helper import and export commands'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
. ./test-lib.sh
. "$TEST_DIRECTORY"/lib-gpg.sh
PATH="$TEST_DIRECTORY/t5801:$PATH"
compare_refs() {
fail= &&
if test "x$1" = 'x!'
then
fail='!' &&
shift
fi &&
git --git-dir="$1/.git" rev-parse --verify $2 >expect &&
git --git-dir="$3/.git" rev-parse --verify $4 >actual &&
eval $fail test_cmp expect actual
}
test_expect_success 'setup repository' '
git init server &&
(cd server &&
echo content >file &&
git add file &&
git commit -m one)
'
test_expect_success 'cloning from local repo' '
git clone "testgit::${PWD}/server" local &&
test_cmp server/file local/file
'
test_expect_success 'clone with remote.*.vcs config' '
GIT_TRACE=$PWD/vcs-clone.trace \
git clone --no-local -c remote.origin.vcs=testgit "$PWD/server" vcs-clone &&
test_grep remote-testgit vcs-clone.trace
'
test_expect_success 'fetch with configured remote.*.vcs' '
git init vcs-fetch &&
git -C vcs-fetch config remote.origin.vcs testgit &&
git -C vcs-fetch config remote.origin.url "$PWD/server" &&
GIT_TRACE=$PWD/vcs-fetch.trace \
git -C vcs-fetch fetch origin &&
test_grep remote-testgit vcs-fetch.trace
'
test_expect_success 'vcs remote with no url' '
NOURL_UPSTREAM=$PWD/server &&
export NOURL_UPSTREAM &&
git init vcs-nourl &&
git -C vcs-nourl config remote.origin.vcs nourl &&
git -C vcs-nourl fetch origin
'
test_expect_success 'create new commit on remote' '
(cd server &&
echo content >>file &&
git commit -a -m two)
'
test_expect_success 'pulling from local repo' '
(cd local && git pull) &&
test_cmp server/file local/file
'
test_expect_success 'pushing to local repo' '
(cd local &&
echo content >>file &&
git commit -a -m three &&
git push) &&
compare_refs local HEAD server HEAD
'
test_expect_success 'fetch new branch' '
(cd server &&
git reset --hard &&
git checkout -b new &&
echo content >>file &&
git commit -a -m five
) &&
(cd local &&
git fetch origin new
) &&
compare_refs server HEAD local FETCH_HEAD
'
test_expect_success 'fetch multiple branches' '
(cd local &&
git fetch
) &&
compare_refs server main local refs/remotes/origin/main &&
compare_refs server new local refs/remotes/origin/new
'
test_expect_success 'push when remote has extra refs' '
(cd local &&
git reset --hard origin/main &&
echo content >>file &&
git commit -a -m six &&
git push
) &&
compare_refs local main server main
'
test_expect_success 'push new branch by name' '
(cd local &&
git checkout -b new-name &&
echo content >>file &&
git commit -a -m seven &&
git push origin new-name
) &&
compare_refs local HEAD server refs/heads/new-name
'
test_expect_success 'push new branch with old:new refspec' '
(cd local &&
git push origin new-name:new-refspec
) &&
compare_refs local HEAD server refs/heads/new-refspec
'
test_expect_success 'push new branch with HEAD:new refspec' '
(cd local &&
git checkout new-name &&
git push origin HEAD:new-refspec-2
) &&
compare_refs local HEAD server refs/heads/new-refspec-2
'
test_expect_success 'push delete branch' '
(cd local &&
git push origin :new-name
) &&
test_must_fail git --git-dir="server/.git" \
rev-parse --verify refs/heads/new-name
'
test_expect_success 'forced push' '
(cd local &&
git checkout -b force-test &&
echo content >> file &&
git commit -a -m eight &&
git push origin force-test &&
echo content >> file &&
git commit -a --amend -m eight-modified &&
git push --force origin force-test
) &&
compare_refs local refs/heads/force-test server refs/heads/force-test
'
test_expect_success 'cloning without refspec' '
GIT_REMOTE_TESTGIT_NOREFSPEC=1 \
git clone "testgit::${PWD}/server" local2 2>error &&
test_grep "this remote helper should implement refspec capability" error &&
compare_refs local2 HEAD server HEAD
'
test_expect_success 'pulling without refspecs' '
(cd local2 &&
git reset --hard &&
GIT_REMOTE_TESTGIT_NOREFSPEC=1 git pull 2>../error) &&
test_grep "this remote helper should implement refspec capability" error &&
compare_refs local2 HEAD server HEAD
'
test_expect_success 'pushing without refspecs' '
test_when_finished "(cd local2 && git reset --hard origin)" &&
(cd local2 &&
echo content >>file &&
git commit -a -m ten &&
GIT_REMOTE_TESTGIT_NOREFSPEC=1 &&
export GIT_REMOTE_TESTGIT_NOREFSPEC &&
test_must_fail git push 2>../error) &&
test_grep "remote-helper doesn.t support push; refspec needed" error
'
test_expect_success 'pulling without marks' '
(cd local2 &&
GIT_REMOTE_TESTGIT_NO_MARKS=1 git pull) &&
compare_refs local2 HEAD server HEAD
'
test_expect_failure 'pushing without marks' '
test_when_finished "(cd local2 && git reset --hard origin)" &&
(cd local2 &&
echo content >>file &&
git commit -a -m twelve &&
GIT_REMOTE_TESTGIT_NO_MARKS=1 git push) &&
compare_refs local2 HEAD server HEAD
'
test_expect_success 'push all with existing object' '
(cd local &&
git branch dup2 main &&
git push origin --all
) &&
compare_refs local dup2 server dup2
'
test_expect_success 'push ref with existing object' '
(cd local &&
git branch dup main &&
git push origin dup
) &&
compare_refs local dup server dup
'
test_expect_success GPG 'push signed tag' '
(cd local &&
git checkout main &&
git tag -s -m signed-tag signed-tag &&
git push origin signed-tag
) &&
compare_refs local signed-tag^{} server signed-tag^{} &&
compare_refs ! local signed-tag server signed-tag
'
test_expect_success GPG 'push signed tag with signed-tags capability' '
(cd local &&
git checkout main &&
git tag -s -m signed-tag signed-tag-2 &&
GIT_REMOTE_TESTGIT_SIGNED_TAGS=1 git push origin signed-tag-2
) &&
compare_refs local signed-tag-2 server signed-tag-2
'
test_expect_success 'push update refs' '
(cd local &&
git checkout -b update main &&
echo update >>file &&
git commit -a -m update &&
git push origin update &&
git rev-parse --verify remotes/origin/update >expect &&
git rev-parse --verify testgit/origin/heads/update >actual &&
test_cmp expect actual
)
'
test_expect_success 'push update refs disabled by no-private-update' '
(cd local &&
echo more-update >>file &&
git commit -a -m more-update &&
git rev-parse --verify testgit/origin/heads/update >expect &&
GIT_REMOTE_TESTGIT_NO_PRIVATE_UPDATE=t git push origin update &&
git rev-parse --verify testgit/origin/heads/update >actual &&
test_cmp expect actual
)
'
test_expect_success 'push update refs failure' '
(cd local &&
git checkout update &&
echo "update fail" >>file &&
git commit -a -m "update fail" &&
git rev-parse --verify testgit/origin/heads/update >expect &&
test_expect_code 1 env GIT_REMOTE_TESTGIT_FAILURE="non-fast forward" \
git push origin update &&
git rev-parse --verify testgit/origin/heads/update >actual &&
test_cmp expect actual
)
'
clean_mark () {
cut -f 2 -d ' ' "$1" |
git cat-file --batch-check |
grep commit |
sort >$(basename "$1")
}
test_expect_success 'proper failure checks for fetching' '
(cd local &&
test_must_fail env GIT_REMOTE_TESTGIT_FAILURE=1 git fetch 2>error &&
test_grep -q "error while running fast-import" error
)
'
test_expect_success 'proper failure checks for pushing' '
test_when_finished "rm -rf local/git.marks local/testgit.marks" &&
(cd local &&
git checkout -b crash main &&
echo crash >>file &&
git commit -a -m crash &&
test_must_fail env GIT_REMOTE_TESTGIT_FAILURE=1 git push --all &&
clean_mark ".git/testgit/origin/git.marks" &&
clean_mark ".git/testgit/origin/testgit.marks" &&
test_cmp git.marks testgit.marks
)
'
test_expect_success 'push messages' '
(cd local &&
git checkout -b new_branch main &&
echo new >>file &&
git commit -a -m new &&
git push origin new_branch &&
git fetch origin &&
echo new >>file &&
git commit -a -m new &&
git push origin new_branch 2> msg &&
! grep "\[new branch\]" msg
)
'
test_expect_success 'fetch HEAD' '
(cd server &&
git checkout main &&
echo more >>file &&
git commit -a -m more
) &&
(cd local &&
git fetch origin HEAD
) &&
compare_refs server HEAD local FETCH_HEAD
'
test_expect_success 'fetch url' '
(cd server &&
git checkout main &&
echo more >>file &&
git commit -a -m more
) &&
(cd local &&
git fetch "testgit::${PWD}/../server"
) &&
compare_refs server HEAD local FETCH_HEAD
'
test_expect_success 'fetch tag' '
(cd server &&
git tag v1.0
) &&
(cd local &&
git fetch
) &&
compare_refs local v1.0 server v1.0
'
test_done