Files
git/t/t5529-push-errors.sh
Harald Nordgren a85a43c480 push: suggest <remote> <branch> for a slash slip
When pushing the 'main' branch to the remote 'origin', i.e.,

    $ git push origin main

it is easy to mistakenly write

    $ git push origin/main

That is parsed as the repository to push to, and since 'origin/main'
is neither a configured remote nor a path it dies with:

    fatal: 'origin/main' does not appear to be a git repository

Often 'origin/main' does not exist as a repository, so the command
fails without doing any harm, but it gives no hint that a space was
meant instead of a slash and can leave the user puzzled.

When the argument is not an existing path or configured remote but
its part before the first slash names one, suggest the intended
'<remote> <branch>' form:

    $ git push origin main

The suggestion is shown as advice so it can be silenced with
advice.pushRepoLooksLikeRef.

Signed-off-by: Harald Nordgren <haraldnordgren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-06-27 19:36:43 -07:00

98 lines
2.9 KiB
Bash
Executable File

#!/bin/sh
test_description='detect some push errors early (before contacting remote)'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
. ./test-lib.sh
test_expect_success 'setup commits' '
test_commit one
'
test_expect_success 'setup remote' '
git init --bare remote.git &&
git remote add origin remote.git
'
test_expect_success 'setup fake receive-pack' '
FAKE_RP_ROOT=$(pwd) &&
export FAKE_RP_ROOT &&
write_script fake-rp <<-\EOF &&
echo yes >"$FAKE_RP_ROOT"/rp-ran
exit 1
EOF
git config remote.origin.receivepack "\"\$FAKE_RP_ROOT/fake-rp\""
'
test_expect_success 'detect missing branches early' '
echo no >rp-ran &&
echo no >expect &&
test_must_fail git push origin missing &&
test_cmp expect rp-ran
'
test_expect_success 'detect missing sha1 expressions early' '
echo no >rp-ran &&
echo no >expect &&
test_must_fail git push origin main~2:main &&
test_cmp expect rp-ran
'
# We use an existing local_ref, since it follows a different flow in
# 'builtin/push.c:set_refspecs()' and we want to test that regression.
test_expect_success 'detect empty remote with existing local ref' '
test_must_fail git push "" main 2> stderr &&
grep "fatal: bad repository ${SQ}${SQ}" stderr
'
# While similar to the previous test, here we want to ensure that
# even targeted refspecs are handled.
test_expect_success 'detect empty remote with targeted refspec' '
test_must_fail git push "" HEAD:refs/heads/main 2> stderr &&
grep "fatal: bad repository ${SQ}${SQ}" stderr
'
test_expect_success 'suggest <remote> <branch> for a <remote>/<branch> slip' '
test_must_fail git push origin/main 2>stderr &&
test_grep "${SQ}origin/main${SQ} is not a valid push target" stderr &&
test_grep "hint: Did you mean to use: git push origin main?" stderr &&
test_must_fail git -c advice.pushRepoLooksLikeRef=false push origin/main 2>stderr &&
test_grep ! "Did you mean" stderr
'
test_expect_success 'suggest <remote> <branch> when the branch has slashes' '
test_must_fail git push origin/feature/x 2>stderr &&
test_grep "hint: Did you mean to use: git push origin feature/x?" stderr
'
test_expect_success 'no suggestion when prefix is not a configured remote' '
test_must_fail git push not-a-remote/main 2>stderr &&
test_grep ! "Did you mean" stderr
'
test_expect_success 'no suggestion for a trailing slash with no branch' '
test_must_fail git push origin/ 2>stderr &&
test_grep ! "Did you mean" stderr
'
test_expect_success 'no suggestion when the argument is an existing path' '
test_when_finished "rm -rf origin" &&
git init --bare origin/main &&
git push origin/main HEAD:refs/heads/pushed 2>stderr &&
test_grep ! "Did you mean" stderr &&
git -C origin/main rev-parse --verify refs/heads/pushed
'
test_expect_success 'detect ambiguous refs early' '
git branch foo &&
git tag foo &&
echo no >rp-ran &&
echo no >expect &&
test_must_fail git push origin foo &&
test_cmp expect rp-ran
'
test_done