Merge branch 'jn/reproducible-build'
[git/git.git] / t / lib-submodule-update.sh
1 # Create a submodule layout used for all tests below.
2 #
3 # The following use cases are covered:
4 # - New submodule (no_submodule => add_sub1)
5 # - Removed submodule (add_sub1 => remove_sub1)
6 # - Updated submodule (add_sub1 => modify_sub1)
7 # - Updated submodule recursively (add_nested_sub => modify_sub1_recursively)
8 # - Submodule updated to invalid commit (add_sub1 => invalid_sub1)
9 # - Submodule updated from invalid commit (invalid_sub1 => valid_sub1)
10 # - Submodule replaced by tracked files in directory (add_sub1 =>
11 # replace_sub1_with_directory)
12 # - Directory containing tracked files replaced by submodule
13 # (replace_sub1_with_directory => replace_directory_with_sub1)
14 # - Submodule replaced by tracked file with the same name (add_sub1 =>
15 # replace_sub1_with_file)
16 # - Tracked file replaced by submodule (replace_sub1_with_file =>
17 # replace_file_with_sub1)
18 #
19 # ----O
20 # / ^
21 # / remove_sub1
22 # /
23 # add_sub1 /-------O---------O--------O modify_sub1_recursively
24 # | / ^ add_nested_sub
25 # | / modify_sub1
26 # v/
27 # O------O-----------O---------O
28 # ^ \ ^ replace_directory_with_sub1
29 # | \ replace_sub1_with_directory
30 # no_submodule \
31 # --------O---------O
32 # \ ^ replace_file_with_sub1
33 # \ replace_sub1_with_file
34 # \
35 # ----O---------O
36 # ^ valid_sub1
37 # invalid_sub1
38 #
39
40 create_lib_submodule_repo () {
41 git init submodule_update_sub1 &&
42 (
43 cd submodule_update_sub1 &&
44 echo "expect" >>.gitignore &&
45 echo "actual" >>.gitignore &&
46 echo "x" >file1 &&
47 echo "y" >file2 &&
48 git add .gitignore file1 file2 &&
49 git commit -m "Base inside first submodule" &&
50 git branch "no_submodule"
51 ) &&
52 git init submodule_update_sub2 &&
53 (
54 cd submodule_update_sub2
55 echo "expect" >>.gitignore &&
56 echo "actual" >>.gitignore &&
57 echo "x" >file1 &&
58 echo "y" >file2 &&
59 git add .gitignore file1 file2 &&
60 git commit -m "nested submodule base" &&
61 git branch "no_submodule"
62 ) &&
63 git init submodule_update_repo &&
64 (
65 cd submodule_update_repo &&
66 echo "expect" >>.gitignore &&
67 echo "actual" >>.gitignore &&
68 echo "x" >file1 &&
69 echo "y" >file2 &&
70 git add .gitignore file1 file2 &&
71 git commit -m "Base" &&
72 git branch "no_submodule" &&
73
74 git checkout -b "add_sub1" &&
75 git submodule add ../submodule_update_sub1 sub1 &&
76 git submodule add ../submodule_update_sub1 uninitialized_sub &&
77 git config -f .gitmodules submodule.sub1.ignore all &&
78 git config submodule.sub1.ignore all &&
79 git add .gitmodules &&
80 git commit -m "Add sub1" &&
81
82 git checkout -b remove_sub1 add_sub1 &&
83 git revert HEAD &&
84
85 git checkout -b modify_sub1 add_sub1 &&
86 git submodule update &&
87 (
88 cd sub1 &&
89 git fetch &&
90 git checkout -b "modifications" &&
91 echo "z" >file2 &&
92 echo "x" >file3 &&
93 git add file2 file3 &&
94 git commit -m "modified file2 and added file3" &&
95 git push origin modifications
96 ) &&
97 git add sub1 &&
98 git commit -m "Modify sub1" &&
99
100 git checkout -b add_nested_sub modify_sub1 &&
101 git -C sub1 checkout -b "add_nested_sub" &&
102 git -C sub1 submodule add --branch no_submodule ../submodule_update_sub2 sub2 &&
103 git -C sub1 commit -a -m "add a nested submodule" &&
104 git add sub1 &&
105 git commit -a -m "update submodule, that updates a nested submodule" &&
106 git checkout -b modify_sub1_recursively &&
107 git -C sub1 checkout -b modify_sub1_recursively &&
108 git -C sub1/sub2 checkout -b modify_sub1_recursively &&
109 echo change >sub1/sub2/file3 &&
110 git -C sub1/sub2 add file3 &&
111 git -C sub1/sub2 commit -m "make a change in nested sub" &&
112 git -C sub1 add sub2 &&
113 git -C sub1 commit -m "update nested sub" &&
114 git add sub1 &&
115 git commit -m "update sub1, that updates nested sub" &&
116 git -C sub1 push origin modify_sub1_recursively &&
117 git -C sub1/sub2 push origin modify_sub1_recursively &&
118 git -C sub1 submodule deinit -f --all &&
119
120 git checkout -b replace_sub1_with_directory add_sub1 &&
121 git submodule update &&
122 git -C sub1 checkout modifications &&
123 git rm --cached sub1 &&
124 rm sub1/.git* &&
125 git config -f .gitmodules --remove-section "submodule.sub1" &&
126 git add .gitmodules sub1/* &&
127 git commit -m "Replace sub1 with directory" &&
128
129 git checkout -b replace_directory_with_sub1 &&
130 git revert HEAD &&
131
132 git checkout -b replace_sub1_with_file add_sub1 &&
133 git rm sub1 &&
134 echo "content" >sub1 &&
135 git add sub1 &&
136 git commit -m "Replace sub1 with file" &&
137
138 git checkout -b replace_file_with_sub1 &&
139 git revert HEAD &&
140
141 git checkout -b invalid_sub1 add_sub1 &&
142 git update-index --cacheinfo 160000 0123456789012345678901234567890123456789 sub1 &&
143 git commit -m "Invalid sub1 commit" &&
144 git checkout -b valid_sub1 &&
145 git revert HEAD &&
146
147 git checkout master
148 )
149 }
150
151 # Helper function to replace gitfile with .git directory
152 replace_gitfile_with_git_dir () {
153 (
154 cd "$1" &&
155 git_dir="$(git rev-parse --git-dir)" &&
156 rm -f .git &&
157 cp -R "$git_dir" .git &&
158 GIT_WORK_TREE=. git config --unset core.worktree
159 )
160 }
161
162 # Test that the .git directory in the submodule is unchanged (except for the
163 # core.worktree setting, which appears only in $GIT_DIR/modules/$1/config).
164 # Call this function before test_submodule_content as the latter might
165 # write the index file leading to false positive index differences.
166 #
167 # Note that this only supports submodules at the root level of the
168 # superproject, with the default name, i.e. same as its path.
169 test_git_directory_is_unchanged () {
170 (
171 cd ".git/modules/$1" &&
172 # does core.worktree point at the right place?
173 test "$(git config core.worktree)" = "../../../$1" &&
174 # remove it temporarily before comparing, as
175 # "$1/.git/config" lacks it...
176 git config --unset core.worktree
177 ) &&
178 diff -r ".git/modules/$1" "$1/.git" &&
179 (
180 # ... and then restore.
181 cd ".git/modules/$1" &&
182 git config core.worktree "../../../$1"
183 )
184 }
185
186 test_git_directory_exists() {
187 test -e ".git/modules/$1" &&
188 if test -f sub1/.git
189 then
190 # does core.worktree point at the right place?
191 test "$(git -C .git/modules/$1 config core.worktree)" = "../../../$1"
192 fi
193 }
194
195 # Helper function to be executed at the start of every test below, it sets up
196 # the submodule repo if it doesn't exist and configures the most problematic
197 # settings for diff.ignoreSubmodules.
198 prolog () {
199 (test -d submodule_update_repo || create_lib_submodule_repo) &&
200 test_config_global diff.ignoreSubmodules all &&
201 test_config diff.ignoreSubmodules all
202 }
203
204 # Helper function to bring work tree back into the state given by the
205 # commit. This includes trying to populate sub1 accordingly if it exists and
206 # should be updated to an existing commit.
207 reset_work_tree_to () {
208 rm -rf submodule_update &&
209 git clone submodule_update_repo submodule_update &&
210 (
211 cd submodule_update &&
212 rm -rf sub1 &&
213 git checkout -f "$1" &&
214 git status -u -s >actual &&
215 test_must_be_empty actual &&
216 hash=$(git rev-parse --revs-only HEAD:sub1) &&
217 if test -n "$hash" &&
218 test $(cd "../submodule_update_sub1" && git rev-parse --verify "$hash^{commit}")
219 then
220 git submodule update --init --recursive "sub1"
221 fi
222 )
223 }
224
225 reset_work_tree_to_interested () {
226 reset_work_tree_to $1 &&
227 # make the submodule git dirs available
228 if ! test -d submodule_update/.git/modules/sub1
229 then
230 mkdir -p submodule_update/.git/modules &&
231 cp -r submodule_update_repo/.git/modules/sub1 submodule_update/.git/modules/sub1
232 GIT_WORK_TREE=. git -C submodule_update/.git/modules/sub1 config --unset core.worktree
233 fi &&
234 if ! test -d submodule_update/.git/modules/sub1/modules/sub2
235 then
236 mkdir -p submodule_update/.git/modules/sub1/modules &&
237 cp -r submodule_update_repo/.git/modules/sub1/modules/sub2 submodule_update/.git/modules/sub1/modules/sub2
238 GIT_WORK_TREE=. git -C submodule_update/.git/modules/sub1/modules/sub2 config --unset core.worktree
239 fi &&
240 # indicate we are interested in the submodule:
241 git -C submodule_update config submodule.sub1.url "bogus" &&
242 # sub1 might not be checked out, so use the git dir
243 git -C submodule_update/.git/modules/sub1 config submodule.sub2.url "bogus"
244 }
245
246 # Test that the superproject contains the content according to commit "$1"
247 # (the work tree must match the index for everything but submodules but the
248 # index must exactly match the given commit including any submodule SHA-1s).
249 test_superproject_content () {
250 git diff-index --cached "$1" >actual &&
251 test_must_be_empty actual &&
252 git diff-files --ignore-submodules >actual &&
253 test_must_be_empty actual
254 }
255
256 # Test that the given submodule at path "$1" contains the content according
257 # to the submodule commit recorded in the superproject's commit "$2"
258 test_submodule_content () {
259 if test x"$1" = "x-C"
260 then
261 cd "$2"
262 shift; shift;
263 fi
264 if test $# != 2
265 then
266 echo "test_submodule_content needs two arguments"
267 return 1
268 fi &&
269 submodule="$1" &&
270 commit="$2" &&
271 test -d "$submodule"/ &&
272 if ! test -f "$submodule"/.git && ! test -d "$submodule"/.git
273 then
274 echo "Submodule $submodule is not populated"
275 return 1
276 fi &&
277 sha1=$(git rev-parse --verify "$commit:$submodule") &&
278 if test -z "$sha1"
279 then
280 echo "Couldn't retrieve SHA-1 of $submodule for $commit"
281 return 1
282 fi &&
283 (
284 cd "$submodule" &&
285 git status -u -s >actual &&
286 test_must_be_empty actual &&
287 git diff "$sha1" >actual &&
288 test_must_be_empty actual
289 )
290 }
291
292 # Test that the following transitions are correctly handled:
293 # - Updated submodule
294 # - New submodule
295 # - Removed submodule
296 # - Directory containing tracked files replaced by submodule
297 # - Submodule replaced by tracked files in directory
298 # - Submodule replaced by tracked file with the same name
299 # - tracked file replaced by submodule
300 #
301 # The default is that submodule contents aren't changed until "git submodule
302 # update" is run. And even then that command doesn't delete the work tree of
303 # a removed submodule.
304 #
305 # Removing a submodule containing a .git directory must fail even when forced
306 # to protect the history!
307 #
308
309 # Internal function; use test_submodule_switch() or
310 # test_submodule_forced_switch() instead.
311 test_submodule_switch_common() {
312 command="$1"
313 ######################### Appearing submodule #########################
314 # Switching to a commit letting a submodule appear creates empty dir ...
315 if test "$KNOWN_FAILURE_STASH_DOES_IGNORE_SUBMODULE_CHANGES" = 1
316 then
317 # Restoring stash fails to restore submodule index entry
318 RESULT="failure"
319 else
320 RESULT="success"
321 fi
322 test_expect_$RESULT "$command: added submodule creates empty directory" '
323 prolog &&
324 reset_work_tree_to no_submodule &&
325 (
326 cd submodule_update &&
327 git branch -t add_sub1 origin/add_sub1 &&
328 $command add_sub1 &&
329 test_superproject_content origin/add_sub1 &&
330 test_dir_is_empty sub1 &&
331 git submodule update --init --recursive &&
332 test_submodule_content sub1 origin/add_sub1
333 )
334 '
335 # ... and doesn't care if it already exists.
336 test_expect_$RESULT "$command: added submodule leaves existing empty directory alone" '
337 prolog &&
338 reset_work_tree_to no_submodule &&
339 (
340 cd submodule_update &&
341 mkdir sub1 &&
342 git branch -t add_sub1 origin/add_sub1 &&
343 $command add_sub1 &&
344 test_superproject_content origin/add_sub1 &&
345 test_dir_is_empty sub1 &&
346 git submodule update --init --recursive &&
347 test_submodule_content sub1 origin/add_sub1
348 )
349 '
350 # Replacing a tracked file with a submodule produces an empty
351 # directory ...
352 test_expect_$RESULT "$command: replace tracked file with submodule creates empty directory" '
353 prolog &&
354 reset_work_tree_to replace_sub1_with_file &&
355 (
356 cd submodule_update &&
357 git branch -t replace_file_with_sub1 origin/replace_file_with_sub1 &&
358 $command replace_file_with_sub1 &&
359 test_superproject_content origin/replace_file_with_sub1 &&
360 test_dir_is_empty sub1 &&
361 git submodule update --init --recursive &&
362 test_submodule_content sub1 origin/replace_file_with_sub1
363 )
364 '
365 # ... as does removing a directory with tracked files with a
366 # submodule.
367 if test "$KNOWN_FAILURE_NOFF_MERGE_DOESNT_CREATE_EMPTY_SUBMODULE_DIR" = 1
368 then
369 # Non fast-forward merges fail with "Directory sub1 doesn't
370 # exist. sub1" because the empty submodule directory is not
371 # created
372 RESULT="failure"
373 else
374 RESULT="success"
375 fi
376 test_expect_$RESULT "$command: replace directory with submodule" '
377 prolog &&
378 reset_work_tree_to replace_sub1_with_directory &&
379 (
380 cd submodule_update &&
381 git branch -t replace_directory_with_sub1 origin/replace_directory_with_sub1 &&
382 $command replace_directory_with_sub1 &&
383 test_superproject_content origin/replace_directory_with_sub1 &&
384 test_dir_is_empty sub1 &&
385 git submodule update --init --recursive &&
386 test_submodule_content sub1 origin/replace_directory_with_sub1
387 )
388 '
389
390 ######################## Disappearing submodule #######################
391 # Removing a submodule doesn't remove its work tree ...
392 if test "$KNOWN_FAILURE_STASH_DOES_IGNORE_SUBMODULE_CHANGES" = 1
393 then
394 RESULT="failure"
395 else
396 RESULT="success"
397 fi
398 test_expect_$RESULT "$command: removed submodule leaves submodule directory and its contents in place" '
399 prolog &&
400 reset_work_tree_to add_sub1 &&
401 (
402 cd submodule_update &&
403 git branch -t remove_sub1 origin/remove_sub1 &&
404 $command remove_sub1 &&
405 test_superproject_content origin/remove_sub1 &&
406 test_submodule_content sub1 origin/add_sub1
407 )
408 '
409 # ... especially when it contains a .git directory.
410 test_expect_$RESULT "$command: removed submodule leaves submodule containing a .git directory alone" '
411 prolog &&
412 reset_work_tree_to add_sub1 &&
413 (
414 cd submodule_update &&
415 git branch -t remove_sub1 origin/remove_sub1 &&
416 replace_gitfile_with_git_dir sub1 &&
417 $command remove_sub1 &&
418 test_superproject_content origin/remove_sub1 &&
419 test_git_directory_is_unchanged sub1 &&
420 test_submodule_content sub1 origin/add_sub1
421 )
422 '
423 # Replacing a submodule with files in a directory must fail as the
424 # submodule work tree isn't removed ...
425 if test "$KNOWN_FAILURE_NOFF_MERGE_ATTEMPTS_TO_MERGE_REMOVED_SUBMODULE_FILES" = 1
426 then
427 # Non fast-forward merges attempt to merge the former
428 # submodule files with the newly checked out ones in the
429 # directory of the same name while it shouldn't.
430 RESULT="failure"
431 elif test "$KNOWN_FAILURE_FORCED_SWITCH_TESTS" = 1
432 then
433 # All existing tests that use test_submodule_forced_switch()
434 # require this.
435 RESULT="failure"
436 else
437 RESULT="success"
438 fi
439 test_expect_$RESULT "$command: replace submodule with a directory must fail" '
440 prolog &&
441 reset_work_tree_to add_sub1 &&
442 (
443 cd submodule_update &&
444 git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory &&
445 test_must_fail $command replace_sub1_with_directory &&
446 test_superproject_content origin/add_sub1 &&
447 test_submodule_content sub1 origin/add_sub1
448 )
449 '
450 # ... especially when it contains a .git directory.
451 test_expect_$RESULT "$command: replace submodule containing a .git directory with a directory must fail" '
452 prolog &&
453 reset_work_tree_to add_sub1 &&
454 (
455 cd submodule_update &&
456 git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory &&
457 replace_gitfile_with_git_dir sub1 &&
458 test_must_fail $command replace_sub1_with_directory &&
459 test_superproject_content origin/add_sub1 &&
460 test_git_directory_is_unchanged sub1 &&
461 test_submodule_content sub1 origin/add_sub1
462 )
463 '
464 # Replacing it with a file must fail as it could throw away any local
465 # work tree changes ...
466 test_expect_failure "$command: replace submodule with a file must fail" '
467 prolog &&
468 reset_work_tree_to add_sub1 &&
469 (
470 cd submodule_update &&
471 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
472 test_must_fail $command replace_sub1_with_file &&
473 test_superproject_content origin/add_sub1 &&
474 test_submodule_content sub1 origin/add_sub1
475 )
476 '
477 # ... or even destroy unpushed parts of submodule history if that
478 # still uses a .git directory.
479 test_expect_failure "$command: replace submodule containing a .git directory with a file must fail" '
480 prolog &&
481 reset_work_tree_to add_sub1 &&
482 (
483 cd submodule_update &&
484 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
485 replace_gitfile_with_git_dir sub1 &&
486 test_must_fail $command replace_sub1_with_file &&
487 test_superproject_content origin/add_sub1 &&
488 test_git_directory_is_unchanged sub1 &&
489 test_submodule_content sub1 origin/add_sub1
490 )
491 '
492
493 ########################## Modified submodule #########################
494 # Updating a submodule sha1 doesn't update the submodule's work tree
495 if test "$KNOWN_FAILURE_CHERRY_PICK_SEES_EMPTY_COMMIT" = 1
496 then
497 # When cherry picking a SHA-1 update for an ignored submodule
498 # the commit incorrectly fails with "The previous cherry-pick
499 # is now empty, possibly due to conflict resolution."
500 RESULT="failure"
501 else
502 RESULT="success"
503 fi
504 test_expect_$RESULT "$command: modified submodule does not update submodule work tree" '
505 prolog &&
506 reset_work_tree_to add_sub1 &&
507 (
508 cd submodule_update &&
509 git branch -t modify_sub1 origin/modify_sub1 &&
510 $command modify_sub1 &&
511 test_superproject_content origin/modify_sub1 &&
512 test_submodule_content sub1 origin/add_sub1 &&
513 git submodule update &&
514 test_submodule_content sub1 origin/modify_sub1
515 )
516 '
517 # Updating a submodule to an invalid sha1 doesn't update the
518 # submodule's work tree, subsequent update will fail
519 test_expect_$RESULT "$command: modified submodule does not update submodule work tree to invalid commit" '
520 prolog &&
521 reset_work_tree_to add_sub1 &&
522 (
523 cd submodule_update &&
524 git branch -t invalid_sub1 origin/invalid_sub1 &&
525 $command invalid_sub1 &&
526 test_superproject_content origin/invalid_sub1 &&
527 test_submodule_content sub1 origin/add_sub1 &&
528 test_must_fail git submodule update &&
529 test_submodule_content sub1 origin/add_sub1
530 )
531 '
532 # Updating a submodule from an invalid sha1 doesn't update the
533 # submodule's work tree, subsequent update will succeed
534 test_expect_$RESULT "$command: modified submodule does not update submodule work tree from invalid commit" '
535 prolog &&
536 reset_work_tree_to invalid_sub1 &&
537 (
538 cd submodule_update &&
539 git branch -t valid_sub1 origin/valid_sub1 &&
540 $command valid_sub1 &&
541 test_superproject_content origin/valid_sub1 &&
542 test_dir_is_empty sub1 &&
543 git submodule update --init --recursive &&
544 test_submodule_content sub1 origin/valid_sub1
545 )
546 '
547 }
548
549 # Declares and invokes several tests that, in various situations, checks that
550 # the provided transition function:
551 # - succeeds in updating the worktree and index of a superproject to a target
552 # commit, or fails atomically (depending on the test situation)
553 # - if succeeds, the contents of submodule directories are unchanged
554 # - if succeeds, once "git submodule update" is invoked, the contents of
555 # submodule directories are updated
556 #
557 # Use as follows:
558 #
559 # my_func () {
560 # target=$1
561 # # Do something here that updates the worktree and index to match target,
562 # # but not any submodule directories.
563 # }
564 # test_submodule_switch "my_func"
565 test_submodule_switch () {
566 command="$1"
567 test_submodule_switch_common "$command"
568
569 # An empty directory does not prevent the creation of a submodule of
570 # the same name, but a file does.
571 test_expect_success "$command: added submodule doesn't remove untracked unignored file with same name" '
572 prolog &&
573 reset_work_tree_to no_submodule &&
574 (
575 cd submodule_update &&
576 git branch -t add_sub1 origin/add_sub1 &&
577 >sub1 &&
578 test_must_fail $command add_sub1 &&
579 test_superproject_content origin/no_submodule &&
580 test_must_be_empty sub1
581 )
582 '
583 }
584
585 # Same as test_submodule_switch(), except that throwing away local changes in
586 # the superproject is allowed.
587 test_submodule_forced_switch () {
588 command="$1"
589 KNOWN_FAILURE_FORCED_SWITCH_TESTS=1
590 test_submodule_switch_common "$command"
591
592 # When forced, a file in the superproject does not prevent creating a
593 # submodule of the same name.
594 test_expect_success "$command: added submodule does remove untracked unignored file with same name when forced" '
595 prolog &&
596 reset_work_tree_to no_submodule &&
597 (
598 cd submodule_update &&
599 git branch -t add_sub1 origin/add_sub1 &&
600 >sub1 &&
601 $command add_sub1 &&
602 test_superproject_content origin/add_sub1 &&
603 test_dir_is_empty sub1
604 )
605 '
606 }
607
608 # Test that submodule contents are correctly updated when switching
609 # between commits that change a submodule.
610 # Test that the following transitions are correctly handled:
611 # (These tests are also above in the case where we expect no change
612 # in the submodule)
613 # - Updated submodule
614 # - New submodule
615 # - Removed submodule
616 # - Directory containing tracked files replaced by submodule
617 # - Submodule replaced by tracked files in directory
618 # - Submodule replaced by tracked file with the same name
619 # - tracked file replaced by submodule
620 #
621 # New test cases
622 # - Removing a submodule with a git directory absorbs the submodules
623 # git directory first into the superproject.
624
625 test_submodule_switch_recursing_with_args () {
626 cmd_args="$1"
627 command="git $cmd_args --recurse-submodules"
628 RESULTDS=success
629 if test "$KNOWN_FAILURE_DIRECTORY_SUBMODULE_CONFLICTS" = 1
630 then
631 RESULTDS=failure
632 fi
633 RESULTOI=success
634 if test "$KNOWN_FAILURE_SUBMODULE_OVERWRITE_IGNORED_UNTRACKED" = 1
635 then
636 RESULTOI=failure
637 fi
638 ######################### Appearing submodule #########################
639 # Switching to a commit letting a submodule appear checks it out ...
640 test_expect_success "$command: added submodule is checked out" '
641 prolog &&
642 reset_work_tree_to_interested no_submodule &&
643 (
644 cd submodule_update &&
645 git branch -t add_sub1 origin/add_sub1 &&
646 $command add_sub1 &&
647 test_superproject_content origin/add_sub1 &&
648 test_submodule_content sub1 origin/add_sub1
649 )
650 '
651 # ... ignoring an empty existing directory ...
652 test_expect_success "$command: added submodule is checked out in empty dir" '
653 prolog &&
654 reset_work_tree_to_interested no_submodule &&
655 (
656 cd submodule_update &&
657 mkdir sub1 &&
658 git branch -t add_sub1 origin/add_sub1 &&
659 $command add_sub1 &&
660 test_superproject_content origin/add_sub1 &&
661 test_submodule_content sub1 origin/add_sub1
662 )
663 '
664 # ... unless there is an untracked file in its place.
665 test_expect_success "$command: added submodule doesn't remove untracked file with same name" '
666 prolog &&
667 reset_work_tree_to_interested no_submodule &&
668 (
669 cd submodule_update &&
670 git branch -t add_sub1 origin/add_sub1 &&
671 : >sub1 &&
672 test_must_fail $command add_sub1 &&
673 test_superproject_content origin/no_submodule &&
674 test_must_be_empty sub1
675 )
676 '
677 # ... but an ignored file is fine.
678 test_expect_$RESULTOI "$command: added submodule removes an untracked ignored file" '
679 test_when_finished "rm submodule_update/.git/info/exclude" &&
680 prolog &&
681 reset_work_tree_to_interested no_submodule &&
682 (
683 cd submodule_update &&
684 git branch -t add_sub1 origin/add_sub1 &&
685 : >sub1 &&
686 echo sub1 >.git/info/exclude
687 $command add_sub1 &&
688 test_superproject_content origin/add_sub1 &&
689 test_submodule_content sub1 origin/add_sub1
690 )
691 '
692 test_expect_success "$command: submodule branch is not changed, detach HEAD instead" '
693 prolog &&
694 reset_work_tree_to_interested add_sub1 &&
695 (
696 cd submodule_update &&
697 git -C sub1 checkout -b keep_branch &&
698 git -C sub1 rev-parse HEAD >expect &&
699 git branch -t check-keep origin/modify_sub1 &&
700 $command check-keep &&
701 test_superproject_content origin/modify_sub1 &&
702 test_submodule_content sub1 origin/modify_sub1 &&
703 git -C sub1 rev-parse keep_branch >actual &&
704 test_cmp expect actual &&
705 test_must_fail git -C sub1 symbolic-ref HEAD
706 )
707 '
708
709 # Replacing a tracked file with a submodule produces a checked out submodule
710 test_expect_success "$command: replace tracked file with submodule checks out submodule" '
711 prolog &&
712 reset_work_tree_to_interested replace_sub1_with_file &&
713 (
714 cd submodule_update &&
715 git branch -t replace_file_with_sub1 origin/replace_file_with_sub1 &&
716 $command replace_file_with_sub1 &&
717 test_superproject_content origin/replace_file_with_sub1 &&
718 test_submodule_content sub1 origin/replace_file_with_sub1
719 )
720 '
721 # ... as does removing a directory with tracked files with a submodule.
722 test_expect_success "$command: replace directory with submodule" '
723 prolog &&
724 reset_work_tree_to_interested replace_sub1_with_directory &&
725 (
726 cd submodule_update &&
727 git branch -t replace_directory_with_sub1 origin/replace_directory_with_sub1 &&
728 $command replace_directory_with_sub1 &&
729 test_superproject_content origin/replace_directory_with_sub1 &&
730 test_submodule_content sub1 origin/replace_directory_with_sub1
731 )
732 '
733
734 ######################## Disappearing submodule #######################
735 # Removing a submodule removes its work tree ...
736 test_expect_success "$command: removed submodule removes submodules working tree" '
737 prolog &&
738 reset_work_tree_to_interested add_sub1 &&
739 (
740 cd submodule_update &&
741 git branch -t remove_sub1 origin/remove_sub1 &&
742 $command remove_sub1 &&
743 test_superproject_content origin/remove_sub1 &&
744 ! test -e sub1
745 )
746 '
747 # ... absorbing a .git directory along the way.
748 test_expect_success "$command: removed submodule absorbs submodules .git directory" '
749 prolog &&
750 reset_work_tree_to_interested add_sub1 &&
751 (
752 cd submodule_update &&
753 git branch -t remove_sub1 origin/remove_sub1 &&
754 replace_gitfile_with_git_dir sub1 &&
755 rm -rf .git/modules &&
756 $command remove_sub1 &&
757 test_superproject_content origin/remove_sub1 &&
758 ! test -e sub1 &&
759 test_git_directory_exists sub1
760 )
761 '
762 # Replacing a submodule with files in a directory must succeeds
763 # when the submodule is clean
764 test_expect_$RESULTDS "$command: replace submodule with a directory" '
765 prolog &&
766 reset_work_tree_to_interested add_sub1 &&
767 (
768 cd submodule_update &&
769 git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory &&
770 $command replace_sub1_with_directory &&
771 test_superproject_content origin/replace_sub1_with_directory &&
772 test_submodule_content sub1 origin/replace_sub1_with_directory
773 )
774 '
775 # ... absorbing a .git directory.
776 test_expect_$RESULTDS "$command: replace submodule containing a .git directory with a directory must absorb the git dir" '
777 prolog &&
778 reset_work_tree_to_interested add_sub1 &&
779 (
780 cd submodule_update &&
781 git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory &&
782 replace_gitfile_with_git_dir sub1 &&
783 rm -rf .git/modules &&
784 $command replace_sub1_with_directory &&
785 test_superproject_content origin/replace_sub1_with_directory &&
786 test_git_directory_exists sub1
787 )
788 '
789
790 # Replacing it with a file ...
791 test_expect_success "$command: replace submodule with a file" '
792 prolog &&
793 reset_work_tree_to_interested add_sub1 &&
794 (
795 cd submodule_update &&
796 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
797 $command replace_sub1_with_file &&
798 test_superproject_content origin/replace_sub1_with_file &&
799 test -f sub1
800 )
801 '
802
803 # ... must check its local work tree for untracked files
804 test_expect_$RESULTDS "$command: replace submodule with a file must fail with untracked files" '
805 prolog &&
806 reset_work_tree_to_interested add_sub1 &&
807 (
808 cd submodule_update &&
809 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
810 : >sub1/untrackedfile &&
811 test_must_fail $command replace_sub1_with_file &&
812 test_superproject_content origin/add_sub1 &&
813 test_submodule_content sub1 origin/add_sub1
814 )
815 '
816
817 # ... and ignored files are ignored
818 test_expect_success "$command: replace submodule with a file works ignores ignored files in submodule" '
819 test_when_finished "rm submodule_update/.git/modules/sub1/info/exclude" &&
820 prolog &&
821 reset_work_tree_to_interested add_sub1 &&
822 (
823 cd submodule_update &&
824 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
825 : >sub1/ignored &&
826 $command replace_sub1_with_file &&
827 test_superproject_content origin/replace_sub1_with_file &&
828 test -f sub1
829 )
830 '
831
832 ########################## Modified submodule #########################
833 # Updating a submodule sha1 updates the submodule's work tree
834 test_expect_success "$command: modified submodule updates submodule work tree" '
835 prolog &&
836 reset_work_tree_to_interested add_sub1 &&
837 (
838 cd submodule_update &&
839 git branch -t modify_sub1 origin/modify_sub1 &&
840 $command modify_sub1 &&
841 test_superproject_content origin/modify_sub1 &&
842 test_submodule_content sub1 origin/modify_sub1
843 )
844 '
845
846 test_expect_success "git -c submodule.recurse=true $cmd_args: modified submodule updates submodule work tree" '
847 prolog &&
848 reset_work_tree_to_interested add_sub1 &&
849 (
850 cd submodule_update &&
851 git branch -t modify_sub1 origin/modify_sub1 &&
852 git -c submodule.recurse=true $cmd_args modify_sub1 &&
853 test_superproject_content origin/modify_sub1 &&
854 test_submodule_content sub1 origin/modify_sub1
855 )
856 '
857
858 # Updating a submodule to an invalid sha1 doesn't update the
859 # superproject nor the submodule's work tree.
860 test_expect_success "$command: updating to a missing submodule commit fails" '
861 prolog &&
862 reset_work_tree_to_interested add_sub1 &&
863 (
864 cd submodule_update &&
865 git branch -t invalid_sub1 origin/invalid_sub1 &&
866 test_must_fail $command invalid_sub1 &&
867 test_superproject_content origin/add_sub1 &&
868 test_submodule_content sub1 origin/add_sub1
869 )
870 '
871
872 # recursing deeper than one level doesn't work yet.
873 test_expect_success "$command: modified submodule updates submodule recursively" '
874 prolog &&
875 reset_work_tree_to_interested add_nested_sub &&
876 (
877 cd submodule_update &&
878 git branch -t modify_sub1_recursively origin/modify_sub1_recursively &&
879 $command modify_sub1_recursively &&
880 test_superproject_content origin/modify_sub1_recursively &&
881 test_submodule_content sub1 origin/modify_sub1_recursively &&
882 test_submodule_content -C sub1 sub2 origin/modify_sub1_recursively
883 )
884 '
885 }
886
887 # Test that submodule contents are updated when switching between commits
888 # that change a submodule, but throwing away local changes in
889 # the superproject as well as the submodule is allowed.
890 test_submodule_forced_switch_recursing_with_args () {
891 cmd_args="$1"
892 command="git $cmd_args --recurse-submodules"
893 RESULT=success
894 if test "$KNOWN_FAILURE_DIRECTORY_SUBMODULE_CONFLICTS" = 1
895 then
896 RESULT=failure
897 fi
898 ######################### Appearing submodule #########################
899 # Switching to a commit letting a submodule appear creates empty dir ...
900 test_expect_success "$command: added submodule is checked out" '
901 prolog &&
902 reset_work_tree_to_interested no_submodule &&
903 (
904 cd submodule_update &&
905 git branch -t add_sub1 origin/add_sub1 &&
906 $command add_sub1 &&
907 test_superproject_content origin/add_sub1 &&
908 test_submodule_content sub1 origin/add_sub1
909 )
910 '
911 # ... and doesn't care if it already exists ...
912 test_expect_success "$command: added submodule ignores empty directory" '
913 prolog &&
914 reset_work_tree_to_interested no_submodule &&
915 (
916 cd submodule_update &&
917 git branch -t add_sub1 origin/add_sub1 &&
918 mkdir sub1 &&
919 $command add_sub1 &&
920 test_superproject_content origin/add_sub1 &&
921 test_submodule_content sub1 origin/add_sub1
922 )
923 '
924 # ... not caring about an untracked file either
925 test_expect_success "$command: added submodule does remove untracked unignored file with same name when forced" '
926 prolog &&
927 reset_work_tree_to_interested no_submodule &&
928 (
929 cd submodule_update &&
930 git branch -t add_sub1 origin/add_sub1 &&
931 >sub1 &&
932 $command add_sub1 &&
933 test_superproject_content origin/add_sub1 &&
934 test_submodule_content sub1 origin/add_sub1
935 )
936 '
937 # Replacing a tracked file with a submodule checks out the submodule
938 test_expect_success "$command: replace tracked file with submodule populates the submodule" '
939 prolog &&
940 reset_work_tree_to_interested replace_sub1_with_file &&
941 (
942 cd submodule_update &&
943 git branch -t replace_file_with_sub1 origin/replace_file_with_sub1 &&
944 $command replace_file_with_sub1 &&
945 test_superproject_content origin/replace_file_with_sub1 &&
946 test_submodule_content sub1 origin/replace_file_with_sub1
947 )
948 '
949 # ... as does removing a directory with tracked files with a
950 # submodule.
951 test_expect_success "$command: replace directory with submodule" '
952 prolog &&
953 reset_work_tree_to_interested replace_sub1_with_directory &&
954 (
955 cd submodule_update &&
956 git branch -t replace_directory_with_sub1 origin/replace_directory_with_sub1 &&
957 $command replace_directory_with_sub1 &&
958 test_superproject_content origin/replace_directory_with_sub1 &&
959 test_submodule_content sub1 origin/replace_directory_with_sub1
960 )
961 '
962
963 ######################## Disappearing submodule #######################
964 # Removing a submodule doesn't remove its work tree ...
965 test_expect_success "$command: removed submodule leaves submodule directory and its contents in place" '
966 prolog &&
967 reset_work_tree_to_interested add_sub1 &&
968 (
969 cd submodule_update &&
970 git branch -t remove_sub1 origin/remove_sub1 &&
971 $command remove_sub1 &&
972 test_superproject_content origin/remove_sub1 &&
973 ! test -e sub1
974 )
975 '
976 # ... especially when it contains a .git directory.
977 test_expect_success "$command: removed submodule leaves submodule containing a .git directory alone" '
978 prolog &&
979 reset_work_tree_to_interested add_sub1 &&
980 (
981 cd submodule_update &&
982 git branch -t remove_sub1 origin/remove_sub1 &&
983 replace_gitfile_with_git_dir sub1 &&
984 rm -rf .git/modules/sub1 &&
985 $command remove_sub1 &&
986 test_superproject_content origin/remove_sub1 &&
987 test_git_directory_exists sub1 &&
988 ! test -e sub1
989 )
990 '
991 # Replacing a submodule with files in a directory ...
992 test_expect_success "$command: replace submodule with a directory" '
993 prolog &&
994 reset_work_tree_to_interested add_sub1 &&
995 (
996 cd submodule_update &&
997 git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory &&
998 $command replace_sub1_with_directory &&
999 test_superproject_content origin/replace_sub1_with_directory
1000 )
1001 '
1002 # ... absorbing a .git directory.
1003 test_expect_success "$command: replace submodule containing a .git directory with a directory must fail" '
1004 prolog &&
1005 reset_work_tree_to_interested add_sub1 &&
1006 (
1007 cd submodule_update &&
1008 git branch -t replace_sub1_with_directory origin/replace_sub1_with_directory &&
1009 replace_gitfile_with_git_dir sub1 &&
1010 rm -rf .git/modules/sub1 &&
1011 $command replace_sub1_with_directory &&
1012 test_superproject_content origin/replace_sub1_with_directory &&
1013 test_submodule_content sub1 origin/modify_sub1
1014 test_git_directory_exists sub1
1015 )
1016 '
1017 # Replacing it with a file
1018 test_expect_success "$command: replace submodule with a file" '
1019 prolog &&
1020 reset_work_tree_to_interested add_sub1 &&
1021 (
1022 cd submodule_update &&
1023 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
1024 $command replace_sub1_with_file &&
1025 test_superproject_content origin/replace_sub1_with_file
1026 )
1027 '
1028
1029 # ... even if the submodule contains ignored files
1030 test_expect_success "$command: replace submodule with a file ignoring ignored files" '
1031 prolog &&
1032 reset_work_tree_to_interested add_sub1 &&
1033 (
1034 cd submodule_update &&
1035 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
1036 : >sub1/expect &&
1037 $command replace_sub1_with_file &&
1038 test_superproject_content origin/replace_sub1_with_file
1039 )
1040 '
1041
1042 # ... but stops for untracked files that would be lost
1043 test_expect_$RESULT "$command: replace submodule with a file stops for untracked files" '
1044 prolog &&
1045 reset_work_tree_to_interested add_sub1 &&
1046 (
1047 cd submodule_update &&
1048 git branch -t replace_sub1_with_file origin/replace_sub1_with_file &&
1049 : >sub1/untracked_file &&
1050 test_must_fail $command replace_sub1_with_file &&
1051 test_superproject_content origin/add_sub1 &&
1052 test -f sub1/untracked_file
1053 )
1054 '
1055
1056 ########################## Modified submodule #########################
1057 # Updating a submodule sha1 updates the submodule's work tree
1058 test_expect_success "$command: modified submodule updates submodule work tree" '
1059 prolog &&
1060 reset_work_tree_to_interested add_sub1 &&
1061 (
1062 cd submodule_update &&
1063 git branch -t modify_sub1 origin/modify_sub1 &&
1064 $command modify_sub1 &&
1065 test_superproject_content origin/modify_sub1 &&
1066 test_submodule_content sub1 origin/modify_sub1
1067 )
1068 '
1069 # Updating a submodule to an invalid sha1 doesn't update the
1070 # submodule's work tree, subsequent update will fail
1071 test_expect_success "$command: modified submodule does not update submodule work tree to invalid commit" '
1072 prolog &&
1073 reset_work_tree_to_interested add_sub1 &&
1074 (
1075 cd submodule_update &&
1076 git branch -t invalid_sub1 origin/invalid_sub1 &&
1077 test_must_fail $command invalid_sub1 &&
1078 test_superproject_content origin/add_sub1 &&
1079 test_submodule_content sub1 origin/add_sub1
1080 )
1081 '
1082 # Updating a submodule from an invalid sha1 updates
1083 test_expect_success "$command: modified submodule does update submodule work tree from invalid commit" '
1084 prolog &&
1085 reset_work_tree_to_interested invalid_sub1 &&
1086 (
1087 cd submodule_update &&
1088 git branch -t valid_sub1 origin/valid_sub1 &&
1089 $command valid_sub1 &&
1090 test_superproject_content origin/valid_sub1 &&
1091 test_submodule_content sub1 origin/valid_sub1
1092 )
1093 '
1094
1095 # Old versions of Git were buggy writing the .git link file
1096 # (e.g. before f8eaa0ba98b and then moving the superproject repo
1097 # whose submodules contained absolute paths)
1098 test_expect_success "$command: updating submodules fixes .git links" '
1099 prolog &&
1100 reset_work_tree_to_interested add_sub1 &&
1101 (
1102 cd submodule_update &&
1103 git branch -t modify_sub1 origin/modify_sub1 &&
1104 echo "gitdir: bogus/path" >sub1/.git &&
1105 $command modify_sub1 &&
1106 test_superproject_content origin/modify_sub1 &&
1107 test_submodule_content sub1 origin/modify_sub1
1108 )
1109 '
1110 }