tenzir-test 0.9.3__tar.gz → 0.9.4__tar.gz

{tenzir_test-0.9.3 → tenzir_test-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tenzir-test
-Version: 0.9.3
+Version: 0.9.4
 Summary: Reusable test execution framework extracted from the Tenzir repository.
 Project-URL: Homepage, https://github.com/tenzir/test
 Project-URL: Repository, https://github.com/tenzir/test

tenzir_test-0.9.4/example-project/tests/fail.tql

@@ -0,0 +1,3 @@
+from {x: "foo"}
+repeat 10
+enumerate

tenzir_test-0.9.4/example-project/tests/fail.txt

@@ -0,0 +1,28 @@
+{
+  "#": 0,
+  x: "foo",
+}
+{
+  "#": 1,
+  x: "foo",
+}
+{
+  "#": -1,
+  x: "qux",
+}
+{
+  "#": 3,
+  x: "foo",
+}
+{
+  "#": 4,
+  x: "foo",
+}
+{
+  "#": -1,
+  x: "foo",
+}
+{
+  "#": -1,
+  x: "baz",
+}

{tenzir_test-0.9.3 → tenzir_test-0.9.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tenzir-test"
-version = "0.9.3"
+version = "0.9.4"
 description = "Reusable test execution framework extracted from the Tenzir repository."
 readme = "README.md"
 requires-python = ">=3.12"

{tenzir_test-0.9.3 → tenzir_test-0.9.4}/src/tenzir_test/cli.py

@@ -90,6 +90,18 @@ def _normalize_exit_code(value: object) -> int:
     is_flag=True,
     help="Show an aggregate table and detailed failure summary after execution.",
 )
+@click.option(
+    "--diff/--no-diff",
+    "show_diff_output",
+    default=True,
+    help="Show unified diffs when expectations differ.",
+)
+@click.option(
+    "--diff-stat/--no-diff-stat",
+    "show_diff_stat",
+    default=True,
+    help="Include per-file diff statistics and change counters when expectations differ.",
+)
 @click.option(
     "-k",
     "--keep",
@@ -134,6 +146,8 @@ def cli(
     runner_summary: bool,
     fixture_summary: bool,
     show_summary: bool,
+    show_diff_output: bool,
+    show_diff_stat: bool,
     keep_tmp_dirs: bool,
     jobs: int,
     passthrough: bool,
@@ -157,6 +171,8 @@ def cli(
         runner_summary=runner_summary,
         fixture_summary=fixture_summary,
         show_summary=show_summary,
+        show_diff_output=show_diff_output,
+        show_diff_stat=show_diff_stat,
         keep_tmp_dirs=keep_tmp_dirs,
         jobs=jobs,
         passthrough=passthrough,

{tenzir_test-0.9.3 → tenzir_test-0.9.4}/src/tenzir_test/run.py

@@ -351,6 +351,30 @@ _TMP_BASE_DIRS: set[Path] = set()
 _ACTIVE_TMP_DIRS: set[Path] = set()
 KEEP_TMP_DIRS = bool(os.environ.get(_TMP_KEEP_ENV_VAR))
 
+SHOW_DIFF_OUTPUT = True
+SHOW_DIFF_STAT = True
+_BLOCK_INDENT = ""
+_PLUS_SYMBOLS = {1: "□", 10: "▣", 100: "■"}
+_MINUS_SYMBOLS = {1: "□", 10: "▣", 100: "■"}
+
+
+def set_show_diff_output(enabled: bool) -> None:
+    global SHOW_DIFF_OUTPUT
+    SHOW_DIFF_OUTPUT = enabled
+
+
+def should_show_diff_output() -> bool:
+    return SHOW_DIFF_OUTPUT
+
+
+def set_show_diff_stat(enabled: bool) -> None:
+    global SHOW_DIFF_STAT
+    SHOW_DIFF_STAT = enabled
+
+
+def should_show_diff_stat() -> bool:
+    return SHOW_DIFF_STAT
+
 
 def set_harness_mode(mode: HarnessMode) -> None:
     """Set the global harness execution mode."""
@@ -2015,10 +2039,9 @@ def _summarize_harness_configuration(
     runner_summary: bool,
     fixture_summary: bool,
     passthrough: bool,
-) -> tuple[int, str]:
+) -> tuple[int, str, str]:
     enabled_flags: list[str] = []
     toggles = (
-        ("update", update),
         ("coverage", coverage),
         ("debug", debug),
         ("summary", show_summary),
@@ -2029,9 +2052,13 @@ def _summarize_harness_configuration(
     for name, flag in toggles:
         if flag:
             enabled_flags.append(name)
-    if passthrough:
-        enabled_flags.append("passthrough")
-    return jobs, ", ".join(enabled_flags)
+    if update:
+        verb = "updating"
+    elif passthrough:
+        verb = "showing"
+    else:
+        verb = "running"
+    return jobs, ", ".join(enabled_flags), verb
 
 
 def _relativize_path(path: Path) -> Path:
@@ -2395,7 +2422,46 @@ def last_and(items: Iterable[T]) -> Iterator[tuple[bool, T]]:
     for item in iterator:
         yield (False, previous)
         previous = item
-    yield (True, previous)
+
+
+def _format_unary_symbols(count: int, symbols: dict[int, str]) -> str:
+    if count <= 0:
+        return ""
+    hundreds, remainder = divmod(count, 100)
+    tens, ones = divmod(remainder, 10)
+    parts: list[str] = []
+    if hundreds:
+        parts.append(symbols[100] * hundreds)
+    if tens:
+        parts.append(symbols[10] * tens)
+    if ones:
+        parts.append(symbols[1] * ones)
+    return "".join(parts)
+
+
+def _format_diff_counter(added: int, removed: int) -> str:
+    plus_segment = _format_unary_symbols(added, _PLUS_SYMBOLS)
+    minus_segment = _format_unary_symbols(removed, _MINUS_SYMBOLS)
+    colored_plus = f"\033[32m{plus_segment}\033[0m" if plus_segment else ""
+    colored_minus = f"\033[31m{minus_segment}\033[0m" if minus_segment else ""
+    return f"{colored_plus}{colored_minus}"
+
+
+def _format_stat_header(path: os.PathLike[str] | str, added: int, removed: int) -> str:
+    path_str = os.fspath(path)
+    counter = _format_diff_counter(added, removed)
+    plus_count = f"\033[32m{added}(+)\033[0m"
+    minus_count = f"\033[31m{removed}(-)\033[0m"
+    if counter:
+        counter_segment = f" {counter}"
+    else:
+        counter_segment = ""
+    return f"{_BLOCK_INDENT}┌ {path_str} {plus_count}/{minus_count}{counter_segment}"
+
+
+def _format_lines_changed(total: int) -> str:
+    line = "line" if total == 1 else "lines"
+    return f"{_BLOCK_INDENT}└ {total} {line} changed"
 
 
 def print_diff(expected: bytes, actual: bytes, path: Path) -> None:
@@ -2409,22 +2475,51 @@ def print_diff(expected: bytes, actual: bytes, path: Path) -> None:
             n=2,
         )
     )
-    with stdout_lock:
-        rel_path = _relativize_path(path)
+    added = sum(
+        1
+        for index, line in enumerate(diff)
+        if index >= 2 and line.startswith(b"+") and not line.startswith(b"+++")
+    )
+    removed = sum(
+        1
+        for index, line in enumerate(diff)
+        if index >= 2 and line.startswith(b"-") and not line.startswith(b"---")
+    )
+    show_stat = should_show_diff_stat()
+    show_diff = should_show_diff_output()
+    diff_lines: list[str] = []
+    if should_show_diff_output():
         skip = 2
-        for i, line in enumerate(diff):
+        for raw_line in diff:
             if skip > 0:
                 skip -= 1
                 continue
-            if line.startswith(b"@@"):
-                print(f"┌─▶ \033[31m{rel_path}\033[0m")
-                continue
-            if line.startswith(b"+"):
-                line = b"\033[92m" + line + b"\033[0m"
-            elif line.startswith(b"-"):
-                line = b"\033[31m" + line + b"\033[0m"
-            prefix = ("│ " if i != len(diff) - 1 else "└─").encode()
-            sys.stdout.buffer.write(prefix + line)
+            text = raw_line.decode("utf-8", "replace").rstrip("\r\n")
+            if raw_line.startswith(b"+") and not raw_line.startswith(b"+++"):
+                text = f"\033[32m{text}\033[0m"
+            elif raw_line.startswith(b"-") and not raw_line.startswith(b"---"):
+                text = f"\033[31m{text}\033[0m"
+            diff_lines.append(text)
+    rel_path = _relativize_path(path)
+    rel_path_str = os.fspath(rel_path)
+    lines: list[str] = []
+    total_changed = added + removed
+    if not show_stat and not show_diff:
+        return
+    header = (
+        _format_stat_header(rel_path, added, removed)
+        if show_stat
+        else f"{_BLOCK_INDENT}┌ {rel_path_str}"
+    )
+    lines.append(header)
+    if show_diff and diff_lines:
+        for diff_line in diff_lines:
+            lines.append(f"{_BLOCK_INDENT}│ {diff_line}")
+    if show_stat or (show_diff and total_changed > 0):
+        lines.append(_format_lines_changed(total_changed))
+    with stdout_lock:
+        for output_line in lines:
+            print(output_line)
 
 
 def check_group_is_empty(pgid: int) -> None:
@@ -2889,6 +2984,8 @@ def run_cli(
     runner_summary: bool,
     fixture_summary: bool,
     show_summary: bool,
+    show_diff_output: bool,
+    show_diff_stat: bool,
     jobs: int,
     keep_tmp_dirs: bool,
     passthrough: bool,
@@ -2937,6 +3034,8 @@ def run_cli(
             fixture_logger.propagate = True
 
         set_keep_tmp_dirs(bool(os.environ.get(_TMP_KEEP_ENV_VAR)) or keep_tmp_dirs)
+        set_show_diff_output(show_diff_output)
+        set_show_diff_stat(show_diff_stat)
         if passthrough:
             harness_mode = HarnessMode.PASSTHROUGH
         elif update:
@@ -3122,7 +3221,7 @@ def run_cli(
                 queue = _build_queue_from_paths(collected_paths, coverage=coverage)
                 queue.sort(key=_queue_sort_key, reverse=True)
                 project_queue_size = _count_queue_tests(queue)
-                job_count, enabled_flags = _summarize_harness_configuration(
+                job_count, enabled_flags, verb = _summarize_harness_configuration(
                     jobs=jobs,
                     update=update,
                     coverage=coverage,
@@ -3159,6 +3258,7 @@ def run_cli(
                     queue_size=project_queue_size,
                     job_count=job_count,
                     enabled_flags=enabled_flags,
+                    verb=verb,
                 )
                 count_width = max((len(str(count)) for _, count, _ in runner_breakdown), default=1)
                 for name, count, version in runner_breakdown:
@@ -3266,6 +3366,7 @@ def _print_project_start(
     queue_size: int,
     job_count: int,
     enabled_flags: str,
+    verb: str,
 ) -> None:
     project_name = selection.root.name or selection.root.as_posix()
     if selection.kind == "root":
@@ -3284,5 +3385,5 @@ def _print_project_start(
     toggles = f"; {enabled_flags}" if enabled_flags else ""
     jobs_segment = f" ({job_count} jobs)" if job_count else ""
     print(
-        f"{INFO} {project_display}: running {queue_size} tests{jobs_segment} from {project_kind} at {location_display}{toggles}"
+        f"{INFO} {project_display}: {verb} {queue_size} tests{jobs_segment} from {project_kind} at {location_display}{toggles}"
     )

{tenzir_test-0.9.3 → tenzir_test-0.9.4}/tests/test_cli.py

@@ -38,6 +38,7 @@ def test_cli_keep_flag(monkeypatch: pytest.MonkeyPatch) -> None:
     assert captured["jobs_overridden"] is False
     assert captured["all_projects"] is False
     assert captured["show_summary"] is False
+    assert captured["show_diff_stat"] is True
 
 
 def test_cli_passthrough_flag(monkeypatch: pytest.MonkeyPatch) -> None:
@@ -109,6 +110,31 @@ def test_cli_summary_flag(monkeypatch: pytest.MonkeyPatch) -> None:
     assert captured["show_summary"] is True
 
 
+def test_cli_no_diff_flag(monkeypatch: pytest.MonkeyPatch) -> None:
+    captured: dict[str, object] = {}
+
+    def fake_run_cli(**kwargs: object) -> None:
+        captured.update(kwargs)
+
+    monkeypatch.setattr(cli.runtime, "run_cli", fake_run_cli)
+
+    assert cli.main(["--no-diff"]) == 0
+    assert captured["show_diff_output"] is False
+    assert captured["show_diff_stat"] is True
+
+
+def test_cli_no_diff_stat_flag(monkeypatch: pytest.MonkeyPatch) -> None:
+    captured: dict[str, object] = {}
+
+    def fake_run_cli(**kwargs: object) -> None:
+        captured.update(kwargs)
+
+    monkeypatch.setattr(cli.runtime, "run_cli", fake_run_cli)
+
+    assert cli.main(["--no-diff-stat"]) == 0
+    assert captured["show_diff_stat"] is False
+
+
 def test_cli_version_flag(capsys: pytest.CaptureFixture[str]) -> None:
     exit_code = cli.main(["--version"])
     assert exit_code == 0

{tenzir_test-0.9.3 → tenzir_test-0.9.4}/tests/test_run.py

@@ -769,6 +769,8 @@ def test_cli_rejects_partial_suite_selection(
                 runner_summary=False,
                 fixture_summary=False,
                 show_summary=False,
+                show_diff_output=True,
+                show_diff_stat=True,
                 jobs=1,
                 keep_tmp_dirs=False,
                 passthrough=False,
@@ -793,6 +795,8 @@ def test_cli_rejects_partial_suite_selection(
                 runner_summary=False,
                 fixture_summary=False,
                 show_summary=False,
+                show_diff_output=True,
+                show_diff_stat=True,
                 jobs=1,
                 keep_tmp_dirs=False,
                 passthrough=False,
@@ -828,6 +832,82 @@ def test_detailed_summary_order(capsys):
     assert skipped_index < failed_index < table_start
 
 
+def test_print_diff_default_layout(capsys):
+    original_show_diff = run.should_show_diff_output()
+    original_show_stat = run.should_show_diff_stat()
+    try:
+        run.set_show_diff_output(True)
+        run.set_show_diff_stat(True)
+        run.print_diff(b"line\nbeta\n", b"line\ngamma\n", Path("tests/example.txt"))
+    finally:
+        run.set_show_diff_output(original_show_diff)
+        run.set_show_diff_stat(original_show_stat)
+
+    output = capsys.readouterr().out.splitlines()
+    assert output[0].startswith(f"{run._BLOCK_INDENT}┌ tests/example.txt")
+    expected_counter = run._format_diff_counter(1, 1)
+    assert "\033[32m1(+)\033[0m/\033[31m1(-)\033[0m" in output[0]
+    assert output[0].endswith(expected_counter)
+    assert output[1] == f"{run._BLOCK_INDENT}│ @@ -1,2 +1,2 @@"
+    assert output[2] == f"{run._BLOCK_INDENT}│  line"
+    assert output[3].startswith(f"{run._BLOCK_INDENT}│ \033[31m-beta")
+    assert output[4].startswith(f"{run._BLOCK_INDENT}│ \033[32m+gamma")
+    assert output[5] == f"{run._BLOCK_INDENT}└ 2 lines changed"
+
+
+def test_print_diff_no_diff_outputs_stat_only(capsys):
+    original_show_diff = run.should_show_diff_output()
+    original_show_stat = run.should_show_diff_stat()
+    try:
+        run.set_show_diff_output(False)
+        run.set_show_diff_stat(True)
+        run.print_diff(b"line\nbeta\n", b"line\ngamma\n", Path("tests/example.txt"))
+    finally:
+        run.set_show_diff_output(original_show_diff)
+        run.set_show_diff_stat(original_show_stat)
+
+    output = capsys.readouterr().out.splitlines()
+    expected_header = (
+        f"{run._BLOCK_INDENT}┌ tests/example.txt "
+        f"\033[32m1(+)\033[0m/\033[31m1(-)\033[0m {run._format_diff_counter(1, 1)}"
+    )
+    assert output == [
+        expected_header,
+        f"{run._BLOCK_INDENT}└ 2 lines changed",
+    ]
+
+
+def test_print_diff_stat_disabled_shows_only_diff(capsys):
+    original_show_diff = run.should_show_diff_output()
+    original_show_stat = run.should_show_diff_stat()
+    try:
+        run.set_show_diff_output(True)
+        run.set_show_diff_stat(False)
+        run.print_diff(b"line\nbeta\n", b"line\ngamma\n", Path("tests/example.txt"))
+    finally:
+        run.set_show_diff_output(original_show_diff)
+        run.set_show_diff_stat(original_show_stat)
+
+    output = capsys.readouterr().out.splitlines()
+    assert output[0] == f"{run._BLOCK_INDENT}┌ tests/example.txt"
+    assert output[1] == f"{run._BLOCK_INDENT}│ @@ -1,2 +1,2 @@"
+    assert output[-1] == f"{run._BLOCK_INDENT}└ 2 lines changed"
+
+
+def test_print_diff_disabled_outputs_nothing(capsys):
+    original_show_diff = run.should_show_diff_output()
+    original_show_stat = run.should_show_diff_stat()
+    try:
+        run.set_show_diff_output(False)
+        run.set_show_diff_stat(False)
+        run.print_diff(b"line\nbeta\n", b"line\ngamma\n", Path("tests/example.txt"))
+    finally:
+        run.set_show_diff_output(original_show_diff)
+        run.set_show_diff_stat(original_show_stat)
+
+    assert capsys.readouterr().out.strip() == ""
+
+
 def test_describe_project_root_detects_standard_project(tmp_path: Path) -> None:
     project_root = tmp_path / "proj"
     tests_dir = project_root / "tests"
@@ -1143,6 +1223,7 @@ def test_print_project_start_reports_empty_projects(tmp_path, capsys):
         queue_size=0,
         job_count=0,
         enabled_flags="",
+        verb="running",
     )
 
     output = capsys.readouterr().out
@@ -1152,6 +1233,66 @@ def test_print_project_start_reports_empty_projects(tmp_path, capsys):
     )
 
 
+def test_summarize_harness_configuration_sets_update_verb() -> None:
+    job_count, enabled_flags, verb = run._summarize_harness_configuration(
+        jobs=1,
+        update=True,
+        coverage=False,
+        debug=False,
+        show_summary=False,
+        runner_summary=False,
+        fixture_summary=False,
+        passthrough=False,
+    )
+
+    assert job_count == 1
+    assert "update" not in enabled_flags
+    assert verb == "updating"
+
+
+def test_summarize_harness_configuration_sets_passthrough_verb() -> None:
+    job_count, enabled_flags, verb = run._summarize_harness_configuration(
+        jobs=2,
+        update=False,
+        coverage=False,
+        debug=False,
+        show_summary=False,
+        runner_summary=False,
+        fixture_summary=False,
+        passthrough=True,
+    )
+
+    assert job_count == 2
+    assert "passthrough" not in enabled_flags
+    assert verb == "showing"
+
+
+def test_print_project_start_uses_custom_verb(tmp_path, capsys):
+    project_root = tmp_path / "example"
+    project_root.mkdir()
+    selection = run.ProjectSelection(
+        root=project_root,
+        selectors=[],
+        run_all=True,
+        kind="root",
+    )
+
+    run._print_project_start(
+        selection=selection,
+        display_base=tmp_path,
+        queue_size=3,
+        job_count=0,
+        enabled_flags="",
+        verb="showing",
+    )
+
+    output = capsys.readouterr().out
+    assert (
+        output
+        == f"{run.INFO} {run.BOLD}example{run.RESET_COLOR}: showing 3 tests from root project at ./example\n"
+    )
+
+
 def test_execution_plan_single_project_summary(tmp_path, monkeypatch, capsys):
     root = tmp_path
     plan = run.ExecutionPlan(