git-commit-vandalism/t/t3202-show-branch.sh
Junio C Hamano 41c64ae0e7 show-branch: -g and --current are incompatible
When "--current" is given to "git show-branch" running in the
"--reflog" mode, the code tries to reference a "reflog" message
that does not even exist.  This is because the --current is not
prepared to work in that mode.

The reason "--current" exists is to support this request:

    I list branches on the command line.  These are the branchesI
    care about and I use as anchoring points. I may or may not be on
    one of these main branches.  Please make sure I can view the
    commits on the current branch with respect to what is in these
    other branches.

And to serve that request, the code checks if the current branch is
among the ones listed on the command line, and adds it only if it is
not to the end of one array, which essentially lists the objects.
The reflog mode additionally uses another array to list reflog
messages, which the "--current" code does not add to.  This leaves
one uninitialized slot at the end of the array of reflog messages,
and causes the program to show garbage or segfault.

Catch the unsupported (and meaningless) combination and exit with a
usage error.

There are other combinations of options that are incompatible but
have not been tested.  Add test to cover them while adding coverage
for this new combination.

Reported-by: Gregory David <gregory.david@p1sec.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-04-21 14:26:42 -07:00

179 lines
5.0 KiB
Bash
Executable File

#!/bin/sh
test_description='test show-branch'
. ./test-lib.sh
# arbitrary reference time: 2009-08-30 19:20:00
GIT_TEST_DATE_NOW=1251660000; export GIT_TEST_DATE_NOW
test_expect_success 'setup' '
test_commit initial &&
for i in $(test_seq 1 10)
do
git checkout -b branch$i initial &&
test_commit --no-tag branch$i || return 1
done &&
git for-each-ref \
--sort=version:refname \
--format="%(refname:strip=2)" \
"refs/heads/branch*" >branches.sorted &&
sed "s/^> //" >expect <<-\EOF
> ! [branch1] branch1
> ! [branch2] branch2
> ! [branch3] branch3
> ! [branch4] branch4
> ! [branch5] branch5
> ! [branch6] branch6
> ! [branch7] branch7
> ! [branch8] branch8
> ! [branch9] branch9
> * [branch10] branch10
> ----------
> * [branch10] branch10
> + [branch9] branch9
> + [branch8] branch8
> + [branch7] branch7
> + [branch6] branch6
> + [branch5] branch5
> + [branch4] branch4
> + [branch3] branch3
> + [branch2] branch2
> + [branch1] branch1
> +++++++++* [branch10^] initial
EOF
'
test_expect_success 'show-branch with more than 8 branches' '
git show-branch $(cat branches.sorted) >actual &&
test_cmp expect actual
'
test_expect_success 'show-branch with showbranch.default' '
for branch in $(cat branches.sorted)
do
test_config showbranch.default $branch --add || return 1
done &&
git show-branch >actual &&
test_cmp expect actual
'
test_expect_success 'show-branch --color output' '
sed "s/^> //" >expect <<-\EOF &&
> <RED>!<RESET> [branch1] branch1
> <GREEN>!<RESET> [branch2] branch2
> <YELLOW>!<RESET> [branch3] branch3
> <BLUE>!<RESET> [branch4] branch4
> <MAGENTA>!<RESET> [branch5] branch5
> <CYAN>!<RESET> [branch6] branch6
> <BOLD;RED>!<RESET> [branch7] branch7
> <BOLD;GREEN>!<RESET> [branch8] branch8
> <BOLD;YELLOW>!<RESET> [branch9] branch9
> <BOLD;BLUE>*<RESET> [branch10] branch10
> ----------
> <BOLD;BLUE>*<RESET> [branch10] branch10
> <BOLD;YELLOW>+<RESET> [branch9] branch9
> <BOLD;GREEN>+<RESET> [branch8] branch8
> <BOLD;RED>+<RESET> [branch7] branch7
> <CYAN>+<RESET> [branch6] branch6
> <MAGENTA>+<RESET> [branch5] branch5
> <BLUE>+<RESET> [branch4] branch4
> <YELLOW>+<RESET> [branch3] branch3
> <GREEN>+<RESET> [branch2] branch2
> <RED>+<RESET> [branch1] branch1
> <RED>+<RESET><GREEN>+<RESET><YELLOW>+<RESET><BLUE>+<RESET><MAGENTA>+<RESET><CYAN>+<RESET><BOLD;RED>+<RESET><BOLD;GREEN>+<RESET><BOLD;YELLOW>+<RESET><BOLD;BLUE>*<RESET> [branch10^] initial
EOF
git show-branch --color=always $(cat branches.sorted) >actual.raw &&
test_decode_color <actual.raw >actual &&
test_cmp expect actual
'
test_expect_success 'show branch --remotes' '
cat >expect.err <<-\EOF &&
No revs to be shown.
EOF
git show-branch -r 2>actual.err >actual.out &&
test_cmp expect.err actual.err &&
test_must_be_empty actual.out
'
test_expect_success 'setup show branch --list' '
sed "s/^> //" >expect <<-\EOF
> [branch1] branch1
> [branch2] branch2
> [branch3] branch3
> [branch4] branch4
> [branch5] branch5
> [branch6] branch6
> [branch7] branch7
> [branch8] branch8
> [branch9] branch9
> * [branch10] branch10
EOF
'
test_expect_success 'show branch --list' '
git show-branch --list $(cat branches.sorted) >actual &&
test_cmp expect actual
'
test_expect_success 'show branch --list has no --color output' '
git show-branch --color=always --list $(cat branches.sorted) >actual &&
test_cmp expect actual
'
test_expect_success 'show branch --merge-base with one argument' '
for branch in $(cat branches.sorted)
do
git rev-parse $branch >expect &&
git show-branch --merge-base $branch >actual &&
test_cmp expect actual || return 1
done
'
test_expect_success 'show branch --merge-base with two arguments' '
for branch in $(cat branches.sorted)
do
git rev-parse initial >expect &&
git show-branch --merge-base initial $branch >actual &&
test_cmp expect actual || return 1
done
'
test_expect_success 'show branch --merge-base with N arguments' '
git rev-parse initial >expect &&
git show-branch --merge-base $(cat branches.sorted) >actual &&
test_cmp expect actual &&
git merge-base $(cat branches.sorted) >actual &&
test_cmp expect actual
'
test_expect_success 'show branch --reflog=2' '
sed "s/^> //" >expect <<-\EOF &&
> ! [refs/heads/branch10@{0}] (4 years, 5 months ago) commit: branch10
> ! [refs/heads/branch10@{1}] (4 years, 5 months ago) commit: branch10
> --
> + [refs/heads/branch10@{0}] branch10
> ++ [refs/heads/branch10@{1}] initial
EOF
git show-branch --reflog=2 >actual &&
test_cmp actual expect
'
# incompatible options
while read combo
do
test_expect_success "show-branch $combo (should fail)" '
test_must_fail git show-branch $combo 2>error &&
grep -e "cannot be used together" -e "usage:" error
'
done <<\EOF
--all --reflog
--merge-base --reflog
--list --merge-base
--reflog --current
EOF
test_done