Automatically run guides and gather screenshots of the steps

[TrentHouliston]

Guides can get out of date super easily as things change.

These changes are working towards making sure that any guides we make in the future are self executing and can be self healing with the help of AI MCP rules.

Also it lets us take screenshots of each step so that we can make pretty step by step instructions without having to gather all those screenshots ourselves!

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

ruff lint

---

⚠️ [ruff] <E402> _{reported by reviewdog 🐶}
Module level import not at top of file

haeo/tests/guides/sigenergy/test_sigenergy_guide.py

Lines 25 to 29 in 8df5fd4

	from tests.guides.sigenergy.run_guide import (
	INPUTS_FILE,
	SCREENSHOTS_DIR,
	run_guide,
	)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/sigenergy/test_sigenergy_guide.py

Line 73 in 8df5fd4

print(f"\n✅ Guide test passed! {len(results)} screenshots captured")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/sigenergy/test_sigenergy_guide.py

Line 74 in 8df5fd4

print(f"📁 Screenshots saved to: {SCREENSHOTS_DIR}")

---

⚠️ [ruff] <EXE001> _{reported by reviewdog 🐶}
Shebang is present but file is not executable

haeo/tests/guides/test_ha_runner.py

Line 1 in 8df5fd4

#!/usr/bin/env python3

---

⚠️ [ruff] <I001> _{reported by reviewdog 🐶}
Import block is un-sorted or un-formatted

haeo/tests/guides/test_ha_runner.py

Lines 7 to 8 in 8df5fd4

	import sys
	from pathlib import Path

---

⚠️ [ruff] <E402> _{reported by reviewdog 🐶}
Module level import not at top of file

haeo/tests/guides/test_ha_runner.py

Line 14 in 8df5fd4

from tests.guides.ha_runner import live_home_assistant

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 19 in 8df5fd4

print("🚀 Testing in-process Home Assistant startup...")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 22 in 8df5fd4

print(f"✅ Home Assistant started at {hass.url}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 23 in 8df5fd4

print(f" Port: {hass.port}")

---

⚠️ [ruff] <PLC0415> _{reported by reviewdog 🐶}
import should be at the top-level of a file

haeo/tests/guides/test_ha_runner.py

Line 26 in 8df5fd4

import urllib.request

---

⚠️ [ruff] <I001> _{reported by reviewdog 🐶}
Import block is un-sorted or un-formatted

haeo/tests/guides/test_ha_runner.py

Lines 26 to 27 in 8df5fd4

	import urllib.request
	from urllib.error import URLError

---

⚠️ [ruff] <PLC0415> _{reported by reviewdog 🐶}
import should be at the top-level of a file

haeo/tests/guides/test_ha_runner.py

Line 27 in 8df5fd4

from urllib.error import URLError

---

⚠️ [ruff] <S310> _{reported by reviewdog 🐶}
Audit URL open for permitted schemes. Allowing use of file: or custom schemes is often unexpected.

haeo/tests/guides/test_ha_runner.py

Line 30 in 8df5fd4

with urllib.request.urlopen(hass.url, timeout=5) as response:

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 31 in 8df5fd4

print(f" HTTP response: {response.status}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 33 in 8df5fd4

print(f" HTTP error (expected without auth): {e}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 36 in 8df5fd4

print("\n📝 Setting entity states...")

---

⚠️ [ruff] <ANN202> _{reported by reviewdog 🐶}
Missing return type annotation for private function check_states

haeo/tests/guides/test_ha_runner.py

Line 61 in 8df5fd4

async def check_states():

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 67 in 8df5fd4

print(f" sensor.test_power: {state1.state if state1 else 'NOT FOUND'}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 68 in 8df5fd4

print(f" sensor.test_energy: {state2.state if state2 else 'NOT FOUND'}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 71 in 8df5fd4

print("\n✅ States verified correctly!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 73 in 8df5fd4

print("\n❌ State verification failed!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 76 in 8df5fd4

print("\n🛑 Home Assistant stopped cleanly")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 82 in 8df5fd4

print("\n🎭 Testing Playwright integration...")

---

⚠️ [ruff] <PLC0415> _{reported by reviewdog 🐶}
import should be at the top-level of a file

haeo/tests/guides/test_ha_runner.py

Line 85 in 8df5fd4

from playwright.sync_api import sync_playwright

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 87 in 8df5fd4

print(" ⚠️ Playwright not installed, skipping browser test")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 91 in 8df5fd4

print(f" HA running at {hass.url}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 100 in 8df5fd4

print(f" Page title: {title}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 103 in 8df5fd4

print(" ✅ Playwright can connect to HA!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 105 in 8df5fd4

print(f" ⚠️ Unexpected title: {title}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 115 in 8df5fd4

print("=" * 60)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 116 in 8df5fd4

print("Home Assistant In-Process Runner Tests")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 117 in 8df5fd4

print("=" * 60)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 125 in 8df5fd4

print(f"\n❌ Basic startup test failed: {e}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 135 in 8df5fd4

print(f"\n❌ Playwright test failed: {e}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 141 in 8df5fd4

print("\n" + "=" * 60)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 143 in 8df5fd4

print("✅ All tests passed!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 146 in 8df5fd4

print("❌ Some tests failed!")

[codecov]

❌ 2 Tests Failed:

Tests completed	Failed	Passed	Skipped
1113	2	1111	21

View the top 2 failed test(s) by shortest run time

tests/guides/sigenergy/test_sigenergy_guide.py::test_sigenergy_guide[dark]

Stack Traces | 0.03s run time

dark_mode = True

    @pytest.mark.guide
    @pytest.mark.enable_socket
    @pytest.mark.timeout(300)  # 5 minutes for full guide run
    @pytest.mark.parametrize("dark_mode", [False, True], ids=["light", "dark"])
    def test_sigenergy_guide(dark_mode: bool) -> None:
        """Test the complete Sigenergy setup guide.
    
        This test:
        1. Starts a fresh Home Assistant instance with pre-authenticated user
        2. Loads entity states from scenario1 inputs.json
        3. Runs through all guide steps using Playwright
        4. Captures screenshots at each step
        5. Validates that all elements were created successfully
        """
        # Use separate directories for light and dark mode screenshots
        mode_suffix = "dark" if dark_mode else "light"
        output_dir = SCREENSHOTS_DIR.parent / f"screenshots_{mode_suffix}"
    
        # Clean and create output directory
        if output_dir.exists():
            shutil.rmtree(output_dir)
        output_dir.mkdir(parents=True)
    
>       with live_home_assistant(timeout=120) as hass:
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.../guides/sigenergy/test_sigenergy_guide.py:64: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
../...../_temp/uv-python-dir/cpython-3.13.11-linux-x86_64-gnu/lib/python3.13/contextlib.py:141: in __enter__
    return next(self.gen)
           ^^^^^^^^^^^^^^
tests/guides/ha_runner.py:512: in live_home_assistant
    raise error_holder[0]
tests/guides/ha_runner.py:408: in _run
    hass, access_token, refresh_token_id = await _setup_home_assistant_async(port, config_dir)
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

port = 59261, config_dir = '/tmp/haeo_guide_psdhxdz7'

    async def _setup_home_assistant_async(
        port: int,
        config_dir: str,
    ) -> tuple[HomeAssistant, str, str]:
        """Set up a Home Assistant instance with HTTP server and pre-authenticated user.
    
        This creates a minimal HA instance with just the components needed
        for browser automation: http, frontend, auth, websocket_api.
        Onboarding is bypassed by creating an owner user programmatically.
    
        Returns:
            Tuple of (HomeAssistant instance, access_token, refresh_token_id)
    
        """
        # Pre-populate onboarding storage to mark all steps complete
        # This MUST be done BEFORE the HomeAssistant instance is created,
        # because the StoreManager scans the storage directory during initialization
        # and caches which files exist. If we write the file after that scan,
        # the onboarding component won't see it.
        storage_dir = Path(config_dir) / ".storage"
        storage_dir.mkdir(exist_ok=True)
        onboarding_storage = storage_dir / "onboarding"
        onboarding_data = {
            "version": 4,
            "minor_version": 1,
            "key": "onboarding",
            "data": {"done": ["user", "core_config", "analytics", "integration"]},
        }
        onboarding_storage.write_text(json.dumps(onboarding_data))
    
        hass = HomeAssistant(config_dir)
    
        # Basic configuration
        hass.config.location_name = "Test Home"
        hass.config.latitude = 32.87336
        hass.config.longitude = -117.22743
        hass.config.elevation = 0
        await hass.config.async_set_time_zone("UTC")
        hass.config.skip_pip = True
        hass.config.skip_pip_packages = []
    
        # Set up loader - don't set DATA_CUSTOM_COMPONENTS, let loader discover them
        loader.async_setup(hass)
    
        # Set up config entries
        hass.config_entries = ConfigEntries(hass, {"_": "placeholder"})
        hass.bus.async_listen_once(
            EVENT_HOMEASSISTANT_STOP,
            hass.config_entries._async_shutdown,
        )
    
        # Set up essential helpers
        entity.async_setup(hass)
    
        # Translation cache
        hass.data[translation.TRANSLATION_FLATTEN_CACHE] = translation._TranslationCache(hass)
    
        # Load registries
        await ar.async_load(hass)
        await cr.async_load(hass)
        await dr.async_load(hass)
        await er.async_load(hass)
        await fr.async_load(hass)
        await ir.async_load(hass)
        await lr.async_load(hass)
        await rs.async_load(hass)
    
        # Set up auth with homeassistant provider
        hass.auth = await auth_manager_from_config(
            hass,
            provider_configs=[{"type": "homeassistant"}],
            module_configs=[],
        )
    
        # Get the homeassistant auth provider to add a user with password.
        # We configure the provider as "homeassistant" type above, so index 0 is always HassAuthProvider.
        # Pyright can't narrow AuthProvider to HassAuthProvider due to incomplete type stubs
        # in Home Assistant - async_add_auth exists on HassAuthProvider but not AuthProvider.
        provider = hass.auth.auth_providers[0]
        await provider.async_add_auth("testuser", "testpass")  # pyright: ignore[reportAttributeAccessIssue]
    
        # Create owner user to bypass onboarding
        # First non-system user automatically becomes owner
        owner = await hass.auth.async_create_user(
            name="Test User",
            group_ids=["system-admin"],
        )
    
        # Create credential and link to user
        credential = Credentials(
            id="test-credential",
            auth_provider_type="homeassistant",
            auth_provider_id=None,
            data={"username": "testuser"},
            is_new=False,
        )
        await hass.auth.async_link_user(owner, credential)
    
        # Create refresh token and access token
        refresh_token = await hass.auth.async_create_refresh_token(
            owner,
            CLIENT_ID,
            credential=credential,
        )
        access_token = hass.auth.async_create_access_token(refresh_token)
        # Store refresh token ID for frontend auth
        refresh_token_id = refresh_token.id
    
        # Set up HTTP on ephemeral port
        http_config = {
            "server_port": port,
        }
    
        # Suppress aiohttp.web_exceptions.NotAppKeyWarning which is raised as an error
        # in newer versions of aiohttp when HA sets app["hass"] = hass
        # This is a compatibility issue between HA and newer aiohttp versions
        warnings.filterwarnings("ignore", category=DeprecationWarning, module="aiohttp")
        try:
            # NotAppKeyWarning only exists in newer aiohttp versions
            from aiohttp.web_exceptions import NotAppKeyWarning  # noqa: PLC0415
    
            warnings.filterwarnings("ignore", category=NotAppKeyWarning)
        except ImportError:
            pass  # Older aiohttp doesn't have this
    
        # Set up components in order (onboarding will see all steps done and skip
        # because we pre-populated the storage file)
        assert await async_setup_component(hass, "http", {"http": http_config})
        assert await async_setup_component(hass, "websocket_api", {})
        assert await async_setup_component(hass, "auth", {})
        assert await async_setup_component(hass, "onboarding", {})
    
        # Verify onboarding is bypassed
        # Import here because component must be set up first
        from homeassistant.components.onboarding import async_is_onboarded  # noqa: PLC0415
    
        if not async_is_onboarded(hass):
            msg = "Onboarding bypass failed - check storage file format and timing"
            raise RuntimeError(msg)
    
>       assert await async_setup_component(hass, "frontend", {})
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       AssertionError

tests/guides/ha_runner.py:375: AssertionError

tests/guides/sigenergy/test_sigenergy_guide.py::test_sigenergy_guide[light]

Stack Traces | 0.049s run time

dark_mode = False

    @pytest.mark.guide
    @pytest.mark.enable_socket
    @pytest.mark.timeout(300)  # 5 minutes for full guide run
    @pytest.mark.parametrize("dark_mode", [False, True], ids=["light", "dark"])
    def test_sigenergy_guide(dark_mode: bool) -> None:
        """Test the complete Sigenergy setup guide.
    
        This test:
        1. Starts a fresh Home Assistant instance with pre-authenticated user
        2. Loads entity states from scenario1 inputs.json
        3. Runs through all guide steps using Playwright
        4. Captures screenshots at each step
        5. Validates that all elements were created successfully
        """
        # Use separate directories for light and dark mode screenshots
        mode_suffix = "dark" if dark_mode else "light"
        output_dir = SCREENSHOTS_DIR.parent / f"screenshots_{mode_suffix}"
    
        # Clean and create output directory
        if output_dir.exists():
            shutil.rmtree(output_dir)
        output_dir.mkdir(parents=True)
    
>       with live_home_assistant(timeout=120) as hass:
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.../guides/sigenergy/test_sigenergy_guide.py:64: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
../...../_temp/uv-python-dir/cpython-3.13.11-linux-x86_64-gnu/lib/python3.13/contextlib.py:141: in __enter__
    return next(self.gen)
           ^^^^^^^^^^^^^^
tests/guides/ha_runner.py:512: in live_home_assistant
    raise error_holder[0]
tests/guides/ha_runner.py:408: in _run
    hass, access_token, refresh_token_id = await _setup_home_assistant_async(port, config_dir)
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

port = 51609, config_dir = '/tmp/haeo_guide_9pzbu9we'

    async def _setup_home_assistant_async(
        port: int,
        config_dir: str,
    ) -> tuple[HomeAssistant, str, str]:
        """Set up a Home Assistant instance with HTTP server and pre-authenticated user.
    
        This creates a minimal HA instance with just the components needed
        for browser automation: http, frontend, auth, websocket_api.
        Onboarding is bypassed by creating an owner user programmatically.
    
        Returns:
            Tuple of (HomeAssistant instance, access_token, refresh_token_id)
    
        """
        # Pre-populate onboarding storage to mark all steps complete
        # This MUST be done BEFORE the HomeAssistant instance is created,
        # because the StoreManager scans the storage directory during initialization
        # and caches which files exist. If we write the file after that scan,
        # the onboarding component won't see it.
        storage_dir = Path(config_dir) / ".storage"
        storage_dir.mkdir(exist_ok=True)
        onboarding_storage = storage_dir / "onboarding"
        onboarding_data = {
            "version": 4,
            "minor_version": 1,
            "key": "onboarding",
            "data": {"done": ["user", "core_config", "analytics", "integration"]},
        }
        onboarding_storage.write_text(json.dumps(onboarding_data))
    
        hass = HomeAssistant(config_dir)
    
        # Basic configuration
        hass.config.location_name = "Test Home"
        hass.config.latitude = 32.87336
        hass.config.longitude = -117.22743
        hass.config.elevation = 0
        await hass.config.async_set_time_zone("UTC")
        hass.config.skip_pip = True
        hass.config.skip_pip_packages = []
    
        # Set up loader - don't set DATA_CUSTOM_COMPONENTS, let loader discover them
        loader.async_setup(hass)
    
        # Set up config entries
        hass.config_entries = ConfigEntries(hass, {"_": "placeholder"})
        hass.bus.async_listen_once(
            EVENT_HOMEASSISTANT_STOP,
            hass.config_entries._async_shutdown,
        )
    
        # Set up essential helpers
        entity.async_setup(hass)
    
        # Translation cache
        hass.data[translation.TRANSLATION_FLATTEN_CACHE] = translation._TranslationCache(hass)
    
        # Load registries
        await ar.async_load(hass)
        await cr.async_load(hass)
        await dr.async_load(hass)
        await er.async_load(hass)
        await fr.async_load(hass)
        await ir.async_load(hass)
        await lr.async_load(hass)
        await rs.async_load(hass)
    
        # Set up auth with homeassistant provider
        hass.auth = await auth_manager_from_config(
            hass,
            provider_configs=[{"type": "homeassistant"}],
            module_configs=[],
        )
    
        # Get the homeassistant auth provider to add a user with password.
        # We configure the provider as "homeassistant" type above, so index 0 is always HassAuthProvider.
        # Pyright can't narrow AuthProvider to HassAuthProvider due to incomplete type stubs
        # in Home Assistant - async_add_auth exists on HassAuthProvider but not AuthProvider.
        provider = hass.auth.auth_providers[0]
        await provider.async_add_auth("testuser", "testpass")  # pyright: ignore[reportAttributeAccessIssue]
    
        # Create owner user to bypass onboarding
        # First non-system user automatically becomes owner
        owner = await hass.auth.async_create_user(
            name="Test User",
            group_ids=["system-admin"],
        )
    
        # Create credential and link to user
        credential = Credentials(
            id="test-credential",
            auth_provider_type="homeassistant",
            auth_provider_id=None,
            data={"username": "testuser"},
            is_new=False,
        )
        await hass.auth.async_link_user(owner, credential)
    
        # Create refresh token and access token
        refresh_token = await hass.auth.async_create_refresh_token(
            owner,
            CLIENT_ID,
            credential=credential,
        )
        access_token = hass.auth.async_create_access_token(refresh_token)
        # Store refresh token ID for frontend auth
        refresh_token_id = refresh_token.id
    
        # Set up HTTP on ephemeral port
        http_config = {
            "server_port": port,
        }
    
        # Suppress aiohttp.web_exceptions.NotAppKeyWarning which is raised as an error
        # in newer versions of aiohttp when HA sets app["hass"] = hass
        # This is a compatibility issue between HA and newer aiohttp versions
        warnings.filterwarnings("ignore", category=DeprecationWarning, module="aiohttp")
        try:
            # NotAppKeyWarning only exists in newer aiohttp versions
            from aiohttp.web_exceptions import NotAppKeyWarning  # noqa: PLC0415
    
            warnings.filterwarnings("ignore", category=NotAppKeyWarning)
        except ImportError:
            pass  # Older aiohttp doesn't have this
    
        # Set up components in order (onboarding will see all steps done and skip
        # because we pre-populated the storage file)
        assert await async_setup_component(hass, "http", {"http": http_config})
        assert await async_setup_component(hass, "websocket_api", {})
        assert await async_setup_component(hass, "auth", {})
        assert await async_setup_component(hass, "onboarding", {})
    
        # Verify onboarding is bypassed
        # Import here because component must be set up first
        from homeassistant.components.onboarding import async_is_onboarded  # noqa: PLC0415
    
        if not async_is_onboarded(hass):
            msg = "Onboarding bypass failed - check storage file format and timing"
            raise RuntimeError(msg)
    
>       assert await async_setup_component(hass, "frontend", {})
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       AssertionError

tests/guides/ha_runner.py:375: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

ruff lint

---

⚠️ [ruff] <PLC0415> _{reported by reviewdog 🐶}
import should be at the top-level of a file

haeo/tests/guides/test_ha_runner.py

Line 27 in 2f847ce

from urllib.error import URLError

---

⚠️ [ruff] <S310> _{reported by reviewdog 🐶}
Audit URL open for permitted schemes. Allowing use of file: or custom schemes is often unexpected.

haeo/tests/guides/test_ha_runner.py

Line 30 in 2f847ce

with urllib.request.urlopen(hass.url, timeout=5) as response:

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 31 in 2f847ce

print(f" HTTP response: {response.status}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 33 in 2f847ce

print(f" HTTP error (expected without auth): {e}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 36 in 2f847ce

print("\n📝 Setting entity states...")

---

⚠️ [ruff] <ANN202> _{reported by reviewdog 🐶}
Missing return type annotation for private function check_states

haeo/tests/guides/test_ha_runner.py

Line 61 in 2f847ce

async def check_states():

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 67 in 2f847ce

print(f" sensor.test_power: {state1.state if state1 else 'NOT FOUND'}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 68 in 2f847ce

print(f" sensor.test_energy: {state2.state if state2 else 'NOT FOUND'}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 71 in 2f847ce

print("\n✅ States verified correctly!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 73 in 2f847ce

print("\n❌ State verification failed!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 76 in 2f847ce

print("\n🛑 Home Assistant stopped cleanly")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 82 in 2f847ce

print("\n🎭 Testing Playwright integration...")

---

⚠️ [ruff] <PLC0415> _{reported by reviewdog 🐶}
import should be at the top-level of a file

haeo/tests/guides/test_ha_runner.py

Line 85 in 2f847ce

from playwright.sync_api import sync_playwright

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 87 in 2f847ce

print(" ⚠️ Playwright not installed, skipping browser test")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 91 in 2f847ce

print(f" HA running at {hass.url}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 100 in 2f847ce

print(f" Page title: {title}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 103 in 2f847ce

print(" ✅ Playwright can connect to HA!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 105 in 2f847ce

print(f" ⚠️ Unexpected title: {title}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 115 in 2f847ce

print("=" * 60)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 116 in 2f847ce

print("Home Assistant In-Process Runner Tests")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 117 in 2f847ce

print("=" * 60)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 125 in 2f847ce

print(f"\n❌ Basic startup test failed: {e}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 135 in 2f847ce

print(f"\n❌ Playwright test failed: {e}")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 141 in 2f847ce

print("\n" + "=" * 60)

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 143 in 2f847ce

print("✅ All tests passed!")

---

⚠️ [ruff] <T201> _{reported by reviewdog 🐶}
print found

haeo/tests/guides/test_ha_runner.py

Line 146 in 2f847ce

print("❌ Some tests failed!")

[github-actions]

[prettier] _{reported by reviewdog 🐶}

Suggested change

	"ha-list-item, mwc-list-item, md-list-item, " +
	'[role="listitem"], [role="option"]'
	"ha-list-item, mwc-list-item, md-list-item, " + '[role="listitem"], [role="option"]'

[github-actions]

[prettier] _{reported by reviewdog 🐶}

Suggested change

	const listItemParent = entityListItem.closest(
	"ha-list-item, mwc-list-item, md-list-item, md-item"
	);
	const listItemParent = entityListItem.closest("ha-list-item, mwc-list-item, md-list-item, md-item");

[github-actions]

[prettier] _{reported by reviewdog 🐶}

Suggested change

	const haWrapper = roleItem.closest(
	"ha-list-item, md-item, mwc-list-item, .combo-box-row"
	);
	const haWrapper = roleItem.closest("ha-list-item, md-item, mwc-list-item, .combo-box-row");

[github-actions]

⚠️ [ruff] <I001> _{reported by reviewdog 🐶}
Import block is un-sorted or un-formatted

Suggested change

	from tests.guides.primitives.ha_page import HAPage
	from tests.guides.primitives.haeo import (
	Entity,
	add_battery,
	add_grid,
	add_integration,
	add_inverter,
	add_load,
	add_node,
	add_solar,
	login,
	verify_setup,
	)
	from tests.guides.primitives.capture import (
	ScreenshotContext,
	guide_step,
	screenshot_context,
	)
	__all__ = [
	from tests.guides.primitives.capture import ScreenshotContext, guide_step, screenshot_context
	from tests.guides.primitives.ha_page import HAPage
	from tests.guides.primitives.haeo import (
	Entity,
	add_battery,
	add_grid,
	add_integration,
	add_inverter,
	add_load,
	add_node,
	add_solar,
	login,
	verify_setup,
	)
	__all__ = [

[github-actions]

⚠️ [ruff] <RUF022> _{reported by reviewdog 🐶}
__all__ is not sorted

Suggested change

	__all__ = [
	# Screenshot context
	"ScreenshotContext",
	"guide_step",
	"screenshot_context",
	# Low-level primitives
	"HAPage",
	# Entity type
	"Entity",
	# HAEO element primitives
	"add_battery",
	"add_grid",
	"add_integration",
	"add_inverter",
	"add_load",
	"add_node",
	"add_solar",
	"login",
	"verify_setup",
	]
	__all__ = [
	# Entity type
	"Entity",
	# Low-level primitives
	"HAPage",
	# Screenshot context
	"ScreenshotContext",
	# HAEO element primitives
	"add_battery",
	"add_grid",
	"add_integration",
	"add_inverter",
	"add_load",
	"add_node",
	"add_solar",
	"guide_step",
	"login",
	"screenshot_context",
	"verify_setup",
	]

[github-actions]

⚠️ [ruff] <UP035> _{reported by reviewdog 🐶}
Import from collections.abc instead: Callable

Suggested change

	from typing import TYPE_CHECKING, Any, Callable, TypeVar
	from typing import TYPE_CHECKING, Any, TypeVar
	from collections.abc import Callable

[github-actions]

⚠️ [ruff] <PLW0603> _{reported by reviewdog 🐶}
Using the global statement to update _current_context is discouraged

[github-actions]

⚠️ [ruff] <PLW0603> _{reported by reviewdog 🐶}
Using the global statement to update _current_context is discouraged

[github-actions]

⚠️ [ruff] <UP047> _{reported by reviewdog 🐶}
Generic function guide_step should use type parameters

Suggested change

	def guide_step(func: F) -> F:
	def guide_step[F: Callable[..., Any]](func: F) -> F:

[github-actions]

⚠️ [ruff] <D401> _{reported by reviewdog 🐶}
First line of docstring should be in imperative mood: "Decorator for HAEO primitive functions."

[github-actions]

⚠️ [ruff] <I001> _{reported by reviewdog 🐶}
Import block is un-sorted or un-formatted

Suggested change

	from __future__ import annotations
	import logging
	from collections import OrderedDict
	from pathlib import Path
	import shutil
	import sys
	from typing import Any
	from playwright.sync_api import sync_playwright
	from tests.guides.ha_runner import LiveHomeAssistant, live_home_assistant
	from tests.guides.primitives import (
	HAPage,
	add_battery,
	add_grid,
	add_integration,
	add_inverter,
	add_load,
	add_solar,
	login,
	screenshot_context,
	verify_setup,
	)
	_LOGGER = logging.getLogger(__name__)
	from __future__ import annotations
	from collections import OrderedDict
	import logging
	from pathlib import Path
	import shutil
	import sys
	from typing import Any
	from playwright.sync_api import sync_playwright
	from tests.guides.ha_runner import LiveHomeAssistant, live_home_assistant
	from tests.guides.primitives import (
	HAPage,
	add_battery,
	add_grid,
	add_integration,
	add_inverter,
	add_load,
	add_solar,
	login,
	screenshot_context,
	verify_setup,
	)
	_LOGGER = logging.getLogger(__name__)

[github-actions]

⚠️ [ruff] <F401> _{reported by reviewdog 🐶}
typing.Any imported but unused

Suggested change

from typing import Any