Disallow external repo double stacking (#324)

* Add safeguard against external repo double stacking * Add test for double stacking repo * Improve error readability * Apply suggestions from code review Co-authored-by: Daniel Huppmann <[email protected]> * Update test after suggestion from @danielhuppmann --------- Co-authored-by: Daniel Huppmann <[email protected]>
IAMconsortium · Feb 9, 2024 · 1a2c2ed · 1a2c2ed
1 parent 8f39de1
commit 1a2c2ed
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/nomenclature/config.py b/nomenclature/config.py
@@ -82,6 +82,20 @@ def fetch_repo(self, to_path):
         repo.git.clean("-xdf")
         if self.revision == "main":
             repo.remotes.origin.pull()
+        self.check_external_repo_double_stacking()
+
+    def check_external_repo_double_stacking(self):
+        nomenclature_config = self.local_path / "nomenclature.yaml"
+        if nomenclature_config.is_file():
+            with open(nomenclature_config, "r") as f:
+                config = yaml.safe_load(f)
+            if config.get("repositories"):
+                raise ValueError(
+                    (
+                        "External repos cannot again refer to external repos, "
+                        f"found in nomenclature.yaml in '{self.url}'"
+                    )
+                )
 
 
 class DataStructureConfig(BaseModel):

diff --git a/tests/data/double_stacked_external_repo/nomenclature.yaml b/tests/data/double_stacked_external_repo/nomenclature.yaml
@@ -0,0 +1,6 @@
+repositories:
+  common-definitions:
+    url: https://github.com/IAMconsortium/common-definitions.git/
+definitions:
+  region:
+    repository: common-definitions
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -55,3 +55,15 @@ def test_multiple_mapping_repos():
         assert nomenclature_config.repositories.keys() == exp_repos
     finally:
         clean_up_external_repos(nomenclature_config.repositories)
+
+
+def test_double_stacked_external_repo_raises(monkeypatch):
+    repo = Repository(url="lorem ipsum")
+    monkeypatch.setitem(
+        repo.__dict__,
+        "local_path",
+        TEST_DATA_DIR / "double_stacked_external_repo",
+    )
+    match = "External repos cannot again refer to external repos"
+    with raises(ValueError, match=match):
+        repo.check_external_repo_double_stacking()