3 test_description='blob conversion via gitattributes'
10 write_script <<\EOF "$TEST_ROOT/rot13.sh"
12 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' \
13 'nopqrstuvwxyzabcdefghijklmNOPQRSTUVWXYZABCDEFGHIJKLM'
16 write_script rot13-filter.pl "$PERL_PATH" \
17 <"$TEST_DIRECTORY"/t0021/rot13-filter.pl
19 generate_random_characters () {
22 test-genrandom some-seed $LEN |
23 perl -pe "s/./chr((ord($&) % 26) + ord('a'))/sge" >"$TEST_ROOT/$NAME"
27 perl -e 'print -s $ARGV[0]' "$1"
31 rm -f rot13-filter.log &&
35 # Compare two files and ensure that `clean` and `smudge` respectively are
36 # called at least once if specified in the `expect` file. The actual
37 # invocation count is not relevant because their number can vary.
38 # c.f. http://public-inbox.org/git/xmqqshv18i8i.fsf@gitster.mtv.corp.google.com/
42 for FILE in "$expect" "$actual"
44 sort "$FILE" | uniq -c |
45 sed -e "s/^ *[0-9][0-9]*[ ]*IN: /x IN: /" >"$FILE.tmp" &&
46 mv "$FILE.tmp" "$FILE" || return
48 test_cmp "$expect" "$actual"
51 # Compare two files but exclude all `clean` invocations because Git can
52 # call `clean` zero or more times.
53 # c.f. http://public-inbox.org/git/xmqqshv18i8i.fsf@gitster.mtv.corp.google.com/
54 test_cmp_exclude_clean () {
57 for FILE in "$expect" "$actual"
59 grep -v "IN: clean" "$FILE" >"$FILE.tmp" &&
60 mv "$FILE.tmp" "$FILE"
62 test_cmp "$expect" "$actual"
65 # Check that the contents of two files are equal and that their rot13 version
66 # is equal to the committed content.
67 test_cmp_committed_rot13 () {
69 rot13.sh <"$1" >expected &&
70 git cat-file blob :"$2" >actual &&
71 test_cmp expected actual
74 test_expect_success setup '
75 git config filter.rot13.smudge ./rot13.sh &&
76 git config filter.rot13.clean ./rot13.sh &&
79 echo "*.t filter=rot13"
84 echo a b c d e f g h i j k l m
85 echo n o p q r s t u v w x y z
91 git add test test.t test.i &&
92 rm -f test test.t test.i &&
93 git checkout -- test test.t test.i &&
95 echo "content-test2" >test2.o &&
96 echo "content-test3 - filename with special characters" >"test3 '\''sq'\'',\$x.o"
99 script='s/^\$Id: \([0-9a-f]*\) \$/\1/p'
101 test_expect_success check '
103 test_cmp test.o test &&
104 test_cmp test.o test.t &&
106 # ident should be stripped in the repository
107 git diff --raw --exit-code :test :test.i &&
108 id=$(git rev-parse --verify :test) &&
109 embedded=$(sed -ne "$script" test.i) &&
110 test "z$id" = "z$embedded" &&
112 git cat-file blob :test.t >test.r &&
114 ./rot13.sh <test.o >test.t &&
115 test_cmp test.r test.t
118 # If an expanded ident ever gets into the repository, we want to make sure that
119 # it is collapsed before being expanded again on checkout
120 test_expect_success expanded_in_repo '
122 echo "File with expanded keywords"
125 echo "\$Id: 0000000000000000000000000000000000000000 \$"
126 echo "\$Id: NoSpaceAtEnd\$"
127 echo "\$Id:NoSpaceAtFront \$"
128 echo "\$Id:NoSpaceAtEitherEnd\$"
129 echo "\$Id: NoTerminatingSymbol"
130 echo "\$Id: Foreign Commit With Spaces \$"
131 } >expanded-keywords.0 &&
134 cat expanded-keywords.0 &&
135 printf "\$Id: NoTerminatingSymbolAtEOF"
136 } >expanded-keywords &&
137 cat expanded-keywords >expanded-keywords-crlf &&
138 git add expanded-keywords expanded-keywords-crlf &&
139 git commit -m "File with keywords expanded" &&
140 id=$(git rev-parse --verify :expanded-keywords) &&
143 echo "File with expanded keywords"
150 echo "\$Id: NoTerminatingSymbol"
151 echo "\$Id: Foreign Commit With Spaces \$"
152 } >expected-output.0 &&
154 cat expected-output.0 &&
155 printf "\$Id: NoTerminatingSymbolAtEOF"
156 } >expected-output &&
158 append_cr <expected-output.0 &&
159 printf "\$Id: NoTerminatingSymbolAtEOF"
160 } >expected-output-crlf &&
162 echo "expanded-keywords ident"
163 echo "expanded-keywords-crlf ident text eol=crlf"
164 } >>.gitattributes &&
166 rm -f expanded-keywords expanded-keywords-crlf &&
168 git checkout -- expanded-keywords &&
169 test_cmp expanded-keywords expected-output &&
171 git checkout -- expanded-keywords-crlf &&
172 test_cmp expanded-keywords-crlf expected-output-crlf
175 # The use of %f in a filter definition is expanded to the path to
176 # the filename being smudged or cleaned. It must be shell escaped.
177 # First, set up some interesting file names and pet them in
179 test_expect_success 'filter shell-escaped filenames' '
180 cat >argc.sh <<-EOF &&
185 normal=name-no-magic &&
186 special="name with '\''sq'\'' and \$x" &&
187 echo some test text >"$normal" &&
188 echo some test text >"$special" &&
189 git add "$normal" "$special" &&
190 git commit -q -m "add files" &&
191 echo "name* filter=argc" >.gitattributes &&
193 # delete the files and check them out again, using a smudge filter
194 # that will count the args and echo the command-line back to us
195 test_config filter.argc.smudge "sh ./argc.sh %f" &&
196 rm "$normal" "$special" &&
197 git checkout -- "$normal" "$special" &&
199 # make sure argc.sh counted the right number of args
200 echo "argc: 1 $normal" >expect &&
201 test_cmp expect "$normal" &&
202 echo "argc: 1 $special" >expect &&
203 test_cmp expect "$special" &&
205 # do the same thing, but with more args in the filter expression
206 test_config filter.argc.smudge "sh ./argc.sh %f --my-extra-arg" &&
207 rm "$normal" "$special" &&
208 git checkout -- "$normal" "$special" &&
210 # make sure argc.sh counted the right number of args
211 echo "argc: 2 $normal --my-extra-arg" >expect &&
212 test_cmp expect "$normal" &&
213 echo "argc: 2 $special --my-extra-arg" >expect &&
214 test_cmp expect "$special" &&
218 test_expect_success 'required filter should filter data' '
219 test_config filter.required.smudge ./rot13.sh &&
220 test_config filter.required.clean ./rot13.sh &&
221 test_config filter.required.required true &&
223 echo "*.r filter=required" >.gitattributes &&
225 cat test.o >test.r &&
229 git checkout -- test.r &&
230 test_cmp test.o test.r &&
232 ./rot13.sh <test.o >expected &&
233 git cat-file blob :test.r >actual &&
234 test_cmp expected actual
237 test_expect_success 'required filter smudge failure' '
238 test_config filter.failsmudge.smudge false &&
239 test_config filter.failsmudge.clean cat &&
240 test_config filter.failsmudge.required true &&
242 echo "*.fs filter=failsmudge" >.gitattributes &&
244 echo test >test.fs &&
247 test_must_fail git checkout -- test.fs
250 test_expect_success 'required filter clean failure' '
251 test_config filter.failclean.smudge cat &&
252 test_config filter.failclean.clean false &&
253 test_config filter.failclean.required true &&
255 echo "*.fc filter=failclean" >.gitattributes &&
257 echo test >test.fc &&
258 test_must_fail git add test.fc
261 test_expect_success 'filtering large input to small output should use little memory' '
262 test_config filter.devnull.clean "cat >/dev/null" &&
263 test_config filter.devnull.required true &&
264 for i in $(test_seq 1 30); do printf "%1048576d" 1; done >30MB &&
265 echo "30MB filter=devnull" >.gitattributes &&
266 GIT_MMAP_LIMIT=1m GIT_ALLOC_LIMIT=1m git add 30MB
269 test_expect_success 'filter that does not read is fine' '
270 test-genrandom foo $((128 * 1024 + 1)) >big &&
271 echo "big filter=epipe" >.gitattributes &&
272 test_config filter.epipe.clean "echo xyzzy" &&
274 git cat-file blob :big >actual &&
275 echo xyzzy >expect &&
276 test_cmp expect actual
279 test_expect_success EXPENSIVE 'filter large file' '
280 test_config filter.largefile.smudge cat &&
281 test_config filter.largefile.clean cat &&
282 for i in $(test_seq 1 2048); do printf "%1048576d" 1; done >2GB &&
283 echo "2GB filter=largefile" >.gitattributes &&
285 test_must_be_empty err &&
287 git checkout -- 2GB 2>err &&
288 test_must_be_empty err
291 test_expect_success "filter: clean empty file" '
292 test_config filter.in-repo-header.clean "echo cleaned && cat" &&
293 test_config filter.in-repo-header.smudge "sed 1d" &&
295 echo "empty-in-worktree filter=in-repo-header" >>.gitattributes &&
296 >empty-in-worktree &&
298 echo cleaned >expected &&
299 git add empty-in-worktree &&
300 git show :empty-in-worktree >actual &&
301 test_cmp expected actual
304 test_expect_success "filter: smudge empty file" '
305 test_config filter.empty-in-repo.clean "cat >/dev/null" &&
306 test_config filter.empty-in-repo.smudge "echo smudged && cat" &&
308 echo "empty-in-repo filter=empty-in-repo" >>.gitattributes &&
309 echo dead data walking >empty-in-repo &&
310 git add empty-in-repo &&
312 echo smudged >expected &&
313 git checkout-index --prefix=filtered- empty-in-repo &&
314 test_cmp expected filtered-empty-in-repo
317 test_expect_success 'disable filter with empty override' '
318 test_config_global filter.disable.smudge false &&
319 test_config_global filter.disable.clean false &&
320 test_config filter.disable.smudge false &&
321 test_config filter.disable.clean false &&
323 echo "*.disable filter=disable" >.gitattributes &&
325 echo test >test.disable &&
326 git -c filter.disable.clean= add test.disable 2>err &&
327 test_must_be_empty err &&
328 rm -f test.disable &&
329 git -c filter.disable.smudge= checkout -- test.disable 2>err &&
330 test_must_be_empty err
333 test_expect_success 'diff does not reuse worktree files that need cleaning' '
334 test_config filter.counter.clean "echo . >>count; sed s/^/clean:/" &&
335 echo "file filter=counter" >.gitattributes &&
336 test_commit one file &&
337 test_commit two file &&
340 git diff-tree -p HEAD &&
341 test_line_count = 0 count
344 test_expect_success PERL 'required process filter should filter data' '
345 test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
346 test_config_global filter.protocol.required true &&
353 echo "*.r filter=protocol" >.gitattributes &&
355 git commit -m "test commit 1" &&
356 git branch empty-branch &&
358 cp "$TEST_ROOT/test.o" test.r &&
359 cp "$TEST_ROOT/test2.o" test2.r &&
361 cp "$TEST_ROOT/test3 '\''sq'\'',\$x.o" "testsubdir/test3 '\''sq'\'',\$x.r" &&
364 S=$(file_size test.r) &&
365 S2=$(file_size test2.r) &&
366 S3=$(file_size "testsubdir/test3 '\''sq'\'',\$x.r") &&
369 cat >expected.log <<-EOF &&
371 init handshake complete
372 IN: clean test.r $S [OK] -- OUT: $S . [OK]
373 IN: clean test2.r $S2 [OK] -- OUT: $S2 . [OK]
374 IN: clean test4-empty.r 0 [OK] -- OUT: 0 [OK]
375 IN: clean testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
378 test_cmp_count expected.log rot13-filter.log &&
380 filter_git commit -m "test commit 2" &&
381 cat >expected.log <<-EOF &&
383 init handshake complete
384 IN: clean test.r $S [OK] -- OUT: $S . [OK]
385 IN: clean test2.r $S2 [OK] -- OUT: $S2 . [OK]
386 IN: clean test4-empty.r 0 [OK] -- OUT: 0 [OK]
387 IN: clean testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
388 IN: clean test.r $S [OK] -- OUT: $S . [OK]
389 IN: clean test2.r $S2 [OK] -- OUT: $S2 . [OK]
390 IN: clean test4-empty.r 0 [OK] -- OUT: 0 [OK]
391 IN: clean testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
394 test_cmp_count expected.log rot13-filter.log &&
396 rm -f test2.r "testsubdir/test3 '\''sq'\'',\$x.r" &&
398 filter_git checkout --quiet --no-progress . &&
399 cat >expected.log <<-EOF &&
401 init handshake complete
402 IN: smudge test2.r $S2 [OK] -- OUT: $S2 . [OK]
403 IN: smudge testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
406 test_cmp_exclude_clean expected.log rot13-filter.log &&
408 filter_git checkout --quiet --no-progress empty-branch &&
409 cat >expected.log <<-EOF &&
411 init handshake complete
412 IN: clean test.r $S [OK] -- OUT: $S . [OK]
415 test_cmp_exclude_clean expected.log rot13-filter.log &&
417 filter_git checkout --quiet --no-progress master &&
418 cat >expected.log <<-EOF &&
420 init handshake complete
421 IN: smudge test.r $S [OK] -- OUT: $S . [OK]
422 IN: smudge test2.r $S2 [OK] -- OUT: $S2 . [OK]
423 IN: smudge test4-empty.r 0 [OK] -- OUT: 0 [OK]
424 IN: smudge testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
427 test_cmp_exclude_clean expected.log rot13-filter.log &&
429 test_cmp_committed_rot13 "$TEST_ROOT/test.o" test.r &&
430 test_cmp_committed_rot13 "$TEST_ROOT/test2.o" test2.r &&
431 test_cmp_committed_rot13 "$TEST_ROOT/test3 '\''sq'\'',\$x.o" "testsubdir/test3 '\''sq'\'',\$x.r"
435 test_expect_success PERL 'required process filter takes precedence' '
436 test_config_global filter.protocol.clean false &&
437 test_config_global filter.protocol.process "rot13-filter.pl clean" &&
438 test_config_global filter.protocol.required true &&
445 echo "*.r filter=protocol" >.gitattributes &&
446 cp "$TEST_ROOT/test.o" test.r &&
447 S=$(file_size test.r) &&
449 # Check that the process filter is invoked here
451 cat >expected.log <<-EOF &&
453 init handshake complete
454 IN: clean test.r $S [OK] -- OUT: $S . [OK]
457 test_cmp_count expected.log rot13-filter.log
461 test_expect_success PERL 'required process filter should be used only for "clean" operation only' '
462 test_config_global filter.protocol.process "rot13-filter.pl clean" &&
469 echo "*.r filter=protocol" >.gitattributes &&
470 cp "$TEST_ROOT/test.o" test.r &&
471 S=$(file_size test.r) &&
474 cat >expected.log <<-EOF &&
476 init handshake complete
477 IN: clean test.r $S [OK] -- OUT: $S . [OK]
480 test_cmp_count expected.log rot13-filter.log &&
484 filter_git checkout --quiet --no-progress . &&
485 # If the filter would be used for "smudge", too, we would see
486 # "IN: smudge test.r 57 [OK] -- OUT: 57 . [OK]" here
487 cat >expected.log <<-EOF &&
489 init handshake complete
492 test_cmp_exclude_clean expected.log rot13-filter.log
496 test_expect_success PERL 'required process filter should process multiple packets' '
497 test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
498 test_config_global filter.protocol.required true &&
506 # Generate data requiring 1, 2, 3 packets
507 S=65516 && # PKTLINE_DATA_MAXLEN -> Maximal size of a packet
508 generate_random_characters $(($S )) 1pkt_1__.file &&
509 generate_random_characters $(($S +1)) 2pkt_1+1.file &&
510 generate_random_characters $(($S*2-1)) 2pkt_2-1.file &&
511 generate_random_characters $(($S*2 )) 2pkt_2__.file &&
512 generate_random_characters $(($S*2+1)) 3pkt_2+1.file &&
514 for FILE in "$TEST_ROOT"/*.file
517 rot13.sh <"$FILE" >"$FILE.rot13"
520 echo "*.file filter=protocol" >.gitattributes &&
521 filter_git add *.file .gitattributes &&
522 cat >expected.log <<-EOF &&
524 init handshake complete
525 IN: clean 1pkt_1__.file $(($S )) [OK] -- OUT: $(($S )) . [OK]
526 IN: clean 2pkt_1+1.file $(($S +1)) [OK] -- OUT: $(($S +1)) .. [OK]
527 IN: clean 2pkt_2-1.file $(($S*2-1)) [OK] -- OUT: $(($S*2-1)) .. [OK]
528 IN: clean 2pkt_2__.file $(($S*2 )) [OK] -- OUT: $(($S*2 )) .. [OK]
529 IN: clean 3pkt_2+1.file $(($S*2+1)) [OK] -- OUT: $(($S*2+1)) ... [OK]
532 test_cmp_count expected.log rot13-filter.log &&
536 filter_git checkout --quiet --no-progress -- *.file &&
537 cat >expected.log <<-EOF &&
539 init handshake complete
540 IN: smudge 1pkt_1__.file $(($S )) [OK] -- OUT: $(($S )) . [OK]
541 IN: smudge 2pkt_1+1.file $(($S +1)) [OK] -- OUT: $(($S +1)) .. [OK]
542 IN: smudge 2pkt_2-1.file $(($S*2-1)) [OK] -- OUT: $(($S*2-1)) .. [OK]
543 IN: smudge 2pkt_2__.file $(($S*2 )) [OK] -- OUT: $(($S*2 )) .. [OK]
544 IN: smudge 3pkt_2+1.file $(($S*2+1)) [OK] -- OUT: $(($S*2+1)) ... [OK]
547 test_cmp_exclude_clean expected.log rot13-filter.log &&
551 test_cmp_committed_rot13 "$TEST_ROOT/$FILE" $FILE
556 test_expect_success PERL 'required process filter with clean error should fail' '
557 test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
558 test_config_global filter.protocol.required true &&
565 echo "*.r filter=protocol" >.gitattributes &&
567 cp "$TEST_ROOT/test.o" test.r &&
568 echo "this is going to fail" >clean-write-fail.r &&
569 echo "content-test3-subdir" >test3.r &&
571 test_must_fail git add .
575 test_expect_success PERL 'process filter should restart after unexpected write failure' '
576 test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
583 echo "*.r filter=protocol" >.gitattributes &&
585 cp "$TEST_ROOT/test.o" test.r &&
586 cp "$TEST_ROOT/test2.o" test2.r &&
587 echo "this is going to fail" >smudge-write-fail.o &&
588 cp smudge-write-fail.o smudge-write-fail.r &&
590 S=$(file_size test.r) &&
591 S2=$(file_size test2.r) &&
592 SF=$(file_size smudge-write-fail.r) &&
597 rm -f rot13-filter.log &&
598 git checkout --quiet --no-progress . 2>git-stderr.log &&
600 grep "smudge write error at" git-stderr.log &&
601 grep "error: external filter" git-stderr.log &&
603 cat >expected.log <<-EOF &&
605 init handshake complete
606 IN: smudge smudge-write-fail.r $SF [OK] -- OUT: $SF [WRITE FAIL]
608 init handshake complete
609 IN: smudge test.r $S [OK] -- OUT: $S . [OK]
610 IN: smudge test2.r $S2 [OK] -- OUT: $S2 . [OK]
613 test_cmp_exclude_clean expected.log rot13-filter.log &&
615 test_cmp_committed_rot13 "$TEST_ROOT/test.o" test.r &&
616 test_cmp_committed_rot13 "$TEST_ROOT/test2.o" test2.r &&
619 ! test_cmp smudge-write-fail.o smudge-write-fail.r &&
620 rot13.sh <smudge-write-fail.o >expected &&
621 git cat-file blob :smudge-write-fail.r >actual &&
622 test_cmp expected actual
626 test_expect_success PERL 'process filter should not be restarted if it signals an error' '
627 test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
634 echo "*.r filter=protocol" >.gitattributes &&
636 cp "$TEST_ROOT/test.o" test.r &&
637 cp "$TEST_ROOT/test2.o" test2.r &&
638 echo "this will cause an error" >error.o &&
639 cp error.o error.r &&
641 S=$(file_size test.r) &&
642 S2=$(file_size test2.r) &&
643 SE=$(file_size error.r) &&
648 filter_git checkout --quiet --no-progress . &&
649 cat >expected.log <<-EOF &&
651 init handshake complete
652 IN: smudge error.r $SE [OK] -- OUT: 0 [ERROR]
653 IN: smudge test.r $S [OK] -- OUT: $S . [OK]
654 IN: smudge test2.r $S2 [OK] -- OUT: $S2 . [OK]
657 test_cmp_exclude_clean expected.log rot13-filter.log &&
659 test_cmp_committed_rot13 "$TEST_ROOT/test.o" test.r &&
660 test_cmp_committed_rot13 "$TEST_ROOT/test2.o" test2.r &&
661 test_cmp error.o error.r
665 test_expect_success PERL 'process filter abort stops processing of all further files' '
666 test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
673 echo "*.r filter=protocol" >.gitattributes &&
675 cp "$TEST_ROOT/test.o" test.r &&
676 cp "$TEST_ROOT/test2.o" test2.r &&
677 echo "error this blob and all future blobs" >abort.o &&
678 cp abort.o abort.r &&
680 SA=$(file_size abort.r) &&
685 # Note: This test assumes that Git filters files in alphabetical
686 # order ("abort.r" before "test.r").
687 filter_git checkout --quiet --no-progress . &&
688 cat >expected.log <<-EOF &&
690 init handshake complete
691 IN: smudge abort.r $SA [OK] -- OUT: 0 [ABORT]
694 test_cmp_exclude_clean expected.log rot13-filter.log &&
696 test_cmp "$TEST_ROOT/test.o" test.r &&
697 test_cmp "$TEST_ROOT/test2.o" test2.r &&
698 test_cmp abort.o abort.r
702 test_expect_success PERL 'invalid process filter must fail (and not hang!)' '
703 test_config_global filter.protocol.process cat &&
704 test_config_global filter.protocol.required true &&
711 echo "*.r filter=protocol" >.gitattributes &&
713 cp "$TEST_ROOT/test.o" test.r &&
714 test_must_fail git add . 2>git-stderr.log &&
715 grep "does not support filter protocol version" git-stderr.log