Move tests/unit/test_provenance.py to tests/unit/provenance and add more tests

Author: bouweandela

tests/unit/provenance/test_trackedfile.py

@@ -1,12 +1,38 @@
+from dataclasses import dataclass
 from pathlib import Path
+from typing import Any
 
+import iris.cube
 import pytest
 from prov.model import ProvDocument
 
 from esmvalcore._provenance import ESMVALTOOL_URI_PREFIX, TrackedFile
+from esmvalcore.io.protocol import DataElement
 from esmvalcore.local import LocalFile
 
 
+def test_set():
+    assert {
+        TrackedFile(Path("file1.nc"), attributes={}),
+        TrackedFile(Path("file1.nc"), attributes={}),
+        TrackedFile(Path("file2.nc"), attributes={}),
+    } == {
+        TrackedFile(Path("file1.nc"), attributes={}),
+        TrackedFile(Path("file2.nc"), attributes={}),
+    }
+
+
+def test_sort():
+    file1 = TrackedFile(Path("file1.nc"), attributes={})
+    file2 = TrackedFile(Path("file2.nc"), attributes={})
+    assert sorted([file2, file1]) == [file1, file2]
+
+
+def test_equals():
+    file = TrackedFile(Path("file.nc"), attributes={})
+    assert file == TrackedFile(Path("file.nc"), attributes={})
+
+
 @pytest.fixture
 def tracked_input_file_nc():
     input_file_nc = LocalFile("/path/to/file.nc")
@@ -39,6 +65,39 @@ def test_init_input_nc(tracked_input_file_nc):
         tracked_input_file_nc.attributes  # noqa: B018
 
 
+def test_provenance_file_nonpath_notimplemented() -> None:
+    """Test `esmvalcore._provenance.TrackedFile.provenance_file` with a DataElement."""
+
+    @dataclass
+    class MockDataElement(DataElement):
+        name: str
+        facets: dict[str, Any]
+        attributes: dict[str, Any]
+
+        def prepare(self) -> None:
+            pass
+
+        def to_iris(
+            self,
+            ignore_warnings: list[dict[str, Any]] | None = None,
+        ) -> iris.cube.CubeList:
+            return []
+
+    input_file = MockDataElement(
+        name="/path/to/input_file.nc",
+        facets={},
+        attributes={},
+    )
+    tracked_file = TrackedFile(filename=input_file)
+
+    assert tracked_file.filename == input_file
+    with pytest.raises(
+        NotImplementedError,
+        match=r"Saving provenance is only supported for pathlib.Path.*",
+    ):
+        _ = tracked_file.provenance_file
+
+
 def test_init_output_nc(tracked_output_file_nc):
     """Test `esmvalcore._provenance.TrackedFile.__init__`."""
     assert tracked_output_file_nc.filename == Path("/path/to/file.nc")