commit --amend: invoke post-rewrite hook
[git/jnareb-git.git] / t / t3301-notes.sh
blobcb7166f6ecc77056d6a5a1626cb97c22b99db5f9
1 #!/bin/sh
3 # Copyright (c) 2007 Johannes E. Schindelin
6 test_description='Test commit notes'
8 . ./test-lib.sh
10 cat > fake_editor.sh << \EOF
11 echo "$MSG" > "$1"
12 echo "$MSG" >& 2
13 EOF
14 chmod a+x fake_editor.sh
15 GIT_EDITOR=./fake_editor.sh
16 export GIT_EDITOR
18 test_expect_success 'cannot annotate non-existing HEAD' '
19 (MSG=3 && export MSG && test_must_fail git notes add)
22 test_expect_success setup '
23 : > a1 &&
24 git add a1 &&
25 test_tick &&
26 git commit -m 1st &&
27 : > a2 &&
28 git add a2 &&
29 test_tick &&
30 git commit -m 2nd
33 test_expect_success 'need valid notes ref' '
34 (MSG=1 GIT_NOTES_REF=/ && export MSG GIT_NOTES_REF &&
35 test_must_fail git notes add) &&
36 (MSG=2 GIT_NOTES_REF=/ && export MSG GIT_NOTES_REF &&
37 test_must_fail git notes show)
40 test_expect_success 'refusing to add notes in refs/heads/' '
41 (MSG=1 GIT_NOTES_REF=refs/heads/bogus &&
42 export MSG GIT_NOTES_REF &&
43 test_must_fail git notes add)
46 test_expect_success 'refusing to edit notes in refs/remotes/' '
47 (MSG=1 GIT_NOTES_REF=refs/remotes/bogus &&
48 export MSG GIT_NOTES_REF &&
49 test_must_fail git notes edit)
52 # 1 indicates caught gracefully by die, 128 means git-show barked
53 test_expect_success 'handle empty notes gracefully' '
54 git notes show ; test 1 = $?
57 test_expect_success 'create notes' '
58 git config core.notesRef refs/notes/commits &&
59 MSG=b4 git notes add &&
60 test ! -f .git/NOTES_EDITMSG &&
61 test 1 = $(git ls-tree refs/notes/commits | wc -l) &&
62 test b4 = $(git notes show) &&
63 git show HEAD^ &&
64 test_must_fail git notes show HEAD^
67 test_expect_success 'edit existing notes' '
68 MSG=b3 git notes edit &&
69 test ! -f .git/NOTES_EDITMSG &&
70 test 1 = $(git ls-tree refs/notes/commits | wc -l) &&
71 test b3 = $(git notes show) &&
72 git show HEAD^ &&
73 test_must_fail git notes show HEAD^
76 test_expect_success 'cannot add note where one exists' '
77 ! MSG=b2 git notes add &&
78 test ! -f .git/NOTES_EDITMSG &&
79 test 1 = $(git ls-tree refs/notes/commits | wc -l) &&
80 test b3 = $(git notes show) &&
81 git show HEAD^ &&
82 test_must_fail git notes show HEAD^
85 test_expect_success 'can overwrite existing note with "git notes add -f"' '
86 MSG=b1 git notes add -f &&
87 test ! -f .git/NOTES_EDITMSG &&
88 test 1 = $(git ls-tree refs/notes/commits | wc -l) &&
89 test b1 = $(git notes show) &&
90 git show HEAD^ &&
91 test_must_fail git notes show HEAD^
94 cat > expect << EOF
95 commit 268048bfb8a1fb38e703baceb8ab235421bf80c5
96 Author: A U Thor <author@example.com>
97 Date: Thu Apr 7 15:14:13 2005 -0700
99 2nd
101 Notes:
105 test_expect_success 'show notes' '
106 ! (git cat-file commit HEAD | grep b1) &&
107 git log -1 > output &&
108 test_cmp expect output
111 test_expect_success 'create multi-line notes (setup)' '
112 : > a3 &&
113 git add a3 &&
114 test_tick &&
115 git commit -m 3rd &&
116 MSG="b3
117 c3c3c3c3
118 d3d3d3" git notes add
121 cat > expect-multiline << EOF
122 commit 1584215f1d29c65e99c6c6848626553fdd07fd75
123 Author: A U Thor <author@example.com>
124 Date: Thu Apr 7 15:15:13 2005 -0700
128 Notes:
130 c3c3c3c3
131 d3d3d3
134 printf "\n" >> expect-multiline
135 cat expect >> expect-multiline
137 test_expect_success 'show multi-line notes' '
138 git log -2 > output &&
139 test_cmp expect-multiline output
141 test_expect_success 'create -F notes (setup)' '
142 : > a4 &&
143 git add a4 &&
144 test_tick &&
145 git commit -m 4th &&
146 echo "xyzzy" > note5 &&
147 git notes add -F note5
150 cat > expect-F << EOF
151 commit 15023535574ded8b1a89052b32673f84cf9582b8
152 Author: A U Thor <author@example.com>
153 Date: Thu Apr 7 15:16:13 2005 -0700
157 Notes:
158 xyzzy
161 printf "\n" >> expect-F
162 cat expect-multiline >> expect-F
164 test_expect_success 'show -F notes' '
165 git log -3 > output &&
166 test_cmp expect-F output
169 cat >expect << EOF
170 commit 15023535574ded8b1a89052b32673f84cf9582b8
171 tree e070e3af51011e47b183c33adf9736736a525709
172 parent 1584215f1d29c65e99c6c6848626553fdd07fd75
173 author A U Thor <author@example.com> 1112912173 -0700
174 committer C O Mitter <committer@example.com> 1112912173 -0700
178 test_expect_success 'git log --pretty=raw does not show notes' '
179 git log -1 --pretty=raw >output &&
180 test_cmp expect output
183 cat >>expect <<EOF
185 Notes:
186 xyzzy
188 test_expect_success 'git log --show-notes' '
189 git log -1 --pretty=raw --show-notes >output &&
190 test_cmp expect output
193 test_expect_success 'git log --no-notes' '
194 git log -1 --no-notes >output &&
195 ! grep xyzzy output
198 test_expect_success 'git format-patch does not show notes' '
199 git format-patch -1 --stdout >output &&
200 ! grep xyzzy output
203 test_expect_success 'git format-patch --show-notes does show notes' '
204 git format-patch --show-notes -1 --stdout >output &&
205 grep xyzzy output
208 for pretty in \
209 "" --pretty --pretty=raw --pretty=short --pretty=medium \
210 --pretty=full --pretty=fuller --pretty=format:%s --oneline
212 case "$pretty" in
213 "") p= not= negate="" ;;
214 ?*) p="$pretty" not=" not" negate="!" ;;
215 esac
216 test_expect_success "git show $pretty does$not show notes" '
217 git show $p >output &&
218 eval "$negate grep xyzzy output"
220 done
222 test_expect_success 'create -m notes (setup)' '
223 : > a5 &&
224 git add a5 &&
225 test_tick &&
226 git commit -m 5th &&
227 git notes add -m spam -m "foo
229 baz"
232 whitespace=" "
233 cat > expect-m << EOF
234 commit bd1753200303d0a0344be813e504253b3d98e74d
235 Author: A U Thor <author@example.com>
236 Date: Thu Apr 7 15:17:13 2005 -0700
240 Notes:
241 spam
242 $whitespace
248 printf "\n" >> expect-m
249 cat expect-F >> expect-m
251 test_expect_success 'show -m notes' '
252 git log -4 > output &&
253 test_cmp expect-m output
256 test_expect_success 'remove note with add -f -F /dev/null (setup)' '
257 git notes add -f -F /dev/null
260 cat > expect-rm-F << EOF
261 commit bd1753200303d0a0344be813e504253b3d98e74d
262 Author: A U Thor <author@example.com>
263 Date: Thu Apr 7 15:17:13 2005 -0700
268 printf "\n" >> expect-rm-F
269 cat expect-F >> expect-rm-F
271 test_expect_success 'verify note removal with -F /dev/null' '
272 git log -4 > output &&
273 test_cmp expect-rm-F output &&
274 ! git notes show
277 test_expect_success 'do not create empty note with -m "" (setup)' '
278 git notes add -m ""
281 test_expect_success 'verify non-creation of note with -m ""' '
282 git log -4 > output &&
283 test_cmp expect-rm-F output &&
284 ! git notes show
287 cat > expect-combine_m_and_F << EOF
290 xyzzy
294 zyxxy
299 test_expect_success 'create note with combination of -m and -F' '
300 echo "xyzzy" > note_a &&
301 echo "zyxxy" > note_b &&
302 git notes add -m "foo" -F note_a -m "bar" -F note_b -m "baz" &&
303 git notes show > output &&
304 test_cmp expect-combine_m_and_F output
307 test_expect_success 'remove note with "git notes remove" (setup)' '
308 git notes remove HEAD^ &&
309 git notes remove
312 cat > expect-rm-remove << EOF
313 commit bd1753200303d0a0344be813e504253b3d98e74d
314 Author: A U Thor <author@example.com>
315 Date: Thu Apr 7 15:17:13 2005 -0700
319 commit 15023535574ded8b1a89052b32673f84cf9582b8
320 Author: A U Thor <author@example.com>
321 Date: Thu Apr 7 15:16:13 2005 -0700
326 printf "\n" >> expect-rm-remove
327 cat expect-multiline >> expect-rm-remove
329 test_expect_success 'verify note removal with "git notes remove"' '
330 git log -4 > output &&
331 test_cmp expect-rm-remove output &&
332 ! git notes show HEAD^
335 cat > expect << EOF
336 c18dc024e14f08d18d14eea0d747ff692d66d6a3 1584215f1d29c65e99c6c6848626553fdd07fd75
337 c9c6af7f78bc47490dbf3e822cf2f3c24d4b9061 268048bfb8a1fb38e703baceb8ab235421bf80c5
340 test_expect_success 'list notes with "git notes list"' '
341 git notes list > output &&
342 test_cmp expect output
345 test_expect_success 'list notes with "git notes"' '
346 git notes > output &&
347 test_cmp expect output
350 cat > expect << EOF
351 c18dc024e14f08d18d14eea0d747ff692d66d6a3
354 test_expect_success 'list specific note with "git notes list <object>"' '
355 git notes list HEAD^^ > output &&
356 test_cmp expect output
359 cat > expect << EOF
362 test_expect_success 'listing non-existing notes fails' '
363 test_must_fail git notes list HEAD > output &&
364 test_cmp expect output
367 cat > expect << EOF
368 Initial set of notes
370 More notes appended with git notes append
373 test_expect_success 'append to existing note with "git notes append"' '
374 git notes add -m "Initial set of notes" &&
375 git notes append -m "More notes appended with git notes append" &&
376 git notes show > output &&
377 test_cmp expect output
380 test_expect_success 'appending empty string does not change existing note' '
381 git notes append -m "" &&
382 git notes show > output &&
383 test_cmp expect output
386 test_expect_success 'git notes append == add when there is no existing note' '
387 git notes remove HEAD &&
388 test_must_fail git notes list HEAD &&
389 git notes append -m "Initial set of notes
391 More notes appended with git notes append" &&
392 git notes show > output &&
393 test_cmp expect output
396 test_expect_success 'appending empty string to non-existing note does not create note' '
397 git notes remove HEAD &&
398 test_must_fail git notes list HEAD &&
399 git notes append -m "" &&
400 test_must_fail git notes list HEAD
403 test_expect_success 'create other note on a different notes ref (setup)' '
404 : > a6 &&
405 git add a6 &&
406 test_tick &&
407 git commit -m 6th &&
408 GIT_NOTES_REF="refs/notes/other" git notes add -m "other note"
411 cat > expect-other << EOF
412 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
413 Author: A U Thor <author@example.com>
414 Date: Thu Apr 7 15:18:13 2005 -0700
418 Notes (other):
419 other note
422 cat > expect-not-other << EOF
423 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
424 Author: A U Thor <author@example.com>
425 Date: Thu Apr 7 15:18:13 2005 -0700
430 test_expect_success 'Do not show note on other ref by default' '
431 git log -1 > output &&
432 test_cmp expect-not-other output
435 test_expect_success 'Do show note when ref is given in GIT_NOTES_REF' '
436 GIT_NOTES_REF="refs/notes/other" git log -1 > output &&
437 test_cmp expect-other output
440 test_expect_success 'Do show note when ref is given in core.notesRef config' '
441 git config core.notesRef "refs/notes/other" &&
442 git log -1 > output &&
443 test_cmp expect-other output
446 test_expect_success 'Do not show note when core.notesRef is overridden' '
447 GIT_NOTES_REF="refs/notes/wrong" git log -1 > output &&
448 test_cmp expect-not-other output
451 cat > expect-both << EOF
452 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
453 Author: A U Thor <author@example.com>
454 Date: Thu Apr 7 15:18:13 2005 -0700
458 Notes:
459 order test
461 Notes (other):
462 other note
464 commit bd1753200303d0a0344be813e504253b3d98e74d
465 Author: A U Thor <author@example.com>
466 Date: Thu Apr 7 15:17:13 2005 -0700
470 Notes:
471 replacement for deleted note
474 test_expect_success 'Show all notes when notes.displayRef=refs/notes/*' '
475 GIT_NOTES_REF=refs/notes/commits git notes add \
476 -m"replacement for deleted note" HEAD^ &&
477 GIT_NOTES_REF=refs/notes/commits git notes add -m"order test" &&
478 git config --unset core.notesRef &&
479 git config notes.displayRef "refs/notes/*" &&
480 git log -2 > output &&
481 test_cmp expect-both output
484 test_expect_success 'core.notesRef is implicitly in notes.displayRef' '
485 git config core.notesRef refs/notes/commits &&
486 git config notes.displayRef refs/notes/other &&
487 git log -2 > output &&
488 test_cmp expect-both output
491 test_expect_success 'notes.displayRef can be given more than once' '
492 git config --unset core.notesRef &&
493 git config notes.displayRef refs/notes/commits &&
494 git config --add notes.displayRef refs/notes/other &&
495 git log -2 > output &&
496 test_cmp expect-both output
499 cat > expect-both-reversed << EOF
500 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
501 Author: A U Thor <author@example.com>
502 Date: Thu Apr 7 15:18:13 2005 -0700
506 Notes (other):
507 other note
509 Notes:
510 order test
513 test_expect_success 'notes.displayRef respects order' '
514 git config core.notesRef refs/notes/other &&
515 git config --unset-all notes.displayRef &&
516 git config notes.displayRef refs/notes/commits &&
517 git log -1 > output &&
518 test_cmp expect-both-reversed output
521 test_expect_success 'GIT_NOTES_DISPLAY_REF works' '
522 git config --unset-all core.notesRef &&
523 git config --unset-all notes.displayRef &&
524 GIT_NOTES_DISPLAY_REF=refs/notes/commits:refs/notes/other \
525 git log -2 > output &&
526 test_cmp expect-both output
529 cat > expect-none << EOF
530 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
531 Author: A U Thor <author@example.com>
532 Date: Thu Apr 7 15:18:13 2005 -0700
536 commit bd1753200303d0a0344be813e504253b3d98e74d
537 Author: A U Thor <author@example.com>
538 Date: Thu Apr 7 15:17:13 2005 -0700
543 test_expect_success 'GIT_NOTES_DISPLAY_REF overrides config' '
544 git config notes.displayRef "refs/notes/*" &&
545 GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log -2 > output &&
546 test_cmp expect-none output
549 test_expect_success '--show-notes=* adds to GIT_NOTES_DISPLAY_REF' '
550 GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log --show-notes=* -2 > output &&
551 test_cmp expect-both output
554 cat > expect-commits << EOF
555 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
556 Author: A U Thor <author@example.com>
557 Date: Thu Apr 7 15:18:13 2005 -0700
561 Notes:
562 order test
565 test_expect_success '--no-standard-notes' '
566 git log --no-standard-notes --show-notes=commits -1 > output &&
567 test_cmp expect-commits output
570 test_expect_success '--standard-notes' '
571 git log --no-standard-notes --show-notes=commits \
572 --standard-notes -2 > output &&
573 test_cmp expect-both output
576 test_expect_success '--show-notes=ref accumulates' '
577 git log --show-notes=other --show-notes=commits \
578 --no-standard-notes -1 > output &&
579 test_cmp expect-both-reversed output
582 test_expect_success 'Allow notes on non-commits (trees, blobs, tags)' '
583 git config core.notesRef refs/notes/other &&
584 echo "Note on a tree" > expect
585 git notes add -m "Note on a tree" HEAD: &&
586 git notes show HEAD: > actual &&
587 test_cmp expect actual &&
588 echo "Note on a blob" > expect
589 filename=$(git ls-tree --name-only HEAD | head -n1) &&
590 git notes add -m "Note on a blob" HEAD:$filename &&
591 git notes show HEAD:$filename > actual &&
592 test_cmp expect actual &&
593 echo "Note on a tag" > expect
594 git tag -a -m "This is an annotated tag" foobar HEAD^ &&
595 git notes add -m "Note on a tag" foobar &&
596 git notes show foobar > actual &&
597 test_cmp expect actual
600 cat > expect << EOF
601 commit 2ede89468182a62d0bde2583c736089bcf7d7e92
602 Author: A U Thor <author@example.com>
603 Date: Thu Apr 7 15:19:13 2005 -0700
607 Notes (other):
608 other note
611 test_expect_success 'create note from other note with "git notes add -C"' '
612 : > a7 &&
613 git add a7 &&
614 test_tick &&
615 git commit -m 7th &&
616 git notes add -C $(git notes list HEAD^) &&
617 git log -1 > actual &&
618 test_cmp expect actual &&
619 test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
622 test_expect_success 'create note from non-existing note with "git notes add -C" fails' '
623 : > a8 &&
624 git add a8 &&
625 test_tick &&
626 git commit -m 8th &&
627 test_must_fail git notes add -C deadbeef &&
628 test_must_fail git notes list HEAD
631 cat > expect << EOF
632 commit 016e982bad97eacdbda0fcbd7ce5b0ba87c81f1b
633 Author: A U Thor <author@example.com>
634 Date: Thu Apr 7 15:21:13 2005 -0700
638 Notes (other):
639 yet another note
642 test_expect_success 'create note from other note with "git notes add -c"' '
643 : > a9 &&
644 git add a9 &&
645 test_tick &&
646 git commit -m 9th &&
647 MSG="yet another note" git notes add -c $(git notes list HEAD^^) &&
648 git log -1 > actual &&
649 test_cmp expect actual
652 test_expect_success 'create note from non-existing note with "git notes add -c" fails' '
653 : > a10 &&
654 git add a10 &&
655 test_tick &&
656 git commit -m 10th &&
657 test_must_fail MSG="yet another note" git notes add -c deadbeef &&
658 test_must_fail git notes list HEAD
661 cat > expect << EOF
662 commit 016e982bad97eacdbda0fcbd7ce5b0ba87c81f1b
663 Author: A U Thor <author@example.com>
664 Date: Thu Apr 7 15:21:13 2005 -0700
668 Notes (other):
669 yet another note
670 $whitespace
671 yet another note
674 test_expect_success 'append to note from other note with "git notes append -C"' '
675 git notes append -C $(git notes list HEAD^) HEAD^ &&
676 git log -1 HEAD^ > actual &&
677 test_cmp expect actual
680 cat > expect << EOF
681 commit ffed603236bfa3891c49644257a83598afe8ae5a
682 Author: A U Thor <author@example.com>
683 Date: Thu Apr 7 15:22:13 2005 -0700
685 10th
687 Notes (other):
688 other note
691 test_expect_success 'create note from other note with "git notes append -c"' '
692 MSG="other note" git notes append -c $(git notes list HEAD^) &&
693 git log -1 > actual &&
694 test_cmp expect actual
697 cat > expect << EOF
698 commit ffed603236bfa3891c49644257a83598afe8ae5a
699 Author: A U Thor <author@example.com>
700 Date: Thu Apr 7 15:22:13 2005 -0700
702 10th
704 Notes (other):
705 other note
706 $whitespace
707 yet another note
710 test_expect_success 'append to note from other note with "git notes append -c"' '
711 MSG="yet another note" git notes append -c $(git notes list HEAD) &&
712 git log -1 > actual &&
713 test_cmp expect actual
716 cat > expect << EOF
717 commit 6352c5e33dbcab725fe0579be16aa2ba8eb369be
718 Author: A U Thor <author@example.com>
719 Date: Thu Apr 7 15:23:13 2005 -0700
721 11th
723 Notes (other):
724 other note
725 $whitespace
726 yet another note
729 test_expect_success 'copy note with "git notes copy"' '
730 : > a11 &&
731 git add a11 &&
732 test_tick &&
733 git commit -m 11th &&
734 git notes copy HEAD^ HEAD &&
735 git log -1 > actual &&
736 test_cmp expect actual &&
737 test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
740 test_expect_success 'prevent overwrite with "git notes copy"' '
741 test_must_fail git notes copy HEAD~2 HEAD &&
742 git log -1 > actual &&
743 test_cmp expect actual &&
744 test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
747 cat > expect << EOF
748 commit 6352c5e33dbcab725fe0579be16aa2ba8eb369be
749 Author: A U Thor <author@example.com>
750 Date: Thu Apr 7 15:23:13 2005 -0700
752 11th
754 Notes (other):
755 yet another note
756 $whitespace
757 yet another note
760 test_expect_success 'allow overwrite with "git notes copy -f"' '
761 git notes copy -f HEAD~2 HEAD &&
762 git log -1 > actual &&
763 test_cmp expect actual &&
764 test "$(git notes list HEAD)" = "$(git notes list HEAD~2)"
767 test_expect_success 'cannot copy note from object without notes' '
768 : > a12 &&
769 git add a12 &&
770 test_tick &&
771 git commit -m 12th &&
772 : > a13 &&
773 git add a13 &&
774 test_tick &&
775 git commit -m 13th &&
776 test_must_fail git notes copy HEAD^ HEAD
779 test_done