Submodules: Add fetch depth options

Author: jorio

pygit2/submodules.py

@@ -73,7 +73,9 @@ def init(self, overwrite: bool = False):
         err = C.git_submodule_init(self._subm, int(overwrite))
         check_error(err)
 
-    def update(self, init: bool = False, callbacks: RemoteCallbacks = None):
+    def update(
+        self, init: bool = False, callbacks: RemoteCallbacks = None, depth: int = 0
+    ):
         """
         Update a submodule. This will clone a missing submodule and checkout
         the subrepository to the commit specified in the index of the
@@ -90,12 +92,17 @@ def update(self, init: bool = False, callbacks: RemoteCallbacks = None):
 
         callbacks
             Optional RemoteCallbacks to clone or fetch the submodule.
+
+        depth
+            Number of commits to fetch.
+            The default is 0 (full commit history).
         """
 
         opts = ffi.new('git_submodule_update_options *')
         C.git_submodule_update_options_init(
             opts, C.GIT_SUBMODULE_UPDATE_OPTIONS_VERSION
         )
+        opts.fetch_opts.depth = depth
 
         with git_fetch_options(callbacks, opts=opts.fetch_opts) as payload:
             err = C.git_submodule_update(self._subm, int(init), opts)
@@ -188,6 +195,7 @@ def add(
         path: str,
         link: bool = True,
         callbacks: Optional[RemoteCallbacks] = None,
+        depth: int = 0,
     ) -> Submodule:
         """
         Add a submodule to the index.
@@ -208,6 +216,10 @@ def add(
 
         callbacks
             Optional RemoteCallbacks to clone the submodule.
+
+        depth
+            Number of commits to fetch.
+            The default is 0 (full commit history).
         """
         csub = ffi.new('git_submodule **')
         curl = ffi.new('char[]', to_bytes(url))
@@ -226,6 +238,7 @@ def add(
         C.git_submodule_update_options_init(
             opts, C.GIT_SUBMODULE_UPDATE_OPTIONS_VERSION
         )
+        opts.fetch_opts.depth = depth
 
         with git_fetch_options(callbacks, opts=opts.fetch_opts) as payload:
             crepo = ffi.new('git_repository **')
@@ -268,6 +281,7 @@ def update(
         submodules: Optional[Iterable[str]] = None,
         init: bool = False,
         callbacks: Optional[RemoteCallbacks] = None,
+        depth: int = 0,
     ):
         """
         Update submodules. This will clone a missing submodule and checkout
@@ -289,14 +303,18 @@ def update(
 
         callbacks
             Optional RemoteCallbacks to clone or fetch the submodule.
+
+        depth
+            Number of commits to fetch.
+            The default is 0 (full commit history).
         """
         if submodules is None:
             submodules = self._repository.listall_submodules()
 
         instances = [self[s] for s in submodules]
 
         for submodule in instances:
-            submodule.update(init, callbacks)
+            submodule.update(init, callbacks, depth)
 
     def status(
         self, name: str, ignore: SubmoduleIgnore = SubmoduleIgnore.UNSPECIFIED

test/test_submodule.py

@@ -38,6 +38,7 @@
 SUBM_PATH = 'TestGitRepository'
 SUBM_URL = 'https://github.com/libgit2/TestGitRepository'
 SUBM_HEAD_SHA = '49322bb17d3acc9146f98c97d078513228bbf3c0'
+SUBM_BOTTOM_SHA = '6c8b137b1c652731597c89668f417b8695f28dd7'
 
 
 @pytest.fixture
@@ -143,37 +144,54 @@ def test_update_instance(repo):
 
 
 @utils.requires_network
-def test_oneshot_update(repo):
+@pytest.mark.parametrize('depth', [0, 1])
+def test_oneshot_update(repo, depth):
     status = repo.submodules.status(SUBM_NAME)
     assert status == (SS.IN_HEAD | SS.IN_INDEX | SS.IN_CONFIG | SS.WD_UNINITIALIZED)
 
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
-    repo.submodules.update(init=True)
+    repo.submodules.update(init=True, depth=depth)
     assert subrepo_file_path.exists()
 
     status = repo.submodules.status(SUBM_NAME)
     assert status == (SS.IN_HEAD | SS.IN_INDEX | SS.IN_CONFIG | SS.IN_WD)
 
+    sm_repo = repo.submodules[SUBM_NAME].open()
+    if depth == 0:
+        sm_repo[SUBM_BOTTOM_SHA]  # full history must be available
+    else:
+        with pytest.raises(KeyError):
+            sm_repo[SUBM_BOTTOM_SHA]  # shallow clone
+
 
 @utils.requires_network
-def test_oneshot_update_instance(repo):
+@pytest.mark.parametrize('depth', [0, 1])
+def test_oneshot_update_instance(repo, depth):
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
     sm = repo.submodules[SUBM_NAME]
-    sm.update(init=True)
+    sm.update(init=True, depth=depth)
     assert subrepo_file_path.exists()
 
+    sm_repo = sm.open()
+    if depth == 0:
+        sm_repo[SUBM_BOTTOM_SHA]  # full history must be available
+    else:
+        with pytest.raises(KeyError):
+            sm_repo[SUBM_BOTTOM_SHA]  # shallow clone
+
 
 @utils.requires_network
 def test_head_id(repo):
     assert repo.submodules[SUBM_PATH].head_id == SUBM_HEAD_SHA
 
 
 @utils.requires_network
-def test_add_submodule(repo):
+@pytest.mark.parametrize('depth', [0, 1])
+def test_add_submodule(repo, depth):
     sm_repo_path = 'test/testrepo'
-    sm = repo.submodules.add(SUBM_URL, sm_repo_path)
+    sm = repo.submodules.add(SUBM_URL, sm_repo_path, depth=depth)
 
     status = repo.submodules.status(sm_repo_path)
     assert status == (SS.IN_INDEX | SS.IN_CONFIG | SS.IN_WD | SS.INDEX_ADDED)
@@ -183,6 +201,12 @@ def test_add_submodule(repo):
     assert SUBM_URL == sm.url
     assert not sm_repo.is_empty
 
+    if depth == 0:
+        sm_repo[SUBM_BOTTOM_SHA]  # full history must be available
+    else:
+        with pytest.raises(KeyError):
+            sm_repo[SUBM_BOTTOM_SHA]  # shallow clone
+
 
 @utils.requires_network
 def test_submodule_status(repo):