Add --verbose flag to test-e2e.py

When enabled, this causes the actual and expected outputs to be printed in full if there is a mismatch.
lunarforge · Mar 31, 2024 · 06241c0 · 06241c0
1 parent 78412c1
commit 06241c0
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/tools/test-e2e.py b/tools/test-e2e.py
@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 
-from argparse import ArgumentParser
+from argparse import ArgumentParser, BooleanOptionalAction
 import re
 import os
 from subprocess import run
 import sys
+import textwrap
 import time
 
 
@@ -28,7 +29,7 @@ def extract_text(image_path: str) -> str:
 IMAGE_PAT = "\\.(jpeg|jpg|png|webp)$"
 
 
-def run_tests(test_case_dir: str) -> bool:
+def run_tests(test_case_dir: str, *, verbose=False) -> bool:
     """
     Compare extracted text for image files against expectations.
 
@@ -60,9 +61,16 @@ def run_tests(test_case_dir: str) -> bool:
         text = text.strip()
 
         if text != expected_text:
-            print(f"Actual vs expected mismatch for {fname}")
             errors += 1
 
+            print(f"Actual vs expected mismatch for {fname}")
+
+            if verbose:
+                print("Actual:")
+                print(textwrap.indent(text, "  "))
+                print("Expected:")
+                print(textwrap.indent(expected_text, "  "))
+
     if errors != 0:
         print(f"{errors} tests failed")
 
@@ -78,11 +86,14 @@ def run_tests(test_case_dir: str) -> bool:
 """
 )
 parser.add_argument("dir", help="Directory containing test images and expected outputs")
+parser.add_argument(
+    "-v", "--verbose", action=BooleanOptionalAction, help="Enable verbose logging"
+)
 args = parser.parse_args()
 
 print("Building ocrs...")
 build_ocrs()
-passed = run_tests(args.dir)
+passed = run_tests(args.dir, verbose=args.verbose)
 
 if not passed:
     sys.exit(1)