Fix metadata tests to not rely on the fact they are ran from a Git clone of openzim/hatch-openzim

Author: benoit74

tests/configs/gitconfig

@@ -0,0 +1,11 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+[remote "origin"]
+	url = git@github.com:openzim/hatch-openzim.git
+	fetch = +refs/heads/*:refs/remotes/origin/*
+[branch "main"]
+	remote = origin
+	merge = refs/heads/main

tests/test_metadata.py

@@ -1,13 +1,17 @@
 import os
+import shutil
 from pathlib import Path
+from typing import Dict, List, Union
 
 import pytest
 
 from hatch_openzim.metadata import update
 
+Metadata = Dict[str, Union[str, List[str]]]
+
 
 @pytest.fixture
-def dynamic_metadata():
+def dynamic_metadata() -> List[str]:
     return [
         "authors",
         "classifiers",
@@ -18,16 +22,28 @@ def dynamic_metadata():
 
 
 @pytest.fixture
-def metadata(dynamic_metadata):
+def root_folder(tmp_path: Path) -> str:
+    git_folder = tmp_path / ".git"
+    git_folder.mkdir()
+    shutil.copy(
+        Path(os.path.dirname(os.path.abspath(__file__))).parent
+        / "tests/configs/gitconfig",
+        git_folder / "config",
+    )
+    return str(tmp_path)
+
+
+@pytest.fixture
+def metadata(dynamic_metadata: List[str]) -> Metadata:
     return {
         "requires-python": ">=3.10,<3.12",
         "dynamic": dynamic_metadata,
     }
 
 
-def test_metadata_nominal(metadata):
+def test_metadata_nominal(metadata: Metadata, root_folder: str):
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config={},
         metadata=metadata,
     )
@@ -57,15 +73,19 @@ def test_metadata_nominal(metadata):
         ("urls"),
     ],
 )
-def test_metadata_missing_dynamic(metadata, metadata_key):
+def test_metadata_missing_dynamic(
+    metadata: Metadata, metadata_key: str, root_folder: str
+):
+    assert isinstance(metadata["dynamic"], List)
+    assert all(isinstance(item, str) for item in metadata["dynamic"])
     metadata["dynamic"].remove(metadata_key)
     with pytest.raises(
         Exception,
         match=f"'{metadata_key}' must be listed in 'project.dynamic' when using openzim"
         " metadata hook",
     ):
         update(
-            root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+            root=root_folder,
             config={},
             metadata=metadata,
         )
@@ -81,15 +101,17 @@ def test_metadata_missing_dynamic(metadata, metadata_key):
         ("urls"),
     ],
 )
-def test_metadata_metadata_already_there(metadata, metadata_key):
+def test_metadata_metadata_already_there(
+    metadata: Metadata, metadata_key: str, root_folder: str
+):
     metadata[metadata_key] = "some_value"
     with pytest.raises(
         Exception,
         match=f"'{metadata_key}' must not be listed in the 'project' table when using "
         "openzim metadata hook",
     ):
         update(
-            root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+            root=root_folder,
             config={},
             metadata=metadata,
         )
@@ -105,38 +127,40 @@ def test_metadata_metadata_already_there(metadata, metadata_key):
         ("urls"),
     ],
 )
-def test_metadata_preserve_value(metadata, metadata_key):
+def test_metadata_preserve_value(
+    metadata: Metadata, metadata_key: str, root_folder: str
+):
     metadata[metadata_key] = f"some_value_for_{metadata_key}"
     config = {}
     config[f"preserve-{metadata_key}"] = True
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config=config,
         metadata=metadata,
     )
     assert metadata[metadata_key] == f"some_value_for_{metadata_key}"
 
 
-def test_metadata_additional_keywords(metadata):
+def test_metadata_additional_keywords(metadata: Metadata, root_folder: str):
     config = {}
     config["additional-keywords"] = ["keyword1", "keyword2"]
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config=config,
         metadata=metadata,
     )
     # we compare sets because order is not relevant
     assert set(metadata["keywords"]) == {"openzim", "keyword1", "keyword2"}
 
 
-def test_metadata_additional_classifiers(metadata):
+def test_metadata_additional_classifiers(metadata: Metadata, root_folder: str):
     config = {}
     config["additional-classifiers"] = [
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
     ]
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config=config,
         metadata=metadata,
     )
@@ -151,11 +175,11 @@ def test_metadata_additional_classifiers(metadata):
     }
 
 
-def test_metadata_additional_authors(metadata):
+def test_metadata_additional_authors(metadata: Metadata, root_folder: str):
     config = {}
     config["additional-authors"] = [{"email": "someone@acme.org", "name": "Some One"}]
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config=config,
         metadata=metadata,
     )
@@ -178,12 +202,14 @@ def test_metadata_additional_authors(metadata):
         (None, "openzim"),
     ],
 )
-def test_metadata_organization(organization, expected_result, metadata):
+def test_metadata_organization(
+    organization: str, expected_result: str, metadata, root_folder: str
+):
     config = {}
     if organization:
         config["organization"] = organization
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config=config,
         metadata=metadata,
     )
@@ -197,11 +223,11 @@ def test_metadata_organization(organization, expected_result, metadata):
         raise Exception(f"Unexpected expected result: {expected_result}")
 
 
-def test_metadata_is_scraper(metadata):
+def test_metadata_is_scraper(metadata: Metadata, root_folder: str):
     config = {}
     config["kind"] = "scraper"
     update(
-        root=str(Path(os.path.dirname(os.path.abspath(__file__))).parent),
+        root=root_folder,
         config=config,
         metadata=metadata,
     )