Merge pull request #77 from per1234/recurse-submodules

libraries/compile-examples: add support for submodules

Author: aentinger

compilesketches/compilesketches.py

@@ -630,7 +630,8 @@ def clone_repository(self, url, git_ref, destination_path):
         """
         if git_ref is None:
             # Shallow clone is only possible if using the tip of the branch
-            clone_arguments = {"depth": 1}
+            # Use `None` as value for `git clone` options with no argument
+            clone_arguments = {"depth": 1, "shallow-submodules": None, "recurse-submodules": True}
         else:
             clone_arguments = {}
         cloned_repository = git.Repo.clone_from(url=url, to_path=destination_path, **clone_arguments)
@@ -646,6 +647,7 @@ def clone_repository(self, url, git_ref, destination_path):
 
             # checkout ref
             cloned_repository.git.checkout(git_ref)
+            cloned_repository.git.submodule("update", "--init", "--recursive", "--recommend-shallow")
 
     def install_platforms_from_download(self, platform_list):
         """Install libraries by downloading them
@@ -894,7 +896,7 @@ def get_sketch_report(self, compilation_result):
             previous_compilation_result = self.compile_sketch(sketch_path=compilation_result.sketch)
 
             # git checkout the head ref to return the repository to its previous state
-            repository.git.checkout(original_git_ref)
+            repository.git.checkout(original_git_ref, recurse_submodules=True)
 
             previous_sizes = self.get_sizes_from_output(compilation_result=previous_compilation_result)
 
@@ -1021,11 +1023,15 @@ def checkout_deltas_base_ref(self):
 
         # git fetch the deltas base ref
         origin_remote = repository.remotes["origin"]
-        origin_remote.fetch(refspec=self.deltas_base_ref, verbose=self.verbose, no_tags=True, prune=True,
-                            depth=1)
+        origin_remote.fetch(refspec=self.deltas_base_ref,
+                            verbose=self.verbose,
+                            no_tags=True,
+                            prune=True,
+                            depth=1,
+                            recurse_submodules=True)
 
         # git checkout the deltas base ref
-        repository.git.checkout(self.deltas_base_ref)
+        repository.git.checkout(self.deltas_base_ref, recurse_submodules=True)
 
     def get_sizes_report(self, current_sizes, previous_sizes):
         """Return a list containing all memory usage data assembled.

compilesketches/tests/test_compilesketches.py

@@ -1364,7 +1364,7 @@ def checkout(self):
         git.Repo.assert_called_once_with(path=os.environ["GITHUB_WORKSPACE"])
         compile_sketches.checkout_deltas_base_ref.assert_called_once()
         compile_sketches.compile_sketch.assert_called_once_with(compile_sketches, sketch_path=compilation_result.sketch)
-        Repo.checkout.assert_called_once_with(original_git_ref)
+        Repo.checkout.assert_called_once_with(original_git_ref, recurse_submodules=True)
         get_sizes_from_output_calls.append(
             unittest.mock.call(compile_sketches, compilation_result=previous_compilation_result))
         expected_previous_sizes = sizes_list[1]
@@ -1646,9 +1646,11 @@ def checkout(self):
     git.Repo.assert_called_once_with(path=os.environ["GITHUB_WORKSPACE"])
     Repo.fetch.assert_called_once_with(refspec=deltas_base_ref,
                                        verbose=compile_sketches.verbose,
-                                       no_tags=True, prune=True,
-                                       depth=1)
-    Repo.checkout.assert_called_once_with(deltas_base_ref)
+                                       no_tags=True,
+                                       prune=True,
+                                       depth=1,
+                                       recurse_submodules=True)
+    Repo.checkout.assert_called_once_with(deltas_base_ref, recurse_submodules=True)
 
 
 def test_get_sizes_report(mocker):