Note: This is a static example. Full interactivity (task selection, step playback)
requires Alpine.js data bindings. See the benchmark viewer generator for the complete implementation.
diff --git a/src/openadapt_viewer/examples/capture_example.py b/src/openadapt_viewer/examples/capture_example.py
index e53dd85..ff3f8a0 100644
--- a/src/openadapt_viewer/examples/capture_example.py
+++ b/src/openadapt_viewer/examples/capture_example.py
@@ -14,10 +14,6 @@
from openadapt_viewer.builders import PageBuilder
from openadapt_viewer.components import (
metrics_grid,
- screenshot_display,
- playback_controls,
- timeline,
- action_display,
)
diff --git a/src/openadapt_viewer/examples/enhanced_capture_example.py b/src/openadapt_viewer/examples/enhanced_capture_example.py
index e5174bb..8a2b94f 100644
--- a/src/openadapt_viewer/examples/enhanced_capture_example.py
+++ b/src/openadapt_viewer/examples/enhanced_capture_example.py
@@ -119,7 +119,7 @@ def generate_enhanced_capture_viewer(
# Feature 1: Video Playback from Screenshots (HIGH PRIORITY)
# ===================
# Properly escape JSON for HTML attributes to prevent Alpine.js parsing errors
- frames_json = html.escape(json.dumps(frames))
+ html.escape(json.dumps(frames))
builder.add_section(f'''
diff --git a/src/openadapt_viewer/examples/retrieval_example.py b/src/openadapt_viewer/examples/retrieval_example.py
index 2f260fb..7a0b624 100644
--- a/src/openadapt_viewer/examples/retrieval_example.py
+++ b/src/openadapt_viewer/examples/retrieval_example.py
@@ -15,7 +15,6 @@
from openadapt_viewer.components import (
metrics_grid,
screenshot_display,
- selectable_list,
)
diff --git a/src/openadapt_viewer/examples/training_example.py b/src/openadapt_viewer/examples/training_example.py
index d0bed13..c5c44eb 100644
--- a/src/openadapt_viewer/examples/training_example.py
+++ b/src/openadapt_viewer/examples/training_example.py
@@ -46,8 +46,8 @@ def generate_training_dashboard(
evaluations = _generate_sample_evaluations()
# Calculate stats
- min_loss = min(l["loss"] for l in losses) if losses else 0
- avg_loss = sum(l["loss"] for l in losses) / len(losses) if losses else 0
+ min_loss = min(loss["loss"] for loss in losses) if losses else 0
+ avg_loss = sum(loss["loss"] for loss in losses) / len(losses) if losses else 0
total_steps = len(losses)
# Build page
diff --git a/src/openadapt_viewer/viewers/benchmark/generator.py b/src/openadapt_viewer/viewers/benchmark/generator.py
index 6e8b185..8af5ade 100644
--- a/src/openadapt_viewer/viewers/benchmark/generator.py
+++ b/src/openadapt_viewer/viewers/benchmark/generator.py
@@ -4,7 +4,6 @@
benchmark evaluation results with interactive features.
"""
-import json
from pathlib import Path
from typing import Optional
diff --git a/tests/test_screenshot_generation.py b/tests/test_screenshot_generation.py
new file mode 100644
index 0000000..e74c77c
--- /dev/null
+++ b/tests/test_screenshot_generation.py
@@ -0,0 +1,311 @@
+"""Tests for README screenshot generation.
+
+This test verifies that:
+1. The screenshot generation script can run successfully
+2. Dependencies are properly configured
+3. We catch failures early in CI before screenshots break
+
+Note: This test requires openadapt-capture to be installed and
+capture directories to exist. In CI, these tests may be skipped
+if captures are not available.
+"""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+from pathlib import Path
+
+import pytest
+
+REPO_ROOT = Path(__file__).parent.parent
+SCRIPT_PATH = REPO_ROOT / "scripts" / "generate_readme_screenshots.py"
+CAPTURE_DIR = Path("/Users/abrichr/oa/src/openadapt-capture")
+
+
+@pytest.fixture
+def script_exists():
+ """Verify the screenshot generation script exists."""
+ assert SCRIPT_PATH.exists(), f"Script not found: {SCRIPT_PATH}"
+ return SCRIPT_PATH
+
+
+def test_script_exists(script_exists):
+ """Test that the screenshot generation script exists."""
+ assert script_exists.is_file()
+ assert script_exists.suffix == ".py"
+
+
+def test_script_has_shebang(script_exists):
+ """Test that the script has a proper shebang."""
+ content = script_exists.read_text()
+ assert content.startswith("#!/usr/bin/env python3")
+
+
+def test_script_imports():
+ """Test that the script can be imported without errors."""
+ try:
+ # Add scripts directory to path
+ sys.path.insert(0, str(REPO_ROOT / "scripts"))
+
+ # Try importing the module (this checks syntax and import errors)
+ import generate_readme_screenshots # noqa: F401
+
+ # Import successful
+ assert True
+ except ImportError as e:
+ pytest.fail(f"Failed to import script: {e}")
+ finally:
+ # Clean up path
+ if str(REPO_ROOT / "scripts") in sys.path:
+ sys.path.remove(str(REPO_ROOT / "scripts"))
+
+
+def test_dependency_check():
+ """Test that dependency checking works."""
+ result = subprocess.run(
+ [sys.executable, str(SCRIPT_PATH), "--check-deps"],
+ capture_output=True,
+ text=True,
+ timeout=10,
+ )
+
+ # Script should exit with 0 if all deps available, 1 if some missing
+ assert result.returncode in (0, 1), f"Unexpected exit code: {result.returncode}"
+ assert "Dependency Status:" in result.stdout
+ assert "openadapt_capture:" in result.stdout
+ assert "playwright:" in result.stdout
+
+
+@pytest.mark.skipif(
+ not CAPTURE_DIR.exists(),
+ reason="openadapt-capture directory not found",
+)
+def test_captures_exist():
+ """Test that required capture directories exist."""
+ captures = [
+ CAPTURE_DIR / "turn-off-nightshift",
+ CAPTURE_DIR / "demo_new",
+ ]
+
+ for capture_path in captures:
+ assert capture_path.exists(), f"Capture not found: {capture_path}"
+ assert (capture_path / "capture.db").exists(), f"No capture.db in {capture_path}"
+
+
+@pytest.mark.skipif(
+ not CAPTURE_DIR.exists(),
+ reason="openadapt-capture directory not found",
+)
+def test_help_message():
+ """Test that the script shows help message."""
+ result = subprocess.run(
+ [sys.executable, str(SCRIPT_PATH), "--help"],
+ capture_output=True,
+ text=True,
+ timeout=10,
+ )
+
+ assert result.returncode == 0
+ assert "Generate screenshots for openadapt-viewer README" in result.stdout
+ assert "--capture-dir" in result.stdout
+ assert "--output-dir" in result.stdout
+ assert "--max-events" in result.stdout
+ assert "--skip-html" in result.stdout
+ assert "--skip-screenshots" in result.stdout
+
+
+@pytest.mark.skipif(
+ not CAPTURE_DIR.exists(),
+ reason="openadapt-capture directory not found",
+)
+@pytest.mark.slow
+def test_html_generation_only(tmp_path):
+ """Test HTML generation without screenshots (faster test).
+
+ This test verifies that:
+ 1. The script can load captures
+ 2. HTML generation works
+ 3. Output files are created
+
+ Note: This skips screenshot generation to keep tests fast.
+ """
+ # Check if openadapt_capture is available
+ try:
+ import openadapt_capture # noqa: F401
+ except ImportError:
+ pytest.skip("openadapt_capture not installed")
+
+ output_dir = tmp_path / "screenshots"
+ output_dir.mkdir()
+
+ result = subprocess.run(
+ [
+ sys.executable,
+ str(SCRIPT_PATH),
+ "--capture-dir",
+ str(CAPTURE_DIR),
+ "--output-dir",
+ str(output_dir),
+ "--max-events",
+ "10", # Limit events for faster test
+ "--skip-screenshots", # Skip screenshot generation
+ ],
+ capture_output=True,
+ text=True,
+ timeout=60,
+ )
+
+ # Check output
+ print("STDOUT:", result.stdout)
+ print("STDERR:", result.stderr)
+
+ # Script should succeed
+ if result.returncode != 0:
+ pytest.fail(
+ f"Script failed with exit code {result.returncode}\n"
+ f"STDOUT: {result.stdout}\n"
+ f"STDERR: {result.stderr}"
+ )
+
+ # Check that HTML files were mentioned in output
+ assert "Generated HTML files:" in result.stdout
+ assert "viewer.html" in result.stdout
+
+
+@pytest.mark.skipif(
+ not CAPTURE_DIR.exists(),
+ reason="openadapt-capture directory not found",
+)
+@pytest.mark.slow
+@pytest.mark.playwright
+def test_full_screenshot_generation(tmp_path):
+ """Test full screenshot generation including Playwright screenshots.
+
+ This is the full integration test that:
+ 1. Generates HTML viewers
+ 2. Takes screenshots with Playwright
+ 3. Verifies all outputs exist
+
+ Note: Requires playwright to be installed and browsers downloaded.
+ Run: uv pip install playwright && uv run playwright install chromium
+ """
+ # Check if dependencies are available
+ try:
+ import openadapt_capture # noqa: F401
+ from playwright.sync_api import sync_playwright # noqa: F401
+ except ImportError as e:
+ pytest.skip(f"Required dependency not available: {e}")
+
+ output_dir = tmp_path / "screenshots"
+ output_dir.mkdir()
+
+ result = subprocess.run(
+ [
+ sys.executable,
+ str(SCRIPT_PATH),
+ "--capture-dir",
+ str(CAPTURE_DIR),
+ "--output-dir",
+ str(output_dir),
+ "--max-events",
+ "10", # Limit events for faster test
+ ],
+ capture_output=True,
+ text=True,
+ timeout=120, # Screenshots take longer
+ )
+
+ # Check output
+ print("STDOUT:", result.stdout)
+ print("STDERR:", result.stderr)
+
+ # Script should succeed
+ if result.returncode != 0:
+ pytest.fail(
+ f"Script failed with exit code {result.returncode}\n"
+ f"STDOUT: {result.stdout}\n"
+ f"STDERR: {result.stderr}"
+ )
+
+ # Check that screenshots were generated
+ assert "Generated screenshots:" in result.stdout
+ assert "completed successfully" in result.stdout
+
+ # Verify screenshot files exist
+ screenshots = list(output_dir.glob("*.png"))
+ assert len(screenshots) > 0, "No screenshot files generated"
+
+ # Check expected screenshot files
+ expected_patterns = [
+ "*_full.png",
+ "*_controls.png",
+ "*_events.png",
+ ]
+
+ for pattern in expected_patterns:
+ matching = list(output_dir.glob(pattern))
+ assert len(matching) > 0, f"No screenshots matching pattern: {pattern}"
+
+
+def test_error_handling_invalid_capture():
+ """Test that the script handles invalid capture paths gracefully."""
+ result = subprocess.run(
+ [
+ sys.executable,
+ str(SCRIPT_PATH),
+ "--capture-dir",
+ "/nonexistent/path",
+ "--max-events",
+ "5",
+ ],
+ capture_output=True,
+ text=True,
+ timeout=10,
+ )
+
+ # Script should fail gracefully
+ assert result.returncode != 0
+ assert "Error" in result.stdout or "Error" in result.stderr or "not found" in result.stdout.lower()
+
+
+@pytest.mark.parametrize(
+ "args,expected_in_output",
+ [
+ (["--skip-html"], "Skipping HTML generation"),
+ (["--skip-screenshots"], "Skipping screenshot generation"),
+ (["--max-events", "5"], "Limiting to"),
+ ],
+)
+def test_command_line_options(args, expected_in_output, tmp_path):
+ """Test that command-line options are respected."""
+ # Skip if captures don't exist
+ if not CAPTURE_DIR.exists():
+ pytest.skip("openadapt-capture directory not found")
+
+ # Skip if openadapt_capture not installed
+ try:
+ import openadapt_capture # noqa: F401
+ except ImportError:
+ pytest.skip("openadapt_capture not installed")
+
+ output_dir = tmp_path / "screenshots"
+ output_dir.mkdir()
+
+ result = subprocess.run(
+ [
+ sys.executable,
+ str(SCRIPT_PATH),
+ "--capture-dir",
+ str(CAPTURE_DIR),
+ "--output-dir",
+ str(output_dir),
+ ]
+ + args,
+ capture_output=True,
+ text=True,
+ timeout=60,
+ )
+
+ # Check that option was recognized
+ assert expected_in_output in result.stdout or result.returncode == 0