Add test for metadata

Author: Descanonge

tests/conftest.py

@@ -37,6 +37,7 @@ def pytest_collection_modifyitems(items):
         "tests.data.test_interface",
         "tests.data.test_params",
         "tests.data.test_source",
+        "tests.data.test_writer",
         "tests.data.test_store",
         "tests.data.test_xarray",
     ]

tests/data/test_writer.py

@@ -0,0 +1,137 @@
+"""Test common Writer features."""
+
+import os
+
+from neba.data import DataInterface, ParametersDict
+from neba.data.writer import MetadataGenerator, WriterAbstract, element
+
+
+class TestMetadata:
+    ELTS_BASIC = [
+        "written_with_interface",
+        "creation_time",
+        "creation_hostname",
+        "creation_script",
+    ]
+    ELTS_PARAMS = ["creation_params"]
+    ELTS_GIT = ["creation_commit", "creation_diff"]
+
+    def get_interface(self, *args, **kwargs) -> DataInterface:
+        class MyDataInterface(DataInterface):
+            Parameters = ParametersDict
+
+        return MyDataInterface(*args, **kwargs)
+
+    def test_elements_selection(self):
+
+        di = self.get_interface()
+        metadata = di.writer.get_metadata()
+
+        # git will fail on github CI for some reason
+        for key in self.ELTS_BASIC + self.ELTS_PARAMS:
+            assert key in metadata
+
+        # Test group skip
+        assert (
+            di.writer.metadata_generator(None, add_git_info=False).get_elements()
+            == self.ELTS_BASIC + self.ELTS_PARAMS
+        )
+
+        assert (
+            di.writer.metadata_generator(None, add_params=False).get_elements()
+            == self.ELTS_BASIC + self.ELTS_GIT
+        )
+
+        metadata = di.writer.get_metadata(add_params=False, add_git_info=False)
+        assert list(metadata.keys()) == self.ELTS_BASIC
+
+        # Test manually specifying elements (in different order)
+        elts = ["creation_hostname", "written_with_interface", "creation_params"]
+        metadata = di.writer.get_metadata(elements=elts)
+        assert list(metadata.keys()) == elts
+
+    def test_generator_subclass(self):
+        class MyGenerator(MetadataGenerator):
+            @element
+            def simple(self):
+                return 0
+
+            @element(elements=["a", "b"])
+            def multiple(self):
+                return {"a": 0, "b": 1}
+
+            @element(elements=["b"])
+            def last(self):
+                return {"b": 5}
+
+        class MyDataInterface(DataInterface):
+            Parameters = ParametersDict
+
+            class Writer(WriterAbstract):
+                metadata_generator = MyGenerator
+
+        di = MyDataInterface()
+        metadata = di.writer.get_metadata(add_git_info=False)
+
+        assert list(metadata.keys()) == self.ELTS_BASIC + self.ELTS_PARAMS + [
+            "simple",
+            "a",
+            "b",
+        ]
+
+        assert metadata["simple"] == 0
+        assert metadata["a"] == 0
+        assert metadata["b"] == 5
+
+    def test_renaming(self):
+        class MyGenerator(MetadataGenerator):
+            @element
+            def simple(self):
+                return 0
+
+            @element(elements=["a", "b"])
+            def multiple(self):
+                return {"a": 0, "b": 1}
+
+        class MyDataInterface(DataInterface):
+            Parameters = ParametersDict
+
+            class Writer(WriterAbstract):
+                metadata_generator = MyGenerator
+
+        di = MyDataInterface()
+        MyGenerator.simple.rename("simple_rename")
+        MyGenerator.multiple.rename(a="a_rename")
+        metadata = di.writer.get_metadata()
+        assert metadata["simple_rename"] == 0
+        assert metadata["a_rename"] == 0
+        assert metadata["b"] == 1
+        assert "a" not in metadata
+        assert "simple" not in metadata
+
+    def test_parameters(self):
+        params = dict(a=0, b=1)
+        di = self.get_interface(params)
+        metadata = di.writer.get_metadata(params_str=False)
+        assert metadata["creation_params"] == params
+
+        metadata = di.writer.get_metadata()
+        assert metadata["creation_params"] == '{"a": 0, "b": 1}'
+
+    def test_script_filename(self):
+        di = self.get_interface()
+        metadata = di.writer.get_metadata(
+            creation_script="a", elements=["creation_script"]
+        )
+        assert metadata["creation_script"] == "a"
+
+        # Pytest messes with getting filename (similarly to IPython)
+        # not sure how to test it properly
+
+    def test_git(self):
+        di = self.get_interface()
+        metadata = di.writer.get_metadata(creation_script=".")
+        assert "creation_commit" in metadata
+
+        if (commit := os.environ.get("GITHUB_SHA")) is not None:
+            assert metadata["creation_commit"] == commit

tests/data/test_xarray.py

@@ -161,8 +161,11 @@ def test_metadata(self, tmpdir):
 
         written = xr.open_dataset(filename)
 
-        assert written.attrs["written_with_interface"] == "XarrayInterface"
-        assert written.attrs["created_with_params"] == '{"a": 0}'
+        assert (
+            written.attrs["written_with_interface"]
+            == "tests.data.test_xarray.XarrayInterface"
+        )
+        assert written.attrs["creation_params"] == '{"a": 0}'
 
     def setup_multifile(self, tmpdir) -> tuple[xr.Dataset, list[xr.Dataset], list[str]]:
         data = np.arange(12).reshape(3, 4)