Repository navigation
Expand file tree
/
Copy pathtest_submodule.py
More file actions
2418 lines (2067 loc) · 99.5 KB
/
Copy pathtest_submodule.py
File metadata and controls
2418 lines (2067 loc) · 99.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
import contextlib
import gc
import os
import os.path as osp
from pathlib import Path
import shutil
import sys
import tempfile
from types import SimpleNamespace
from unittest import mock, skipUnless
import pytest
import git
from git.cmd import Git
from git.config import GitConfigParser, cp
from git.exc import (
GitCommandError,
InvalidGitRepositoryError,
RepositoryDirtyError,
UnsafeOptionError,
UnsafeProtocolError,
)
from git.objects.submodule.base import Submodule
from git.objects.submodule.root import RootModule, RootUpdateProgress
from git.repo.fun import find_submodule_git_dir, touch
from git.util import HIDE_WINDOWS_KNOWN_ERRORS, cwd, join_path_native, to_native_path_linux
from test.lib import TestBase, with_rw_directory, with_rw_repo, PathLikeMock
@contextlib.contextmanager
def _patch_git_config(name, value):
"""Temporarily add a git config name-value pair, using environment variables."""
pair_index = int(os.getenv("GIT_CONFIG_COUNT", "0"))
# This is recomputed each time the context is entered, for compatibility with
# existing GIT_CONFIG_* environment variables, even if changed in this process.
patcher = mock.patch.dict(
os.environ,
{
"GIT_CONFIG_COUNT": str(pair_index + 1),
f"GIT_CONFIG_KEY_{pair_index}": name,
f"GIT_CONFIG_VALUE_{pair_index}": value,
},
)
with patcher:
yield
@pytest.mark.parametrize(
"name", ["module", "$GITPYTHON_TEST_SECRET", "prefix-${GITPYTHON_TEST_SECRET}-suffix", "%GITPYTHON_TEST_SECRET%"]
)
def test_submodule_update_preserves_literal_name(tmp_path, monkeypatch, caplog, name):
monkeypatch.setenv("GITPYTHON_TEST_SECRET", "sensitive-value")
caplog.set_level("DEBUG", logger="git.cmd")
with git.Repo.init(tmp_path / "source") as source, git.Repo.init(tmp_path / "parent") as parent:
source.git.symbolic_ref("HEAD", "refs/heads/master")
source.index.commit("Initial commit")
with _patch_git_config("protocol.file.allow", "always"):
parent.git.submodule("add", "--name", name, source.working_tree_dir, "module")
parent.index.commit("Add submodule")
with git.Repo.clone_from(parent.working_tree_dir, tmp_path / "clone") as clone:
clone.submodule_update(init=True, recursive=True)
modules_dir = Path(clone.git_dir, "modules")
assert {path.name for path in modules_dir.iterdir()} == {name}
# Exercise relative gitfile conversion on every platform.
with mock.patch.object(Git, "is_cygwin", return_value=True):
resolved_git_dir = find_submodule_git_dir(Path(clone.working_tree_dir, "module", ".git"))
assert resolved_git_dir is not None
assert (modules_dir / name).samefile(resolved_git_dir)
with clone.submodules[0].module() as module:
assert (modules_dir / name).samefile(module.git_dir)
assert module.head.commit == source.head.commit
assert "sensitive-value" not in caplog.text
@pytest.fixture
def movable_submodule(tmp_path):
"""Create a committed local submodule whose logical name stays fixed when moved."""
with git.Repo.init(tmp_path / "source") as source, git.Repo.init(tmp_path / "parent") as parent:
source.git.symbolic_ref("HEAD", "refs/heads/master")
(tmp_path / "source" / "file").write_text("content", encoding="utf-8")
source.index.add(["file"])
source.index.commit("Create source")
with _patch_git_config("protocol.file.allow", "always"):
submodule = parent.create_submodule("logical-name", "module", source.working_tree_dir)
parent.index.commit("Create submodule")
# Release clone handles before Windows moves the checkout.
submodule.module().close()
yield submodule
def _move_snapshot(submodule):
"""Capture index, configuration, and path state to detect side effects of rejected moves."""
parent = submodule.repo
with submodule.module() as module:
config = Path(module.git_dir, "config").read_bytes()
return (
Path(parent.index.path).read_bytes(),
Path(parent.working_tree_dir, ".gitmodules").read_bytes(),
Path(submodule.abspath, ".git").read_bytes(),
config,
submodule.path,
)
@pytest.mark.parametrize(
"path",
[
".git/child",
".GiT/child",
"nested/.git/child",
"git~1/child",
"GIT~1 . /child",
".git. /child",
".git:stream/child",
".git::$INDEX_ALLOCATION/child",
"nested\\.git\\child",
"C:relative",
"nul\0name",
]
+ [
f".g{chr(codepoint)}it/child"
for codepoint in (*range(0x200C, 0x2010), *range(0x202A, 0x202F), *range(0x206A, 0x2070), 0xFEFF)
],
)
@pytest.mark.parametrize("operation", ["add", "clone", "update", "move", "move-module", "move-config"])
def test_submodule_rejects_unsafe_checkout_before_mutation(movable_submodule, tmp_path, path, operation):
sm = movable_submodule
root = Path(sm.repo.working_tree_dir)
before = _move_snapshot(sm)
paths = set(root.rglob("*"))
# Check the portable metadata aliases against Git's index validation as well.
if operation == "clone" and path not in ("C:relative", "nul\0name"):
with sm.repo.git.custom_environment(GIT_INDEX_FILE=str(tmp_path / "validation-index")):
with _patch_git_config("core.protectHFS", "true"), _patch_git_config("core.protectNTFS", "true"):
with pytest.raises(GitCommandError):
sm.repo.git.update_index("--add", "--cacheinfo", f"160000,{sm.hexsha},{path}")
with mock.patch.object(git.Repo, "clone_from", side_effect=AssertionError("clone attempted")):
with pytest.raises(ValueError):
if operation == "add":
sm.repo.create_submodule("new", path, sm.url)
elif operation == "clone":
Submodule._clone_repo(sm.repo, sm.url, path, "new")
elif operation == "update":
Submodule(sm.repo, sm.binsha, name="new", path=path, url=sm.url).update(init=True)
else:
sm.move(path, configuration=operation != "move-module", module=operation != "move-config")
assert _move_snapshot(sm) == before
assert set(root.rglob("*")) == paths
def test_add_rejects_metadata_checkout_without_writing_files(movable_submodule):
sm = movable_submodule
before = _move_snapshot(sm)
with pytest.raises(ValueError, match="Git metadata"):
sm.repo.create_submodule("new", ".git/new", sm.url)
assert not Path(sm.repo.git_dir, "new").exists()
assert not Path(sm.repo.git_dir, "modules/new").exists()
assert _move_snapshot(sm) == before
@pytest.mark.parametrize("absolute_path", [False, True])
@pytest.mark.parametrize("metadata_name", ["metadata", "MeTaDaTa"])
@pytest.mark.parametrize("operation", ["add", "clone", "update", "move"])
def test_submodule_rejects_checkout_in_separate_metadata(
movable_submodule, tmp_path, absolute_path, metadata_name, operation
):
root = tmp_path / "separate"
with git.Repo.init(root, separate_git_dir=str(root / "metadata"), allow_unsafe_options=True) as parent:
if not (root / metadata_name).is_dir():
pytest.skip("Requires a case-insensitive filesystem")
sm = parent.create_submodule("module", "module", movable_submodule.url)
parent.index.commit("Add submodule")
before = _move_snapshot(sm)
paths = set(root.rglob("*"))
path = root / metadata_name / "new" if absolute_path else f"{metadata_name}/new"
with pytest.raises(ValueError, match="Git metadata"):
if operation == "add":
parent.create_submodule("new", path, sm.url)
elif operation == "clone":
Submodule._clone_repo(parent, sm.url, path, "new")
elif operation == "update":
Submodule(parent, sm.binsha, name="new", path=path, url=sm.url).update(init=True)
else:
sm.move(path)
assert _move_snapshot(sm) == before
assert set(root.rglob("*")) == paths
@pytest.mark.parametrize("operation", ["add", "clone", "update", "rename", "move"])
def test_submodule_rejects_nested_metadata_before_mutation(movable_submodule, operation):
sm = movable_submodule
other = sm.repo.create_submodule("other", "other", sm.url)
other.module().close()
root = Path(sm.repo.working_tree_dir)
before = _move_snapshot(sm), _move_snapshot(other)
paths = set(root.rglob("*"))
name = f"{sm.name}/child"
with pytest.raises(ValueError, match="inside.*Git directory"):
if operation == "add":
sm.repo.create_submodule(name, "new", sm.url)
elif operation == "clone":
Submodule._clone_repo(sm.repo, sm.url, "new", name)
elif operation == "update":
Submodule(sm.repo, sm.binsha, name=name, path="new", url=sm.url).update(init=True)
elif operation == "rename":
other.rename(name)
else:
other.move(name)
assert (_move_snapshot(sm), _move_snapshot(other)) == before
assert set(root.rglob("*")) == paths
@pytest.mark.parametrize("state", ["retained", "checked-out"])
def test_update_rejects_existing_nested_metadata(movable_submodule, state):
sm = movable_submodule
name = f"{sm.name}/child"
checkout = Path(sm.repo.working_tree_dir, "new")
with git.Repo.clone_from(
sm.url, checkout, separate_git_dir=str(Path(sm.repo.git_dir, "modules", name)), allow_unsafe_options=True
):
pass
if state == "retained":
shutil.rmtree(checkout)
before = _move_snapshot(sm)
paths = set(Path(sm.repo.working_tree_dir).rglob("*"))
with pytest.raises(ValueError, match="inside.*Git directory"):
Submodule(sm.repo, sm.binsha, name=name, path="new", url=sm.url).update(init=True, no_fetch=True)
assert _move_snapshot(sm) == before
assert set(Path(sm.repo.working_tree_dir).rglob("*")) == paths
@pytest.mark.parametrize(
"path",
[
"CON",
"con.txt",
"CONIN$",
"conout$.txt",
"AUX .txt",
"PRN",
"NUL",
"COM9",
"LPT1",
"name:stream",
"space ",
"period.",
"line\nbreak",
"star*",
'quote"',
"question?",
"angle<",
"angle>",
"pipe|",
],
)
def test_submodule_rejects_windows_destination_names_before_mutation(movable_submodule, path):
sm = movable_submodule
before = _move_snapshot(sm)
paths = set(Path(sm.repo.working_tree_dir).rglob("*"))
with mock.patch("git.objects.submodule.base.sys", SimpleNamespace(platform="win32")):
with mock.patch.object(git.Repo, "clone_from", side_effect=AssertionError("clone attempted")):
with pytest.raises(ValueError):
sm.repo.create_submodule("new", f"nested/{path}", sm.url)
with pytest.raises(ValueError):
sm.repo.create_submodule(f"nested/{path}", "new", sm.url)
assert _move_snapshot(sm) == before
assert set(Path(sm.repo.working_tree_dir).rglob("*")) == paths
@pytest.mark.parametrize("path", ["nested/space ", "nested/period."])
def test_windows_destination_validation_precedes_normalization(tmp_path, path):
parent = SimpleNamespace(working_tree_dir=str(tmp_path))
# Windows' GetFullPathName removes trailing spaces and periods.
with mock.patch("git.objects.submodule.base._to_relative_path", return_value=path.rstrip(" .")):
with mock.patch("git.objects.submodule.base.sys", SimpleNamespace(platform="win32")):
with pytest.raises(ValueError, match="Invalid submodule path on Windows"):
Submodule._to_relative_path(parent, path)
def test_submodule_can_relocate_its_own_metadata(movable_submodule):
sm = movable_submodule
sm.rename(f"{sm.name}/child")
assert Path(sm.abspath, "file").read_text() == "content"
with sm.module() as module:
assert Path(module.git_dir) == Path(sm.repo.git_dir, "modules", sm.name)
def test_clone_disables_metadata_that_becomes_nested(movable_submodule, monkeypatch):
sm = movable_submodule
clone_from = git.Repo.clone_from
ancestor = Path(sm.repo.git_dir, "modules/new")
def clone_and_create_ancestor(*args, **kwargs):
clone = clone_from(*args, **kwargs)
with git.Repo.init(ancestor, bare=True):
pass
return clone
monkeypatch.setattr(git.Repo, "clone_from", clone_and_create_ancestor)
with pytest.raises(ValueError, match="inside.*Git directory"):
Submodule._clone_repo(sm.repo, sm.url, "new", "new/child")
assert not (ancestor / "child/HEAD").exists()
assert (ancestor / "HEAD").is_file()
@pytest.mark.parametrize("target_kind", ["relative", "absolute", "internal", "dangling"])
@pytest.mark.parametrize("configuration,module", [(True, True), (False, True), (True, False)])
@pytest.mark.parametrize("absolute_path", [False, True])
def test_move_rejects_intermediate_symlink(
movable_submodule, tmp_path, target_kind, configuration, module, absolute_path
):
"""Reject intermediate symlinks before changing repository state or their targets.
Cover relative and absolute destinations in every move mode, including links
within the repository and dangling links, which must also be rejected.
"""
submodule = movable_submodule
parent = submodule.repo
root = Path(parent.working_tree_dir)
target = root / "target" if target_kind == "internal" else tmp_path / "outside"
if target_kind != "dangling":
target.mkdir()
(root / "nested").mkdir()
link = root / "nested" / "link"
link.symlink_to(
target if target_kind == "absolute" else os.path.relpath(target, link.parent), target_is_directory=True
)
parent.index.add(["nested/link"])
parent.index.commit("Record layout")
tree = parent.git.write_tree()
before = _move_snapshot(submodule)
destination = root / "nested/link/new/moved" if absolute_path else "nested/link/new/moved"
with pytest.raises(ValueError, match="contains a symbolic link"):
submodule.move(destination, configuration=configuration, module=module)
assert _move_snapshot(submodule) == before
assert parent.git.write_tree() == tree
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "content"
if target_kind == "dangling":
assert not target.exists()
else:
assert list(target.iterdir()) == []
@pytest.mark.parametrize("absolute_path", [False, True])
def test_move_normal_destination(movable_submodule, absolute_path):
"""Allow ordinary relative and absolute moves, and make a repeated move a no-op."""
submodule = movable_submodule
root = Path(submodule.repo.working_tree_dir)
destination = root / "nested/moved" if absolute_path else "nested/moved"
assert submodule.move(destination) is submodule
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "content"
assert not (root / "module").exists()
assert submodule.path == "nested/moved"
submodule.repo.git.write_tree()
before = _move_snapshot(submodule)
assert submodule.move(destination) is submodule
assert _move_snapshot(submodule) == before
@pytest.mark.parametrize("metadata_dir", ["git_dir", "common_dir"])
def test_move_rejects_leaf_symlink_to_metadata(movable_submodule, tmp_path, metadata_dir):
root = tmp_path / "worktree"
movable_submodule.repo.git.worktree("add", "--detach", str(root))
with git.Repo(root) as parent:
assert not osp.samefile(parent.git_dir, parent.common_dir)
submodule = parent.submodules[0]
submodule.update(init=True)
target = Path(getattr(parent, metadata_dir))
destination = root / "destination"
destination.symlink_to(target, target_is_directory=True)
before = _move_snapshot(submodule)
with pytest.raises(ValueError, match="Git metadata"):
submodule.move("destination", module=False)
assert _move_snapshot(submodule) == before
assert destination.is_symlink()
assert destination.samefile(target)
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "content"
@pytest.mark.parametrize("kind", ["empty", "nonempty", "file", "dangling"])
def test_move_leaf_symlink_compatibility(movable_submodule, tmp_path, kind):
"""Preserve leaf-symlink replacement without modifying the external target.
Moving onto a link to an empty directory replaces the link; nonempty, file,
and dangling targets fail without changing repository state. Direct checkout
path access must still reject every leaf symlink.
"""
submodule = movable_submodule
root = Path(submodule.repo.working_tree_dir)
target = tmp_path / "outside"
if kind in ("empty", "nonempty"):
target.mkdir()
if kind == "nonempty":
(target / "keep").write_text("keep", encoding="utf-8")
if kind == "file":
target.write_text("keep", encoding="utf-8")
destination = root / "destination"
destination.symlink_to(target, target_is_directory=kind != "file")
with pytest.raises(ValueError, match="contains a symbolic link"):
Submodule(submodule.repo, Submodule.NULL_BIN_SHA, name="unused", path="destination").abspath
before = _move_snapshot(submodule)
if kind == "empty":
assert submodule.move("destination") is submodule
assert not destination.is_symlink()
assert (destination / "file").is_file()
assert list(target.iterdir()) == []
else:
with pytest.raises(OSError if kind == "dangling" else ValueError):
submodule.move("destination")
assert _move_snapshot(submodule) == before
assert destination.is_symlink()
if kind == "nonempty":
assert (target / "keep").read_text(encoding="utf-8") == "keep"
elif kind == "file":
assert target.read_text(encoding="utf-8") == "keep"
else:
assert not target.exists()
@pytest.mark.parametrize("leaf", [False, True])
@pytest.mark.parametrize("dangling", [False, True])
@pytest.mark.parametrize("operation", ["add", "clone"])
@pytest.mark.parametrize("gitfile", [False, True])
def test_clone_rejects_checkout_symlinks(movable_submodule, tmp_path, leaf, dangling, operation, gitfile):
"""Reject checkout symlinks before add or clone creates metadata or touches the target.
Cover leaf and intermediate links, including dangling targets, with both
embedded and separate Git directories.
"""
sm = movable_submodule
root = Path(sm.repo.working_tree_dir)
target = tmp_path / "outside"
if not dangling:
target.mkdir()
(root / "link").symlink_to(target, target_is_directory=True)
path = "link" if leaf else "link/new/module"
before = _move_snapshot(sm)
with mock.patch.object(Submodule, "_need_gitfile_submodules", return_value=gitfile):
with pytest.raises(ValueError, match="contains a symbolic link"):
if operation == "add":
Submodule.add(sm.repo, "new", path, sm.url)
else:
Submodule._clone_repo(sm.repo, sm.url, path, "new")
assert _move_snapshot(sm) == before
assert not (Path(sm.repo.git_dir) / "modules/new").exists()
assert not target.exists() if dangling else list(target.iterdir()) == []
@pytest.mark.parametrize("link_kind", ["gitmodules", "checkout"])
@pytest.mark.parametrize("operation", ["update", "move", "rename", "remove"])
def test_submodule_rejects_checkout_and_gitmodules_symlinks(movable_submodule, tmp_path, link_kind, operation):
"""Reject operations on symlinked checkouts or .gitmodules without side effects.
Update, move, rename, and forced removal must preserve the external target,
repository configuration, index, checkout, and any existing move destination.
"""
sm = movable_submodule
sm.rename("nested/module")
root = Path(sm.repo.working_tree_dir)
path = root / (".gitmodules" if link_kind == "gitmodules" else "module")
target = tmp_path / "outside"
path.rename(target)
path.symlink_to(target, target_is_directory=target.is_dir())
before = (
{p.relative_to(target): p.read_bytes() for p in target.rglob("*") if p.is_file()}
if target.is_dir()
else target.read_bytes()
)
config = Path(sm.repo.git_dir, "config").read_bytes()
index = Path(sm.repo.index.path).read_bytes()
gitmodules = (root / ".gitmodules").read_bytes()
(root / "moved").mkdir()
with pytest.raises(ValueError, match="contains a symbolic link"):
if operation == "update":
sm.update()
elif operation == "move":
sm.move("moved")
elif operation == "rename":
sm.rename("renamed")
else:
sm.remove(force=True)
after = (
{p.relative_to(target): p.read_bytes() for p in target.rglob("*") if p.is_file()}
if target.is_dir()
else target.read_bytes()
)
assert after == before
assert Path(sm.repo.git_dir, "config").read_bytes() == config
assert Path(sm.repo.index.path).read_bytes() == index
assert (root / ".gitmodules").read_bytes() == gitmodules
assert (root / "module/file").read_text() == "content"
assert path.is_symlink()
assert (root / "moved").is_dir()
def test_add_closes_checkout_processes(movable_submodule, monkeypatch):
"""Adding a submodule must not leave a child process holding its checkout open."""
sm = movable_submodule
checkout = Path(sm.repo.working_tree_dir, "new")
execute = Git.execute
processes = []
def capture_process(self, command, *args, **kwargs):
result = execute(self, command, *args, **kwargs)
if (
kwargs.get("as_process")
and "cat-file" in command
and Path(self.working_dir).resolve() == checkout.resolve()
):
processes.append(result.proc)
return result
monkeypatch.setattr(Git, "execute", capture_process)
try:
added = Submodule.add(sm.repo, "new", "new", sm.url)
assert processes, "The HEAD read must exercise a persistent cat-file process"
assert all(process.poll() is not None for process in processes)
added.move("moved")
finally:
for process in processes:
if process.poll() is None:
process.terminate()
process.wait()
@pytest.fixture
def windows_directory_symlink_removal(monkeypatch):
"""Exercise Windows rmdir semantics on POSIX, where rmdir rejects symlinks."""
if sys.platform != "win32":
original_rmdir = os.rmdir
def rmdir(path, *args, **kwargs):
if osp.islink(path):
return os.unlink(path, *args, **kwargs)
return original_rmdir(path, *args, **kwargs)
monkeypatch.setattr(os, "rmdir", rmdir)
def test_submodule_allows_symlink_above_worktree(
movable_submodule, tmp_path, windows_directory_symlink_removal, metadata_realpath
):
"""Allow adding and moving submodules when the parent is opened through a symlink."""
sm = movable_submodule
alias = tmp_path / "alias"
alias.symlink_to(sm.repo.working_tree_dir, target_is_directory=True)
with git.Repo(alias) as parent:
added = Submodule.add(parent, "new", "new", sm.url)
added.move("moved")
assert alias.is_symlink()
with added.module() as module:
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == Path(added.abspath).resolve()
assert Path(added.abspath, "file").read_text() == "content"
@pytest.fixture(params=[False, True], ids=["native-realpath", "windows37-realpath"])
def metadata_realpath(request):
"""Model Python 3.7 on Windows without altering pathlib's own resolver."""
if request.param:
paths = SimpleNamespace(**vars(osp))
paths.realpath = osp.abspath
with mock.patch("git.objects.submodule.base.osp", paths):
yield
else:
yield
@pytest.mark.parametrize("operation", ["add", "reconnect", "rename"])
def test_submodule_allows_metadata_destination_symlinks(movable_submodule, tmp_path, operation, metadata_realpath):
"""Allow linked metadata destinations while keeping the checkout correctly connected.
Adding, reconnecting after deinit, and renaming may store metadata outside the
parent repository through a symlink under .git/modules, preserving that link.
"""
sm = movable_submodule
root = Path(sm.repo.working_tree_dir)
outside = tmp_path / "outside"
outside.mkdir()
link = Path(sm.repo.git_dir) / "modules/link"
link.symlink_to(outside, target_is_directory=True)
if operation == "rename":
sm.rename("link/new")
else:
sm = Submodule.add(sm.repo, "link/new", "new", sm.url)
if operation == "reconnect":
sm.repo.index.commit("Add linked metadata submodule")
sm.repo.git.submodule("deinit", "--force", "new")
sm.update(init=True)
assert link.is_symlink()
assert (outside / "new/HEAD").is_file()
with sm.module() as module:
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == Path(sm.abspath).resolve()
assert Path(sm.abspath, "file").read_text() == "content"
assert (root / ".gitmodules").is_file()
@pytest.mark.parametrize("kind", ["modules", "intermediate", "leaf", "gitfile", "config", "alias"])
@pytest.mark.parametrize("operation", ["update", "move", "rename", "remove"])
def test_submodule_allows_existing_metadata_symlinks(
movable_submodule, tmp_path, kind, operation, windows_directory_symlink_removal, metadata_realpath
):
"""Keep submodule operations compatible with existing symlinks in Git metadata.
Cover linked metadata directories, gitfiles, configs, and internal aliases.
Update, move, and rename must retain a usable checkout; forced removal must
still remove both the checkout and the resolved metadata directory.
"""
sm = movable_submodule
sm.rename("nested/module")
root = Path(sm.repo.working_tree_dir)
modules = Path(sm.repo.git_dir) / "modules"
paths = {
"modules": modules,
"intermediate": modules / "nested",
"leaf": modules / "nested/module",
"gitfile": root / "module/.git",
"config": modules / "nested/module/config",
"alias": modules / "alias",
}
link = paths[kind]
target = tmp_path / "outside"
if kind == "alias":
target = modules / "nested"
(root / "module/.git").write_text("gitdir: ../.git/modules/alias/module")
else:
link.rename(target)
link.symlink_to(target, target_is_directory=target.is_dir())
# Relocating metadata changes the base of a relative core.worktree setting.
sm.repo.git.config("--file", str(modules / "nested/module/config"), "core.worktree", str(root / "module"))
assert sm.module_exists()
if operation == "remove":
metadata_dir = (modules / "nested/module").resolve()
assert metadata_dir.is_dir()
url = sm.url
sm.remove(force=True)
assert not (root / "module").exists()
assert not metadata_dir.exists()
if kind in ("modules", "intermediate", "alias"):
assert link.is_symlink() and link.is_dir()
replacement = Submodule.add(sm.repo, "nested/module", "module", url)
if kind == "leaf":
assert link.is_symlink() and link.is_dir()
assert target.is_dir()
with replacement.module() as module:
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == (root / "module").resolve()
return
if operation == "update":
sm.update()
elif operation == "move":
sm.move("moved")
else:
sm.rename("renamed")
if kind == "modules" or (operation == "rename" and kind in ("intermediate", "alias")):
assert link.is_symlink()
assert link.is_dir()
if operation == "rename" and kind == "leaf":
assert (modules / "renamed").is_symlink()
assert target.is_dir()
with sm.module() as module:
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == Path(sm.abspath).resolve()
assert Path(sm.abspath, "file").read_text() == "content"
@pytest.mark.parametrize("kind", ["modules", "intermediate", "leaf"])
def test_remove_linked_metadata_keeps_siblings_and_can_reinitialize(
movable_submodule, tmp_path, kind, metadata_realpath
):
sm = movable_submodule
sm.rename("nested/module")
sibling = Submodule.add(sm.repo, "nested/sibling", "sibling", sm.url)
sm.repo.index.commit("Add sibling")
modules = Path(sm.repo.git_dir) / "modules"
link = {"modules": modules, "intermediate": modules / "nested", "leaf": modules / "nested/module"}[kind]
target = tmp_path / "outside"
link.rename(target)
link.symlink_to(target, target_is_directory=True)
for child in (sm, sibling):
sm.repo.git.config("--file", str(modules / child.name / "config"), "core.worktree", str(child.abspath))
sm.remove(force=True, configuration=False)
assert link.is_symlink()
assert link.exists() == (kind != "leaf")
with sibling.module() as module:
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == Path(sibling.abspath).resolve()
assert Path(sibling.abspath, "file").read_text() == "content"
sm.update(init=True)
assert link.is_symlink() and link.is_dir()
assert Path(sm.abspath, "file").read_text() == "content"
with sm.module() as module:
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == Path(sm.abspath).resolve()
@pytest.mark.parametrize("relative_target", [False, True], ids=["absolute-target", "relative-target"])
def test_add_to_dangling_metadata_symlink(movable_submodule, tmp_path, metadata_realpath, relative_target):
sm = movable_submodule
link = Path(sm.repo.git_dir) / "modules/new"
target = tmp_path / "missing" / "metadata"
link.symlink_to(osp.relpath(target, link.parent) if relative_target else target, target_is_directory=True)
link_target = os.readlink(str(link))
added = Submodule.add(sm.repo, "new", "new", sm.url)
assert link.is_symlink() and link.is_dir()
assert os.readlink(str(link)) == link_target
assert (target / "HEAD").is_file()
with added.module() as module:
assert Path(module.git_dir).resolve() == target.resolve()
assert Path(module.git.rev_parse("--show-toplevel")).resolve() == Path(added.abspath).resolve()
assert Path(added.abspath, "file").read_text() == "content"
class TestRootProgress(RootUpdateProgress):
"""Just prints messages, for now without checking the correctness of the states"""
def update(self, op, cur_count, max_count, message=""):
print(op, cur_count, max_count, message)
TestRootProgress.__test__ = False
prog = TestRootProgress()
class TestSubmodule(TestBase):
def tearDown(self):
gc.collect()
k_subm_current = "c15a6e1923a14bc760851913858a3942a4193cdb"
k_subm_changed = "394ed7006ee5dc8bddfd132b64001d5dfc0ffdd3"
k_no_subm_tag = "0.1.6"
def _do_base_tests(self, rwrepo):
"""Perform all tests in the given repository, it may be bare or nonbare"""
# Manual instantiation.
smm = Submodule(rwrepo, "\0" * 20)
# Name needs to be set in advance.
self.assertRaises(AttributeError, getattr, smm, "name")
# Iterate - 1 submodule.
sms = Submodule.list_items(rwrepo, self.k_subm_current)
assert len(sms) == 1
sm = sms[0]
# At a different time, there is None.
assert len(Submodule.list_items(rwrepo, self.k_no_subm_tag)) == 0
assert sm.path == "git/ext/gitdb"
assert sm.path != sm.name # In our case, we have ids there, which don't equal the path.
assert sm.url.endswith("github.com/gitpython-developers/gitdb.git")
assert sm.branch_path == "refs/heads/master" # the default ...
assert sm.branch_name == "master"
assert sm.parent_commit == rwrepo.head.commit
# Size is always 0.
assert sm.size == 0
# The module is not checked-out yet.
self.assertRaises(InvalidGitRepositoryError, sm.module)
# ...which is why we can't get the branch either - it points into the module()
# repository.
self.assertRaises(InvalidGitRepositoryError, getattr, sm, "branch")
# branch_path works, as it's just a string.
assert isinstance(sm.branch_path, str)
# Some commits earlier we still have a submodule, but it's at a different
# commit.
smold = next(Submodule.iter_items(rwrepo, self.k_subm_changed))
assert smold.binsha != sm.binsha
assert smold != sm # the name changed
# Force it to reread its information.
del smold._url
smold.url == sm.url # noqa: B015 # FIXME: Should this be an assertion?
# Test config_reader/writer methods.
sm.config_reader()
new_smclone_path = None # Keep custom paths for later.
new_csmclone_path = None #
if rwrepo.bare:
with self.assertRaises(InvalidGitRepositoryError):
with sm.config_writer() as cw:
pass
else:
with sm.config_writer() as writer:
# For faster checkout, set the url to the local path.
new_smclone_path = self._gitdb_repo_url()
writer.set_value("url", new_smclone_path)
writer.release()
assert sm.config_reader().get_value("url") == new_smclone_path
assert sm.url == new_smclone_path
# END handle bare repo
smold.config_reader()
# Cannot get a writer on historical submodules.
if not rwrepo.bare:
with self.assertRaises(ValueError):
with smold.config_writer():
pass
# END handle bare repo
# Make the old into a new - this doesn't work as the name changed.
self.assertRaises(ValueError, smold.set_parent_commit, self.k_subm_current)
# the sha is properly updated
smold.set_parent_commit(self.k_subm_changed + "~1")
assert smold.binsha != sm.binsha
# Raises if the sm didn't exist in new parent - it keeps its parent_commit
# unchanged.
self.assertRaises(ValueError, smold.set_parent_commit, self.k_no_subm_tag)
# TODO: Test that, if a path is in the .gitmodules file, but not in the index,
# then it raises.
# TEST UPDATE
##############
# Module retrieval is not always possible.
if rwrepo.bare:
self.assertRaises(InvalidGitRepositoryError, sm.module)
self.assertRaises(InvalidGitRepositoryError, sm.remove)
self.assertRaises(InvalidGitRepositoryError, sm.add, rwrepo, "here", "there")
else:
# It's not checked out in our case.
self.assertRaises(InvalidGitRepositoryError, sm.module)
assert not sm.module_exists()
# Currently there is only one submodule.
assert len(list(rwrepo.iter_submodules())) == 1
assert sm.binsha != "\0" * 20
# TEST ADD
###########
# Preliminary tests.
# Adding existing returns exactly the existing.
sma = Submodule.add(rwrepo, sm.name, sm.path)
assert sma.path == sm.path
# Adding existing as pathlike
sma = Submodule.add(rwrepo, sm.name, PathLikeMock(sm.path))
assert sma.path == sm.path
# No url and no module at path fails.
self.assertRaises(ValueError, Submodule.add, rwrepo, "newsubm", "pathtorepo", url=None)
# CONTINUE UPDATE
#################
# Let's update it - it's a recursive one too.
newdir = osp.join(sm.abspath, "dir")
os.makedirs(newdir)
# Update fails if the path already exists non-empty.
self.assertRaises(OSError, sm.update)
os.rmdir(newdir)
# Dry-run does nothing.
sm.update(dry_run=True, progress=prog)
assert not sm.module_exists()
assert sm.update() is sm
sm_repopath = sm.path # Cache for later.
assert sm.module_exists()
assert isinstance(sm.module(), git.Repo)
assert sm.module().working_tree_dir == sm.abspath
# INTERLEAVE ADD TEST
#####################
# url must match the one in the existing repository (if submodule name
# suggests a new one) or we raise.
self.assertRaises(
ValueError,
Submodule.add,
rwrepo,
"newsubm",
sm.path,
"git://someurl/repo.git",
)
# CONTINUE UPDATE
#################
# We should have setup a tracking branch, which is also active.
assert sm.module().head.ref.tracking_branch() is not None
# Delete the whole directory and re-initialize.
assert len(sm.children()) != 0
# shutil.rmtree(sm.abspath)
sm.remove(force=True, configuration=False)
assert len(sm.children()) == 0
# Dry-run does nothing.
sm.update(dry_run=True, recursive=False, progress=prog)
assert len(sm.children()) == 0
sm.update(recursive=False)
assert len(list(rwrepo.iter_submodules())) == 2
assert len(sm.children()) == 1 # It's not checked out yet.
csm = sm.children()[0]
assert not csm.module_exists()
csm_repopath = csm.path
# Adjust the path of the submodules module to point to the local
# destination.
new_csmclone_path = self._small_repo_url()
with csm.config_writer() as writer:
writer.set_value("url", new_csmclone_path)
assert csm.url == new_csmclone_path
# Dry-run does nothing.
assert not csm.module_exists()
sm.update(recursive=True, dry_run=True, progress=prog)
assert not csm.module_exists()
# Update recursively again.
sm.update(recursive=True)
assert csm.module_exists()
# Tracking branch once again.
assert csm.module().head.ref.tracking_branch() is not None
# This flushed in a sub-submodule.
assert len(list(rwrepo.iter_submodules())) == 2
# Reset both heads to the previous version, verify that to_latest_revision
# works.
smods = (sm.module(), csm.module())
for repo in smods:
repo.head.reset("HEAD~2", working_tree=1)
# END for each repo to reset
# Dry-run does nothing.
self.assertRaises(
RepositoryDirtyError,
sm.update,
recursive=True,
dry_run=True,
progress=prog,
)
sm.update(recursive=True, dry_run=True, progress=prog, force=True)
for repo in smods:
assert repo.head.commit != repo.head.ref.tracking_branch().commit
# END for each repo to check
self.assertRaises(RepositoryDirtyError, sm.update, recursive=True, to_latest_revision=True)
sm.update(recursive=True, to_latest_revision=True, force=True)
for repo in smods:
assert repo.head.commit == repo.head.ref.tracking_branch().commit
# END for each repo to check
del smods
# If the head is detached, it still works (but warns).
smref = sm.module().head.ref
sm.module().head.ref = "HEAD~1"
# If there is no tracking branch, we get a warning as well.
csm_tracking_branch = csm.module().head.ref.tracking_branch()
csm.module().head.ref.set_tracking_branch(None)
sm.update(recursive=True, to_latest_revision=True)
# to_latest_revision changes the child submodule's commit, it needs an
# update now.
csm.set_parent_commit(csm.repo.head.commit)
# Undo the changes.
sm.module().head.ref = smref
csm.module().head.ref.set_tracking_branch(csm_tracking_branch)
# REMOVAL OF REPOSITORY
#######################
# Must delete something.
self.assertRaises(ValueError, csm.remove, module=False, configuration=False)
# module() is supposed to point to gitdb, which has a child-submodule whose
# URL is still pointing to GitHub. To save time, we will change it to:
csm.set_parent_commit(csm.repo.head.commit)
with csm.config_writer() as cw:
cw.set_value("url", self._small_repo_url())
csm.repo.index.commit("adjusted URL to point to local source, instead of the internet")
# We have modified the configuration, hence the index is dirty, and the
# deletion will fail.
# NOTE: As we did a few updates in the meanwhile, the indices were reset.
# Hence we create some changes.
csm.set_parent_commit(csm.repo.head.commit)
with sm.config_writer() as writer:
writer.set_value("somekey", "somevalue")
with csm.config_writer() as writer:
writer.set_value("okey", "ovalue")
self.assertRaises(InvalidGitRepositoryError, sm.remove)
# If we remove the dirty index, it would work.