Repository navigation
Expand file tree
/
Copy pathtest_submodule_no_fetch.py
More file actions
451 lines (378 loc) · 21.1 KB
/
Copy pathtest_submodule_no_fetch.py
File metadata and controls
451 lines (378 loc) · 21.1 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
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
from functools import partial
from pathlib import Path
import shutil
from unittest import mock
import pytest
from git import Git, Remote, Repo, RootModule, Submodule
from git.exc import GitCommandError
from git.util import rmtree
def _commit_file(repo, content):
Path(repo.working_tree_dir, "file").write_text(content, encoding="utf-8")
repo.index.add(["file"])
return repo.index.commit("Write " + content, skip_hooks=True)
def _cached_remote_refs(repo):
return {ref.path: ref.commit.hexsha for remote in repo.remotes for ref in remote.refs}
@pytest.fixture(scope="module")
def local_submodule_baseline(tmp_path_factory):
"""Use only local repositories, with two commits already available in the clone."""
tmp_path = tmp_path_factory.mktemp("local-submodule")
with Repo.init(tmp_path / "source") as source, Repo.init(tmp_path / "parent") as parent:
# RootModule's URL-change handling currently assumes a master branch.
source.git.symbolic_ref("HEAD", "refs/heads/master")
_commit_file(source, "initial")
_commit_file(source, "cached")
submodule = parent.create_submodule(
"module", "module", source.working_tree_dir, branch=source.head.reference.name
)
parent.index.commit("Add submodule", skip_hooks=True)
submodule.module().close()
return tmp_path
@pytest.fixture
def local_submodule(tmp_path, local_submodule_baseline):
shutil.copytree(local_submodule_baseline / "source", tmp_path / "source", symlinks=True)
shutil.copytree(local_submodule_baseline / "parent", tmp_path / "parent", symlinks=True)
with Repo(tmp_path / "source") as source, Repo(tmp_path / "parent") as parent:
submodule = parent.submodules[0]
url = Git.polish_url(source.working_tree_dir)
with submodule.config_writer() as writer:
writer.set_value("url", url)
with parent.config_writer() as writer:
writer.set_value('submodule "module"', "url", url)
# RootModule compares URLs in committed history as well as current config.
parent.index.commit("Relocate fixture source", skip_hooks=True)
# Re-enumerate after the config writer invalidates the submodule cache.
submodule = parent.submodules[0]
with submodule.module() as module:
module.remotes.origin.set_url(url)
yield submodule, source, module
def test_local_submodule_source_is_isolated(local_submodule, local_submodule_baseline):
submodule, source, module = local_submodule
assert submodule.url == module.remotes.origin.url == Git.polish_url(source.working_tree_dir)
remote_only = _commit_file(source, "private")
with Repo(local_submodule_baseline / "source") as original:
assert original.head.commit != remote_only
assert Path(original.working_tree_dir, "file").read_text(encoding="utf-8") == "cached"
@pytest.fixture(params=["submodule", "root", "repo"])
def update_submodule(request, local_submodule):
submodule, _, _ = local_submodule
if request.param == "submodule":
return submodule.update
if request.param == "root":
update = RootModule(submodule.repo).update
else:
update = submodule.repo.submodule_update
return partial(update, previous_commit=submodule.repo.head.commit, recursive=False)
@pytest.fixture(params=["missing", "deinitialized"])
def uninitialized_submodule(request, local_submodule):
submodule, _, module = local_submodule
metadata = Path(module.git_dir)
module.close()
if request.param == "deinitialized":
submodule.deinit()
else:
submodule.remove(configuration=False, force=True)
# Removal retains recoverable metadata; remove it explicitly for this fixture.
rmtree(metadata)
assert not submodule.module_exists()
assert metadata.is_dir() == (request.param == "deinitialized")
return submodule, metadata
@pytest.mark.parametrize("no_fetch", [None, False, True], ids=["default", "fetch", "no-fetch"])
def test_update_no_fetch_checks_out_cached_commit(local_submodule, update_submodule, no_fetch):
submodule, source, module = local_submodule
module.create_remote("backup", source.working_tree_dir)
module.head.reset("HEAD~1", index=True, working_tree=True)
assert module.head.commit.binsha != submodule.binsha
options = {} if no_fetch is None else {"no_fetch": no_fetch}
with mock.patch.object(Remote, "fetch", autospec=True, side_effect=Remote.fetch) as fetch:
update_submodule(**options)
assert module.head.commit.binsha == submodule.binsha
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"
assert fetch.call_count == (0 if no_fetch else 2)
assert {call[0][0].name for call in fetch.call_args_list} == (set() if no_fetch else {"origin", "backup"})
def test_update_no_fetch_to_latest_revision_uses_cached_tip(local_submodule, update_submodule):
submodule, source, module = local_submodule
cached_tip = module.head.reference.tracking_branch().commit
module.head.reset("HEAD~1", index=True, working_tree=True)
submodule.binsha = module.head.commit.binsha
submodule.repo.index.add([submodule])
submodule.repo.index.commit("Pin submodule to initial commit", skip_hooks=True)
remote_tip = _commit_file(source, "remote-only")
assert submodule.binsha != cached_tip.binsha != remote_tip.binsha
with mock.patch.object(Remote, "fetch", side_effect=AssertionError("Unexpected fetch")) as fetch:
update_submodule(no_fetch=True, to_latest_revision=True)
fetch.assert_not_called()
assert module.head.commit == cached_tip
assert module.head.reference.tracking_branch().commit == cached_tip
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"
def test_update_no_fetch_cannot_check_out_missing_commit(local_submodule, update_submodule):
submodule, source, module = local_submodule
cached_tip = module.head.commit
submodule.binsha = _commit_file(source, "remote-only").binsha
submodule.repo.index.add([submodule])
submodule.repo.index.commit("Pin submodule to uncached commit", skip_hooks=True)
with mock.patch.object(Remote, "fetch", side_effect=AssertionError("Unexpected fetch")) as fetch:
with pytest.raises(GitCommandError, match="merge-base"):
update_submodule(no_fetch=True)
fetch.assert_not_called()
assert module.head.commit == cached_tip
assert module.head.reference.tracking_branch().commit == cached_tip
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"
@pytest.mark.parametrize("uninitialized_submodule", ["missing"], indirect=True)
@pytest.mark.parametrize("keep_going", [False, True], ids=["raise", "keep-going"])
def test_update_no_fetch_rejects_missing_submodule(uninitialized_submodule, update_submodule, keep_going, caplog):
submodule, metadata = uninitialized_submodule
parent_config = Path(submodule.repo.git_dir, "config").read_bytes()
with mock.patch.object(Remote, "fetch") as fetch, mock.patch.object(Submodule, "_clone_repo") as clone:
if keep_going:
update_submodule(no_fetch=True, keep_going=True)
assert "fetching is disabled" in caplog.text
else:
with pytest.raises(ValueError, match="fetching is disabled"):
update_submodule(no_fetch=True)
fetch.assert_not_called()
clone.assert_not_called()
assert not submodule.module_exists()
assert not Path(submodule.abspath, ".git").exists()
assert not metadata.exists()
assert Path(submodule.repo.git_dir, "config").read_bytes() == parent_config
@pytest.mark.parametrize(
"options",
[
pytest.param({"init": False}, id="init-false"),
pytest.param({"dry_run": True}, id="dry-run"),
],
)
def test_update_no_fetch_can_skip_uninitialized_submodule(uninitialized_submodule, update_submodule, options):
submodule, metadata = uninitialized_submodule
retained_metadata = metadata.is_dir()
parent_config = Path(submodule.repo.git_dir, "config").read_bytes()
with mock.patch.object(Remote, "fetch") as fetch, mock.patch.object(Submodule, "_clone_repo") as clone:
update_submodule(no_fetch=True, **options)
fetch.assert_not_called()
clone.assert_not_called()
assert not submodule.module_exists()
assert not Path(submodule.abspath, ".git").exists()
assert metadata.is_dir() == retained_metadata
assert Path(submodule.repo.git_dir, "config").read_bytes() == parent_config
@pytest.mark.parametrize("to_latest_revision", [False, True], ids=["gitlink", "cached-tip"])
@pytest.mark.parametrize("keep_going", [False, True], ids=["raise", "keep-going"])
def test_update_no_fetch_restores_deinitialized_submodule(
local_submodule, update_submodule, to_latest_revision, keep_going, caplog
):
submodule, source, module = local_submodule
tracking_branch = module.head.reference.tracking_branch()
cached_tip = tracking_branch.commit
branch_path = module.head.reference.path
cached_refs = _cached_remote_refs(module)
module.head.reset("HEAD~1", index=True, working_tree=True)
assert module.head.commit != cached_tip
if to_latest_revision:
submodule.binsha = module.head.commit.binsha
submodule.repo.index.add([submodule])
submodule.repo.index.commit("Pin submodule to initial commit", skip_hooks=True)
assert submodule.binsha != cached_tip.binsha
metadata = Path(module.git_dir)
module.close()
submodule.deinit(force=True)
assert not submodule.module_exists()
assert metadata.is_dir()
remote_tip = _commit_file(source, "remote-only")
assert remote_tip != cached_tip
with mock.patch.object(Remote, "fetch") as fetch, mock.patch.object(Submodule, "_clone_repo") as clone:
update_submodule(no_fetch=True, to_latest_revision=to_latest_revision, keep_going=keep_going)
fetch.assert_not_called()
clone.assert_not_called()
assert not caplog.records
assert submodule.module_exists()
assert Path(submodule.abspath, ".git").is_file()
with submodule.module() as restored:
assert Path(restored.git_dir).samefile(metadata)
assert restored.head.commit == cached_tip
assert restored.head.reference.path == branch_path
assert restored.head.reference.tracking_branch().path == tracking_branch.path
assert _cached_remote_refs(restored) == cached_refs
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"
assert not restored.is_dirty(untracked_files=True)
with submodule.repo.config_reader() as reader:
assert reader.get_value(f'submodule "{submodule.name}"', "url") == submodule.url
@pytest.mark.parametrize("no_fetch", [None, False], ids=["default", "fetch"])
def test_update_after_deinit_fetches_remote_tip(local_submodule, update_submodule, no_fetch):
submodule, source, module = local_submodule
metadata = Path(module.git_dir)
module.close()
submodule.deinit()
remote_tip = _commit_file(source, "remote-only")
options = {} if no_fetch is None else {"no_fetch": no_fetch}
with mock.patch.object(Remote, "fetch", autospec=True, side_effect=Remote.fetch) as fetch:
with mock.patch.object(Submodule, "_clone_repo") as clone:
update_submodule(to_latest_revision=True, **options)
clone.assert_not_called()
fetch.assert_called_once()
assert fetch.call_args[0][0].name == "origin"
assert Path(fetch.call_args[0][0].repo.git_dir).samefile(metadata)
with submodule.module() as restored:
assert Path(restored.git_dir).samefile(metadata)
assert restored.head.commit == remote_tip
assert restored.head.reference.tracking_branch().commit == remote_tip
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "remote-only"
@pytest.mark.parametrize("uninitialized_submodule", ["deinitialized"], indirect=True)
def test_update_no_fetch_preserves_nonempty_deinitialized_checkout(uninitialized_submodule, update_submodule):
submodule, metadata = uninitialized_submodule
checkout_file = Path(submodule.abspath, "file")
checkout_file.write_text("user content", encoding="utf-8")
parent_config = Path(submodule.repo.git_dir, "config").read_bytes()
with mock.patch.object(Remote, "fetch") as fetch, mock.patch.object(Submodule, "_clone_repo") as clone:
with pytest.raises(OSError, match="does already exist and is non-empty"):
update_submodule(no_fetch=True)
fetch.assert_not_called()
clone.assert_not_called()
assert checkout_file.read_text(encoding="utf-8") == "user content"
assert not Path(submodule.abspath, ".git").exists()
assert metadata.is_dir()
assert Path(submodule.repo.git_dir, "config").read_bytes() == parent_config
@pytest.mark.parametrize("no_fetch", [False, True], ids=["fetch", "no-fetch"])
def test_update_no_fetch_is_recursive(local_submodule, update_submodule, no_fetch):
submodule, source, module = local_submodule
child = module.create_submodule("nested", "nested", source.working_tree_dir, branch=source.head.reference.name)
with child.module() as nested:
cached_tip = nested.head.commit
nested.head.reset("HEAD~1", index=True, working_tree=True)
child.binsha = nested.head.commit.binsha
module.index.add([child])
previous = module.index.commit("Add nested submodule at initial commit", skip_hooks=True)
child.binsha = cached_tip.binsha
module.index.add([child])
target = module.index.commit("Advance nested submodule", skip_hooks=True)
submodule.binsha = target.binsha
submodule.repo.index.add([submodule])
submodule.repo.index.commit("Record nested submodule update", skip_hooks=True)
module.head.reset(previous, index=True, working_tree=True)
with mock.patch.object(Remote, "fetch", autospec=True, side_effect=Remote.fetch) as fetch:
update_submodule(recursive=True, no_fetch=no_fetch)
assert module.head.commit == target
assert nested.head.commit == cached_tip
assert Path(child.abspath, "file").read_text(encoding="utf-8") == "cached"
assert fetch.call_count == (0 if no_fetch else 2)
assert {call[0][0].repo.git_dir for call in fetch.call_args_list} == (
set() if no_fetch else {module.git_dir, nested.git_dir}
)
@pytest.mark.parametrize("no_fetch", [False, True], ids=["fetch", "no-fetch"])
def test_root_update_no_fetch_on_branch_change(local_submodule, no_fetch):
submodule, source, module = local_submodule
branch_name = source.head.reference.name + "-other"
source.create_head(branch_name)
module.remotes.origin.fetch()
tracking_branch = module.remotes.origin.refs[branch_name]
previous = submodule.repo.head.commit
with submodule.config_writer() as writer:
writer.set_value("branch", branch_name)
submodule.repo.index.commit("Change submodule branch", skip_hooks=True)
module.head.reset("HEAD~1", index=True, working_tree=True)
with mock.patch.object(Remote, "fetch", autospec=True, side_effect=Remote.fetch) as fetch:
RootModule(submodule.repo).update(previous_commit=previous, recursive=False, no_fetch=no_fetch)
assert module.head.reference.name == branch_name
assert module.head.reference.tracking_branch() == tracking_branch
assert module.head.commit.binsha == submodule.binsha
if no_fetch:
fetch.assert_not_called()
else:
assert fetch.called
@pytest.mark.parametrize("no_fetch", [False, True], ids=["fetch", "no-fetch"])
def test_root_update_no_fetch_on_url_change(local_submodule, tmp_path, no_fetch):
submodule, source, module = local_submodule
previous = submodule.repo.head.commit
branch_path = module.head.reference.path
tracking_branch = module.head.reference.tracking_branch()
cached_refs = _cached_remote_refs(module)
module.head.reset("HEAD~1", index=True, working_tree=True)
assert module.head.commit.binsha != submodule.binsha
with source.clone(tmp_path / "mirror") as mirror:
mirror_url = Git.polish_url(mirror.working_tree_dir)
with submodule.config_writer() as writer:
writer.set_value("url", mirror_url)
submodule.repo.index.commit("Change submodule URL", skip_hooks=True)
with mock.patch.object(Remote, "fetch", autospec=True, side_effect=Remote.fetch) as fetch:
RootModule(submodule.repo).update(previous_commit=previous, recursive=False, no_fetch=no_fetch)
if no_fetch:
fetch.assert_not_called()
assert module.head.reference.path == branch_path
assert module.head.reference.tracking_branch() == tracking_branch
assert _cached_remote_refs(module) == cached_refs
else:
assert fetch.call_count == 2
assert {call[0][0].name for call in fetch.call_args_list} == {"origin"}
assert module.remotes.origin.url == mirror_url
assert {remote.name for remote in module.remotes} == {"origin"}
assert module.head.commit.binsha == submodule.binsha
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"
@pytest.mark.parametrize("change_branch", [False, True], ids=["same-branch", "branch-change"])
def test_root_update_no_fetch_url_change_uses_cached_tip(local_submodule, tmp_path, change_branch):
submodule, source, module = local_submodule
branch_name = source.head.reference.name
if change_branch:
branch_name += "-other"
source.create_head(branch_name)
module.remotes.origin.fetch()
tracking_branch = module.remotes.origin.refs[branch_name]
cached_tip = tracking_branch.commit
cached_refs = _cached_remote_refs(module)
module.head.reset("HEAD~1", index=True, working_tree=True)
submodule.binsha = module.head.commit.binsha
submodule.repo.index.add([submodule])
previous = submodule.repo.index.commit("Pin submodule to initial commit", skip_hooks=True)
assert submodule.binsha != cached_tip.binsha
with source.clone(tmp_path / "mirror") as mirror:
if change_branch:
mirror.create_head(branch_name).checkout()
remote_tip = _commit_file(mirror, "remote-only")
assert remote_tip != cached_tip
mirror_url = Git.polish_url(mirror.working_tree_dir)
with submodule.config_writer() as writer:
writer.set_value("url", mirror_url)
writer.set_value("branch", branch_name)
submodule.repo.index.commit("Change submodule URL and tracking branch", skip_hooks=True)
with mock.patch.object(Remote, "fetch", side_effect=AssertionError("Unexpected fetch")) as fetch:
RootModule(submodule.repo).update(
previous_commit=previous, recursive=False, no_fetch=True, to_latest_revision=True
)
fetch.assert_not_called()
assert module.remotes.origin.url == mirror_url
assert {remote.name for remote in module.remotes} == {"origin"}
assert _cached_remote_refs(module) == cached_refs
assert module.head.reference.name == branch_name
assert module.head.reference.tracking_branch() == tracking_branch
assert module.head.commit == cached_tip
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"
@pytest.mark.parametrize("multiple_remotes", [False, True], ids=["single-remote-fallback", "matching-remote"])
def test_root_update_no_fetch_selects_url_change_remote(local_submodule, tmp_path, multiple_remotes):
submodule, source, module = local_submodule
previous = submodule.repo.head.commit
original_url = module.remotes.origin.url
module.remotes.origin.set_url(Git.polish_url(str(tmp_path / "unrelated")))
if multiple_remotes:
upstream = module.create_remote("upstream", original_url)
upstream.fetch()
module.head.reference.set_tracking_branch(upstream.refs[submodule.branch_name])
else:
module.remotes.origin.rename("upstream")
tracking_branch = module.head.reference.tracking_branch()
cached_refs = _cached_remote_refs(module)
module.head.reset("HEAD~1", index=True, working_tree=True)
assert module.head.commit.binsha != submodule.binsha
with source.clone(tmp_path / "mirror") as mirror:
mirror_url = Git.polish_url(mirror.working_tree_dir)
expected_urls = {remote.name: remote.url for remote in module.remotes}
expected_urls["upstream"] = mirror_url
with submodule.config_writer() as writer:
writer.set_value("url", mirror_url)
submodule.repo.index.commit("Change submodule URL", skip_hooks=True)
with mock.patch.object(Remote, "fetch", side_effect=AssertionError("Unexpected fetch")) as fetch:
RootModule(submodule.repo).update(previous_commit=previous, recursive=False, no_fetch=True)
fetch.assert_not_called()
assert {remote.name: remote.url for remote in module.remotes} == expected_urls
assert _cached_remote_refs(module) == cached_refs
assert module.head.reference.tracking_branch() == tracking_branch
assert module.head.commit.binsha == submodule.binsha
assert Path(submodule.abspath, "file").read_text(encoding="utf-8") == "cached"