change: show diff when output differs

Author: noave

pyproject.toml

@@ -23,6 +23,7 @@ dependencies = [
   "pexpect==4.*",
   "termcolor==2.*",
   "PyYAML>=6",
+  "rich>=14",
 ]
 dynamic = ["version"]
 

src/shellinspector/reporter.py

@@ -2,12 +2,19 @@
 import os
 import sys
 from pathlib import Path
+import rich
 
 from termcolor import colored
 
 from shellinspector.logging import get_logger
 from shellinspector.runner import RunnerEvent
 
+import difflib
+
+from rich.console import Console
+from rich.syntax import Syntax
+from rich.padding import Padding
+
 LOGGER = get_logger(Path(__file__).name)
 
 
@@ -16,6 +23,7 @@ def __init__(self, only_show_failed_runs=False):
         self.has_unfinished_line = False
         self.only_show_failed_runs = only_show_failed_runs
         self.buffer = []
+        self.rich_console = Console()
 
     def print_indented(self, prefix, text, color):
         if not text:
@@ -81,21 +89,41 @@ def __call__(self, event, cmd, **kwargs):
         elif event == RunnerEvent.COMMAND_FAILED:
             self.print(colored(f"{prefix} FAIL {line}", "red"))
             if "message" in kwargs:
-                self.print(colored(f'  {kwargs["message"]}', "red"))
+                self.print(colored(f"  {kwargs['message']}", "red"))
             if "returncode" in kwargs["reasons"]:
                 rc = kwargs["returncode"]
                 self.print(colored("  command failed", "red"))
                 self.print(colored("    expected: 0", "light_grey"))
                 self.print(colored(f"    actual:   {rc}", "light_grey"))
                 self.print_indented("    output:", kwargs["actual"], "white")
             if "output" in kwargs["reasons"]:
+                expected = cmd.get_expected_with_vars(kwargs.get("env", {}))
+                actual = kwargs["actual"]
+
                 self.print(colored("  output did not match", "red"))
                 self.print_indented(
-                    "    expected:",
-                    cmd.get_expected_with_vars(kwargs.get("env", {})),
+                    "  expected:",
+                    expected,
                     "light_grey",
                 )
-                self.print_indented("    actual:", kwargs["actual"], "white")
+                self.print_indented("  actual:", actual, "white")
+
+                self.print(colored("  diff:", "white"))
+                diff = difflib.unified_diff(
+                    expected.splitlines(),
+                    actual.splitlines(),
+                    fromfile="expected",
+                    tofile="actual",
+                    lineterm="",
+                    n=0,
+                )
+                diff_syntax = Syntax(
+                    "\n".join(diff),
+                    "diff",
+                    theme="monokai",
+                    background_color="default",
+                )
+                self.rich_console.print(Padding(diff_syntax, (0, 0, 0, 4)))
         elif event == RunnerEvent.RUN_FAILED:
             self._print_buffer()
         elif event == RunnerEvent.RUN_SUCCEEDED: