]> git.ipfire.org Git - thirdparty/git.git/blob - t/t1091-sparse-checkout-builtin.sh
Sync with 2.31.5
[thirdparty/git.git] / t / t1091-sparse-checkout-builtin.sh
1 #!/bin/sh
2
3 test_description='sparse checkout builtin tests'
4
5 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
6 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
7
8 . ./test-lib.sh
9
10 list_files() {
11 # Do not replace this with 'ls "$1"', as "ls" with BSD-lineage
12 # enables "-A" by default for root and ends up including ".git" and
13 # such in its output. (Note, though, that running the test suite as
14 # root is generally not recommended.)
15 (cd "$1" && printf '%s\n' *)
16 }
17
18 check_files() {
19 list_files "$1" >actual &&
20 shift &&
21 printf "%s\n" $@ >expect &&
22 test_cmp expect actual
23 }
24
25 test_expect_success 'setup' '
26 git init repo &&
27 (
28 cd repo &&
29 echo "initial" >a &&
30 mkdir folder1 folder2 deep &&
31 mkdir deep/deeper1 deep/deeper2 &&
32 mkdir deep/deeper1/deepest &&
33 cp a folder1 &&
34 cp a folder2 &&
35 cp a deep &&
36 cp a deep/deeper1 &&
37 cp a deep/deeper2 &&
38 cp a deep/deeper1/deepest &&
39 git add . &&
40 git commit -m "initial commit"
41 )
42 '
43
44 test_expect_success 'git sparse-checkout list (empty)' '
45 git -C repo sparse-checkout list >list 2>err &&
46 test_must_be_empty list &&
47 test_i18ngrep "this worktree is not sparse (sparse-checkout file may not exist)" err
48 '
49
50 test_expect_success 'git sparse-checkout list (populated)' '
51 test_when_finished rm -f repo/.git/info/sparse-checkout &&
52 cat >repo/.git/info/sparse-checkout <<-\EOF &&
53 /folder1/*
54 /deep/
55 **/a
56 !*bin*
57 EOF
58 cp repo/.git/info/sparse-checkout expect &&
59 git -C repo sparse-checkout list >list &&
60 test_cmp expect list
61 '
62
63 test_expect_success 'git sparse-checkout init' '
64 git -C repo sparse-checkout init &&
65 cat >expect <<-\EOF &&
66 /*
67 !/*/
68 EOF
69 test_cmp expect repo/.git/info/sparse-checkout &&
70 test_cmp_config -C repo true core.sparsecheckout &&
71 check_files repo a
72 '
73
74 test_expect_success 'git sparse-checkout list after init' '
75 git -C repo sparse-checkout list >actual &&
76 cat >expect <<-\EOF &&
77 /*
78 !/*/
79 EOF
80 test_cmp expect actual
81 '
82
83 test_expect_success 'init with existing sparse-checkout' '
84 echo "*folder*" >> repo/.git/info/sparse-checkout &&
85 git -C repo sparse-checkout init &&
86 cat >expect <<-\EOF &&
87 /*
88 !/*/
89 *folder*
90 EOF
91 test_cmp expect repo/.git/info/sparse-checkout &&
92 check_files repo a folder1 folder2
93 '
94
95 test_expect_success 'clone --sparse' '
96 git clone --sparse "file://$(pwd)/repo" clone &&
97 git -C clone sparse-checkout list >actual &&
98 cat >expect <<-\EOF &&
99 /*
100 !/*/
101 EOF
102 test_cmp expect actual &&
103 check_files clone a
104 '
105
106 test_expect_success 'interaction with clone --no-checkout (unborn index)' '
107 git clone --no-checkout "file://$(pwd)/repo" clone_no_checkout &&
108 git -C clone_no_checkout sparse-checkout init --cone &&
109 git -C clone_no_checkout sparse-checkout set folder1 &&
110
111 git -C clone_no_checkout sparse-checkout list >actual &&
112 cat >expect <<-\EOF &&
113 folder1
114 EOF
115 test_cmp expect actual &&
116
117 # nothing checked out, expect "No such file or directory"
118 ! ls clone_no_checkout/* >actual &&
119 test_must_be_empty actual &&
120 test_path_is_missing clone_no_checkout/.git/index &&
121
122 # No branch is checked out until we manually switch to one
123 git -C clone_no_checkout switch main &&
124 test_path_is_file clone_no_checkout/.git/index &&
125 check_files clone_no_checkout a folder1
126 '
127
128 test_expect_success 'set enables config' '
129 git init empty-config &&
130 (
131 cd empty-config &&
132 test_commit test file &&
133 test_path_is_missing .git/config.worktree &&
134 git sparse-checkout set nothing &&
135 test_path_is_file .git/config.worktree &&
136 test_cmp_config true core.sparseCheckout
137 )
138 '
139
140 test_expect_success 'set sparse-checkout using builtin' '
141 git -C repo sparse-checkout set "/*" "!/*/" "*folder*" &&
142 cat >expect <<-\EOF &&
143 /*
144 !/*/
145 *folder*
146 EOF
147 git -C repo sparse-checkout list >actual &&
148 test_cmp expect actual &&
149 test_cmp expect repo/.git/info/sparse-checkout &&
150 check_files repo a folder1 folder2
151 '
152
153 test_expect_success 'set sparse-checkout using --stdin' '
154 cat >expect <<-\EOF &&
155 /*
156 !/*/
157 /folder1/
158 /folder2/
159 EOF
160 git -C repo sparse-checkout set --stdin <expect &&
161 git -C repo sparse-checkout list >actual &&
162 test_cmp expect actual &&
163 test_cmp expect repo/.git/info/sparse-checkout &&
164 check_files repo "a folder1 folder2"
165 '
166
167 test_expect_success 'add to sparse-checkout' '
168 cat repo/.git/info/sparse-checkout >expect &&
169 cat >add <<-\EOF &&
170 pattern1
171 /folder1/
172 pattern2
173 EOF
174 cat add >>expect &&
175 git -C repo sparse-checkout add --stdin <add &&
176 git -C repo sparse-checkout list >actual &&
177 test_cmp expect actual &&
178 test_cmp expect repo/.git/info/sparse-checkout &&
179 check_files repo "a folder1 folder2"
180 '
181
182 test_expect_success 'cone mode: match patterns' '
183 git -C repo config --worktree core.sparseCheckoutCone true &&
184 rm -rf repo/a repo/folder1 repo/folder2 &&
185 git -C repo read-tree -mu HEAD 2>err &&
186 test_i18ngrep ! "disabling cone patterns" err &&
187 git -C repo reset --hard &&
188 check_files repo a folder1 folder2
189 '
190
191 test_expect_success 'cone mode: warn on bad pattern' '
192 test_when_finished mv sparse-checkout repo/.git/info/ &&
193 cp repo/.git/info/sparse-checkout . &&
194 echo "!/deep/deeper/*" >>repo/.git/info/sparse-checkout &&
195 git -C repo read-tree -mu HEAD 2>err &&
196 test_i18ngrep "unrecognized negative pattern" err
197 '
198
199 test_expect_success 'sparse-checkout disable' '
200 test_when_finished rm -rf repo/.git/info/sparse-checkout &&
201 git -C repo sparse-checkout disable &&
202 test_path_is_file repo/.git/info/sparse-checkout &&
203 git -C repo config --list >config &&
204 test_must_fail git config core.sparseCheckout &&
205 check_files repo a deep folder1 folder2
206 '
207
208 test_expect_success 'sparse-index enabled and disabled' '
209 git -C repo sparse-checkout init --cone --sparse-index &&
210 test_cmp_config -C repo true index.sparse &&
211 test-tool -C repo read-cache --table >cache &&
212 grep " tree " cache &&
213
214 git -C repo sparse-checkout disable &&
215 test-tool -C repo read-cache --table >cache &&
216 ! grep " tree " cache &&
217 git -C repo config --list >config &&
218 ! grep index.sparse config
219 '
220
221 test_expect_success 'cone mode: init and set' '
222 git -C repo sparse-checkout init --cone &&
223 git -C repo config --list >config &&
224 test_i18ngrep "core.sparsecheckoutcone=true" config &&
225 list_files repo >dir &&
226 echo a >expect &&
227 test_cmp expect dir &&
228 git -C repo sparse-checkout set deep/deeper1/deepest/ 2>err &&
229 test_must_be_empty err &&
230 check_files repo a deep &&
231 check_files repo/deep a deeper1 &&
232 check_files repo/deep/deeper1 a deepest &&
233 cat >expect <<-\EOF &&
234 /*
235 !/*/
236 /deep/
237 !/deep/*/
238 /deep/deeper1/
239 !/deep/deeper1/*/
240 /deep/deeper1/deepest/
241 EOF
242 test_cmp expect repo/.git/info/sparse-checkout &&
243 git -C repo sparse-checkout set --stdin 2>err <<-\EOF &&
244 folder1
245 folder2
246 EOF
247 test_must_be_empty err &&
248 check_files repo a folder1 folder2
249 '
250
251 test_expect_success 'cone mode: list' '
252 cat >expect <<-\EOF &&
253 folder1
254 folder2
255 EOF
256 git -C repo sparse-checkout set --stdin <expect &&
257 git -C repo sparse-checkout list >actual 2>err &&
258 test_must_be_empty err &&
259 test_cmp expect actual
260 '
261
262 test_expect_success 'cone mode: set with nested folders' '
263 git -C repo sparse-checkout set deep deep/deeper1/deepest 2>err &&
264 test_line_count = 0 err &&
265 cat >expect <<-\EOF &&
266 /*
267 !/*/
268 /deep/
269 EOF
270 test_cmp repo/.git/info/sparse-checkout expect
271 '
272
273 test_expect_success 'cone mode: add independent path' '
274 git -C repo sparse-checkout set deep/deeper1 &&
275 git -C repo sparse-checkout add folder1 &&
276 cat >expect <<-\EOF &&
277 /*
278 !/*/
279 /deep/
280 !/deep/*/
281 /deep/deeper1/
282 /folder1/
283 EOF
284 test_cmp expect repo/.git/info/sparse-checkout &&
285 check_files repo a deep folder1
286 '
287
288 test_expect_success 'cone mode: add sibling path' '
289 git -C repo sparse-checkout set deep/deeper1 &&
290 git -C repo sparse-checkout add deep/deeper2 &&
291 cat >expect <<-\EOF &&
292 /*
293 !/*/
294 /deep/
295 !/deep/*/
296 /deep/deeper1/
297 /deep/deeper2/
298 EOF
299 test_cmp expect repo/.git/info/sparse-checkout &&
300 check_files repo a deep
301 '
302
303 test_expect_success 'cone mode: add parent path' '
304 git -C repo sparse-checkout set deep/deeper1 folder1 &&
305 git -C repo sparse-checkout add deep &&
306 cat >expect <<-\EOF &&
307 /*
308 !/*/
309 /deep/
310 /folder1/
311 EOF
312 test_cmp expect repo/.git/info/sparse-checkout &&
313 check_files repo a deep folder1
314 '
315
316 test_expect_success 'not-up-to-date does not block rest of sparsification' '
317 test_when_finished git -C repo sparse-checkout disable &&
318 test_when_finished git -C repo reset --hard &&
319 git -C repo sparse-checkout set deep &&
320
321 echo update >repo/deep/deeper2/a &&
322 cp repo/.git/info/sparse-checkout expect &&
323 test_write_lines "!/deep/*/" "/deep/deeper1/" >>expect &&
324
325 git -C repo sparse-checkout set deep/deeper1 2>err &&
326
327 test_i18ngrep "The following paths are not up to date" err &&
328 test_cmp expect repo/.git/info/sparse-checkout &&
329 check_files repo/deep a deeper1 deeper2 &&
330 check_files repo/deep/deeper1 a deepest &&
331 check_files repo/deep/deeper1/deepest a &&
332 check_files repo/deep/deeper2 a
333 '
334
335 test_expect_success 'revert to old sparse-checkout on empty update' '
336 git init empty-test &&
337 (
338 echo >file &&
339 git add file &&
340 git commit -m "test" &&
341 git sparse-checkout set nothing 2>err &&
342 test_i18ngrep ! "Sparse checkout leaves no entry on working directory" err &&
343 test_i18ngrep ! ".git/index.lock" err &&
344 git sparse-checkout set file
345 )
346 '
347
348 test_expect_success 'fail when lock is taken' '
349 test_when_finished rm -rf repo/.git/info/sparse-checkout.lock &&
350 touch repo/.git/info/sparse-checkout.lock &&
351 test_must_fail git -C repo sparse-checkout set deep 2>err &&
352 test_i18ngrep "Unable to create .*\.lock" err
353 '
354
355 test_expect_success '.gitignore should not warn about cone mode' '
356 git -C repo config --worktree core.sparseCheckoutCone true &&
357 echo "**/bin/*" >repo/.gitignore &&
358 git -C repo reset --hard 2>err &&
359 test_i18ngrep ! "disabling cone patterns" err
360 '
361
362 test_expect_success 'sparse-checkout (init|set|disable) warns with dirty status' '
363 git clone repo dirty &&
364 echo dirty >dirty/folder1/a &&
365
366 git -C dirty sparse-checkout init 2>err &&
367 test_i18ngrep "warning.*The following paths are not up to date" err &&
368
369 git -C dirty sparse-checkout set /folder2/* /deep/deeper1/* 2>err &&
370 test_i18ngrep "warning.*The following paths are not up to date" err &&
371 test_path_is_file dirty/folder1/a &&
372
373 git -C dirty sparse-checkout disable 2>err &&
374 test_must_be_empty err &&
375
376 git -C dirty reset --hard &&
377 git -C dirty sparse-checkout init &&
378 git -C dirty sparse-checkout set /folder2/* /deep/deeper1/* &&
379 test_path_is_missing dirty/folder1/a &&
380 git -C dirty sparse-checkout disable &&
381 test_path_is_file dirty/folder1/a
382 '
383
384 test_expect_success 'sparse-checkout (init|set|disable) warns with unmerged status' '
385 git clone repo unmerged &&
386
387 cat >input <<-EOF &&
388 0 $ZERO_OID folder1/a
389 100644 $(git -C unmerged rev-parse HEAD:folder1/a) 1 folder1/a
390 EOF
391 git -C unmerged update-index --index-info <input &&
392
393 git -C unmerged sparse-checkout init 2>err &&
394 test_i18ngrep "warning.*The following paths are unmerged" err &&
395
396 git -C unmerged sparse-checkout set /folder2/* /deep/deeper1/* 2>err &&
397 test_i18ngrep "warning.*The following paths are unmerged" err &&
398 test_path_is_file dirty/folder1/a &&
399
400 git -C unmerged sparse-checkout disable 2>err &&
401 test_i18ngrep "warning.*The following paths are unmerged" err &&
402
403 git -C unmerged reset --hard &&
404 git -C unmerged sparse-checkout init &&
405 git -C unmerged sparse-checkout set /folder2/* /deep/deeper1/* &&
406 git -C unmerged sparse-checkout disable
407 '
408
409 test_expect_success 'sparse-checkout reapply' '
410 git clone repo tweak &&
411
412 echo dirty >tweak/deep/deeper2/a &&
413
414 cat >input <<-EOF &&
415 0 $ZERO_OID folder1/a
416 100644 $(git -C tweak rev-parse HEAD:folder1/a) 1 folder1/a
417 EOF
418 git -C tweak update-index --index-info <input &&
419
420 git -C tweak sparse-checkout init --cone 2>err &&
421 test_i18ngrep "warning.*The following paths are not up to date" err &&
422 test_i18ngrep "warning.*The following paths are unmerged" err &&
423
424 git -C tweak sparse-checkout set folder2 deep/deeper1 2>err &&
425 test_i18ngrep "warning.*The following paths are not up to date" err &&
426 test_i18ngrep "warning.*The following paths are unmerged" err &&
427
428 git -C tweak sparse-checkout reapply 2>err &&
429 test_i18ngrep "warning.*The following paths are not up to date" err &&
430 test_path_is_file tweak/deep/deeper2/a &&
431 test_i18ngrep "warning.*The following paths are unmerged" err &&
432 test_path_is_file tweak/folder1/a &&
433
434 git -C tweak checkout HEAD deep/deeper2/a &&
435 git -C tweak sparse-checkout reapply 2>err &&
436 test_i18ngrep ! "warning.*The following paths are not up to date" err &&
437 test_path_is_missing tweak/deep/deeper2/a &&
438 test_i18ngrep "warning.*The following paths are unmerged" err &&
439 test_path_is_file tweak/folder1/a &&
440
441 git -C tweak add folder1/a &&
442 git -C tweak sparse-checkout reapply 2>err &&
443 test_must_be_empty err &&
444 test_path_is_missing tweak/deep/deeper2/a &&
445 test_path_is_missing tweak/folder1/a &&
446
447 git -C tweak sparse-checkout disable
448 '
449
450 test_expect_success 'cone mode: set with core.ignoreCase=true' '
451 rm repo/.git/info/sparse-checkout &&
452 git -C repo sparse-checkout init --cone &&
453 git -C repo -c core.ignoreCase=true sparse-checkout set folder1 &&
454 cat >expect <<-\EOF &&
455 /*
456 !/*/
457 /folder1/
458 EOF
459 test_cmp expect repo/.git/info/sparse-checkout &&
460 check_files repo a folder1
461 '
462
463 test_expect_success 'interaction with submodules' '
464 git clone repo super &&
465 (
466 cd super &&
467 mkdir modules &&
468 git -c protocol.file.allow=always \
469 submodule add ../repo modules/child &&
470 git add . &&
471 git commit -m "add submodule" &&
472 git sparse-checkout init --cone &&
473 git sparse-checkout set folder1
474 ) &&
475 check_files super a folder1 modules &&
476 check_files super/modules/child a deep folder1 folder2
477 '
478
479 test_expect_success 'different sparse-checkouts with worktrees' '
480 git -C repo worktree add --detach ../worktree &&
481 check_files worktree "a deep folder1 folder2" &&
482 git -C worktree sparse-checkout init --cone &&
483 git -C repo sparse-checkout set folder1 &&
484 git -C worktree sparse-checkout set deep/deeper1 &&
485 check_files repo a folder1 &&
486 check_files worktree a deep
487 '
488
489 test_expect_success 'set using filename keeps file on-disk' '
490 git -C repo sparse-checkout set a deep &&
491 cat >expect <<-\EOF &&
492 /*
493 !/*/
494 /a/
495 /deep/
496 EOF
497 test_cmp expect repo/.git/info/sparse-checkout &&
498 check_files repo a deep
499 '
500
501 check_read_tree_errors () {
502 REPO=$1
503 FILES=$2
504 ERRORS=$3
505 git -C $REPO -c core.sparseCheckoutCone=false read-tree -mu HEAD 2>err &&
506 test_must_be_empty err &&
507 check_files $REPO "$FILES" &&
508 git -C $REPO read-tree -mu HEAD 2>err &&
509 if test -z "$ERRORS"
510 then
511 test_must_be_empty err
512 else
513 test_i18ngrep "$ERRORS" err
514 fi &&
515 check_files $REPO $FILES
516 }
517
518 test_expect_success 'pattern-checks: /A/**' '
519 cat >repo/.git/info/sparse-checkout <<-\EOF &&
520 /*
521 !/*/
522 /folder1/**
523 EOF
524 check_read_tree_errors repo "a folder1" "disabling cone pattern matching"
525 '
526
527 test_expect_success 'pattern-checks: /A/**/B/' '
528 cat >repo/.git/info/sparse-checkout <<-\EOF &&
529 /*
530 !/*/
531 /deep/**/deepest
532 EOF
533 check_read_tree_errors repo "a deep" "disabling cone pattern matching" &&
534 check_files repo/deep "deeper1" &&
535 check_files repo/deep/deeper1 "deepest"
536 '
537
538 test_expect_success 'pattern-checks: too short' '
539 cat >repo/.git/info/sparse-checkout <<-\EOF &&
540 /*
541 !/*/
542 /
543 EOF
544 check_read_tree_errors repo "a" "disabling cone pattern matching"
545 '
546 test_expect_success 'pattern-checks: not too short' '
547 cat >repo/.git/info/sparse-checkout <<-\EOF &&
548 /*
549 !/*/
550 /b/
551 EOF
552 git -C repo read-tree -mu HEAD 2>err &&
553 test_must_be_empty err &&
554 check_files repo a
555 '
556
557 test_expect_success 'pattern-checks: trailing "*"' '
558 cat >repo/.git/info/sparse-checkout <<-\EOF &&
559 /*
560 !/*/
561 /a*
562 EOF
563 check_read_tree_errors repo "a" "disabling cone pattern matching"
564 '
565
566 test_expect_success 'pattern-checks: starting "*"' '
567 cat >repo/.git/info/sparse-checkout <<-\EOF &&
568 /*
569 !/*/
570 *eep/
571 EOF
572 check_read_tree_errors repo "a deep" "disabling cone pattern matching"
573 '
574
575 test_expect_success 'pattern-checks: contained glob characters' '
576 for c in "[a]" "\\" "?" "*"
577 do
578 cat >repo/.git/info/sparse-checkout <<-EOF &&
579 /*
580 !/*/
581 something$c-else/
582 EOF
583 check_read_tree_errors repo "a" "disabling cone pattern matching"
584 done
585 '
586
587 test_expect_success BSLASHPSPEC 'pattern-checks: escaped characters' '
588 git clone repo escaped &&
589 TREEOID=$(git -C escaped rev-parse HEAD:folder1) &&
590 NEWTREE=$(git -C escaped mktree <<-EOF
591 $(git -C escaped ls-tree HEAD)
592 040000 tree $TREEOID zbad\\dir
593 040000 tree $TREEOID zdoes*exist
594 040000 tree $TREEOID zglob[!a]?
595 EOF
596 ) &&
597 COMMIT=$(git -C escaped commit-tree $NEWTREE -p HEAD) &&
598 git -C escaped reset --hard $COMMIT &&
599 check_files escaped "a deep folder1 folder2 zbad\\dir zdoes*exist" zglob[!a]? &&
600 git -C escaped sparse-checkout init --cone &&
601 git -C escaped sparse-checkout set zbad\\dir/bogus "zdoes*not*exist" "zdoes*exist" "zglob[!a]?" &&
602 cat >expect <<-\EOF &&
603 /*
604 !/*/
605 /zbad\\dir/
606 !/zbad\\dir/*/
607 /zbad\\dir/bogus/
608 /zdoes\*exist/
609 /zdoes\*not\*exist/
610 /zglob\[!a]\?/
611 EOF
612 test_cmp expect escaped/.git/info/sparse-checkout &&
613 check_read_tree_errors escaped "a zbad\\dir zdoes*exist zglob[!a]?" &&
614 git -C escaped ls-tree -d --name-only HEAD >list-expect &&
615 git -C escaped sparse-checkout set --stdin <list-expect &&
616 cat >expect <<-\EOF &&
617 /*
618 !/*/
619 /deep/
620 /folder1/
621 /folder2/
622 /zbad\\dir/
623 /zdoes\*exist/
624 /zglob\[!a]\?/
625 EOF
626 test_cmp expect escaped/.git/info/sparse-checkout &&
627 check_files escaped "a deep folder1 folder2 zbad\\dir zdoes*exist" zglob[!a]? &&
628 git -C escaped sparse-checkout list >list-actual &&
629 test_cmp list-expect list-actual
630 '
631
632 test_expect_success MINGW 'cone mode replaces backslashes with slashes' '
633 git -C repo sparse-checkout set deep\\deeper1 &&
634 cat >expect <<-\EOF &&
635 /*
636 !/*/
637 /deep/
638 !/deep/*/
639 /deep/deeper1/
640 EOF
641 test_cmp expect repo/.git/info/sparse-checkout &&
642 check_files repo a deep &&
643 check_files repo/deep a deeper1
644 '
645
646 test_done