Add snapshot tests. (#475)

Author: tobiasraabe

.pre-commit-config.yaml

@@ -16,6 +16,7 @@ repos:
     -   id: no-commit-to-branch
         args: [--branch, main]
     -   id: trailing-whitespace
+        exclude: (__snapshots__)
 -   repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:

environment.yml

@@ -35,6 +35,7 @@ dependencies:
   - pytest-cov
   - pytest-env
   - pytest-xdist
+  - syrupy
   - tabulate
   - tox
 

src/_pytask/dag.py

@@ -234,7 +234,7 @@ def _check_if_root_nodes_are_available(dag: nx.DiGraph, paths: Sequence[Path]) -
                 try:
                     node_exists = dag.nodes[node]["node"].state()
                 except Exception as e:  # noqa: BLE001
-                    msg = _format_exception_from_failed_node_state(node, dag)
+                    msg = _format_exception_from_failed_node_state(node, dag, paths)
                     raise ResolvingDependenciesError(msg) from e
                 if not node_exists:
                     missing_root_nodes.append(node)
@@ -256,13 +256,13 @@ def _check_if_root_nodes_are_available(dag: nx.DiGraph, paths: Sequence[Path]) -
 
 
 def _format_exception_from_failed_node_state(
-    node_signature: str, dag: nx.DiGraph
+    node_signature: str, dag: nx.DiGraph, paths: Sequence[Path]
 ) -> str:
     """Format message when ``node.state()`` threw an exception."""
     tasks = [dag.nodes[i]["task"] for i in dag.successors(node_signature)]
     names = [task.name for task in tasks]
     successors = ", ".join([f"{name!r}" for name in names])
-    node_name = dag.nodes[node_signature]["node"].name
+    node_name = format_node_name(dag.nodes[node_signature]["node"], paths).plain
     return (
         f"While checking whether dependency {node_name!r} from task(s) "
         f"{successors} exists, an error was raised."

tests/__snapshots__/test_collect_command.ambr

@@ -0,0 +1,27 @@
+# serializer version: 1
+# name: test_more_nested_pytree_and_python_node_as_return
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 1 task.
+  
+  Collected tasks:
+  └── 🐍 <Module test_more_nested_pytree_and_py0/task_module.py>
+      └── 📝 <Function task_module.py::task_example>
+          ├── 📄 <Product 
+          │   test_more_nested_pytree_and_py0/task_module.py::task_example::return
+          │   ::0>
+          ├── 📄 <Product 
+          │   test_more_nested_pytree_and_py0/task_module.py::task_example::return
+          │   ::1-0>
+          ├── 📄 <Product 
+          │   test_more_nested_pytree_and_py0/task_module.py::task_example::return
+          │   ::1-1>
+          └── 📄 <Product 
+              test_more_nested_pytree_and_py0/task_module.py::task_example::return
+              ::2>
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---

tests/__snapshots__/test_dag.ambr

@@ -0,0 +1,141 @@
+# serializer version: 1
+# name: test_check_if_root_nodes_are_available
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 1 task.
+  
+  ──────────────────── Failures during resolving dependencies ────────────────────
+  
+  ResolvingDependenciesError: Some dependencies do not exist or are not produced 
+  by any task. See the following tree which shows which dependencies are missing 
+  for which tasks.
+  
+  Missing dependencies:
+  └── 📄 test_check_if_root_nodes_are_a0/in.txt
+      └── 📝 task_d.py::task_d
+  
+  
+  (Hint: Your file-system is case-sensitive. Check the paths' capitalization 
+  carefully.)
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---
+# name: test_check_if_root_nodes_are_available_w_name
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 1 task.
+  
+  ──────────────────── Failures during resolving dependencies ────────────────────
+  
+  ResolvingDependenciesError: Some dependencies do not exist or are not produced 
+  by any task. See the following tree which shows which dependencies are missing 
+  for which tasks.
+  
+  Missing dependencies:
+  └── 📄 input1
+      └── 📝 task_e.py::task_e
+  
+  
+  (Hint: Your file-system is case-sensitive. Check the paths' capitalization 
+  carefully.)
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---
+# name: test_check_if_root_nodes_are_available_with_separate_build_folder
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 1 task.
+  
+  ──────────────────── Failures during resolving dependencies ────────────────────
+  
+  ResolvingDependenciesError: Some dependencies do not exist or are not produced 
+  by any task. See the following tree which shows which dependencies are missing 
+  for which tasks.
+  
+  Missing dependencies:
+  └── 📄 test_check_if_root_nodes_are_a2/bld/in.txt
+      └── 📝 task_d.py::task_d
+  
+  
+  (Hint: Your file-system is case-sensitive. Check the paths' capitalization 
+  carefully.)
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---
+# name: test_cycle_in_dag
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 2 tasks.
+  
+  ──────────────────── Failures during resolving dependencies ────────────────────
+  
+  ResolvingDependenciesError: The DAG contains cycles which means a dependency is 
+  directly or indirectly a product of the same task. See the following the path of
+  nodes in the graph which forms the cycle.
+  
+  task_module.py::task_1
+       ⬇
+  test_cycle_in_dag0/out_1.txt
+       ⬇
+  task_module.py::task_2
+       ⬇
+  test_cycle_in_dag0/out_2.txt
+       ⬇
+  task_module.py::task_1
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---
+# name: test_error_when_node_state_throws_error
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 1 task.
+  
+  ──────────────────── Failures during resolving dependencies ────────────────────
+  
+  TypeError: unhashable type: 'dict'
+  
+  The above exception was the direct cause of the following exception:
+  
+  ResolvingDependenciesError: While checking whether dependency 
+  'test_error_when_node_state_thr0/task_example.py::task_example::a' from task(s) 
+  'task_example.py::task_example' exists, an error was raised.
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---
+# name: test_two_tasks_have_the_same_product
+  '''
+  ───────────────────────────── Start pytask session ─────────────────────────────
+  Platform: <platform> -- Python <version>, pytask <version>, pluggy <version>
+  Root: <path>
+  Collected 2 tasks.
+  
+  ──────────────────── Failures during resolving dependencies ────────────────────
+  
+  ResolvingDependenciesError: There are some tasks which produce the same output. 
+  See the following tree which shows which products are produced by multiple 
+  tasks.
+  
+  Products from multiple tasks:
+  └── 📄 test_two_tasks_have_the_same_p0/out.txt
+      ├── 📝 task_d.py::task_1
+      └── 📝 task_d.py::task_2
+  
+  
+  ────────────────────────────────────────────────────────────────────────────────
+  '''
+# ---

tests/conftest.py

@@ -1,19 +1,54 @@
 from __future__ import annotations
 
+import re
 import sys
 from contextlib import contextmanager
 from pathlib import Path
+from typing import Any
 from typing import Callable
 
 import pytest
 from click.testing import CliRunner
+from packaging import version
+from pytask import console
 
 
 @pytest.fixture(autouse=True)
 def _add_objects_to_doctest_namespace(doctest_namespace):
     doctest_namespace["Path"] = Path
 
 
+@pytest.fixture(autouse=True, scope="session")
+def _path_for_snapshots():
+    console.width = 80
+
+
+def _remove_variable_info_from_output(data: str, path: Any) -> str:  # noqa: ARG001
+    lines = data.splitlines()
+
+    # Remove dynamic versions.
+    index_root = next(i for i, line in enumerate(lines) if line.startswith("Root:"))
+    new_info_line = "".join(lines[1:index_root])
+    for platform in ("linux", "win32", "darwin"):
+        new_info_line = new_info_line.replace(platform, "<platform>")
+    pattern = re.compile(version.VERSION_PATTERN, flags=re.IGNORECASE | re.VERBOSE)
+    new_info_line = re.sub(pattern=pattern, repl="<version>", string=new_info_line)
+
+    # Remove dynamic root path
+    index_collected = next(
+        i for i, line in enumerate(lines) if line.startswith("Collected")
+    )
+    new_root_line = "Root: <path>"
+
+    new_lines = [lines[0], new_info_line, new_root_line, *lines[index_collected:]]
+    return "\n".join(new_lines)
+
+
+@pytest.fixture()
+def snapshot_cli(snapshot):
+    return snapshot.with_defaults(matcher=_remove_variable_info_from_output)
+
+
 class SysPathsSnapshot:
     """A snapshot for sys.path."""
 

tests/test_collect.py

@@ -455,8 +455,6 @@ def task_write_text(depends_on, produces):
 
     result = runner.invoke(cli, [tmp_path.as_posix()])
     assert "FutureWarning" in result.output
-    assert "Using strings to specify a dependency" in result.output
-    assert "Using strings to specify a product" in result.output
 
 
 @pytest.mark.end_to_end()

tests/test_collect_command.py

@@ -2,6 +2,7 @@
 
 import os
 import pickle
+import sys
 import textwrap
 from pathlib import Path
 
@@ -610,7 +611,7 @@ def task_example(
 
 
 @pytest.mark.end_to_end()
-def test_more_nested_pytree_and_python_node_as_return(runner, tmp_path):
+def test_more_nested_pytree_and_python_node_as_return(runner, snapshot_cli, tmp_path):
     source = """
     from pathlib import Path
     from typing import Any
@@ -630,8 +631,5 @@ def task_example() -> Annotated[Dict[str, str], nodes]:
     tmp_path.joinpath("task_module.py").write_text(textwrap.dedent(source))
     result = runner.invoke(cli, ["collect", "--nodes", tmp_path.as_posix()])
     assert result.exit_code == ExitCode.OK
-    output = result.output.replace(" ", "").replace("\n", "").replace("│", "")
-    assert "return::0" in output
-    assert "return::1-0" in output
-    assert "return::1-1" in output
-    assert "return::2" in output
+    if sys.platform != "win32":
+        assert result.output == snapshot_cli()