Replace verify_canvas_matches_reference with enhanced capture_and_verify_baseline in Playwright tests; refactor to support optional timeout handling and remove redundant method.

Author: StevenSchlechte

tests/acceptance/test_tracks_add_and_display.py

@@ -14,7 +14,6 @@
     load_main_page,
     reset_date_filter,
     setup_tracks_display,
-    verify_canvas_matches_reference,
     verify_filter_active,
     verify_filter_inactive,
     verify_filter_range_label_cleared,
@@ -78,9 +77,9 @@ def test_add_tracks_and_display_all(
     wait_for_canvas_change(page, canvas, canvas_before_tracks)
 
     # Capture and compare with reference image
-    verify_canvas_matches_reference(
-        canvas, acceptance_test_data_folder, ALL_TRACKS_FILE_NAME
-    )
+    actual_path = acceptance_test_data_folder / "new_file.png"
+    reference_path = acceptance_test_data_folder / ALL_TRACKS_FILE_NAME
+    capture_and_verify_baseline(canvas, actual_path, reference_path)
 
 
 @pytest.mark.skip(reason="only works in headed right now")
@@ -126,7 +125,7 @@ def test_filter_tracks_by_date(
     # Capture baseline and verify against reference
     reference_screenshot = acceptance_test_data_folder / ALL_TRACKS_FILE_NAME
     canvas_with_all_tracks = capture_and_verify_baseline(
-        page, canvas, actual_screenshot_path, reference_screenshot
+        canvas, actual_screenshot_path, reference_screenshot, page
     )
 
     # Apply date filter
@@ -140,9 +139,9 @@ def test_filter_tracks_by_date(
     wait_for_canvas_change(page, canvas, canvas_with_all_tracks)
 
     # Capture and compare with reference image
-    verify_canvas_matches_reference(
-        canvas, acceptance_test_data_folder, FILTERED_TRACKS_FILE_NAME
-    )
+    filtered_actual_path = acceptance_test_data_folder / "new_filtered_file.png"
+    filtered_reference_path = acceptance_test_data_folder / FILTERED_TRACKS_FILE_NAME
+    capture_and_verify_baseline(canvas, filtered_actual_path, filtered_reference_path)
 
 
 @pytest.mark.skip(reason="only works in headed right now")
@@ -170,9 +169,9 @@ def test_toggle_intersection_layers(
     page.wait_for_timeout(PLAYWRIGHT_VISIBLE_TIMEOUT_MS)
 
     # Capture screenshot and verify against reference
-    verify_canvas_matches_reference(
-        canvas, acceptance_test_data_folder, ALL_TRACKS_FILE_NAME
-    )
+    actual_path = acceptance_test_data_folder / "new_file.png"
+    reference_path = acceptance_test_data_folder / ALL_TRACKS_FILE_NAME
+    capture_and_verify_baseline(canvas, actual_path, reference_path)
 
 
 @pytest.mark.skip(reason="only works in headed right now")

tests/utils/playwright_helpers.py

@@ -1081,20 +1081,20 @@ def _verify_screenshot_against_reference(
 
 
 def capture_and_verify_baseline(
-    page: Page,
     canvas: Any,
     actual_screenshot_path: Path,
     reference_screenshot: Path,
+    page: Page | None = None,
     *,
     timeout_ms: int = PLAYWRIGHT_VISIBLE_TIMEOUT_MS,
 ) -> bytes:
     """Capture canvas screenshot and verify against reference baseline.
 
     Args:
-        page: Playwright page object
         canvas: Canvas locator
         actual_screenshot_path: Path to save actual screenshot
         reference_screenshot: Path to reference screenshot file
+        page: Optional Playwright page object for timeout
         timeout_ms: Timeout in milliseconds to wait before taking screenshot
 
     Returns:
@@ -1104,7 +1104,8 @@ def capture_and_verify_baseline(
         pytest.skip: If reference screenshot doesn't exist
         AssertionError: If screenshots don't match within tolerance
     """
-    page.wait_for_timeout(timeout_ms)
+    if page and timeout_ms:
+        page.wait_for_timeout(timeout_ms)
     canvas_screenshot = canvas.screenshot(path=actual_screenshot_path)
     _verify_screenshot_against_reference(actual_screenshot_path, reference_screenshot)
     return canvas_screenshot
@@ -1116,26 +1117,6 @@ def verify_filter_range_label_visible(page: Page) -> None:
     range_label.wait_for(state="visible", timeout=PLAYWRIGHT_QUICK_VISIBLE_TIMEOUT_MS)
 
 
-def verify_canvas_matches_reference(
-    canvas: Any, acceptance_test_data_folder: Path, all_tracks_filename: str
-) -> None:
-    """Take screenshot and verify it matches the expected baseline.
-
-    Args:
-        canvas: Canvas locator
-        acceptance_test_data_folder: Path to folder with test data
-        all_tracks_filename: Name of reference screenshot file
-
-    Raises:
-        pytest.skip: If reference screenshot doesn't exist
-        AssertionError: If screenshots don't match within tolerance
-    """
-    actual_path = acceptance_test_data_folder / "new_file.png"
-    reference_path = acceptance_test_data_folder / all_tracks_filename
-    canvas.screenshot(path=actual_path)
-    _verify_screenshot_against_reference(actual_path, reference_path)
-
-
 def reset_date_filter(page: Page) -> None:
     """Reset the date filter by clicking Reset button and unchecking checkbox."""