convert: add 'working-tree-encoding' attribute
Git recognizes files encoded with ASCII or one of its supersets (e.g. UTF-8 or ISO-8859-1) as text files. All other encodings are usually interpreted as binary and consequently built-in Git text processing tools (e.g. 'git diff') as well as most Git web front ends do not visualize the content. Add an attribute to tell Git what encoding the user has defined for a given file. If the content is added to the index, then Git reencodes the content to a canonical UTF-8 representation. On checkout Git will reverse this operation. Signed-off-by: Lars Schneider <larsxschneider@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Lars Schneider
committed by
Junio C Hamano
Junio C Hamano
parent
c6e48652f6
commit
107642fe26
142
t/t0028-working-tree-encoding.sh
Executable file
142
t/t0028-working-tree-encoding.sh
Executable file
@ -0,0 +1,142 @@
|
||||
#!/bin/sh
|
||||
|
||||
test_description='working-tree-encoding conversion via gitattributes'
|
||||
|
||||
. ./test-lib.sh
|
||||
|
||||
test_expect_success 'setup test files' '
|
||||
git config core.eol lf &&
|
||||
|
||||
text="hallo there!\ncan you read me?" &&
|
||||
echo "*.utf16 text working-tree-encoding=utf-16" >.gitattributes &&
|
||||
printf "$text" >test.utf8.raw &&
|
||||
printf "$text" | iconv -f UTF-8 -t UTF-16 >test.utf16.raw &&
|
||||
printf "$text" | iconv -f UTF-8 -t UTF-32 >test.utf32.raw &&
|
||||
|
||||
# Line ending tests
|
||||
printf "one\ntwo\nthree\n" >lf.utf8.raw &&
|
||||
printf "one\r\ntwo\r\nthree\r\n" >crlf.utf8.raw &&
|
||||
|
||||
# BOM tests
|
||||
printf "\0a\0b\0c" >nobom.utf16be.raw &&
|
||||
printf "a\0b\0c\0" >nobom.utf16le.raw &&
|
||||
printf "\376\777\0a\0b\0c" >bebom.utf16be.raw &&
|
||||
printf "\777\376a\0b\0c\0" >lebom.utf16le.raw &&
|
||||
printf "\0\0\0a\0\0\0b\0\0\0c" >nobom.utf32be.raw &&
|
||||
printf "a\0\0\0b\0\0\0c\0\0\0" >nobom.utf32le.raw &&
|
||||
printf "\0\0\376\777\0\0\0a\0\0\0b\0\0\0c" >bebom.utf32be.raw &&
|
||||
printf "\777\376\0\0a\0\0\0b\0\0\0c\0\0\0" >lebom.utf32le.raw &&
|
||||
|
||||
# Add only UTF-16 file, we will add the UTF-32 file later
|
||||
cp test.utf16.raw test.utf16 &&
|
||||
cp test.utf32.raw test.utf32 &&
|
||||
git add .gitattributes test.utf16 &&
|
||||
git commit -m initial
|
||||
'
|
||||
|
||||
test_expect_success 'ensure UTF-8 is stored in Git' '
|
||||
test_when_finished "rm -f test.utf16.git" &&
|
||||
|
||||
git cat-file -p :test.utf16 >test.utf16.git &&
|
||||
test_cmp_bin test.utf8.raw test.utf16.git
|
||||
'
|
||||
|
||||
test_expect_success 're-encode to UTF-16 on checkout' '
|
||||
test_when_finished "rm -f test.utf16.raw" &&
|
||||
|
||||
rm test.utf16 &&
|
||||
git checkout test.utf16 &&
|
||||
test_cmp_bin test.utf16.raw test.utf16
|
||||
'
|
||||
|
||||
test_expect_success 'check $GIT_DIR/info/attributes support' '
|
||||
test_when_finished "rm -f test.utf32.git" &&
|
||||
test_when_finished "git reset --hard HEAD" &&
|
||||
|
||||
echo "*.utf32 text working-tree-encoding=utf-32" >.git/info/attributes &&
|
||||
git add test.utf32 &&
|
||||
|
||||
git cat-file -p :test.utf32 >test.utf32.git &&
|
||||
test_cmp_bin test.utf8.raw test.utf32.git
|
||||
'
|
||||
|
||||
for i in 16 32
|
||||
do
|
||||
test_expect_success "eol conversion for UTF-${i} encoded files on checkout" '
|
||||
test_when_finished "rm -f crlf.utf${i}.raw lf.utf${i}.raw" &&
|
||||
test_when_finished "git reset --hard HEAD^" &&
|
||||
|
||||
cat lf.utf8.raw | iconv -f UTF-8 -t UTF-${i} >lf.utf${i}.raw &&
|
||||
cat crlf.utf8.raw | iconv -f UTF-8 -t UTF-${i} >crlf.utf${i}.raw &&
|
||||
cp crlf.utf${i}.raw eol.utf${i} &&
|
||||
|
||||
cat >expectIndexLF <<-EOF &&
|
||||
i/lf w/-text attr/text eol.utf${i}
|
||||
EOF
|
||||
|
||||
git add eol.utf${i} &&
|
||||
git commit -m eol &&
|
||||
|
||||
# UTF-${i} with CRLF (Windows line endings)
|
||||
rm eol.utf${i} &&
|
||||
git -c core.eol=crlf checkout eol.utf${i} &&
|
||||
test_cmp_bin crlf.utf${i}.raw eol.utf${i} &&
|
||||
|
||||
# Although the file has CRLF in the working tree,
|
||||
# ensure LF in the index
|
||||
git ls-files --eol eol.utf${i} >actual &&
|
||||
test_cmp expectIndexLF actual &&
|
||||
|
||||
# UTF-${i} with LF (Unix line endings)
|
||||
rm eol.utf${i} &&
|
||||
git -c core.eol=lf checkout eol.utf${i} &&
|
||||
test_cmp_bin lf.utf${i}.raw eol.utf${i} &&
|
||||
|
||||
# The file LF in the working tree, ensure LF in the index
|
||||
git ls-files --eol eol.utf${i} >actual &&
|
||||
test_cmp expectIndexLF actual
|
||||
'
|
||||
done
|
||||
|
||||
test_expect_success 'check unsupported encodings' '
|
||||
test_when_finished "git reset --hard HEAD" &&
|
||||
|
||||
echo "*.set text working-tree-encoding" >.gitattributes &&
|
||||
printf "set" >t.set &&
|
||||
test_must_fail git add t.set 2>err.out &&
|
||||
test_i18ngrep "true/false are no valid working-tree-encodings" err.out &&
|
||||
|
||||
echo "*.unset text -working-tree-encoding" >.gitattributes &&
|
||||
printf "unset" >t.unset &&
|
||||
git add t.unset &&
|
||||
|
||||
echo "*.empty text working-tree-encoding=" >.gitattributes &&
|
||||
printf "empty" >t.empty &&
|
||||
git add t.empty &&
|
||||
|
||||
echo "*.garbage text working-tree-encoding=garbage" >.gitattributes &&
|
||||
printf "garbage" >t.garbage &&
|
||||
test_must_fail git add t.garbage 2>err.out &&
|
||||
test_i18ngrep "failed to encode" err.out
|
||||
'
|
||||
|
||||
test_expect_success 'error if encoding round trip is not the same during refresh' '
|
||||
BEFORE_STATE=$(git rev-parse HEAD) &&
|
||||
test_when_finished "git reset --hard $BEFORE_STATE" &&
|
||||
|
||||
# Add and commit a UTF-16 file but skip the "working-tree-encoding"
|
||||
# filter. Consequently, the in-repo representation is UTF-16 and not
|
||||
# UTF-8. This simulates a Git version that has no working tree encoding
|
||||
# support.
|
||||
echo "*.utf16le text working-tree-encoding=utf-16le" >.gitattributes &&
|
||||
echo "hallo" >nonsense.utf16le &&
|
||||
TEST_HASH=$(git hash-object --no-filters -w nonsense.utf16le) &&
|
||||
git update-index --add --cacheinfo 100644 $TEST_HASH nonsense.utf16le &&
|
||||
COMMIT=$(git commit-tree -p $(git rev-parse HEAD) -m "plain commit" $(git write-tree)) &&
|
||||
git update-ref refs/heads/master $COMMIT &&
|
||||
|
||||
test_must_fail git checkout HEAD^ 2>err.out &&
|
||||
test_i18ngrep "error: .* overwritten by checkout:" err.out
|
||||
'
|
||||
|
||||
test_done
|
||||
Reference in New Issue
Block a user