]> git.ipfire.org Git - thirdparty/git.git/blob - t/t3301-notes.sh
rebase: use child_process_clear() to clean
[thirdparty/git.git] / t / t3301-notes.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2007 Johannes E. Schindelin
4 #
5
6 test_description='Test commit notes'
7
8 . ./test-lib.sh
9
10 write_script fake_editor <<\EOF
11 echo "$MSG" >"$1"
12 echo "$MSG" >&2
13 EOF
14 GIT_EDITOR=./fake_editor
15 export GIT_EDITOR
16
17 indent=" "
18
19 test_expect_success 'cannot annotate non-existing HEAD' '
20 test_must_fail env MSG=3 git notes add
21 '
22
23 test_expect_success 'setup' '
24 test_commit 1st &&
25 test_commit 2nd
26 '
27
28 test_expect_success 'need valid notes ref' '
29 test_must_fail env MSG=1 GIT_NOTES_REF=/ git notes show &&
30 test_must_fail env MSG=2 GIT_NOTES_REF=/ git notes show
31 '
32
33 test_expect_success 'refusing to add notes in refs/heads/' '
34 test_must_fail env MSG=1 GIT_NOTES_REF=refs/heads/bogus git notes add
35 '
36
37 test_expect_success 'refusing to edit notes in refs/remotes/' '
38 test_must_fail env MSG=1 GIT_NOTES_REF=refs/heads/bogus git notes edit
39 '
40
41 # 1 indicates caught gracefully by die, 128 means git-show barked
42 test_expect_success 'handle empty notes gracefully' '
43 test_expect_code 1 git notes show
44 '
45
46 test_expect_success 'show non-existent notes entry with %N' '
47 test_write_lines A B >expect &&
48 git show -s --format="A%n%NB" >actual &&
49 test_cmp expect actual
50 '
51
52 test_expect_success 'create notes' '
53 MSG=b4 git notes add &&
54 test_path_is_missing .git/NOTES_EDITMSG &&
55 git ls-tree -r refs/notes/commits >actual &&
56 test_line_count = 1 actual &&
57 echo b4 >expect &&
58 git notes show >actual &&
59 test_cmp expect actual &&
60 git show HEAD^ &&
61 test_must_fail git notes show HEAD^
62 '
63
64 test_expect_success 'show notes entry with %N' '
65 test_write_lines A b4 B >expect &&
66 git show -s --format="A%n%NB" >actual &&
67 test_cmp expect actual
68 '
69
70 test_expect_success 'create reflog entry' '
71 ref=$(git rev-parse --short refs/notes/commits) &&
72 cat <<-EOF >expect &&
73 $ref refs/notes/commits@{0}: notes: Notes added by '\''git notes add'\''
74 EOF
75 git reflog show refs/notes/commits >actual &&
76 test_cmp expect actual
77 '
78
79 test_expect_success 'edit existing notes' '
80 MSG=b3 git notes edit &&
81 test_path_is_missing .git/NOTES_EDITMSG &&
82 git ls-tree -r refs/notes/commits >actual &&
83 test_line_count = 1 actual &&
84 echo b3 >expect &&
85 git notes show >actual &&
86 test_cmp expect actual &&
87 git show HEAD^ &&
88 test_must_fail git notes show HEAD^
89 '
90
91 test_expect_success 'show notes from treeish' '
92 echo b3 >expect &&
93 git notes --ref commits^{tree} show >actual &&
94 test_cmp expect actual &&
95
96 echo b4 >expect &&
97 git notes --ref commits@{1} show >actual &&
98 test_cmp expect actual
99 '
100
101 test_expect_success 'cannot edit notes from non-ref' '
102 test_must_fail git notes --ref commits^{tree} edit &&
103 test_must_fail git notes --ref commits@{1} edit
104 '
105
106 test_expect_success 'cannot "git notes add -m" where notes already exists' '
107 test_must_fail git notes add -m "b2" &&
108 test_path_is_missing .git/NOTES_EDITMSG &&
109 git ls-tree -r refs/notes/commits >actual &&
110 test_line_count = 1 actual &&
111 echo b3 >expect &&
112 git notes show >actual &&
113 test_cmp expect actual &&
114 git show HEAD^ &&
115 test_must_fail git notes show HEAD^
116 '
117
118 test_expect_success 'can overwrite existing note with "git notes add -f -m"' '
119 git notes add -f -m "b1" &&
120 test_path_is_missing .git/NOTES_EDITMSG &&
121 git ls-tree -r refs/notes/commits >actual &&
122 test_line_count = 1 actual &&
123 echo b1 >expect &&
124 git notes show >actual &&
125 test_cmp expect actual &&
126 git show HEAD^ &&
127 test_must_fail git notes show HEAD^
128 '
129
130 test_expect_success 'add w/no options on existing note morphs into edit' '
131 MSG=b2 git notes add &&
132 test_path_is_missing .git/NOTES_EDITMSG &&
133 git ls-tree -r refs/notes/commits >actual &&
134 test_line_count = 1 actual &&
135 echo b2 >expect &&
136 git notes show >actual &&
137 test_cmp expect actual &&
138 git show HEAD^ &&
139 test_must_fail git notes show HEAD^
140 '
141
142 test_expect_success 'can overwrite existing note with "git notes add -f"' '
143 MSG=b1 git notes add -f &&
144 test_path_is_missing .git/NOTES_EDITMSG &&
145 git ls-tree -r refs/notes/commits >actual &&
146 test_line_count = 1 actual &&
147 echo b1 >expect &&
148 git notes show >actual &&
149 test_cmp expect actual &&
150 git show HEAD^ &&
151 test_must_fail git notes show HEAD^
152 '
153
154 test_expect_success 'show notes' '
155 commit=$(git rev-parse HEAD) &&
156 cat >expect <<-EOF &&
157 commit $commit
158 Author: A U Thor <author@example.com>
159 Date: Thu Apr 7 15:14:13 2005 -0700
160
161 ${indent}2nd
162
163 Notes:
164 ${indent}b1
165 EOF
166 git cat-file commit HEAD >commits &&
167 ! grep b1 commits &&
168 git log -1 >actual &&
169 test_cmp expect actual
170 '
171
172 test_expect_success 'show multi-line notes' '
173 test_commit 3rd &&
174 MSG="b3${LF}c3c3c3c3${LF}d3d3d3" git notes add &&
175 commit=$(git rev-parse HEAD) &&
176 cat >expect-multiline <<-EOF &&
177 commit $commit
178 Author: A U Thor <author@example.com>
179 Date: Thu Apr 7 15:15:13 2005 -0700
180
181 ${indent}3rd
182
183 Notes:
184 ${indent}b3
185 ${indent}c3c3c3c3
186 ${indent}d3d3d3
187
188 EOF
189 cat expect >>expect-multiline &&
190 git log -2 >actual &&
191 test_cmp expect-multiline actual
192 '
193
194 test_expect_success 'show -F notes' '
195 test_commit 4th &&
196 echo "xyzzy" >note5 &&
197 git notes add -F note5 &&
198 commit=$(git rev-parse HEAD) &&
199 cat >expect-F <<-EOF &&
200 commit $commit
201 Author: A U Thor <author@example.com>
202 Date: Thu Apr 7 15:16:13 2005 -0700
203
204 ${indent}4th
205
206 Notes:
207 ${indent}xyzzy
208
209 EOF
210 cat expect-multiline >>expect-F &&
211 git log -3 >actual &&
212 test_cmp expect-F actual
213 '
214
215 test_expect_success 'Re-adding -F notes without -f fails' '
216 echo "zyxxy" >note5 &&
217 test_must_fail git notes add -F note5 &&
218 git log -3 >actual &&
219 test_cmp expect-F actual
220 '
221
222 test_expect_success 'git log --pretty=raw does not show notes' '
223 commit=$(git rev-parse HEAD) &&
224 tree=$(git rev-parse HEAD^{tree}) &&
225 parent=$(git rev-parse HEAD^) &&
226 cat >expect <<-EOF &&
227 commit $commit
228 tree $tree
229 parent $parent
230 author A U Thor <author@example.com> 1112912173 -0700
231 committer C O Mitter <committer@example.com> 1112912173 -0700
232
233 ${indent}4th
234 EOF
235 git log -1 --pretty=raw >actual &&
236 test_cmp expect actual
237 '
238
239 test_expect_success 'git log --show-notes' '
240 cat >>expect <<-EOF &&
241
242 Notes:
243 ${indent}xyzzy
244 EOF
245 git log -1 --pretty=raw --show-notes >actual &&
246 test_cmp expect actual
247 '
248
249 test_expect_success 'git log --no-notes' '
250 git log -1 --no-notes >actual &&
251 ! grep xyzzy actual
252 '
253
254 test_expect_success 'git format-patch does not show notes' '
255 git format-patch -1 --stdout >actual &&
256 ! grep xyzzy actual
257 '
258
259 test_expect_success 'git format-patch --show-notes does show notes' '
260 git format-patch --show-notes -1 --stdout >actual &&
261 grep xyzzy actual
262 '
263
264 for pretty in \
265 "" --pretty --pretty=raw --pretty=short --pretty=medium \
266 --pretty=full --pretty=fuller --pretty=format:%s --oneline
267 do
268 case "$pretty" in
269 "") p= not= negate="" ;;
270 ?*) p="$pretty" not=" not" negate="!" ;;
271 esac
272 test_expect_success "git show $pretty does$not show notes" '
273 git show $p >actual &&
274 eval "$negate grep xyzzy actual"
275 '
276 done
277
278 test_expect_success 'setup alternate notes ref' '
279 git notes --ref=alternate add -m alternate
280 '
281
282 test_expect_success 'git log --notes shows default notes' '
283 git log -1 --notes >actual &&
284 grep xyzzy actual &&
285 ! grep alternate actual
286 '
287
288 test_expect_success 'git log --notes=X shows only X' '
289 git log -1 --notes=alternate >actual &&
290 ! grep xyzzy actual &&
291 grep alternate actual
292 '
293
294 test_expect_success 'git log --notes --notes=X shows both' '
295 git log -1 --notes --notes=alternate >actual &&
296 grep xyzzy actual &&
297 grep alternate actual
298 '
299
300 test_expect_success 'git log --no-notes resets default state' '
301 git log -1 --notes --notes=alternate \
302 --no-notes --notes=alternate \
303 >actual &&
304 ! grep xyzzy actual &&
305 grep alternate actual
306 '
307
308 test_expect_success 'git log --no-notes resets ref list' '
309 git log -1 --notes --notes=alternate \
310 --no-notes --notes \
311 >actual &&
312 grep xyzzy actual &&
313 ! grep alternate actual
314 '
315
316 test_expect_success 'show -m notes' '
317 test_commit 5th &&
318 git notes add -m spam -m "foo${LF}bar${LF}baz" &&
319 commit=$(git rev-parse HEAD) &&
320 cat >expect-m <<-EOF &&
321 commit $commit
322 Author: A U Thor <author@example.com>
323 Date: Thu Apr 7 15:17:13 2005 -0700
324
325 ${indent}5th
326
327 Notes:
328 ${indent}spam
329 ${indent}
330 ${indent}foo
331 ${indent}bar
332 ${indent}baz
333
334 EOF
335 cat expect-F >>expect-m &&
336 git log -4 >actual &&
337 test_cmp expect-m actual
338 '
339
340 test_expect_success 'remove note with add -f -F /dev/null' '
341 git notes add -f -F /dev/null &&
342 commit=$(git rev-parse HEAD) &&
343 cat >expect-rm-F <<-EOF &&
344 commit $commit
345 Author: A U Thor <author@example.com>
346 Date: Thu Apr 7 15:17:13 2005 -0700
347
348 ${indent}5th
349
350 EOF
351 cat expect-F >>expect-rm-F &&
352 git log -4 >actual &&
353 test_cmp expect-rm-F actual &&
354 test_must_fail git notes show
355 '
356
357 test_expect_success 'do not create empty note with -m ""' '
358 git notes add -m "" &&
359 git log -4 >actual &&
360 test_cmp expect-rm-F actual &&
361 test_must_fail git notes show
362 '
363
364 test_expect_success 'create note with combination of -m and -F' '
365 cat >expect-combine_m_and_F <<-EOF &&
366 foo
367
368 xyzzy
369
370 bar
371
372 zyxxy
373
374 baz
375 EOF
376 echo "xyzzy" >note_a &&
377 echo "zyxxy" >note_b &&
378 git notes add -m "foo" -F note_a -m "bar" -F note_b -m "baz" &&
379 git notes show >actual &&
380 test_cmp expect-combine_m_and_F actual
381 '
382
383 test_expect_success 'remove note with "git notes remove"' '
384 git notes remove HEAD^ &&
385 git notes remove &&
386 commit=$(git rev-parse HEAD) &&
387 parent=$(git rev-parse HEAD^) &&
388 cat >expect-rm-remove <<-EOF &&
389 commit $commit
390 Author: A U Thor <author@example.com>
391 Date: Thu Apr 7 15:17:13 2005 -0700
392
393 ${indent}5th
394
395 commit $parent
396 Author: A U Thor <author@example.com>
397 Date: Thu Apr 7 15:16:13 2005 -0700
398
399 ${indent}4th
400
401 EOF
402 cat expect-multiline >>expect-rm-remove &&
403 git log -4 >actual &&
404 test_cmp expect-rm-remove actual &&
405 test_must_fail git notes show HEAD^
406 '
407
408 test_expect_success 'removing non-existing note should not create new commit' '
409 git rev-parse --verify refs/notes/commits >before_commit &&
410 test_must_fail git notes remove HEAD^ &&
411 git rev-parse --verify refs/notes/commits >after_commit &&
412 test_cmp before_commit after_commit
413 '
414
415 test_expect_success 'removing more than one' '
416 before=$(git rev-parse --verify refs/notes/commits) &&
417 test_when_finished "git update-ref refs/notes/commits $before" &&
418
419 # We have only two -- add another and make sure it stays
420 git notes add -m "extra" &&
421 git notes list HEAD >after-removal-expect &&
422 git notes remove HEAD^^ HEAD^^^ &&
423 git notes list | sed -e "s/ .*//" >actual &&
424 test_cmp after-removal-expect actual
425 '
426
427 test_expect_success 'removing is atomic' '
428 before=$(git rev-parse --verify refs/notes/commits) &&
429 test_when_finished "git update-ref refs/notes/commits $before" &&
430 test_must_fail git notes remove HEAD^^ HEAD^^^ HEAD^ &&
431 after=$(git rev-parse --verify refs/notes/commits) &&
432 test "$before" = "$after"
433 '
434
435 test_expect_success 'removing with --ignore-missing' '
436 before=$(git rev-parse --verify refs/notes/commits) &&
437 test_when_finished "git update-ref refs/notes/commits $before" &&
438
439 # We have only two -- add another and make sure it stays
440 git notes add -m "extra" &&
441 git notes list HEAD >after-removal-expect &&
442 git notes remove --ignore-missing HEAD^^ HEAD^^^ HEAD^ &&
443 git notes list | sed -e "s/ .*//" >actual &&
444 test_cmp after-removal-expect actual
445 '
446
447 test_expect_success 'removing with --ignore-missing but bogus ref' '
448 before=$(git rev-parse --verify refs/notes/commits) &&
449 test_when_finished "git update-ref refs/notes/commits $before" &&
450 test_must_fail git notes remove --ignore-missing HEAD^^ HEAD^^^ NO-SUCH-COMMIT &&
451 after=$(git rev-parse --verify refs/notes/commits) &&
452 test "$before" = "$after"
453 '
454
455 test_expect_success 'remove reads from --stdin' '
456 before=$(git rev-parse --verify refs/notes/commits) &&
457 test_when_finished "git update-ref refs/notes/commits $before" &&
458
459 # We have only two -- add another and make sure it stays
460 git notes add -m "extra" &&
461 git notes list HEAD >after-removal-expect &&
462 git rev-parse HEAD^^ HEAD^^^ >input &&
463 git notes remove --stdin <input &&
464 git notes list | sed -e "s/ .*//" >actual &&
465 test_cmp after-removal-expect actual
466 '
467
468 test_expect_success 'remove --stdin is also atomic' '
469 before=$(git rev-parse --verify refs/notes/commits) &&
470 test_when_finished "git update-ref refs/notes/commits $before" &&
471 git rev-parse HEAD^^ HEAD^^^ HEAD^ >input &&
472 test_must_fail git notes remove --stdin <input &&
473 after=$(git rev-parse --verify refs/notes/commits) &&
474 test "$before" = "$after"
475 '
476
477 test_expect_success 'removing with --stdin --ignore-missing' '
478 before=$(git rev-parse --verify refs/notes/commits) &&
479 test_when_finished "git update-ref refs/notes/commits $before" &&
480
481 # We have only two -- add another and make sure it stays
482 git notes add -m "extra" &&
483 git notes list HEAD >after-removal-expect &&
484 git rev-parse HEAD^^ HEAD^^^ HEAD^ >input &&
485 git notes remove --ignore-missing --stdin <input &&
486 git notes list | sed -e "s/ .*//" >actual &&
487 test_cmp after-removal-expect actual
488 '
489
490 test_expect_success 'list notes with "git notes list"' '
491 commit_2=$(git rev-parse 2nd) &&
492 commit_3=$(git rev-parse 3rd) &&
493 note_2=$(git rev-parse refs/notes/commits:$commit_2) &&
494 note_3=$(git rev-parse refs/notes/commits:$commit_3) &&
495 sort -t" " -k2 >expect <<-EOF &&
496 $note_2 $commit_2
497 $note_3 $commit_3
498 EOF
499 git notes list >actual &&
500 test_cmp expect actual
501 '
502
503 test_expect_success 'list notes with "git notes"' '
504 git notes >actual &&
505 test_cmp expect actual
506 '
507
508 test_expect_success '"git notes" without subcommand does not take arguments' '
509 test_expect_code 129 git notes HEAD^^ 2>err &&
510 grep "^error: unknown subcommand" err
511 '
512
513 test_expect_success 'list specific note with "git notes list <object>"' '
514 git rev-parse refs/notes/commits:$commit_3 >expect &&
515 git notes list HEAD^^ >actual &&
516 test_cmp expect actual
517 '
518
519 test_expect_success 'listing non-existing notes fails' '
520 test_must_fail git notes list HEAD >actual &&
521 test_must_be_empty actual
522 '
523
524 test_expect_success 'append to existing note with "git notes append"' '
525 cat >expect <<-EOF &&
526 Initial set of notes
527
528 More notes appended with git notes append
529 EOF
530 git notes add -m "Initial set of notes" &&
531 git notes append -m "More notes appended with git notes append" &&
532 git notes show >actual &&
533 test_cmp expect actual
534 '
535
536 test_expect_success '"git notes list" does not expand to "git notes list HEAD"' '
537 commit_5=$(git rev-parse 5th) &&
538 note_5=$(git rev-parse refs/notes/commits:$commit_5) &&
539 sort -t" " -k2 >expect_list <<-EOF &&
540 $note_2 $commit_2
541 $note_3 $commit_3
542 $note_5 $commit_5
543 EOF
544 git notes list >actual &&
545 test_cmp expect_list actual
546 '
547
548 test_expect_success 'appending empty string does not change existing note' '
549 git notes append -m "" &&
550 git notes show >actual &&
551 test_cmp expect actual
552 '
553
554 test_expect_success 'git notes append == add when there is no existing note' '
555 git notes remove HEAD &&
556 test_must_fail git notes list HEAD &&
557 git notes append -m "Initial set of notes${LF}${LF}More notes appended with git notes append" &&
558 git notes show >actual &&
559 test_cmp expect actual
560 '
561
562 test_expect_success 'appending empty string to non-existing note does not create note' '
563 git notes remove HEAD &&
564 test_must_fail git notes list HEAD &&
565 git notes append -m "" &&
566 test_must_fail git notes list HEAD
567 '
568
569 test_expect_success 'create other note on a different notes ref (setup)' '
570 test_commit 6th &&
571 GIT_NOTES_REF="refs/notes/other" git notes add -m "other note" &&
572 commit=$(git rev-parse HEAD) &&
573 cat >expect-not-other <<-EOF &&
574 commit $commit
575 Author: A U Thor <author@example.com>
576 Date: Thu Apr 7 15:18:13 2005 -0700
577
578 ${indent}6th
579 EOF
580 cp expect-not-other expect-other &&
581 cat >>expect-other <<-EOF
582
583 Notes (other):
584 ${indent}other note
585 EOF
586 '
587
588 test_expect_success 'Do not show note on other ref by default' '
589 git log -1 >actual &&
590 test_cmp expect-not-other actual
591 '
592
593 test_expect_success 'Do show note when ref is given in GIT_NOTES_REF' '
594 GIT_NOTES_REF="refs/notes/other" git log -1 >actual &&
595 test_cmp expect-other actual
596 '
597
598 test_expect_success 'Do show note when ref is given in core.notesRef config' '
599 test_config core.notesRef "refs/notes/other" &&
600 git log -1 >actual &&
601 test_cmp expect-other actual
602 '
603
604 test_expect_success 'Do not show note when core.notesRef is overridden' '
605 test_config core.notesRef "refs/notes/other" &&
606 GIT_NOTES_REF="refs/notes/wrong" git log -1 >actual &&
607 test_cmp expect-not-other actual
608 '
609
610 test_expect_success 'Show all notes when notes.displayRef=refs/notes/*' '
611 commit=$(git rev-parse HEAD) &&
612 parent=$(git rev-parse HEAD^) &&
613 cat >expect-both <<-EOF &&
614 commit $commit
615 Author: A U Thor <author@example.com>
616 Date: Thu Apr 7 15:18:13 2005 -0700
617
618 ${indent}6th
619
620 Notes:
621 ${indent}order test
622
623 Notes (other):
624 ${indent}other note
625
626 commit $parent
627 Author: A U Thor <author@example.com>
628 Date: Thu Apr 7 15:17:13 2005 -0700
629
630 ${indent}5th
631
632 Notes:
633 ${indent}replacement for deleted note
634 EOF
635 GIT_NOTES_REF=refs/notes/commits git notes add \
636 -m"replacement for deleted note" HEAD^ &&
637 GIT_NOTES_REF=refs/notes/commits git notes add -m"order test" &&
638 test_unconfig core.notesRef &&
639 test_config notes.displayRef "refs/notes/*" &&
640 git log -2 >actual &&
641 test_cmp expect-both actual
642 '
643
644 test_expect_success 'core.notesRef is implicitly in notes.displayRef' '
645 test_config core.notesRef refs/notes/commits &&
646 test_config notes.displayRef refs/notes/other &&
647 git log -2 >actual &&
648 test_cmp expect-both actual
649 '
650
651 test_expect_success 'notes.displayRef can be given more than once' '
652 test_unconfig core.notesRef &&
653 test_config notes.displayRef refs/notes/commits &&
654 git config --add notes.displayRef refs/notes/other &&
655 git log -2 >actual &&
656 test_cmp expect-both actual
657 '
658
659 test_expect_success 'notes.displayRef respects order' '
660 commit=$(git rev-parse HEAD) &&
661 cat >expect-both-reversed <<-EOF &&
662 commit $commit
663 Author: A U Thor <author@example.com>
664 Date: Thu Apr 7 15:18:13 2005 -0700
665
666 ${indent}6th
667
668 Notes (other):
669 ${indent}other note
670
671 Notes:
672 ${indent}order test
673 EOF
674 test_config core.notesRef refs/notes/other &&
675 test_config notes.displayRef refs/notes/commits &&
676 git log -1 >actual &&
677 test_cmp expect-both-reversed actual
678 '
679
680 test_expect_success 'notes.displayRef with no value handled gracefully' '
681 test_must_fail git -c notes.displayRef log -0 --notes &&
682 test_must_fail git -c notes.displayRef diff-tree --notes HEAD
683 '
684
685 test_expect_success 'GIT_NOTES_DISPLAY_REF works' '
686 GIT_NOTES_DISPLAY_REF=refs/notes/commits:refs/notes/other \
687 git log -2 >actual &&
688 test_cmp expect-both actual
689 '
690
691 test_expect_success 'GIT_NOTES_DISPLAY_REF overrides config' '
692 commit=$(git rev-parse HEAD) &&
693 parent=$(git rev-parse HEAD^) &&
694 cat >expect-none <<-EOF &&
695 commit $commit
696 Author: A U Thor <author@example.com>
697 Date: Thu Apr 7 15:18:13 2005 -0700
698
699 ${indent}6th
700
701 commit $parent
702 Author: A U Thor <author@example.com>
703 Date: Thu Apr 7 15:17:13 2005 -0700
704
705 ${indent}5th
706 EOF
707 test_config notes.displayRef "refs/notes/*" &&
708 GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log -2 >actual &&
709 test_cmp expect-none actual
710 '
711
712 test_expect_success '--show-notes=* adds to GIT_NOTES_DISPLAY_REF' '
713 GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log --show-notes=* -2 >actual &&
714 test_cmp expect-both actual
715 '
716
717 test_expect_success '--no-standard-notes' '
718 commit=$(git rev-parse HEAD) &&
719 cat >expect-commits <<-EOF &&
720 commit $commit
721 Author: A U Thor <author@example.com>
722 Date: Thu Apr 7 15:18:13 2005 -0700
723
724 ${indent}6th
725
726 Notes:
727 ${indent}order test
728 EOF
729 git log --no-standard-notes --show-notes=commits -1 >actual &&
730 test_cmp expect-commits actual
731 '
732
733 test_expect_success '--standard-notes' '
734 test_config notes.displayRef "refs/notes/*" &&
735 git log --no-standard-notes --show-notes=commits \
736 --standard-notes -2 >actual &&
737 test_cmp expect-both actual
738 '
739
740 test_expect_success '--show-notes=ref accumulates' '
741 git log --show-notes=other --show-notes=commits \
742 --no-standard-notes -1 >actual &&
743 test_cmp expect-both-reversed actual
744 '
745
746 test_expect_success 'Allow notes on non-commits (trees, blobs, tags)' '
747 test_config core.notesRef refs/notes/other &&
748 echo "Note on a tree" >expect &&
749 git notes add -m "Note on a tree" HEAD: &&
750 git notes show HEAD: >actual &&
751 test_cmp expect actual &&
752 echo "Note on a blob" >expect &&
753 git ls-tree --name-only HEAD >files &&
754 filename=$(head -n1 files) &&
755 git notes add -m "Note on a blob" HEAD:$filename &&
756 git notes show HEAD:$filename >actual &&
757 test_cmp expect actual &&
758 echo "Note on a tag" >expect &&
759 git tag -a -m "This is an annotated tag" foobar HEAD^ &&
760 git notes add -m "Note on a tag" foobar &&
761 git notes show foobar >actual &&
762 test_cmp expect actual
763 '
764
765 test_expect_success 'create note from other note with "git notes add -C"' '
766 test_commit 7th &&
767 commit=$(git rev-parse HEAD) &&
768 cat >expect <<-EOF &&
769 commit $commit
770 Author: A U Thor <author@example.com>
771 Date: Thu Apr 7 15:19:13 2005 -0700
772
773 ${indent}7th
774
775 Notes:
776 ${indent}order test
777 EOF
778 note=$(git notes list HEAD^) &&
779 git notes add -C $note &&
780 git log -1 >actual &&
781 test_cmp expect actual &&
782 git notes list HEAD^ >expect &&
783 git notes list HEAD >actual &&
784 test_cmp expect actual
785 '
786
787 test_expect_success 'create note from non-existing note with "git notes add -C" fails' '
788 test_commit 8th &&
789 test_must_fail git notes add -C deadbeef &&
790 test_must_fail git notes list HEAD
791 '
792
793 test_expect_success 'create note from non-blob with "git notes add -C" fails' '
794 commit=$(git rev-parse --verify HEAD) &&
795 tree=$(git rev-parse --verify HEAD:) &&
796 test_must_fail git notes add -C $commit &&
797 test_must_fail git notes add -C $tree &&
798 test_must_fail git notes list HEAD
799 '
800
801 test_expect_success 'create note from blob with "git notes add -C" reuses blob id' '
802 commit=$(git rev-parse HEAD) &&
803 cat >expect <<-EOF &&
804 commit $commit
805 Author: A U Thor <author@example.com>
806 Date: Thu Apr 7 15:20:13 2005 -0700
807
808 ${indent}8th
809
810 Notes:
811 ${indent}This is a blob object
812 EOF
813 echo "This is a blob object" | git hash-object -w --stdin >blob &&
814 git notes add -C $(cat blob) &&
815 git log -1 >actual &&
816 test_cmp expect actual &&
817 git notes list HEAD >actual &&
818 test_cmp blob actual
819 '
820
821 test_expect_success 'create note from other note with "git notes add -c"' '
822 test_commit 9th &&
823 commit=$(git rev-parse HEAD) &&
824 cat >expect <<-EOF &&
825 commit $commit
826 Author: A U Thor <author@example.com>
827 Date: Thu Apr 7 15:21:13 2005 -0700
828
829 ${indent}9th
830
831 Notes:
832 ${indent}yet another note
833 EOF
834 note=$(git notes list HEAD^^) &&
835 MSG="yet another note" git notes add -c $note &&
836 git log -1 >actual &&
837 test_cmp expect actual
838 '
839
840 test_expect_success 'create note from non-existing note with "git notes add -c" fails' '
841 test_commit 10th &&
842 test_must_fail env MSG="yet another note" git notes add -c deadbeef &&
843 test_must_fail git notes list HEAD
844 '
845
846 test_expect_success 'append to note from other note with "git notes append -C"' '
847 commit=$(git rev-parse HEAD^) &&
848 cat >expect <<-EOF &&
849 commit $commit
850 Author: A U Thor <author@example.com>
851 Date: Thu Apr 7 15:21:13 2005 -0700
852
853 ${indent}9th
854
855 Notes:
856 ${indent}yet another note
857 ${indent}
858 ${indent}yet another note
859 EOF
860 note=$(git notes list HEAD^) &&
861 git notes append -C $note HEAD^ &&
862 git log -1 HEAD^ >actual &&
863 test_cmp expect actual
864 '
865
866 test_expect_success 'create note from other note with "git notes append -c"' '
867 commit=$(git rev-parse HEAD) &&
868 cat >expect <<-EOF &&
869 commit $commit
870 Author: A U Thor <author@example.com>
871 Date: Thu Apr 7 15:22:13 2005 -0700
872
873 ${indent}10th
874
875 Notes:
876 ${indent}other note
877 EOF
878 note=$(git notes list HEAD^) &&
879 MSG="other note" git notes append -c $note &&
880 git log -1 >actual &&
881 test_cmp expect actual
882 '
883
884 test_expect_success 'append to note from other note with "git notes append -c"' '
885 commit=$(git rev-parse HEAD) &&
886 cat >expect <<-EOF &&
887 commit $commit
888 Author: A U Thor <author@example.com>
889 Date: Thu Apr 7 15:22:13 2005 -0700
890
891 ${indent}10th
892
893 Notes:
894 ${indent}other note
895 ${indent}
896 ${indent}yet another note
897 EOF
898 note=$(git notes list HEAD) &&
899 MSG="yet another note" git notes append -c $note &&
900 git log -1 >actual &&
901 test_cmp expect actual
902 '
903
904 test_expect_success 'copy note with "git notes copy"' '
905 commit=$(git rev-parse 4th) &&
906 cat >expect <<-EOF &&
907 commit $commit
908 Author: A U Thor <author@example.com>
909 Date: Thu Apr 7 15:16:13 2005 -0700
910
911 ${indent}4th
912
913 Notes:
914 ${indent}This is a blob object
915 EOF
916 git notes copy 8th 4th &&
917 git log 3rd..4th >actual &&
918 test_cmp expect actual &&
919 git notes list 4th >expect &&
920 git notes list 8th >actual &&
921 test_cmp expect actual
922 '
923
924 test_expect_success 'copy note with "git notes copy" with default' '
925 test_commit 11th &&
926 commit=$(git rev-parse HEAD) &&
927 cat >expect <<-EOF &&
928 commit $commit
929 Author: A U Thor <author@example.com>
930 Date: Thu Apr 7 15:23:13 2005 -0700
931
932 ${indent}11th
933
934 Notes:
935 ${indent}other note
936 ${indent}
937 ${indent}yet another note
938 EOF
939 git notes copy HEAD^ &&
940 git log -1 >actual &&
941 test_cmp expect actual &&
942 git notes list HEAD^ >expect &&
943 git notes list HEAD >actual &&
944 test_cmp expect actual
945 '
946
947 test_expect_success 'prevent overwrite with "git notes copy"' '
948 test_must_fail git notes copy HEAD~2 HEAD &&
949 cat >expect <<-EOF &&
950 commit $commit
951 Author: A U Thor <author@example.com>
952 Date: Thu Apr 7 15:23:13 2005 -0700
953
954 ${indent}11th
955
956 Notes:
957 ${indent}other note
958 ${indent}
959 ${indent}yet another note
960 EOF
961 git log -1 >actual &&
962 test_cmp expect actual &&
963 git notes list HEAD^ >expect &&
964 git notes list HEAD >actual &&
965 test_cmp expect actual
966 '
967
968 test_expect_success 'allow overwrite with "git notes copy -f"' '
969 commit=$(git rev-parse HEAD) &&
970 cat >expect <<-EOF &&
971 commit $commit
972 Author: A U Thor <author@example.com>
973 Date: Thu Apr 7 15:23:13 2005 -0700
974
975 ${indent}11th
976
977 Notes:
978 ${indent}This is a blob object
979 EOF
980 git notes copy -f HEAD~3 HEAD &&
981 git log -1 >actual &&
982 test_cmp expect actual &&
983 git notes list HEAD~3 >expect &&
984 git notes list HEAD >actual &&
985 test_cmp expect actual
986 '
987
988 test_expect_success 'allow overwrite with "git notes copy -f" with default' '
989 commit=$(git rev-parse HEAD) &&
990 cat >expect <<-EOF &&
991 commit $commit
992 Author: A U Thor <author@example.com>
993 Date: Thu Apr 7 15:23:13 2005 -0700
994
995 ${indent}11th
996
997 Notes:
998 ${indent}yet another note
999 ${indent}
1000 ${indent}yet another note
1001 EOF
1002 git notes copy -f HEAD~2 &&
1003 git log -1 >actual &&
1004 test_cmp expect actual &&
1005 git notes list HEAD~2 >expect &&
1006 git notes list HEAD >actual &&
1007 test_cmp expect actual
1008 '
1009
1010 test_expect_success 'cannot copy note from object without notes' '
1011 test_commit 12th &&
1012 test_commit 13th &&
1013 test_must_fail git notes copy HEAD^ HEAD
1014 '
1015
1016 test_expect_success 'git notes copy --stdin' '
1017 commit=$(git rev-parse HEAD) &&
1018 parent=$(git rev-parse HEAD^) &&
1019 cat >expect <<-EOF &&
1020 commit $commit
1021 Author: A U Thor <author@example.com>
1022 Date: Thu Apr 7 15:25:13 2005 -0700
1023
1024 ${indent}13th
1025
1026 Notes:
1027 ${indent}yet another note
1028 ${indent}
1029 ${indent}yet another note
1030
1031 commit $parent
1032 Author: A U Thor <author@example.com>
1033 Date: Thu Apr 7 15:24:13 2005 -0700
1034
1035 ${indent}12th
1036
1037 Notes:
1038 ${indent}other note
1039 ${indent}
1040 ${indent}yet another note
1041 EOF
1042 from=$(git rev-parse HEAD~3) &&
1043 to=$(git rev-parse HEAD^) &&
1044 echo "$from" "$to" >copy &&
1045 from=$(git rev-parse HEAD~2) &&
1046 to=$(git rev-parse HEAD) &&
1047 echo "$from" "$to" >>copy &&
1048 git notes copy --stdin <copy &&
1049 git log -2 >actual &&
1050 test_cmp expect actual &&
1051 git notes list HEAD~2 >expect &&
1052 git notes list HEAD >actual &&
1053 test_cmp expect actual &&
1054 git notes list HEAD~3 >expect &&
1055 git notes list HEAD^ >actual &&
1056 test_cmp expect actual
1057 '
1058
1059 test_expect_success 'git notes copy --for-rewrite (unconfigured)' '
1060 test_commit 14th &&
1061 test_commit 15th &&
1062 commit=$(git rev-parse HEAD) &&
1063 parent=$(git rev-parse HEAD^) &&
1064 cat >expect <<-EOF &&
1065 commit $commit
1066 Author: A U Thor <author@example.com>
1067 Date: Thu Apr 7 15:27:13 2005 -0700
1068
1069 ${indent}15th
1070
1071 commit $parent
1072 Author: A U Thor <author@example.com>
1073 Date: Thu Apr 7 15:26:13 2005 -0700
1074
1075 ${indent}14th
1076 EOF
1077 from=$(git rev-parse HEAD~3) &&
1078 to=$(git rev-parse HEAD^) &&
1079 echo "$from" "$to" >copy &&
1080 from=$(git rev-parse HEAD~2) &&
1081 to=$(git rev-parse HEAD) &&
1082 echo "$from" "$to" >>copy &&
1083 git notes copy --for-rewrite=foo <copy &&
1084 git log -2 >actual &&
1085 test_cmp expect actual
1086 '
1087
1088 test_expect_success 'git notes copy --for-rewrite (enabled)' '
1089 commit=$(git rev-parse HEAD) &&
1090 parent=$(git rev-parse HEAD^) &&
1091 cat >expect <<-EOF &&
1092 commit $commit
1093 Author: A U Thor <author@example.com>
1094 Date: Thu Apr 7 15:27:13 2005 -0700
1095
1096 ${indent}15th
1097
1098 Notes:
1099 ${indent}yet another note
1100 ${indent}
1101 ${indent}yet another note
1102
1103 commit $parent
1104 Author: A U Thor <author@example.com>
1105 Date: Thu Apr 7 15:26:13 2005 -0700
1106
1107 ${indent}14th
1108
1109 Notes:
1110 ${indent}other note
1111 ${indent}
1112 ${indent}yet another note
1113 EOF
1114 test_config notes.rewriteMode overwrite &&
1115 test_config notes.rewriteRef "refs/notes/*" &&
1116 from=$(git rev-parse HEAD~3) &&
1117 to=$(git rev-parse HEAD^) &&
1118 echo "$from" "$to" >copy &&
1119 from=$(git rev-parse HEAD~2) &&
1120 to=$(git rev-parse HEAD) &&
1121 echo "$from" "$to" >>copy &&
1122 git notes copy --for-rewrite=foo <copy &&
1123 git log -2 >actual &&
1124 test_cmp expect actual
1125 '
1126
1127 test_expect_success 'git notes copy --for-rewrite (disabled)' '
1128 test_config notes.rewrite.bar false &&
1129 from=$(git rev-parse HEAD~3) &&
1130 to=$(git rev-parse HEAD) &&
1131 echo "$from" "$to" >copy &&
1132 git notes copy --for-rewrite=bar <copy &&
1133 git log -2 >actual &&
1134 test_cmp expect actual
1135 '
1136
1137 test_expect_success 'git notes copy --for-rewrite (overwrite)' '
1138 commit=$(git rev-parse HEAD) &&
1139 cat >expect <<-EOF &&
1140 commit $commit
1141 Author: A U Thor <author@example.com>
1142 Date: Thu Apr 7 15:27:13 2005 -0700
1143
1144 ${indent}15th
1145
1146 Notes:
1147 ${indent}a fresh note
1148 EOF
1149 git notes add -f -m"a fresh note" HEAD^ &&
1150 test_config notes.rewriteMode overwrite &&
1151 test_config notes.rewriteRef "refs/notes/*" &&
1152 from=$(git rev-parse HEAD^) &&
1153 to=$(git rev-parse HEAD) &&
1154 echo "$from" "$to" >copy &&
1155 git notes copy --for-rewrite=foo <copy &&
1156 git log -1 >actual &&
1157 test_cmp expect actual
1158 '
1159
1160 test_expect_success 'git notes copy --for-rewrite (ignore)' '
1161 test_config notes.rewriteMode ignore &&
1162 test_config notes.rewriteRef "refs/notes/*" &&
1163 from=$(git rev-parse HEAD^) &&
1164 to=$(git rev-parse HEAD) &&
1165 echo "$from" "$to" >copy &&
1166 git notes copy --for-rewrite=foo <copy &&
1167 git log -1 >actual &&
1168 test_cmp expect actual
1169 '
1170
1171 test_expect_success 'git notes copy --for-rewrite (append)' '
1172 commit=$(git rev-parse HEAD) &&
1173 cat >expect <<-EOF &&
1174 commit $commit
1175 Author: A U Thor <author@example.com>
1176 Date: Thu Apr 7 15:27:13 2005 -0700
1177
1178 ${indent}15th
1179
1180 Notes:
1181 ${indent}a fresh note
1182 ${indent}
1183 ${indent}another fresh note
1184 EOF
1185 git notes add -f -m"another fresh note" HEAD^ &&
1186 test_config notes.rewriteMode concatenate &&
1187 test_config notes.rewriteRef "refs/notes/*" &&
1188 from=$(git rev-parse HEAD^) &&
1189 to=$(git rev-parse HEAD) &&
1190 echo "$from" "$to" >copy &&
1191 git notes copy --for-rewrite=foo <copy &&
1192 git log -1 >actual &&
1193 test_cmp expect actual
1194 '
1195
1196 test_expect_success 'git notes copy --for-rewrite (append two to one)' '
1197 commit=$(git rev-parse HEAD) &&
1198 cat >expect <<-EOF &&
1199 commit $commit
1200 Author: A U Thor <author@example.com>
1201 Date: Thu Apr 7 15:27:13 2005 -0700
1202
1203 ${indent}15th
1204
1205 Notes:
1206 ${indent}a fresh note
1207 ${indent}
1208 ${indent}another fresh note
1209 ${indent}
1210 ${indent}append 1
1211 ${indent}
1212 ${indent}append 2
1213 EOF
1214 git notes add -f -m"append 1" HEAD^ &&
1215 git notes add -f -m"append 2" HEAD^^ &&
1216 test_config notes.rewriteMode concatenate &&
1217 test_config notes.rewriteRef "refs/notes/*" &&
1218 from=$(git rev-parse HEAD^) &&
1219 to=$(git rev-parse HEAD) &&
1220 echo "$from" "$to" >copy &&
1221 from=$(git rev-parse HEAD^^) &&
1222 to=$(git rev-parse HEAD) &&
1223 echo "$from" "$to" >>copy &&
1224 git notes copy --for-rewrite=foo <copy &&
1225 git log -1 >actual &&
1226 test_cmp expect actual
1227 '
1228
1229 test_expect_success 'git notes copy --for-rewrite (append empty)' '
1230 git notes remove HEAD^ &&
1231 test_config notes.rewriteMode concatenate &&
1232 test_config notes.rewriteRef "refs/notes/*" &&
1233 from=$(git rev-parse HEAD^) &&
1234 to=$(git rev-parse HEAD) &&
1235 echo "$from" "$to" >copy &&
1236 git notes copy --for-rewrite=foo <copy &&
1237 git log -1 >actual &&
1238 test_cmp expect actual
1239 '
1240
1241 test_expect_success 'GIT_NOTES_REWRITE_MODE works' '
1242 commit=$(git rev-parse HEAD) &&
1243 cat >expect <<-EOF &&
1244 commit $commit
1245 Author: A U Thor <author@example.com>
1246 Date: Thu Apr 7 15:27:13 2005 -0700
1247
1248 ${indent}15th
1249
1250 Notes:
1251 ${indent}replacement note 1
1252 EOF
1253 test_config notes.rewriteMode concatenate &&
1254 test_config notes.rewriteRef "refs/notes/*" &&
1255 git notes add -f -m"replacement note 1" HEAD^ &&
1256 from=$(git rev-parse HEAD^) &&
1257 to=$(git rev-parse HEAD) &&
1258 echo "$from" "$to" >copy &&
1259 GIT_NOTES_REWRITE_MODE=overwrite git notes copy --for-rewrite=foo <copy &&
1260 git log -1 >actual &&
1261 test_cmp expect actual
1262 '
1263
1264 test_expect_success 'GIT_NOTES_REWRITE_REF works' '
1265 commit=$(git rev-parse HEAD) &&
1266 cat >expect <<-EOF &&
1267 commit $commit
1268 Author: A U Thor <author@example.com>
1269 Date: Thu Apr 7 15:27:13 2005 -0700
1270
1271 ${indent}15th
1272
1273 Notes:
1274 ${indent}replacement note 2
1275 EOF
1276 git notes add -f -m"replacement note 2" HEAD^ &&
1277 test_config notes.rewriteMode overwrite &&
1278 test_unconfig notes.rewriteRef &&
1279 from=$(git rev-parse HEAD^) &&
1280 to=$(git rev-parse HEAD) &&
1281 echo "$from" "$to" >copy &&
1282 GIT_NOTES_REWRITE_REF=refs/notes/commits:refs/notes/other \
1283 git notes copy --for-rewrite=foo <copy &&
1284 git log -1 >actual &&
1285 test_cmp expect actual
1286 '
1287
1288 test_expect_success 'GIT_NOTES_REWRITE_REF overrides config' '
1289 git notes add -f -m"replacement note 3" HEAD^ &&
1290 test_config notes.rewriteMode overwrite &&
1291 test_config notes.rewriteRef refs/notes/other &&
1292 from=$(git rev-parse HEAD^) &&
1293 to=$(git rev-parse HEAD) &&
1294 echo "$from" "$to" >copy &&
1295 GIT_NOTES_REWRITE_REF=refs/notes/commits \
1296 git notes copy --for-rewrite=foo <copy &&
1297 git log -1 >actual &&
1298 grep "replacement note 3" actual
1299 '
1300
1301 test_expect_success 'git notes copy diagnoses too many or too few arguments' '
1302 test_must_fail git notes copy 2>error &&
1303 test_i18ngrep "too few arguments" error &&
1304 test_must_fail git notes copy one two three 2>error &&
1305 test_i18ngrep "too many arguments" error
1306 '
1307
1308 test_expect_success 'git notes get-ref expands refs/heads/main to refs/notes/refs/heads/main' '
1309 test_unconfig core.notesRef &&
1310 sane_unset GIT_NOTES_REF &&
1311 echo refs/notes/refs/heads/main >expect &&
1312 git notes --ref=refs/heads/main get-ref >actual &&
1313 test_cmp expect actual
1314 '
1315
1316 test_expect_success 'git notes get-ref (no overrides)' '
1317 test_unconfig core.notesRef &&
1318 sane_unset GIT_NOTES_REF &&
1319 echo refs/notes/commits >expect &&
1320 git notes get-ref >actual &&
1321 test_cmp expect actual
1322 '
1323
1324 test_expect_success 'git notes get-ref (core.notesRef)' '
1325 test_config core.notesRef refs/notes/foo &&
1326 echo refs/notes/foo >expect &&
1327 git notes get-ref >actual &&
1328 test_cmp expect actual
1329 '
1330
1331 test_expect_success 'git notes get-ref (GIT_NOTES_REF)' '
1332 echo refs/notes/bar >expect &&
1333 GIT_NOTES_REF=refs/notes/bar git notes get-ref >actual &&
1334 test_cmp expect actual
1335 '
1336
1337 test_expect_success 'git notes get-ref (--ref)' '
1338 echo refs/notes/baz >expect &&
1339 GIT_NOTES_REF=refs/notes/bar git notes --ref=baz get-ref >actual &&
1340 test_cmp expect actual
1341 '
1342
1343 test_expect_success 'setup testing of empty notes' '
1344 test_unconfig core.notesRef &&
1345 test_commit 16th &&
1346 empty_blob=$(git hash-object -w /dev/null) &&
1347 echo "$empty_blob" >expect_empty
1348 '
1349
1350 while read cmd
1351 do
1352 test_expect_success "'git notes $cmd' removes empty note" "
1353 test_might_fail git notes remove HEAD &&
1354 MSG= git notes $cmd &&
1355 test_must_fail git notes list HEAD
1356 "
1357
1358 test_expect_success "'git notes $cmd --allow-empty' stores empty note" "
1359 test_might_fail git notes remove HEAD &&
1360 MSG= git notes $cmd --allow-empty &&
1361 git notes list HEAD >actual &&
1362 test_cmp expect_empty actual
1363 "
1364 done <<\EOF
1365 add
1366 add -F /dev/null
1367 add -m ""
1368 add -c "$empty_blob"
1369 add -C "$empty_blob"
1370 append
1371 append -F /dev/null
1372 append -m ""
1373 append -c "$empty_blob"
1374 append -C "$empty_blob"
1375 edit
1376 EOF
1377
1378 test_expect_success 'empty notes are displayed by git log' '
1379 test_commit 17th &&
1380 git log -1 >expect &&
1381 cat >>expect <<-EOF &&
1382
1383 Notes:
1384 EOF
1385 git notes add -C "$empty_blob" --allow-empty &&
1386 git log -1 >actual &&
1387 test_cmp expect actual
1388 '
1389
1390 test_done