update test fixture to use matchers from dvc.testing (#10940)

Author: skshetry

dvc/testing/matchers.py

@@ -1,5 +1,5 @@
 from collections.abc import Iterable, Mapping
-from typing import TYPE_CHECKING, Any, Optional
+from typing import TYPE_CHECKING, Any, Optional, Union
 
 if TYPE_CHECKING:
     import builtins
@@ -68,8 +68,37 @@ def __eq__(self, other: object) -> bool:
         return all(getattr(other, name) == v for name, v in self.attribs.items())
 
 
+class instance_of:  # noqa: N801, PLW1641
+    def __init__(self, expected_type: Union[Any, tuple[Any, ...]]) -> None:
+        self.expected_type = expected_type
+
+    def __repr__(self) -> str:
+        if isinstance(self.expected_type, tuple):
+            inner = f"({', '.join(t.__name__ for t in self.expected_type)})"
+        else:
+            inner = self.expected_type.__name__
+        return f"{self.__class__.__name__}({inner})"
+
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, self.expected_type)
+
+
+class any_of:  # noqa: N801, PLW1641
+    def __init__(self, *items: Any) -> None:
+        self.items = sorted(items)
+
+    def __repr__(self) -> str:
+        inner = ", ".join(map(repr, self.items))
+        return f"any_of({inner})"
+
+    def __eq__(self, other: object) -> bool:
+        return other in self.items
+
+
 __all__ = [
+    "any_of",
     "attrs",
     "dict",
+    "instance_of",
     "unordered",
 ]

tests/func/metrics/test_diff.py

@@ -4,6 +4,7 @@
 import pytest
 
 from dvc.cli import main
+from dvc.testing import matchers as M
 from dvc.utils import relpath
 from dvc.utils.serialize import JSONFileCorruptedError
 
@@ -95,7 +96,7 @@ def _gen(val):
     assert dvc.metrics.diff(a_rev="HEAD~2") == {}
 
 
-def test_metrics_diff_broken_json(M, tmp_dir, scm, dvc, run_copy_metrics):
+def test_metrics_diff_broken_json(tmp_dir, scm, dvc, run_copy_metrics):
     metrics = {"a": {"b": {"c": 1, "d": 1, "e": "3"}}}
     (tmp_dir / "m_temp.json").dump(metrics)
     run_copy_metrics(
@@ -143,7 +144,7 @@ def test_metrics_diff_new_metric(tmp_dir, scm, dvc, run_copy_metrics):
     }
 
 
-def test_metrics_diff_deleted_metric(M, tmp_dir, scm, dvc, run_copy_metrics):
+def test_metrics_diff_deleted_metric(tmp_dir, scm, dvc, run_copy_metrics):
     metrics = {"a": {"b": {"c": 1, "d": 1, "e": "3"}}}
     (tmp_dir / "m_temp.json").dump(metrics)
     run_copy_metrics(

tests/func/metrics/test_show.py

@@ -11,6 +11,7 @@
 from dvc.exceptions import OverlappingOutputPathsError
 from dvc.repo import Repo
 from dvc.repo.metrics.show import FileResult, Result
+from dvc.testing import matchers as M
 from dvc.utils.fs import remove
 from dvc.utils.serialize import JSONFileCorruptedError
 from dvc_data.index import DataIndexDirError
@@ -246,7 +247,7 @@ def test_show_malformed_metric(tmp_dir, scm, dvc, caplog):
     )
 
 
-def test_metrics_show_no_target(M, tmp_dir, dvc, capsys):
+def test_metrics_show_no_target(tmp_dir, dvc, capsys):
     assert dvc.metrics.show(targets=["metrics.json"]) == {
         "": {"data": {"metrics.json": {"error": M.instance_of(FileNotFoundError)}}}
     }
@@ -356,7 +357,7 @@ def test_top_level_parametrized(tmp_dir, dvc):
     }
 
 
-def test_metric_in_a_tracked_directory_with_missing_dir_file(M, tmp_dir, dvc):
+def test_metric_in_a_tracked_directory_with_missing_dir_file(tmp_dir, dvc):
     tmp_dir.dvc_gen({"dir": {"file": "2"}})
     (tmp_dir / "dvc.yaml").dump({"metrics": [join("dir", "file")]})
     shutil.rmtree(tmp_dir / "dir")  # remove from workspace

tests/func/params/test_diff.py

@@ -2,6 +2,7 @@
 
 import pytest
 
+from dvc.testing import matchers as M
 from dvc.utils import relpath
 
 
@@ -54,7 +55,7 @@ def test_diff_new(tmp_dir, scm, dvc):
     }
 
 
-def test_diff_deleted(M, tmp_dir, scm, dvc):
+def test_diff_deleted(tmp_dir, scm, dvc):
     tmp_dir.gen("params.yaml", "foo: bar")
     dvc.run(cmd="echo params.yaml", params=["foo"], name="echo-params")
     scm.add(["params.yaml", "Dvcfile"])

tests/func/params/test_show.py

@@ -6,6 +6,7 @@
 from dvc.dvcfile import PROJECT_FILE
 from dvc.repo import Repo
 from dvc.repo.metrics.show import FileResult, Result
+from dvc.testing import matchers as M
 from dvc_data.index import DataIndexDirError
 
 
@@ -197,7 +198,7 @@ def test_top_level_parametrized(tmp_dir, dvc):
     }
 
 
-def test_param_in_a_tracked_directory_with_missing_dir_file(M, tmp_dir, dvc):
+def test_param_in_a_tracked_directory_with_missing_dir_file(tmp_dir, dvc):
     tmp_dir.dvc_gen({"dir": {"file": "2"}})
     (tmp_dir / "dvc.yaml").dump({"params": [join("dir", "file")]})
     shutil.rmtree(tmp_dir / "dir")  # remove from workspace

tests/func/repro/test_repro.py

@@ -15,6 +15,7 @@
 from dvc.stage import PipelineStage, Stage
 from dvc.stage.cache import RunCacheNotSupported
 from dvc.stage.exceptions import StageFileDoesNotExistError, StageNotFound
+from dvc.testing import matchers as M
 from dvc.utils.fs import remove
 from dvc.utils.serialize import modify_yaml
 from dvc_data.hashfile.hash import file_md5
@@ -55,7 +56,7 @@ def test_repro_frozen(tmp_dir, dvc, run_copy):
     assert stages == [data_stage, stage0]
 
 
-def test_downstream(M, tmp_dir, dvc):
+def test_downstream(tmp_dir, dvc):
     # The dependency graph should look like this:
     #
     #       E

tests/func/test_data_status.py

@@ -577,7 +577,7 @@ def test_root_from_file_to_dir(tmp_dir, dvc, scm):
     }
 
 
-def test_empty_dir(tmp_dir, scm, dvc, M):
+def test_empty_dir(tmp_dir, scm, dvc):
     # regression testing for https://github.com/treeverse/dvc/issues/8958
     tmp_dir.dvc_gen({"data": {"foo": "foo"}})
     remove("data")

tests/func/test_import_db.py

@@ -6,6 +6,8 @@
 import pytest
 from funcy import compact
 
+from dvc.testing import matchers as M
+
 
 @pytest.fixture
 def db_path(tmp_dir):
@@ -46,7 +48,7 @@ def load_data(file, output_format):
         ({"table": "model"}, "model"),
     ],
 )
-def test(M, tmp_dir, scm, dvc, db_connection, seed_db, output_format, args, file_name):
+def test(tmp_dir, scm, dvc, db_connection, seed_db, output_format, args, file_name):
     seed_db(values=range(5))
     if output_format == "json":
         file_size = 96, 192

tests/func/test_ls.py

@@ -10,6 +10,7 @@
 from dvc.repo import Repo
 from dvc.repo.ls import _ls_tree, ls_tree
 from dvc.scm import CloneError
+from dvc.testing import matchers as M
 
 FS_STRUCTURE = {
     "README.md": "content",
@@ -460,7 +461,7 @@ def test_ls_shows_pipeline_tracked_outs(tmp_dir, dvc, scm, run_copy):
     match_files(files, ((("bar",), True),))
 
 
-def test_ls_granular(erepo_dir, M):
+def test_ls_granular(erepo_dir):
     with erepo_dir.chdir():
         erepo_dir.dvc_gen(
             {
@@ -624,7 +625,7 @@ def _list_files(repo, path=None):
     assert _list_files(subrepo, "dvc_dir") == {"lorem"}
 
 
-def test_broken_symlink(tmp_dir, dvc, M):
+def test_broken_symlink(tmp_dir, dvc):
     from dvc.fs import system
 
     tmp_dir.gen("file", "content")
@@ -654,7 +655,7 @@ def test_broken_symlink(tmp_dir, dvc, M):
     ]
 
 
-def test_ls_broken_dir(tmp_dir, dvc, M):
+def test_ls_broken_dir(tmp_dir, dvc):
     from dvc_data.index import DataIndexDirError
 
     tmp_dir.dvc_gen(
@@ -836,7 +837,7 @@ def _simplify_tree(files):
     return ret
 
 
-def test_ls_tree(M, tmp_dir, scm, dvc):
+def test_ls_tree(tmp_dir, scm, dvc):
     tmp_dir.scm_gen(FS_STRUCTURE, commit="init")
     tmp_dir.dvc_gen(DVC_STRUCTURE, commit="dvc")
 
@@ -887,7 +888,7 @@ def test_ls_tree(M, tmp_dir, scm, dvc):
     }
 
 
-def test_ls_tree_dvc_only(M, tmp_dir, scm, dvc):
+def test_ls_tree_dvc_only(tmp_dir, scm, dvc):
     tmp_dir.scm_gen(FS_STRUCTURE, commit="init")
     tmp_dir.dvc_gen(DVC_STRUCTURE, commit="dvc")
 
@@ -905,7 +906,7 @@ def test_ls_tree_dvc_only(M, tmp_dir, scm, dvc):
     assert _simplify_tree(files) == expected
 
 
-def test_ls_tree_maxdepth(M, tmp_dir, scm, dvc):
+def test_ls_tree_maxdepth(tmp_dir, scm, dvc):
     tmp_dir.scm_gen(FS_STRUCTURE, commit="init")
     tmp_dir.dvc_gen(DVC_STRUCTURE, commit="dvc")
 

tests/func/test_virtual_directory.py

@@ -166,7 +166,7 @@ def test_virtual_update_noop(tmp_dir, dvc, remote):
     assert not dvc.push()
 
 
-def test_partial_checkout_and_update(M, tmp_dir, dvc, remote):
+def test_partial_checkout_and_update(tmp_dir, dvc, remote):
     dir1 = {f"{i}.txt": f"dir1 {i}" for i in range(10)}
     dir2 = {f"{i}.txt": f"dir2 {i}" for i in range(10)}
     tmp_dir.gen({"dir": {"foo": "foo", "subdir": dir1, "subdir2": dir2}})