mirror of
https://github.com/git/git.git
synced 2024-10-30 22:07:53 +01:00
d9f31fbfe9
Recent patches have expanded on the trailers.c code and we have the builtin commant git-interpret-trailers which can be used to add or modify trailer lines. However, there is no easy way to simply display the trailers of a commit message. Add support for %(trailers) format modifier which will use the trailer_info_get() calls to read trailers in an identical way as git interpret-trailers does. Use a long format option instead of a short name so that future work can more easily unify ref-filter and pretty formats. Add documentation and tests for the same. Signed-off-by: Jacob Keller <jacob.keller@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
564 lines
17 KiB
Bash
Executable file
564 lines
17 KiB
Bash
Executable file
#!/bin/sh
|
|
#
|
|
# Copyright (c) 2010, Will Palmer
|
|
# Copyright (c) 2011, Alexey Shumkin (+ non-UTF-8 commit encoding tests)
|
|
#
|
|
|
|
test_description='Test pretty formats'
|
|
. ./test-lib.sh
|
|
|
|
# Tested non-UTF-8 encoding
|
|
test_encoding="ISO8859-1"
|
|
|
|
sample_utf8_part=$(printf "f\303\244ng")
|
|
|
|
commit_msg () {
|
|
# String "initial. initial" partly in German
|
|
# (translated with Google Translate),
|
|
# encoded in UTF-8, used as a commit log message below.
|
|
msg="initial. an${sample_utf8_part}lich\n"
|
|
if test -n "$1"
|
|
then
|
|
printf "$msg" | iconv -f utf-8 -t "$1"
|
|
else
|
|
printf "$msg"
|
|
fi
|
|
}
|
|
|
|
test_expect_success 'set up basic repos' '
|
|
>foo &&
|
|
>bar &&
|
|
git add foo &&
|
|
test_tick &&
|
|
git config i18n.commitEncoding $test_encoding &&
|
|
commit_msg $test_encoding | git commit -F - &&
|
|
git add bar &&
|
|
test_tick &&
|
|
git commit -m "add bar" &&
|
|
git config --unset i18n.commitEncoding
|
|
'
|
|
|
|
test_expect_success 'alias builtin format' '
|
|
git log --pretty=oneline >expected &&
|
|
git config pretty.test-alias oneline &&
|
|
git log --pretty=test-alias >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'alias masking builtin format' '
|
|
git log --pretty=oneline >expected &&
|
|
git config pretty.oneline "%H" &&
|
|
git log --pretty=oneline >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'alias user-defined format' '
|
|
git log --pretty="format:%h" >expected &&
|
|
git config pretty.test-alias "format:%h" &&
|
|
git log --pretty=test-alias >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'alias user-defined tformat with %s (ISO8859-1 encoding)' '
|
|
git config i18n.logOutputEncoding $test_encoding &&
|
|
git log --oneline >expected-s &&
|
|
git log --pretty="tformat:%h %s" >actual-s &&
|
|
git config --unset i18n.logOutputEncoding &&
|
|
test_cmp expected-s actual-s
|
|
'
|
|
|
|
test_expect_success 'alias user-defined tformat with %s (utf-8 encoding)' '
|
|
git log --oneline >expected-s &&
|
|
git log --pretty="tformat:%h %s" >actual-s &&
|
|
test_cmp expected-s actual-s
|
|
'
|
|
|
|
test_expect_success 'alias user-defined tformat' '
|
|
git log --pretty="tformat:%h" >expected &&
|
|
git config pretty.test-alias "tformat:%h" &&
|
|
git log --pretty=test-alias >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'alias non-existent format' '
|
|
git config pretty.test-alias format-that-will-never-exist &&
|
|
test_must_fail git log --pretty=test-alias
|
|
'
|
|
|
|
test_expect_success 'alias of an alias' '
|
|
git log --pretty="tformat:%h" >expected &&
|
|
git config pretty.test-foo "tformat:%h" &&
|
|
git config pretty.test-bar test-foo &&
|
|
git log --pretty=test-bar >actual && test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'alias masking an alias' '
|
|
git log --pretty=format:"Two %H" >expected &&
|
|
git config pretty.duplicate "format:One %H" &&
|
|
git config --add pretty.duplicate "format:Two %H" &&
|
|
git log --pretty=duplicate >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'alias loop' '
|
|
git config pretty.test-foo test-bar &&
|
|
git config pretty.test-bar test-foo &&
|
|
test_must_fail git log --pretty=test-foo
|
|
'
|
|
|
|
test_expect_success 'NUL separation' '
|
|
printf "add bar\0$(commit_msg)" >expected &&
|
|
git log -z --pretty="format:%s" >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'NUL termination' '
|
|
printf "add bar\0$(commit_msg)\0" >expected &&
|
|
git log -z --pretty="tformat:%s" >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'NUL separation with --stat' '
|
|
stat0_part=$(git diff --stat HEAD^ HEAD) &&
|
|
stat1_part=$(git diff-tree --no-commit-id --stat --root HEAD^) &&
|
|
printf "add bar\n$stat0_part\n\0$(commit_msg)\n$stat1_part\n" >expected &&
|
|
git log -z --stat --pretty="format:%s" >actual &&
|
|
test_i18ncmp expected actual
|
|
'
|
|
|
|
test_expect_failure 'NUL termination with --stat' '
|
|
stat0_part=$(git diff --stat HEAD^ HEAD) &&
|
|
stat1_part=$(git diff-tree --no-commit-id --stat --root HEAD^) &&
|
|
printf "add bar\n$stat0_part\n\0$(commit_msg)\n$stat1_part\n0" >expected &&
|
|
git log -z --stat --pretty="tformat:%s" >actual &&
|
|
test_i18ncmp expected actual
|
|
'
|
|
|
|
test_expect_success 'setup more commits' '
|
|
test_commit "message one" one one message-one &&
|
|
test_commit "message two" two two message-two &&
|
|
head1=$(git rev-parse --verify --short HEAD~0) &&
|
|
head2=$(git rev-parse --verify --short HEAD~1) &&
|
|
head3=$(git rev-parse --verify --short HEAD~2) &&
|
|
head4=$(git rev-parse --verify --short HEAD~3)
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting' '
|
|
git log --pretty="tformat:%<(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
message two Z
|
|
message one Z
|
|
add bar Z
|
|
$(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
message two Z
|
|
message one Z
|
|
add bar Z
|
|
$(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting at the nth column' '
|
|
git log --pretty="tformat:%h %<|(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
$head1 message two Z
|
|
$head2 message one Z
|
|
$head3 add bar Z
|
|
$head4 $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting at the nth column' '
|
|
COLUMNS=50 git log --pretty="tformat:%h %<|(-10)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
$head1 message two Z
|
|
$head2 message one Z
|
|
$head3 add bar Z
|
|
$head4 $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting at the nth column. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %<|(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
$head1 message two Z
|
|
$head2 message one Z
|
|
$head3 add bar Z
|
|
$head4 $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with no padding' '
|
|
git log --pretty="tformat:%<(1)%s" >actual &&
|
|
cat <<-EOF >expected &&
|
|
message two
|
|
message one
|
|
add bar
|
|
$(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with no padding. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(1)%s" >actual &&
|
|
cat <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
message two
|
|
message one
|
|
add bar
|
|
$(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with trunc' '
|
|
git log --pretty="tformat:%<(10,trunc)%s" >actual &&
|
|
qz_to_tab_space <<-\EOF >expected &&
|
|
message ..
|
|
message ..
|
|
add bar Z
|
|
initial...
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with trunc. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,trunc)%s" >actual &&
|
|
qz_to_tab_space <<-\EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
message ..
|
|
message ..
|
|
add bar Z
|
|
initial...
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with ltrunc' '
|
|
git log --pretty="tformat:%<(10,ltrunc)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
..sage two
|
|
..sage one
|
|
add bar Z
|
|
..${sample_utf8_part}lich
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with ltrunc. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,ltrunc)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
..sage two
|
|
..sage one
|
|
add bar Z
|
|
..${sample_utf8_part}lich
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with mtrunc' '
|
|
git log --pretty="tformat:%<(10,mtrunc)%s" >actual &&
|
|
qz_to_tab_space <<-\EOF >expected &&
|
|
mess.. two
|
|
mess.. one
|
|
add bar Z
|
|
init..lich
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left alignment formatting with mtrunc. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,mtrunc)%s" >actual &&
|
|
qz_to_tab_space <<-\EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
mess.. two
|
|
mess.. one
|
|
add bar Z
|
|
init..lich
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting' '
|
|
git log --pretty="tformat:%>(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
Z message two
|
|
Z message one
|
|
Z add bar
|
|
Z $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%>(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
Z message two
|
|
Z message one
|
|
Z add bar
|
|
Z $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting at the nth column' '
|
|
git log --pretty="tformat:%h %>|(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
$head1 message two
|
|
$head2 message one
|
|
$head3 add bar
|
|
$head4 $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting at the nth column' '
|
|
COLUMNS=50 git log --pretty="tformat:%h %>|(-10)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
$head1 message two
|
|
$head2 message one
|
|
$head3 add bar
|
|
$head4 $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting at the nth column. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %>|(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
$head1 message two
|
|
$head2 message one
|
|
$head3 add bar
|
|
$head4 $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
# Note: Space between 'message' and 'two' should be in the same column
|
|
# as in previous test.
|
|
test_expect_success 'right alignment formatting at the nth column with --graph. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --graph --pretty="tformat:%h %>|(40)%s" >actual &&
|
|
iconv -f utf-8 -t $test_encoding >expected <<-EOF &&
|
|
* $head1 message two
|
|
* $head2 message one
|
|
* $head3 add bar
|
|
* $head4 $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting with no padding' '
|
|
git log --pretty="tformat:%>(1)%s" >actual &&
|
|
cat <<-EOF >expected &&
|
|
message two
|
|
message one
|
|
add bar
|
|
$(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting with no padding and with --graph' '
|
|
git log --graph --pretty="tformat:%>(1)%s" >actual &&
|
|
cat <<-EOF >expected &&
|
|
* message two
|
|
* message one
|
|
* add bar
|
|
* $(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'right alignment formatting with no padding. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%>(1)%s" >actual &&
|
|
cat <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
message two
|
|
message one
|
|
add bar
|
|
$(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'center alignment formatting' '
|
|
git log --pretty="tformat:%><(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
Z message two Z
|
|
Z message one Z
|
|
Z add bar Z
|
|
Z $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'center alignment formatting. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%><(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
Z message two Z
|
|
Z message one Z
|
|
Z add bar Z
|
|
Z $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
test_expect_success 'center alignment formatting at the nth column' '
|
|
git log --pretty="tformat:%h %><|(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
$head1 message two Z
|
|
$head2 message one Z
|
|
$head3 add bar Z
|
|
$head4 $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'center alignment formatting at the nth column' '
|
|
COLUMNS=70 git log --pretty="tformat:%h %><|(-30)%s" >actual &&
|
|
qz_to_tab_space <<-EOF >expected &&
|
|
$head1 message two Z
|
|
$head2 message one Z
|
|
$head3 add bar Z
|
|
$head4 $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'center alignment formatting at the nth column. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %><|(40)%s" >actual &&
|
|
qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
$head1 message two Z
|
|
$head2 message one Z
|
|
$head3 add bar Z
|
|
$head4 $(commit_msg) Z
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'center alignment formatting with no padding' '
|
|
git log --pretty="tformat:%><(1)%s" >actual &&
|
|
cat <<-EOF >expected &&
|
|
message two
|
|
message one
|
|
add bar
|
|
$(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
# save HEAD's SHA-1 digest (with no abbreviations) to use it below
|
|
# as far as the next test amends HEAD
|
|
old_head1=$(git rev-parse --verify HEAD~0)
|
|
test_expect_success 'center alignment formatting with no padding. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%><(1)%s" >actual &&
|
|
cat <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
message two
|
|
message one
|
|
add bar
|
|
$(commit_msg)
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'left/right alignment formatting with stealing' '
|
|
git commit --amend -m short --author "long long long <long@me.com>" &&
|
|
git log --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)% an" >actual &&
|
|
cat <<-\EOF >expected &&
|
|
short long long long
|
|
message .. A U Thor
|
|
add bar A U Thor
|
|
initial... A U Thor
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
test_expect_success 'left/right alignment formatting with stealing. i18n.logOutputEncoding' '
|
|
git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)% an" >actual &&
|
|
cat <<-\EOF | iconv -f utf-8 -t $test_encoding >expected &&
|
|
short long long long
|
|
message .. A U Thor
|
|
add bar A U Thor
|
|
initial... A U Thor
|
|
EOF
|
|
test_cmp expected actual
|
|
'
|
|
|
|
test_expect_success 'strbuf_utf8_replace() not producing NUL' '
|
|
git log --color --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)%C(auto)%d" |
|
|
test_decode_color |
|
|
nul_to_q >actual &&
|
|
! grep Q actual
|
|
'
|
|
|
|
# ISO strict date format
|
|
test_expect_success 'ISO and ISO-strict date formats display the same values' '
|
|
git log --format=%ai%n%ci |
|
|
sed -e "s/ /T/; s/ //; s/..\$/:&/" >expected &&
|
|
git log --format=%aI%n%cI >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
# get new digests (with no abbreviations)
|
|
test_expect_success 'set up log decoration tests' '
|
|
head1=$(git rev-parse --verify HEAD~0) &&
|
|
head2=$(git rev-parse --verify HEAD~1)
|
|
'
|
|
|
|
test_expect_success 'log decoration properly follows tag chain' '
|
|
git tag -a tag1 -m tag1 &&
|
|
git tag -a tag2 -m tag2 tag1 &&
|
|
git tag -d tag1 &&
|
|
git commit --amend -m shorter &&
|
|
git log --no-walk --tags --pretty="%H %d" --decorate=full >actual &&
|
|
cat <<-EOF >expected &&
|
|
$head1 (tag: refs/tags/tag2)
|
|
$head2 (tag: refs/tags/message-one)
|
|
$old_head1 (tag: refs/tags/message-two)
|
|
EOF
|
|
sort actual >actual1 &&
|
|
test_cmp expected actual1
|
|
'
|
|
|
|
test_expect_success 'clean log decoration' '
|
|
git log --no-walk --tags --pretty="%H %D" --decorate=full >actual &&
|
|
cat >expected <<-EOF &&
|
|
$head1 tag: refs/tags/tag2
|
|
$head2 tag: refs/tags/message-one
|
|
$old_head1 tag: refs/tags/message-two
|
|
EOF
|
|
sort actual >actual1 &&
|
|
test_cmp expected actual1
|
|
'
|
|
|
|
cat >trailers <<EOF
|
|
Signed-off-by: A U Thor <author@example.com>
|
|
Acked-by: A U Thor <author@example.com>
|
|
[ v2 updated patch description ]
|
|
Signed-off-by: A U Thor <author@example.com>
|
|
EOF
|
|
|
|
test_expect_success 'pretty format %(trailers) shows trailers' '
|
|
echo "Some contents" >trailerfile &&
|
|
git add trailerfile &&
|
|
git commit -F - <<-EOF &&
|
|
trailers: this commit message has trailers
|
|
|
|
This commit is a test commit with trailers at the end. We parse this
|
|
message and display the trailers using %bT
|
|
|
|
$(cat trailers)
|
|
EOF
|
|
git log --no-walk --pretty="%(trailers)" >actual &&
|
|
cat >expect <<-EOF &&
|
|
$(cat trailers)
|
|
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_done
|