ha-testcontainer 2.2.0__tar.gz → 2.3.0__tar.gz

{ha_testcontainer-2.2.0 → ha_testcontainer-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ha-testcontainer
-Version: 2.2.0
+Version: 2.3.0
 Summary: Full test container for Home Assistant with demo config, custom components, and visual testing
 License: MIT License
         

{ha_testcontainer-2.2.0 → ha_testcontainer-2.3.0}/ha_testcontainer/visual/scenario_runner.py

@@ -524,6 +524,9 @@ REPO_ROOT: Path = Path.cwd()
 # They participate in ``test_doc_images.py`` but not in ``test_scenarios.py``.
 DOCS_SCENARIOS_DIR: Path = REPO_ROOT / "docs" / "scenarios"
 
+# Background color for normalized doc_animation canvases.
+CANVAS_BACKGROUND_RGBA: tuple[int, int, int, int] = (255, 255, 255, 255)
+
 # ---------------------------------------------------------------------------
 # Extension registry
 # ---------------------------------------------------------------------------
@@ -2005,7 +2008,7 @@ def capture_doc_animation(
             _inject_click_circle(page)
         n: int = seg.get("frames", 10)
         for i in range(n):
-            frame_images.append(take_frame(fixed_clip))
+            raw_frame_images.append(take_frame(fixed_clip))
             if i < n - 1:
                 page.wait_for_timeout(interval_ms)
 
@@ -2019,7 +2022,7 @@ def capture_doc_animation(
 
     # --- capture frames ---
     # Each frame is an Image.Image object (PIL dynamically imported above).
-    frame_images: list[Any] = []
+    raw_frame_images: list[Any] = []
 
     segments = doc_animation.get("segments")
     if segments is not None:
@@ -2038,7 +2041,7 @@ def capture_doc_animation(
         if cursor_type:
             _inject_cursor(page, cursor_type)
         for i in range(frame_count):
-            frame_images.append(take_frame(clip))
+            raw_frame_images.append(take_frame(clip))
             if i < frame_count - 1:
                 page.wait_for_timeout(interval_ms)
 
@@ -2048,6 +2051,28 @@ def capture_doc_animation(
     _remove_cursor(page)
     _remove_click_circle(page)
 
+    if not raw_frame_images:
+        raise AssertionError(
+            f"Doc animation '{doc_animation['output']}': captured 0 frames. "
+            "Set frames > 0 (or at least one segment with frames > 0)."
+        )
+
+    # --- normalize frame sizes ---
+    # When viewport size changes within one animation, later screenshots may be
+    # smaller than earlier ones.  Composite every frame onto a fixed-size canvas
+    # so uncovered regions are explicitly cleared and no stale pixels bleed
+    # through during GIF playback.
+    max_w = max(f.size[0] for f in raw_frame_images)
+    max_h = max(f.size[1] for f in raw_frame_images)
+    frame_images: list[Any] = []
+    for f in raw_frame_images:
+        if f.size == (max_w, max_h):
+            frame_images.append(f)
+            continue
+        canvas = Image.new("RGBA", (max_w, max_h), CANVAS_BACKGROUND_RGBA)
+        canvas.paste(f, (0, 0))
+        frame_images.append(canvas)
+
     # --- assemble GIF ---
     # Build a global palette by stacking all frames vertically into one image
     # so the quantiser sees the actual pixel distribution across the entire
@@ -2075,6 +2100,7 @@ def capture_doc_animation(
         loop=0,
         duration=interval_ms,
         optimize=False,
+        disposal=2,
     )
     actual_gif = gif_buf.getvalue()
 

{ha_testcontainer-2.2.0 → ha_testcontainer-2.3.0}/ha_testcontainer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ha-testcontainer
-Version: 2.2.0
+Version: 2.3.0
 Summary: Full test container for Home Assistant with demo config, custom components, and visual testing
 License: MIT License
         

{ha_testcontainer-2.2.0 → ha_testcontainer-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ha-testcontainer"
-version = "2.2.0"
+version = "2.3.0"
 description = "Full test container for Home Assistant with demo config, custom components, and visual testing"
 readme = "README.md"
 requires-python = ">=3.11"

ha_testcontainer-2.3.0/tests/test_scenario_runner_unit.py

@@ -0,0 +1,227 @@
+"""Unit tests for scenario_runner interaction types — no Docker or browser required.
+
+Covers interaction dispatch logic using mocks so that a running Playwright
+browser is not needed.
+"""
+
+from __future__ import annotations
+
+import io
+from unittest.mock import MagicMock, call
+
+import pytest
+from PIL import Image, ImageSequence
+
+import ha_testcontainer.visual.scenario_runner as sr
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+
+def _make_page() -> MagicMock:
+    """Return a lightweight mock that records Playwright Page calls."""
+    return MagicMock()
+
+
+# ---------------------------------------------------------------------------
+# set_viewport interaction
+# ---------------------------------------------------------------------------
+
+
+class TestSetViewportInteraction:
+    """run_interactions dispatches set_viewport correctly."""
+
+    def test_set_viewport_calls_set_viewport_size(self):
+        page = _make_page()
+        scenario = {
+            "interactions": [
+                {"type": "set_viewport", "width": 375, "height": 812},
+            ]
+        }
+        sr.run_interactions(page, scenario)
+        page.set_viewport_size.assert_called_once_with({"width": 375, "height": 812})
+
+    def test_set_viewport_no_settle_ms_by_default(self):
+        page = _make_page()
+        scenario = {
+            "interactions": [
+                {"type": "set_viewport", "width": 1280, "height": 800},
+            ]
+        }
+        sr.run_interactions(page, scenario)
+        page.wait_for_timeout.assert_not_called()
+
+    def test_set_viewport_settle_ms_waits(self):
+        page = _make_page()
+        scenario = {
+            "interactions": [
+                {"type": "set_viewport", "width": 768, "height": 1024, "settle_ms": 300},
+            ]
+        }
+        sr.run_interactions(page, scenario)
+        page.set_viewport_size.assert_called_once_with({"width": 768, "height": 1024})
+        page.wait_for_timeout.assert_called_once_with(300)
+
+    def test_set_viewport_coerces_string_dimensions(self):
+        """width/height may arrive as strings from YAML and must be coerced to int."""
+        page = _make_page()
+        scenario = {
+            "interactions": [
+                {"type": "set_viewport", "width": "390", "height": "844"},
+            ]
+        }
+        sr.run_interactions(page, scenario)
+        page.set_viewport_size.assert_called_once_with({"width": 390, "height": 844})
+
+    def test_unknown_type_raises(self):
+        page = _make_page()
+        scenario = {
+            "interactions": [
+                {"type": "not_a_real_type"},
+            ]
+        }
+        with pytest.raises(ValueError, match="Unknown interaction type"):
+            sr.run_interactions(page, scenario)
+
+
+def _png_bytes(width: int, height: int, color: tuple[int, int, int]) -> bytes:
+    """Return an in-memory PNG of the requested size and solid RGB color."""
+    img = Image.new("RGB", (width, height), color)
+    buf = io.BytesIO()
+    img.save(buf, format="PNG")
+    return buf.getvalue()
+
+
+def _read_gif_frames(path) -> list[Image.Image]:
+    """Return frames from the GIF at *path* as per-frame RGB Pillow images."""
+    with Image.open(path) as gif:
+        if gif.format != "GIF":
+            raise ValueError(f"Expected GIF file, got: {gif.format}")
+        return [f.copy().convert("RGB") for f in ImageSequence.Iterator(gif)]
+
+
+class TestDocAnimationViewportNormalization:
+    """doc_animation normalizes variable-size viewport frames to one canvas."""
+
+    def test_large_to_small_viewport_clears_uncovered_area(self, tmp_path, monkeypatch):
+        page = _make_page()
+        page.screenshot.side_effect = [
+            _png_bytes(8, 6, (255, 0, 0)),
+            _png_bytes(4, 3, (0, 255, 0)),
+        ]
+
+        save_kwargs: dict[str, object] = {}
+        orig_save = Image.Image.save
+
+        def _save_with_capture(self, file_obj, format=None, **params):
+            save_kwargs.update(params)
+            return orig_save(self, file_obj, format=format, **params)
+
+        monkeypatch.setattr(Image.Image, "save", _save_with_capture)
+        monkeypatch.setattr(sr, "REPO_ROOT", tmp_path)
+        monkeypatch.setenv("DOC_IMAGE_UPDATE", "1")
+
+        scenario = {
+            "doc_animation": {
+                "output": "docs/assets/viewport-large-small.gif",
+                "interval_ms": 1,
+                "dither": False,
+                "segments": [
+                    {"interactions": [{"type": "set_viewport", "width": 8, "height": 6}], "frames": 1},
+                    {"interactions": [{"type": "set_viewport", "width": 4, "height": 3}], "frames": 1},
+                ],
+            }
+        }
+
+        sr.capture_doc_animation(page, scenario)
+
+        output = tmp_path / "docs/assets/viewport-large-small.gif"
+        frames = _read_gif_frames(output)
+        assert [f.size for f in frames] == [(8, 6), (8, 6)]
+        # (6,4) sits outside the 4x3 second frame; it must be cleared to white.
+        assert frames[1].getpixel((6, 4)) == (255, 255, 255)
+        assert save_kwargs.get("disposal") == 2
+        assert page.set_viewport_size.call_args_list == [
+            call({"width": 8, "height": 6}),
+            call({"width": 4, "height": 3}),
+        ]
+
+    def test_small_to_large_viewport_uses_max_canvas(self, tmp_path, monkeypatch):
+        page = _make_page()
+        page.screenshot.side_effect = [
+            _png_bytes(4, 3, (0, 255, 0)),
+            _png_bytes(8, 6, (0, 0, 255)),
+        ]
+
+        monkeypatch.setattr(sr, "REPO_ROOT", tmp_path)
+        monkeypatch.setenv("DOC_IMAGE_UPDATE", "1")
+
+        scenario = {
+            "doc_animation": {
+                "output": "docs/assets/viewport-small-large.gif",
+                "interval_ms": 1,
+                "dither": False,
+                "segments": [
+                    {"interactions": [{"type": "set_viewport", "width": 4, "height": 3}], "frames": 1},
+                    {"interactions": [{"type": "set_viewport", "width": 8, "height": 6}], "frames": 1},
+                ],
+            }
+        }
+
+        sr.capture_doc_animation(page, scenario)
+
+        output = tmp_path / "docs/assets/viewport-small-large.gif"
+        frames = _read_gif_frames(output)
+        assert [f.size for f in frames] == [(8, 6), (8, 6)]
+        # (6,4) sits outside the 4x3 first frame; it must be cleared to white.
+        assert frames[0].getpixel((6, 4)) == (255, 255, 255)
+
+    def test_mixed_segment_interactions_keep_consistent_frame_size(self, tmp_path, monkeypatch):
+        page = _make_page()
+        page.screenshot.side_effect = [
+            _png_bytes(8, 6, (255, 0, 0)),
+            _png_bytes(5, 4, (0, 255, 0)),
+            _png_bytes(3, 2, (0, 0, 255)),
+        ]
+
+        monkeypatch.setattr(sr, "REPO_ROOT", tmp_path)
+        monkeypatch.setenv("DOC_IMAGE_UPDATE", "1")
+
+        scenario = {
+            "doc_animation": {
+                "output": "docs/assets/viewport-mixed-segments.gif",
+                "interval_ms": 1,
+                "dither": False,
+                "segments": [
+                    {"interactions": [{"type": "set_viewport", "width": 8, "height": 6}], "frames": 1},
+                    {"interactions": [{"type": "set_viewport", "width": 5, "height": 4}], "frames": 1},
+                    {"interactions": [{"type": "set_viewport", "width": 3, "height": 2}], "frames": 1},
+                ],
+            }
+        }
+
+        sr.capture_doc_animation(page, scenario)
+
+        output = tmp_path / "docs/assets/viewport-mixed-segments.gif"
+        frames = _read_gif_frames(output)
+        assert [f.size for f in frames] == [(8, 6), (8, 6), (8, 6)]
+        # (7,5) is outside both smaller later frames and must be white.
+        assert frames[1].getpixel((7, 5)) == (255, 255, 255)
+        assert frames[2].getpixel((7, 5)) == (255, 255, 255)
+
+    def test_raises_when_no_frames_captured(self, tmp_path, monkeypatch):
+        page = _make_page()
+        monkeypatch.setattr(sr, "REPO_ROOT", tmp_path)
+        monkeypatch.setenv("DOC_IMAGE_UPDATE", "1")
+
+        scenario = {
+            "doc_animation": {
+                "output": "docs/assets/no-frames.gif",
+                "frames": 0,
+            }
+        }
+
+        with pytest.raises(AssertionError, match="captured 0 frames"):
+            sr.capture_doc_animation(page, scenario)

ha_testcontainer-2.2.0/tests/test_scenario_runner_unit.py

@@ -1,84 +0,0 @@
-"""Unit tests for scenario_runner interaction types — no Docker or browser required.
-
-Covers interaction dispatch logic using mocks so that a running Playwright
-browser is not needed.
-"""
-
-from __future__ import annotations
-
-from unittest.mock import MagicMock, call
-
-import pytest
-
-import ha_testcontainer.visual.scenario_runner as sr
-
-
-# ---------------------------------------------------------------------------
-# Helpers
-# ---------------------------------------------------------------------------
-
-
-def _make_page() -> MagicMock:
-    """Return a lightweight mock that records Playwright Page calls."""
-    return MagicMock()
-
-
-# ---------------------------------------------------------------------------
-# set_viewport interaction
-# ---------------------------------------------------------------------------
-
-
-class TestSetViewportInteraction:
-    """run_interactions dispatches set_viewport correctly."""
-
-    def test_set_viewport_calls_set_viewport_size(self):
-        page = _make_page()
-        scenario = {
-            "interactions": [
-                {"type": "set_viewport", "width": 375, "height": 812},
-            ]
-        }
-        sr.run_interactions(page, scenario)
-        page.set_viewport_size.assert_called_once_with({"width": 375, "height": 812})
-
-    def test_set_viewport_no_settle_ms_by_default(self):
-        page = _make_page()
-        scenario = {
-            "interactions": [
-                {"type": "set_viewport", "width": 1280, "height": 800},
-            ]
-        }
-        sr.run_interactions(page, scenario)
-        page.wait_for_timeout.assert_not_called()
-
-    def test_set_viewport_settle_ms_waits(self):
-        page = _make_page()
-        scenario = {
-            "interactions": [
-                {"type": "set_viewport", "width": 768, "height": 1024, "settle_ms": 300},
-            ]
-        }
-        sr.run_interactions(page, scenario)
-        page.set_viewport_size.assert_called_once_with({"width": 768, "height": 1024})
-        page.wait_for_timeout.assert_called_once_with(300)
-
-    def test_set_viewport_coerces_string_dimensions(self):
-        """width/height may arrive as strings from YAML and must be coerced to int."""
-        page = _make_page()
-        scenario = {
-            "interactions": [
-                {"type": "set_viewport", "width": "390", "height": "844"},
-            ]
-        }
-        sr.run_interactions(page, scenario)
-        page.set_viewport_size.assert_called_once_with({"width": 390, "height": 844})
-
-    def test_unknown_type_raises(self):
-        page = _make_page()
-        scenario = {
-            "interactions": [
-                {"type": "not_a_real_type"},
-            ]
-        }
-        with pytest.raises(ValueError, match="Unknown interaction type"):
-            sr.run_interactions(page, scenario)