scitex 2.4.1__py3-none-any.whl → 2.4.3__py3-none-any.whl

scitex/browser/debugging/_test_monitor.py

@@ -0,0 +1,284 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: 2025-12-08
+# File: /home/ywatanabe/proj/scitex-code/src/scitex/browser/debugging/_test_monitor.py
+
+"""
+Test monitoring with periodic screenshots using scitex.capture.
+
+Provides automated visual monitoring during E2E tests:
+- Periodic screenshots at configurable intervals
+- Integration with scitex.capture for WSL/Windows support
+- GIF generation from test sessions
+- Pytest fixture integration
+
+Usage in conftest.py:
+    from scitex.browser.debugging import (
+        create_test_monitor,
+        TestMonitor,
+    )
+
+    @pytest.fixture
+    def test_monitor():
+        monitor = TestMonitor(interval=2.0, verbose=True)
+        monitor.start()
+        yield monitor
+        monitor.stop()
+        monitor.create_gif()  # Optional: create GIF from screenshots
+"""
+
+from datetime import datetime
+from pathlib import Path
+from typing import TYPE_CHECKING, Optional
+
+if TYPE_CHECKING:
+    from playwright.sync_api import Page
+
+
+class TestMonitor:
+    """
+    Monitor E2E tests with periodic screenshots using scitex.capture.
+
+    Captures screenshots at regular intervals during test execution,
+    allowing visual inspection of test progress and debugging.
+    """
+
+    def __init__(
+        self,
+        output_dir: str | Path = None,
+        interval: float = 2.0,
+        quality: int = 70,
+        verbose: bool = False,
+        test_name: str = None,
+    ):
+        """
+        Initialize test monitor.
+
+        Args:
+            output_dir: Directory for screenshots (default: ~/.scitex/test_monitor)
+            interval: Seconds between screenshots (default: 2.0)
+            quality: JPEG quality 1-100 (default: 70)
+            verbose: Print capture messages
+            test_name: Optional test name for session identification
+        """
+        self.output_dir = Path(output_dir or Path.home() / ".scitex" / "test_monitor")
+        self.interval = interval
+        self.quality = quality
+        self.verbose = verbose
+        self.test_name = test_name
+        self.session_id = None
+        self._worker = None
+        self._capture_manager = None
+
+    def start(self, test_name: str = None) -> str:
+        """
+        Start periodic screenshot capture.
+
+        Args:
+            test_name: Optional test name to include in session
+
+        Returns:
+            Session ID for this capture session
+        """
+        try:
+            from scitex.capture import CaptureManager
+        except ImportError:
+            if self.verbose:
+                print("[TestMonitor] scitex.capture not available")
+            return None
+
+        # Generate session ID
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+        name = test_name or self.test_name or "test"
+        safe_name = name.replace("::", "_").replace("[", "_").replace("]", "").replace("/", "_")
+        self.session_id = f"{timestamp}_{safe_name}"
+
+        # Create session directory
+        session_dir = self.output_dir / self.session_id
+        session_dir.mkdir(parents=True, exist_ok=True)
+
+        # Start capture
+        self._capture_manager = CaptureManager()
+        self._worker = self._capture_manager.start_capture(
+            output_dir=str(session_dir),
+            interval=self.interval,
+            jpeg=True,
+            quality=self.quality,
+            verbose=self.verbose,
+        )
+
+        if self.verbose:
+            print(f"[TestMonitor] Started: {session_dir} (interval: {self.interval}s)")
+
+        return self.session_id
+
+    def stop(self) -> dict:
+        """
+        Stop screenshot capture.
+
+        Returns:
+            Status dict with session info
+        """
+        if self._capture_manager:
+            self._capture_manager.stop_capture()
+
+        status = self.get_status()
+
+        if self.verbose and self._worker:
+            print(f"[TestMonitor] Stopped: {self._worker.screenshot_count} screenshots")
+
+        return status
+
+    def get_status(self) -> dict:
+        """Get current monitor status."""
+        if self._worker:
+            return self._worker.get_status()
+        return {
+            "running": False,
+            "session_id": self.session_id,
+            "output_dir": str(self.output_dir),
+        }
+
+    def take_snapshot(self, message: str = None) -> Optional[str]:
+        """
+        Take an immediate snapshot (in addition to periodic captures).
+
+        Args:
+            message: Optional message to include in filename
+
+        Returns:
+            Path to saved screenshot
+        """
+        try:
+            from scitex.capture import snap
+            return snap(message=message, output_dir=str(self.output_dir))
+        except ImportError:
+            return None
+
+    def create_gif(self, duration: float = 0.5, output_path: str = None) -> Optional[str]:
+        """
+        Create GIF from captured screenshots.
+
+        Args:
+            duration: Duration per frame in seconds
+            output_path: Output path for GIF (auto-generated if None)
+
+        Returns:
+            Path to created GIF
+        """
+        if not self.session_id:
+            return None
+
+        try:
+            from scitex.capture import create_gif_from_session
+
+            session_dir = self.output_dir / self.session_id
+            if output_path is None:
+                output_path = str(session_dir / f"{self.session_id}.gif")
+
+            return create_gif_from_session(
+                session_id=self.session_id,
+                output_path=output_path,
+                duration=duration,
+            )
+        except ImportError:
+            if self.verbose:
+                print("[TestMonitor] GIF creation requires scitex.capture")
+            return None
+
+    def get_screenshots(self) -> list:
+        """Get list of captured screenshot paths."""
+        if not self.session_id:
+            return []
+
+        session_dir = self.output_dir / self.session_id
+        if not session_dir.exists():
+            return []
+
+        return sorted(session_dir.glob("*.jpg")) + sorted(session_dir.glob("*.png"))
+
+
+def create_test_monitor_fixture(
+    output_dir: str | Path = None,
+    interval: float = 2.0,
+    auto_gif: bool = False,
+):
+    """
+    Create a pytest fixture for test monitoring.
+
+    Usage in conftest.py:
+        from scitex.browser.debugging import create_test_monitor_fixture
+
+        test_monitor = create_test_monitor_fixture(interval=2.0, auto_gif=True)
+
+    Args:
+        output_dir: Directory for screenshots
+        interval: Seconds between screenshots
+        auto_gif: Create GIF automatically on test completion
+
+    Returns:
+        A pytest fixture function
+    """
+    import pytest
+
+    @pytest.fixture
+    def test_monitor(request):
+        """Pytest fixture for visual test monitoring."""
+        monitor = TestMonitor(
+            output_dir=output_dir,
+            interval=interval,
+            verbose=True,
+            test_name=request.node.nodeid,
+        )
+        monitor.start()
+        yield monitor
+        monitor.stop()
+        if auto_gif:
+            gif_path = monitor.create_gif()
+            if gif_path:
+                print(f"[TestMonitor] GIF created: {gif_path}")
+
+    return test_monitor
+
+
+# Convenience function for quick monitoring
+def monitor_test(
+    test_func=None,
+    interval: float = 2.0,
+    auto_gif: bool = False,
+):
+    """
+    Decorator for monitoring tests with periodic screenshots.
+
+    Usage:
+        @monitor_test(interval=1.0, auto_gif=True)
+        def test_my_feature(page):
+            # test code...
+
+    Args:
+        test_func: Test function (for use without parentheses)
+        interval: Seconds between screenshots
+        auto_gif: Create GIF on completion
+    """
+    def decorator(func):
+        def wrapper(*args, **kwargs):
+            monitor = TestMonitor(
+                interval=interval,
+                verbose=True,
+                test_name=func.__name__,
+            )
+            monitor.start()
+            try:
+                return func(*args, **kwargs)
+            finally:
+                monitor.stop()
+                if auto_gif:
+                    monitor.create_gif()
+        return wrapper
+
+    if test_func is not None:
+        return decorator(test_func)
+    return decorator
+
+
+# EOF

scitex/browser/debugging/_visual_cursor.py

@@ -0,0 +1,432 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: 2025-12-08
+# File: /home/ywatanabe/proj/scitex-code/src/scitex/browser/debugging/_visual_cursor.py
+
+"""
+Visual cursor and click effects for E2E test feedback.
+
+Provides visual feedback during browser automation:
+- Visual cursor indicator that follows mouse movements
+- Click ripple effects
+- Drag state visualization
+- Step progress messages
+
+Works with both async and sync Playwright APIs.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from playwright.async_api import Page as AsyncPage
+    from playwright.sync_api import Page as SyncPage
+
+# CSS styles for visual effects
+VISUAL_EFFECTS_CSS = """
+/* Visual cursor indicator */
+#_scitex_cursor {
+    position: fixed;
+    width: 24px;
+    height: 24px;
+    border: 3px solid #FF4444;
+    border-radius: 50%;
+    pointer-events: none;
+    z-index: 2147483647;
+    transform: translate(-50%, -50%);
+    transition: all 0.15s ease-out;
+    box-shadow: 0 0 15px rgba(255, 68, 68, 0.6);
+    display: none;
+}
+#_scitex_cursor.clicking {
+    transform: translate(-50%, -50%) scale(0.6);
+    background: rgba(255, 68, 68, 0.4);
+    box-shadow: 0 0 25px rgba(255, 68, 68, 0.8);
+}
+#_scitex_cursor.dragging {
+    border-color: #28A745;
+    box-shadow: 0 0 15px rgba(40, 167, 69, 0.6);
+    width: 28px;
+    height: 28px;
+}
+
+/* Click ripple effect */
+.scitex-click-ripple {
+    position: fixed;
+    border-radius: 50%;
+    border: 3px solid #FF4444;
+    pointer-events: none;
+    z-index: 2147483646;
+    animation: clickRipple 0.5s ease-out forwards;
+}
+@keyframes clickRipple {
+    0% { width: 0; height: 0; opacity: 1; transform: translate(-50%, -50%); }
+    100% { width: 80px; height: 80px; opacity: 0; transform: translate(-50%, -50%); }
+}
+
+/* Step message container */
+#_scitex_step_messages {
+    position: fixed;
+    top: 10px;
+    left: 10px;
+    z-index: 2147483647;
+    display: flex;
+    flex-direction: column;
+    gap: 8px;
+    max-width: 600px;
+    pointer-events: none;
+}
+.scitex-step-msg {
+    background: rgba(0, 0, 0, 0.9);
+    color: white;
+    padding: 14px 24px;
+    border-radius: 8px;
+    font-size: 16px;
+    font-family: 'Courier New', monospace;
+    box-shadow: 0 4px 12px rgba(0, 0, 0, 0.5);
+    word-wrap: break-word;
+    animation: stepSlideIn 0.3s ease-out;
+}
+@keyframes stepSlideIn {
+    0% { opacity: 0; transform: translateX(-20px); }
+    100% { opacity: 1; transform: translateX(0); }
+}
+
+/* Test result banner */
+#_scitex_result_banner {
+    position: fixed;
+    top: 50%;
+    left: 50%;
+    transform: translate(-50%, -50%);
+    padding: 40px 80px;
+    border-radius: 16px;
+    font-size: 48px;
+    font-weight: bold;
+    font-family: 'Arial', sans-serif;
+    z-index: 2147483647;
+    pointer-events: none;
+    animation: resultPulse 0.5s ease-out;
+}
+#_scitex_result_banner.success {
+    background: rgba(40, 167, 69, 0.95);
+    color: white;
+    box-shadow: 0 0 50px rgba(40, 167, 69, 0.8);
+}
+#_scitex_result_banner.failure {
+    background: rgba(220, 53, 69, 0.95);
+    color: white;
+    box-shadow: 0 0 50px rgba(220, 53, 69, 0.8);
+}
+@keyframes resultPulse {
+    0% { transform: translate(-50%, -50%) scale(0.5); opacity: 0; }
+    50% { transform: translate(-50%, -50%) scale(1.1); }
+    100% { transform: translate(-50%, -50%) scale(1); opacity: 1; }
+}
+"""
+
+# JavaScript to inject visual effects
+INJECT_EFFECTS_JS = f"""
+() => {{
+    if (document.getElementById('_scitex_visual_effects')) return;
+
+    const style = document.createElement('style');
+    style.id = '_scitex_visual_effects';
+    style.textContent = `{VISUAL_EFFECTS_CSS}`;
+    document.head.appendChild(style);
+
+    // Create cursor element
+    const cursor = document.createElement('div');
+    cursor.id = '_scitex_cursor';
+    document.body.appendChild(cursor);
+
+    // Create step messages container
+    const msgContainer = document.createElement('div');
+    msgContainer.id = '_scitex_step_messages';
+    document.body.appendChild(msgContainer);
+}}
+"""
+
+
+def inject_visual_effects(page: Union["AsyncPage", "SyncPage"]) -> None:
+    """Inject CSS and elements for visual effects (sync version)."""
+    page.evaluate(INJECT_EFFECTS_JS)
+
+
+async def inject_visual_effects_async(page: "AsyncPage") -> None:
+    """Inject CSS and elements for visual effects (async version)."""
+    await page.evaluate(INJECT_EFFECTS_JS)
+
+
+def show_cursor_at(
+    page: Union["AsyncPage", "SyncPage"],
+    x: float,
+    y: float,
+    state: str = "normal"
+) -> None:
+    """Move visual cursor to position (sync version).
+
+    Args:
+        page: Playwright page object
+        x: X coordinate
+        y: Y coordinate
+        state: Cursor state - "normal", "clicking", or "dragging"
+    """
+    page.evaluate("""
+    ([x, y, state]) => {
+        let cursor = document.getElementById('_scitex_cursor');
+        if (!cursor) {
+            cursor = document.createElement('div');
+            cursor.id = '_scitex_cursor';
+            document.body.appendChild(cursor);
+        }
+        cursor.style.display = 'block';
+        cursor.style.left = x + 'px';
+        cursor.style.top = y + 'px';
+        cursor.className = state === 'clicking' ? 'clicking' :
+                          state === 'dragging' ? 'dragging' : '';
+        if (state === 'dragging') {
+            cursor.style.borderColor = '#28A745';
+            cursor.style.boxShadow = '0 0 15px rgba(40, 167, 69, 0.6)';
+        } else {
+            cursor.style.borderColor = '#FF4444';
+            cursor.style.boxShadow = '0 0 15px rgba(255, 68, 68, 0.6)';
+        }
+    }
+    """, [x, y, state])
+
+
+async def show_cursor_at_async(
+    page: "AsyncPage",
+    x: float,
+    y: float,
+    state: str = "normal"
+) -> None:
+    """Move visual cursor to position (async version)."""
+    await page.evaluate("""
+    ([x, y, state]) => {
+        let cursor = document.getElementById('_scitex_cursor');
+        if (!cursor) {
+            cursor = document.createElement('div');
+            cursor.id = '_scitex_cursor';
+            document.body.appendChild(cursor);
+        }
+        cursor.style.display = 'block';
+        cursor.style.left = x + 'px';
+        cursor.style.top = y + 'px';
+        cursor.className = state === 'clicking' ? 'clicking' :
+                          state === 'dragging' ? 'dragging' : '';
+        if (state === 'dragging') {
+            cursor.style.borderColor = '#28A745';
+            cursor.style.boxShadow = '0 0 15px rgba(40, 167, 69, 0.6)';
+        } else {
+            cursor.style.borderColor = '#FF4444';
+            cursor.style.boxShadow = '0 0 15px rgba(255, 68, 68, 0.6)';
+        }
+    }
+    """, [x, y, state])
+
+
+def show_click_effect(page: Union["AsyncPage", "SyncPage"], x: float, y: float) -> None:
+    """Show click ripple effect at position (sync version)."""
+    page.evaluate("""
+    ([x, y]) => {
+        const ripple = document.createElement('div');
+        ripple.className = 'scitex-click-ripple';
+        ripple.style.left = x + 'px';
+        ripple.style.top = y + 'px';
+        document.body.appendChild(ripple);
+        setTimeout(() => ripple.remove(), 600);
+
+        const cursor = document.getElementById('_scitex_cursor');
+        if (cursor) {
+            cursor.classList.add('clicking');
+            setTimeout(() => cursor.classList.remove('clicking'), 150);
+        }
+    }
+    """, [x, y])
+
+
+async def show_click_effect_async(page: "AsyncPage", x: float, y: float) -> None:
+    """Show click ripple effect at position (async version)."""
+    await page.evaluate("""
+    ([x, y]) => {
+        const ripple = document.createElement('div');
+        ripple.className = 'scitex-click-ripple';
+        ripple.style.left = x + 'px';
+        ripple.style.top = y + 'px';
+        document.body.appendChild(ripple);
+        setTimeout(() => ripple.remove(), 600);
+
+        const cursor = document.getElementById('_scitex_cursor');
+        if (cursor) {
+            cursor.classList.add('clicking');
+            setTimeout(() => cursor.classList.remove('clicking'), 150);
+        }
+    }
+    """, [x, y])
+
+
+def show_step(
+    page: Union["AsyncPage", "SyncPage"],
+    step: int,
+    total: int,
+    message: str,
+    level: str = "info"
+) -> None:
+    """Show numbered step message in browser (sync version).
+
+    Args:
+        page: Playwright page object
+        step: Current step number
+        total: Total number of steps
+        message: Message to display
+        level: Message level - "info", "success", "warning", or "error"
+    """
+    color_map = {
+        "info": "#17A2B8",
+        "success": "#28A745",
+        "warning": "#FFC107",
+        "error": "#DC3545",
+    }
+    color = color_map.get(level, color_map["info"])
+
+    page.evaluate("""
+    ([step, total, message, color]) => {
+        let container = document.getElementById('_scitex_step_messages');
+        if (!container) {
+            container = document.createElement('div');
+            container.id = '_scitex_step_messages';
+            container.style.cssText = `
+                position: fixed; top: 10px; left: 10px; z-index: 2147483647;
+                display: flex; flex-direction: column; gap: 8px;
+                max-width: 600px; pointer-events: none;
+            `;
+            document.body.appendChild(container);
+        }
+        const popup = document.createElement('div');
+        popup.className = 'scitex-step-msg';
+        popup.innerHTML = `<strong>[${step}/${total}] ${message}</strong>`;
+        popup.style.cssText = `
+            background: rgba(0, 0, 0, 0.9); color: white;
+            padding: 14px 24px; border-radius: 8px; font-size: 16px;
+            font-family: 'Courier New', monospace;
+            box-shadow: 0 4px 12px rgba(0, 0, 0, 0.5);
+            border-left: 6px solid ${color}; word-wrap: break-word;
+        `;
+        container.appendChild(popup);
+        while (container.children.length > 5) container.removeChild(container.firstChild);
+        setTimeout(() => { if (popup.parentNode) popup.parentNode.removeChild(popup); }, 8000);
+    }
+    """, [step, total, message, color])
+    page.wait_for_timeout(200)
+
+
+async def show_step_async(
+    page: "AsyncPage",
+    step: int,
+    total: int,
+    message: str,
+    level: str = "info"
+) -> None:
+    """Show numbered step message in browser (async version)."""
+    color_map = {
+        "info": "#17A2B8",
+        "success": "#28A745",
+        "warning": "#FFC107",
+        "error": "#DC3545",
+    }
+    color = color_map.get(level, color_map["info"])
+
+    await page.evaluate("""
+    ([step, total, message, color]) => {
+        let container = document.getElementById('_scitex_step_messages');
+        if (!container) {
+            container = document.createElement('div');
+            container.id = '_scitex_step_messages';
+            container.style.cssText = `
+                position: fixed; top: 10px; left: 10px; z-index: 2147483647;
+                display: flex; flex-direction: column; gap: 8px;
+                max-width: 600px; pointer-events: none;
+            `;
+            document.body.appendChild(container);
+        }
+        const popup = document.createElement('div');
+        popup.className = 'scitex-step-msg';
+        popup.innerHTML = `<strong>[${step}/${total}] ${message}</strong>`;
+        popup.style.cssText = `
+            background: rgba(0, 0, 0, 0.9); color: white;
+            padding: 14px 24px; border-radius: 8px; font-size: 16px;
+            font-family: 'Courier New', monospace;
+            box-shadow: 0 4px 12px rgba(0, 0, 0, 0.5);
+            border-left: 6px solid ${color}; word-wrap: break-word;
+        `;
+        container.appendChild(popup);
+        while (container.children.length > 5) container.removeChild(container.firstChild);
+        setTimeout(() => { if (popup.parentNode) popup.parentNode.removeChild(popup); }, 8000);
+    }
+    """, [step, total, message, color])
+    await page.wait_for_timeout(200)
+
+
+def show_test_result(
+    page: Union["AsyncPage", "SyncPage"],
+    success: bool,
+    message: str = "",
+    delay_ms: int = 3000
+) -> None:
+    """Show test result banner (PASS/FAIL) and wait (sync version).
+
+    Args:
+        page: Playwright page object
+        success: True for PASS, False for FAIL
+        message: Optional message to display
+        delay_ms: How long to display before continuing
+    """
+    status = "PASS" if success else "FAIL"
+    css_class = "success" if success else "failure"
+    display_text = f"{status}" + (f": {message}" if message else "")
+
+    page.evaluate("""
+    ([displayText, cssClass]) => {
+        // Remove existing banner
+        const existing = document.getElementById('_scitex_result_banner');
+        if (existing) existing.remove();
+
+        const banner = document.createElement('div');
+        banner.id = '_scitex_result_banner';
+        banner.className = cssClass;
+        banner.textContent = displayText;
+        document.body.appendChild(banner);
+    }
+    """, [display_text, css_class])
+    page.wait_for_timeout(delay_ms)
+
+
+async def show_test_result_async(
+    page: "AsyncPage",
+    success: bool,
+    message: str = "",
+    delay_ms: int = 3000
+) -> None:
+    """Show test result banner (PASS/FAIL) and wait (async version)."""
+    status = "PASS" if success else "FAIL"
+    css_class = "success" if success else "failure"
+    display_text = f"{status}" + (f": {message}" if message else "")
+
+    await page.evaluate("""
+    ([displayText, cssClass]) => {
+        const existing = document.getElementById('_scitex_result_banner');
+        if (existing) existing.remove();
+
+        const banner = document.createElement('div');
+        banner.id = '_scitex_result_banner';
+        banner.className = cssClass;
+        banner.textContent = displayText;
+        document.body.appendChild(banner);
+    }
+    """, [display_text, css_class])
+    await page.wait_for_timeout(delay_ms)
+
+
+# EOF