Merge branch 'jc/doc-git-updates'
[git] / t / t3310-notes-merge-manual-resolve.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2010 Johan Herland
4 #
5
6 test_description='Test notes merging with manual conflict resolution'
7
8 . ./test-lib.sh
9
10 # Set up a notes merge scenario with different kinds of conflicts
11 test_expect_success 'setup commits' '
12         test_commit 1st &&
13         test_commit 2nd &&
14         test_commit 3rd &&
15         test_commit 4th &&
16         test_commit 5th
17 '
18
19 commit_sha1=$(git rev-parse 1st^{commit})
20 commit_sha2=$(git rev-parse 2nd^{commit})
21 commit_sha3=$(git rev-parse 3rd^{commit})
22 commit_sha4=$(git rev-parse 4th^{commit})
23 commit_sha5=$(git rev-parse 5th^{commit})
24
25 verify_notes () {
26         notes_ref="$1"
27         git -c core.notesRef="refs/notes/$notes_ref" notes |
28                 sort >"output_notes_$notes_ref" &&
29         test_cmp "expect_notes_$notes_ref" "output_notes_$notes_ref" &&
30         git -c core.notesRef="refs/notes/$notes_ref" log --format="%H %s%n%N" \
31                 >"output_log_$notes_ref" &&
32         test_cmp "expect_log_$notes_ref" "output_log_$notes_ref"
33 }
34
35 cat <<EOF | sort >expect_notes_x
36 6e8e3febca3c2bb896704335cc4d0c34cb2f8715 $commit_sha4
37 e5388c10860456ee60673025345fe2e153eb8cf8 $commit_sha3
38 ceefa674873670e7ecd131814d909723cce2b669 $commit_sha2
39 EOF
40
41 cat >expect_log_x <<EOF
42 $commit_sha5 5th
43
44 $commit_sha4 4th
45 x notes on 4th commit
46
47 $commit_sha3 3rd
48 x notes on 3rd commit
49
50 $commit_sha2 2nd
51 x notes on 2nd commit
52
53 $commit_sha1 1st
54
55 EOF
56
57 test_expect_success 'setup merge base (x)' '
58         git config core.notesRef refs/notes/x &&
59         git notes add -m "x notes on 2nd commit" 2nd &&
60         git notes add -m "x notes on 3rd commit" 3rd &&
61         git notes add -m "x notes on 4th commit" 4th &&
62         verify_notes x
63 '
64
65 cat <<EOF | sort >expect_notes_y
66 e2bfd06a37dd2031684a59a6e2b033e212239c78 $commit_sha4
67 5772f42408c0dd6f097a7ca2d24de0e78d1c46b1 $commit_sha3
68 b0a6021ec006d07e80e9b20ec9b444cbd9d560d3 $commit_sha1
69 EOF
70
71 cat >expect_log_y <<EOF
72 $commit_sha5 5th
73
74 $commit_sha4 4th
75 y notes on 4th commit
76
77 $commit_sha3 3rd
78 y notes on 3rd commit
79
80 $commit_sha2 2nd
81
82 $commit_sha1 1st
83 y notes on 1st commit
84
85 EOF
86
87 test_expect_success 'setup local branch (y)' '
88         git update-ref refs/notes/y refs/notes/x &&
89         git config core.notesRef refs/notes/y &&
90         git notes add -f -m "y notes on 1st commit" 1st &&
91         git notes remove 2nd &&
92         git notes add -f -m "y notes on 3rd commit" 3rd &&
93         git notes add -f -m "y notes on 4th commit" 4th &&
94         verify_notes y
95 '
96
97 cat <<EOF | sort >expect_notes_z
98 cff59c793c20bb49a4e01bc06fb06bad642e0d54 $commit_sha4
99 283b48219aee9a4105f6cab337e789065c82c2b9 $commit_sha2
100 0a81da8956346e19bcb27a906f04af327e03e31b $commit_sha1
101 EOF
102
103 cat >expect_log_z <<EOF
104 $commit_sha5 5th
105
106 $commit_sha4 4th
107 z notes on 4th commit
108
109 $commit_sha3 3rd
110
111 $commit_sha2 2nd
112 z notes on 2nd commit
113
114 $commit_sha1 1st
115 z notes on 1st commit
116
117 EOF
118
119 test_expect_success 'setup remote branch (z)' '
120         git update-ref refs/notes/z refs/notes/x &&
121         git config core.notesRef refs/notes/z &&
122         git notes add -f -m "z notes on 1st commit" 1st &&
123         git notes add -f -m "z notes on 2nd commit" 2nd &&
124         git notes remove 3rd &&
125         git notes add -f -m "z notes on 4th commit" 4th &&
126         verify_notes z
127 '
128
129 # At this point, before merging z into y, we have the following status:
130 #
131 # commit | base/x  | local/y | remote/z | diff from x to y/z
132 # -------|---------|---------|----------|---------------------------
133 # 1st    | [none]  | b0a6021 | 0a81da8  | added     / added (diff)
134 # 2nd    | ceefa67 | [none]  | 283b482  | removed   / changed
135 # 3rd    | e5388c1 | 5772f42 | [none]   | changed   / removed
136 # 4th    | 6e8e3fe | e2bfd06 | cff59c7  | changed   / changed (diff)
137 # 5th    | [none]  | [none]  | [none]   | [none]
138
139 cat <<EOF | sort >expect_conflicts
140 $commit_sha1
141 $commit_sha2
142 $commit_sha3
143 $commit_sha4
144 EOF
145
146 cat >expect_conflict_$commit_sha1 <<EOF
147 <<<<<<< refs/notes/m
148 y notes on 1st commit
149 =======
150 z notes on 1st commit
151 >>>>>>> refs/notes/z
152 EOF
153
154 cat >expect_conflict_$commit_sha2 <<EOF
155 z notes on 2nd commit
156 EOF
157
158 cat >expect_conflict_$commit_sha3 <<EOF
159 y notes on 3rd commit
160 EOF
161
162 cat >expect_conflict_$commit_sha4 <<EOF
163 <<<<<<< refs/notes/m
164 y notes on 4th commit
165 =======
166 z notes on 4th commit
167 >>>>>>> refs/notes/z
168 EOF
169
170 cp expect_notes_y expect_notes_m
171 cp expect_log_y expect_log_m
172
173 git rev-parse refs/notes/y > pre_merge_y
174 git rev-parse refs/notes/z > pre_merge_z
175
176 test_expect_success 'merge z into m (== y) with default ("manual") resolver => Conflicting 3-way merge' '
177         git update-ref refs/notes/m refs/notes/y &&
178         git config core.notesRef refs/notes/m &&
179         test_must_fail git notes merge z >output &&
180         # Output should point to where to resolve conflicts
181         grep -q "\\.git/NOTES_MERGE_WORKTREE" output &&
182         # Inspect merge conflicts
183         ls .git/NOTES_MERGE_WORKTREE >output_conflicts &&
184         test_cmp expect_conflicts output_conflicts &&
185         ( for f in $(cat expect_conflicts); do
186                 test_cmp "expect_conflict_$f" ".git/NOTES_MERGE_WORKTREE/$f" ||
187                 exit 1
188         done ) &&
189         # Verify that current notes tree (pre-merge) has not changed (m == y)
190         verify_notes y &&
191         verify_notes m &&
192         test "$(git rev-parse refs/notes/m)" = "$(cat pre_merge_y)"
193 '
194
195 cat <<EOF | sort >expect_notes_z
196 00494adecf2d9635a02fa431308d67993f853968 $commit_sha4
197 283b48219aee9a4105f6cab337e789065c82c2b9 $commit_sha2
198 0a81da8956346e19bcb27a906f04af327e03e31b $commit_sha1
199 EOF
200
201 cat >expect_log_z <<EOF
202 $commit_sha5 5th
203
204 $commit_sha4 4th
205 z notes on 4th commit
206
207 More z notes on 4th commit
208
209 $commit_sha3 3rd
210
211 $commit_sha2 2nd
212 z notes on 2nd commit
213
214 $commit_sha1 1st
215 z notes on 1st commit
216
217 EOF
218
219 test_expect_success 'change notes in z' '
220         git notes --ref z append -m "More z notes on 4th commit" 4th &&
221         verify_notes z
222 '
223
224 test_expect_success 'cannot do merge w/conflicts when previous merge is unfinished' '
225         test -d .git/NOTES_MERGE_WORKTREE &&
226         test_must_fail git notes merge z >output 2>&1 &&
227         # Output should indicate what is wrong
228         grep -q "\\.git/NOTES_MERGE_\\* exists" output
229 '
230
231 # Setup non-conflicting merge between x and new notes ref w
232
233 cat <<EOF | sort >expect_notes_w
234 ceefa674873670e7ecd131814d909723cce2b669 $commit_sha2
235 f75d1df88cbfe4258d49852f26cfc83f2ad4494b $commit_sha1
236 EOF
237
238 cat >expect_log_w <<EOF
239 $commit_sha5 5th
240
241 $commit_sha4 4th
242
243 $commit_sha3 3rd
244
245 $commit_sha2 2nd
246 x notes on 2nd commit
247
248 $commit_sha1 1st
249 w notes on 1st commit
250
251 EOF
252
253 test_expect_success 'setup unrelated notes ref (w)' '
254         git config core.notesRef refs/notes/w &&
255         git notes add -m "w notes on 1st commit" 1st &&
256         git notes add -m "x notes on 2nd commit" 2nd &&
257         verify_notes w
258 '
259
260 cat <<EOF | sort >expect_notes_w
261 6e8e3febca3c2bb896704335cc4d0c34cb2f8715 $commit_sha4
262 e5388c10860456ee60673025345fe2e153eb8cf8 $commit_sha3
263 ceefa674873670e7ecd131814d909723cce2b669 $commit_sha2
264 f75d1df88cbfe4258d49852f26cfc83f2ad4494b $commit_sha1
265 EOF
266
267 cat >expect_log_w <<EOF
268 $commit_sha5 5th
269
270 $commit_sha4 4th
271 x notes on 4th commit
272
273 $commit_sha3 3rd
274 x notes on 3rd commit
275
276 $commit_sha2 2nd
277 x notes on 2nd commit
278
279 $commit_sha1 1st
280 w notes on 1st commit
281
282 EOF
283
284 test_expect_success 'can do merge without conflicts even if previous merge is unfinished (x => w)' '
285         test -d .git/NOTES_MERGE_WORKTREE &&
286         git notes merge x &&
287         verify_notes w &&
288         # Verify that other notes refs has not changed (x and y)
289         verify_notes x &&
290         verify_notes y
291 '
292
293 cat <<EOF | sort >expect_notes_m
294 021faa20e931fb48986ffc6282b4bb05553ac946 $commit_sha4
295 5772f42408c0dd6f097a7ca2d24de0e78d1c46b1 $commit_sha3
296 283b48219aee9a4105f6cab337e789065c82c2b9 $commit_sha2
297 0a59e787e6d688aa6309e56e8c1b89431a0fc1c1 $commit_sha1
298 EOF
299
300 cat >expect_log_m <<EOF
301 $commit_sha5 5th
302
303 $commit_sha4 4th
304 y and z notes on 4th commit
305
306 $commit_sha3 3rd
307 y notes on 3rd commit
308
309 $commit_sha2 2nd
310 z notes on 2nd commit
311
312 $commit_sha1 1st
313 y and z notes on 1st commit
314
315 EOF
316
317 test_expect_success 'finalize conflicting merge (z => m)' '
318         # Resolve conflicts and finalize merge
319         cat >.git/NOTES_MERGE_WORKTREE/$commit_sha1 <<EOF &&
320 y and z notes on 1st commit
321 EOF
322         cat >.git/NOTES_MERGE_WORKTREE/$commit_sha4 <<EOF &&
323 y and z notes on 4th commit
324 EOF
325         git notes merge --commit &&
326         # No .git/NOTES_MERGE_* files left
327         test_might_fail ls .git/NOTES_MERGE_* >output 2>/dev/null &&
328         test_cmp /dev/null output &&
329         # Merge commit has pre-merge y and pre-merge z as parents
330         test "$(git rev-parse refs/notes/m^1)" = "$(cat pre_merge_y)" &&
331         test "$(git rev-parse refs/notes/m^2)" = "$(cat pre_merge_z)" &&
332         # Merge commit mentions the notes refs merged
333         git log -1 --format=%B refs/notes/m > merge_commit_msg &&
334         grep -q refs/notes/m merge_commit_msg &&
335         grep -q refs/notes/z merge_commit_msg &&
336         # Merge commit mentions conflicting notes
337         grep -q "Conflicts" merge_commit_msg &&
338         ( for sha1 in $(cat expect_conflicts); do
339                 grep -q "$sha1" merge_commit_msg ||
340                 exit 1
341         done ) &&
342         # Verify contents of merge result
343         verify_notes m &&
344         # Verify that other notes refs has not changed (w, x, y and z)
345         verify_notes w &&
346         verify_notes x &&
347         verify_notes y &&
348         verify_notes z
349 '
350
351 cat >expect_conflict_$commit_sha4 <<EOF
352 <<<<<<< refs/notes/m
353 y notes on 4th commit
354 =======
355 z notes on 4th commit
356
357 More z notes on 4th commit
358 >>>>>>> refs/notes/z
359 EOF
360
361 cp expect_notes_y expect_notes_m
362 cp expect_log_y expect_log_m
363
364 git rev-parse refs/notes/y > pre_merge_y
365 git rev-parse refs/notes/z > pre_merge_z
366
367 test_expect_success 'redo merge of z into m (== y) with default ("manual") resolver => Conflicting 3-way merge' '
368         git update-ref refs/notes/m refs/notes/y &&
369         git config core.notesRef refs/notes/m &&
370         test_must_fail git notes merge z >output &&
371         # Output should point to where to resolve conflicts
372         grep -q "\\.git/NOTES_MERGE_WORKTREE" output &&
373         # Inspect merge conflicts
374         ls .git/NOTES_MERGE_WORKTREE >output_conflicts &&
375         test_cmp expect_conflicts output_conflicts &&
376         ( for f in $(cat expect_conflicts); do
377                 test_cmp "expect_conflict_$f" ".git/NOTES_MERGE_WORKTREE/$f" ||
378                 exit 1
379         done ) &&
380         # Verify that current notes tree (pre-merge) has not changed (m == y)
381         verify_notes y &&
382         verify_notes m &&
383         test "$(git rev-parse refs/notes/m)" = "$(cat pre_merge_y)"
384 '
385
386 test_expect_success 'abort notes merge' '
387         git notes merge --abort &&
388         # No .git/NOTES_MERGE_* files left
389         test_might_fail ls .git/NOTES_MERGE_* >output 2>/dev/null &&
390         test_cmp /dev/null output &&
391         # m has not moved (still == y)
392         test "$(git rev-parse refs/notes/m)" = "$(cat pre_merge_y)" &&
393         # Verify that other notes refs has not changed (w, x, y and z)
394         verify_notes w &&
395         verify_notes x &&
396         verify_notes y &&
397         verify_notes z
398 '
399
400 git rev-parse refs/notes/y > pre_merge_y
401 git rev-parse refs/notes/z > pre_merge_z
402
403 test_expect_success 'redo merge of z into m (== y) with default ("manual") resolver => Conflicting 3-way merge' '
404         test_must_fail git notes merge z >output &&
405         # Output should point to where to resolve conflicts
406         grep -q "\\.git/NOTES_MERGE_WORKTREE" output &&
407         # Inspect merge conflicts
408         ls .git/NOTES_MERGE_WORKTREE >output_conflicts &&
409         test_cmp expect_conflicts output_conflicts &&
410         ( for f in $(cat expect_conflicts); do
411                 test_cmp "expect_conflict_$f" ".git/NOTES_MERGE_WORKTREE/$f" ||
412                 exit 1
413         done ) &&
414         # Verify that current notes tree (pre-merge) has not changed (m == y)
415         verify_notes y &&
416         verify_notes m &&
417         test "$(git rev-parse refs/notes/m)" = "$(cat pre_merge_y)"
418 '
419
420 cat <<EOF | sort >expect_notes_m
421 304dfb4325cf243025b9957486eb605a9b51c199 $commit_sha5
422 283b48219aee9a4105f6cab337e789065c82c2b9 $commit_sha2
423 0a59e787e6d688aa6309e56e8c1b89431a0fc1c1 $commit_sha1
424 EOF
425
426 cat >expect_log_m <<EOF
427 $commit_sha5 5th
428 new note on 5th commit
429
430 $commit_sha4 4th
431
432 $commit_sha3 3rd
433
434 $commit_sha2 2nd
435 z notes on 2nd commit
436
437 $commit_sha1 1st
438 y and z notes on 1st commit
439
440 EOF
441
442 test_expect_success 'add + remove notes in finalized merge (z => m)' '
443         # Resolve one conflict
444         cat >.git/NOTES_MERGE_WORKTREE/$commit_sha1 <<EOF &&
445 y and z notes on 1st commit
446 EOF
447         # Remove another conflict
448         rm .git/NOTES_MERGE_WORKTREE/$commit_sha4 &&
449         # Remove a D/F conflict
450         rm .git/NOTES_MERGE_WORKTREE/$commit_sha3 &&
451         # Add a new note
452         echo "new note on 5th commit" > .git/NOTES_MERGE_WORKTREE/$commit_sha5 &&
453         # Finalize merge
454         git notes merge --commit &&
455         # No .git/NOTES_MERGE_* files left
456         test_might_fail ls .git/NOTES_MERGE_* >output 2>/dev/null &&
457         test_cmp /dev/null output &&
458         # Merge commit has pre-merge y and pre-merge z as parents
459         test "$(git rev-parse refs/notes/m^1)" = "$(cat pre_merge_y)" &&
460         test "$(git rev-parse refs/notes/m^2)" = "$(cat pre_merge_z)" &&
461         # Merge commit mentions the notes refs merged
462         git log -1 --format=%B refs/notes/m > merge_commit_msg &&
463         grep -q refs/notes/m merge_commit_msg &&
464         grep -q refs/notes/z merge_commit_msg &&
465         # Merge commit mentions conflicting notes
466         grep -q "Conflicts" merge_commit_msg &&
467         ( for sha1 in $(cat expect_conflicts); do
468                 grep -q "$sha1" merge_commit_msg ||
469                 exit 1
470         done ) &&
471         # Verify contents of merge result
472         verify_notes m &&
473         # Verify that other notes refs has not changed (w, x, y and z)
474         verify_notes w &&
475         verify_notes x &&
476         verify_notes y &&
477         verify_notes z
478 '
479
480 cp expect_notes_y expect_notes_m
481 cp expect_log_y expect_log_m
482
483 test_expect_success 'redo merge of z into m (== y) with default ("manual") resolver => Conflicting 3-way merge' '
484         git update-ref refs/notes/m refs/notes/y &&
485         test_must_fail git notes merge z >output &&
486         # Output should point to where to resolve conflicts
487         grep -q "\\.git/NOTES_MERGE_WORKTREE" output &&
488         # Inspect merge conflicts
489         ls .git/NOTES_MERGE_WORKTREE >output_conflicts &&
490         test_cmp expect_conflicts output_conflicts &&
491         ( for f in $(cat expect_conflicts); do
492                 test_cmp "expect_conflict_$f" ".git/NOTES_MERGE_WORKTREE/$f" ||
493                 exit 1
494         done ) &&
495         # Verify that current notes tree (pre-merge) has not changed (m == y)
496         verify_notes y &&
497         verify_notes m &&
498         test "$(git rev-parse refs/notes/m)" = "$(cat pre_merge_y)"
499 '
500
501 cp expect_notes_w expect_notes_m
502 cp expect_log_w expect_log_m
503
504 test_expect_success 'reset notes ref m to somewhere else (w)' '
505         git update-ref refs/notes/m refs/notes/w &&
506         verify_notes m &&
507         test "$(git rev-parse refs/notes/m)" = "$(git rev-parse refs/notes/w)"
508 '
509
510 test_expect_success 'fail to finalize conflicting merge if underlying ref has moved in the meantime (m != NOTES_MERGE_PARTIAL^1)' '
511         # Resolve conflicts
512         cat >.git/NOTES_MERGE_WORKTREE/$commit_sha1 <<EOF &&
513 y and z notes on 1st commit
514 EOF
515         cat >.git/NOTES_MERGE_WORKTREE/$commit_sha4 <<EOF &&
516 y and z notes on 4th commit
517 EOF
518         # Fail to finalize merge
519         test_must_fail git notes merge --commit >output 2>&1 &&
520         # .git/NOTES_MERGE_* must remain
521         test -f .git/NOTES_MERGE_PARTIAL &&
522         test -f .git/NOTES_MERGE_REF &&
523         test -f .git/NOTES_MERGE_WORKTREE/$commit_sha1 &&
524         test -f .git/NOTES_MERGE_WORKTREE/$commit_sha2 &&
525         test -f .git/NOTES_MERGE_WORKTREE/$commit_sha3 &&
526         test -f .git/NOTES_MERGE_WORKTREE/$commit_sha4 &&
527         # Refs are unchanged
528         test "$(git rev-parse refs/notes/m)" = "$(git rev-parse refs/notes/w)" &&
529         test "$(git rev-parse refs/notes/y)" = "$(git rev-parse NOTES_MERGE_PARTIAL^1)" &&
530         test "$(git rev-parse refs/notes/m)" != "$(git rev-parse NOTES_MERGE_PARTIAL^1)" &&
531         # Mention refs/notes/m, and its current and expected value in output
532         grep -q "refs/notes/m" output &&
533         grep -q "$(git rev-parse refs/notes/m)" output &&
534         grep -q "$(git rev-parse NOTES_MERGE_PARTIAL^1)" output &&
535         # Verify that other notes refs has not changed (w, x, y and z)
536         verify_notes w &&
537         verify_notes x &&
538         verify_notes y &&
539         verify_notes z
540 '
541
542 test_expect_success 'resolve situation by aborting the notes merge' '
543         git notes merge --abort &&
544         # No .git/NOTES_MERGE_* files left
545         test_might_fail ls .git/NOTES_MERGE_* >output 2>/dev/null &&
546         test_cmp /dev/null output &&
547         # m has not moved (still == w)
548         test "$(git rev-parse refs/notes/m)" = "$(git rev-parse refs/notes/w)" &&
549         # Verify that other notes refs has not changed (w, x, y and z)
550         verify_notes w &&
551         verify_notes x &&
552         verify_notes y &&
553         verify_notes z
554 '
555
556 cat >expect_notes <<EOF
557 foo
558 bar
559 EOF
560
561 test_expect_success 'switch cwd before committing notes merge' '
562         git notes add -m foo HEAD &&
563         git notes --ref=other add -m bar HEAD &&
564         test_must_fail git notes merge refs/notes/other &&
565         (
566                 cd .git/NOTES_MERGE_WORKTREE &&
567                 echo "foo" > $(git rev-parse HEAD) &&
568                 echo "bar" >> $(git rev-parse HEAD) &&
569                 git notes merge --commit
570         ) &&
571         git notes show HEAD > actual_notes &&
572         test_cmp expect_notes actual_notes
573 '
574
575 test_done