pytest-homeassistant-custom-component 0.13.289__py3-none-any.whl → 0.13.291__py3-none-any.whl

pytest_homeassistant_custom_component/components/recorder/common.py

@@ -15,10 +15,12 @@ from functools import partial
 import importlib
 import sys
 import time
+from types import ModuleType
 from typing import Any, Literal, cast
 from unittest.mock import MagicMock, patch, sentinel
 
 from freezegun import freeze_time
+import pytest
 from sqlalchemy import create_engine, event as sqlalchemy_event
 from sqlalchemy.orm.session import Session
 
@@ -32,18 +34,25 @@ from homeassistant.components.recorder import (
     statistics,
 )
 from homeassistant.components.recorder.db_schema import (
+    EventData,
     Events,
     EventTypes,
     RecorderRuns,
+    StateAttributes,
     States,
     StatesMeta,
 )
+from homeassistant.components.recorder.models import (
+    bytes_to_ulid_or_none,
+    bytes_to_uuid_hex_or_none,
+)
 from homeassistant.components.recorder.tasks import RecorderTask, StatisticsTask
 from homeassistant.components.sensor import SensorDeviceClass, SensorStateClass
 from homeassistant.const import DEGREE, UnitOfTemperature
 from homeassistant.core import Event, HomeAssistant, State
 from homeassistant.helpers import recorder as recorder_helper
 from homeassistant.util import dt as dt_util
+from homeassistant.util.json import json_loads, json_loads_object
 
 from . import db_schema_0
 
@@ -456,6 +465,13 @@ def get_schema_module_path(schema_version_postfix: str) -> str:
     return f"...components.recorder.db_schema_{schema_version_postfix}"
 
 
+def get_patched_live_version(old_db_schema: ModuleType) -> int:
+    """Return the patched live migration version."""
+    return min(
+        migration.LIVE_MIGRATION_MIN_SCHEMA_VERSION, old_db_schema.SCHEMA_VERSION
+    )
+
+
 @contextmanager
 def old_db_schema(hass: HomeAssistant, schema_version_postfix: str) -> Iterator[None]:
     """Fixture to initialize the db with the old schema."""
@@ -466,6 +482,11 @@ def old_db_schema(hass: HomeAssistant, schema_version_postfix: str) -> Iterator[
     with (
         patch.object(recorder, "db_schema", old_db_schema),
         patch.object(migration, "SCHEMA_VERSION", old_db_schema.SCHEMA_VERSION),
+        patch.object(
+            migration,
+            "LIVE_MIGRATION_MIN_SCHEMA_VERSION",
+            get_patched_live_version(old_db_schema),
+        ),
         patch.object(migration, "non_live_data_migration_needed", return_value=False),
         patch.object(core, "StatesMeta", old_db_schema.StatesMeta),
         patch.object(core, "EventTypes", old_db_schema.EventTypes),
@@ -496,3 +517,97 @@ async def async_attach_db_engine(hass: HomeAssistant) -> None:
             )
 
     await instance.async_add_executor_job(_mock_setup_recorder_connection)
+
+
+EVENT_ORIGIN_ORDER = [ha.EventOrigin.local, ha.EventOrigin.remote]
+
+
+def db_event_to_native(event: Events, validate_entity_id: bool = True) -> Event | None:
+    """Convert to a native HA Event."""
+    context = ha.Context(
+        id=bytes_to_ulid_or_none(event.context_id_bin),
+        user_id=bytes_to_uuid_hex_or_none(event.context_user_id_bin),
+        parent_id=bytes_to_ulid_or_none(event.context_parent_id_bin),
+    )
+    return Event(
+        event.event_type or "",
+        json_loads_object(event.event_data) if event.event_data else {},
+        ha.EventOrigin(event.origin)
+        if event.origin
+        else EVENT_ORIGIN_ORDER[event.origin_idx or 0],
+        event.time_fired_ts or 0,
+        context=context,
+    )
+
+
+def db_event_data_to_native(event_data: EventData) -> dict[str, Any]:
+    """Convert to an event data dictionary."""
+    shared_data = event_data.shared_data
+    if shared_data is None:
+        return {}
+    return cast(dict[str, Any], json_loads(shared_data))
+
+
+def db_state_to_native(state: States, validate_entity_id: bool = True) -> State | None:
+    """Convert to an HA state object."""
+    context = ha.Context(
+        id=bytes_to_ulid_or_none(state.context_id_bin),
+        user_id=bytes_to_uuid_hex_or_none(state.context_user_id_bin),
+        parent_id=bytes_to_ulid_or_none(state.context_parent_id_bin),
+    )
+    attrs = json_loads_object(state.attributes) if state.attributes else {}
+    last_updated = dt_util.utc_from_timestamp(state.last_updated_ts or 0)
+    if state.last_changed_ts is None or state.last_changed_ts == state.last_updated_ts:
+        last_changed = dt_util.utc_from_timestamp(state.last_updated_ts or 0)
+    else:
+        last_changed = dt_util.utc_from_timestamp(state.last_changed_ts or 0)
+    if (
+        state.last_reported_ts is None
+        or state.last_reported_ts == state.last_updated_ts
+    ):
+        last_reported = dt_util.utc_from_timestamp(state.last_updated_ts or 0)
+    else:
+        last_reported = dt_util.utc_from_timestamp(state.last_reported_ts or 0)
+    return State(
+        state.entity_id or "",
+        state.state,  # type: ignore[arg-type]
+        # Join the state_attributes table on attributes_id to get the attributes
+        # for newer states
+        attrs,
+        last_changed=last_changed,
+        last_reported=last_reported,
+        last_updated=last_updated,
+        context=context,
+        validate_entity_id=validate_entity_id,
+    )
+
+
+def db_state_attributes_to_native(state_attrs: StateAttributes) -> dict[str, Any]:
+    """Convert to a state attributes dictionary."""
+    shared_attrs = state_attrs.shared_attrs
+    if shared_attrs is None:
+        return {}
+    return cast(dict[str, Any], json_loads(shared_attrs))
+
+
+async def async_drop_index(
+    recorder: Recorder, table: str, index: str, caplog: pytest.LogCaptureFixture
+) -> None:
+    """Drop an index from the database.
+
+    migration._drop_index does not return or raise, so we verify the result
+    by checking the log for success or failure messages.
+    """
+
+    finish_msg = f"Finished dropping index `{index}` from table `{table}`"
+    fail_msg = f"Failed to drop index `{index}` from table `{table}`"
+
+    count_finish = caplog.text.count(finish_msg)
+    count_fail = caplog.text.count(fail_msg)
+
+    await recorder.async_add_executor_job(
+        migration._drop_index, recorder.get_session, table, index
+    )
+
+    assert caplog.text.count(finish_msg) == count_finish + 1
+    assert caplog.text.count(fail_msg) == count_fail

pytest_homeassistant_custom_component/const.py

@@ -5,8 +5,8 @@ This file is originally from homeassistant/core and modified by pytest-homeassis
 """
 from typing import TYPE_CHECKING, Final
 MAJOR_VERSION: Final = 2025
-MINOR_VERSION: Final = 10
-PATCH_VERSION: Final = "4"
+MINOR_VERSION: Final = 11
+PATCH_VERSION: Final = "0b1"
 __short_version__: Final = f"{MAJOR_VERSION}.{MINOR_VERSION}"
 __version__: Final = f"{__short_version__}.{PATCH_VERSION}"
 CONF_API_VERSION: Final = "api_version"

pytest_homeassistant_custom_component/patch_time.py

@@ -30,8 +30,31 @@ def ha_datetime_to_fakedatetime(datetime) -> freezegun.api.FakeDatetime:  # type
     )
 
 
-class HAFakeDatetime(freezegun.api.FakeDatetime):  # type: ignore[name-defined]
-    """Modified to include https://github.com/spulec/freezegun/pull/424."""
+class HAFakeDateMeta(freezegun.api.FakeDateMeta):
+    """Modified to override the string representation."""
+
+    def __str__(cls) -> str:  # noqa: N805 (ruff doesn't know this is a metaclass)
+        """Return the string representation of the class."""
+        return "<class 'datetime.date'>"
+
+
+class HAFakeDate(freezegun.api.FakeDate, metaclass=HAFakeDateMeta):  # type: ignore[name-defined]
+    """Modified to improve class str."""
+
+
+class HAFakeDatetimeMeta(freezegun.api.FakeDatetimeMeta):
+    """Modified to override the string representation."""
+
+    def __str__(cls) -> str:  # noqa: N805 (ruff doesn't know this is a metaclass)
+        """Return the string representation of the class."""
+        return "<class 'datetime.datetime'>"
+
+
+class HAFakeDatetime(freezegun.api.FakeDatetime, metaclass=HAFakeDatetimeMeta):  # type: ignore[name-defined]
+    """Modified to include basic fold support and improve class str.
+
+    Fold support submitted to upstream in https://github.com/spulec/freezegun/pull/424.
+    """
 
     @classmethod
     def now(cls, tz=None):

pytest_homeassistant_custom_component/plugins.py

@@ -163,6 +163,7 @@ asyncio.set_event_loop_policy = lambda policy: None
 def pytest_addoption(parser: pytest.Parser) -> None:
     """Register custom pytest options."""
     parser.addoption("--dburl", action="store", default="sqlite://")
+    parser.addoption("--drop-existing-db", action="store_const", const=True)
 
 
 def pytest_configure(config: pytest.Config) -> None:
@@ -190,11 +191,13 @@ def pytest_runtest_setup() -> None:
     destinations will be allowed.
 
     freezegun:
-    Modified to include https://github.com/spulec/freezegun/pull/424
+    Modified to include https://github.com/spulec/freezegun/pull/424 and improve class str.
     """
     pytest_socket.socket_allow_hosts(["127.0.0.1"])
     pytest_socket.disable_socket(allow_unix_socket=True)
 
+    freezegun.api.FakeDate = patch_time.HAFakeDate  # type: ignore[attr-defined]
+
     freezegun.api.datetime_to_fakedatetime = patch_time.ha_datetime_to_fakedatetime  # type: ignore[attr-defined]
     freezegun.api.FakeDatetime = patch_time.HAFakeDatetime  # type: ignore[attr-defined]
 
@@ -1494,44 +1497,58 @@ def recorder_db_url(
     assert not hass_fixture_setup
 
     db_url = cast(str, pytestconfig.getoption("dburl"))
+    drop_existing_db = pytestconfig.getoption("drop_existing_db")
+
+    def drop_db() -> None:
+        import sqlalchemy as sa  # noqa: PLC0415
+        import sqlalchemy_utils  # noqa: PLC0415
+
+        if db_url.startswith("mysql://"):
+            made_url = sa.make_url(db_url)
+            db = made_url.database
+            engine = sa.create_engine(db_url)
+            # Check for any open connections to the database before dropping it
+            # to ensure that InnoDB does not deadlock.
+            with engine.begin() as connection:
+                query = sa.text(
+                    "select id FROM information_schema.processlist WHERE db=:db and id != CONNECTION_ID()"
+                )
+                rows = connection.execute(query, parameters={"db": db}).fetchall()
+                if rows:
+                    raise RuntimeError(
+                        f"Unable to drop database {db} because it is in use by {rows}"
+                    )
+            engine.dispose()
+            sqlalchemy_utils.drop_database(db_url)
+        elif db_url.startswith("postgresql://"):
+            sqlalchemy_utils.drop_database(db_url)
+
     if db_url == "sqlite://" and persistent_database:
         tmp_path = tmp_path_factory.mktemp("recorder")
         db_url = "sqlite:///" + str(tmp_path / "pytest.db")
-    elif db_url.startswith("mysql://"):
+    elif db_url.startswith(("mysql://", "postgresql://")):
         import sqlalchemy_utils  # noqa: PLC0415
 
-        charset = "utf8mb4' COLLATE = 'utf8mb4_unicode_ci"
-        assert not sqlalchemy_utils.database_exists(db_url)
-        sqlalchemy_utils.create_database(db_url, encoding=charset)
-    elif db_url.startswith("postgresql://"):
-        import sqlalchemy_utils  # noqa: PLC0415
+        if drop_existing_db and sqlalchemy_utils.database_exists(db_url):
+            drop_db()
 
-        assert not sqlalchemy_utils.database_exists(db_url)
-        sqlalchemy_utils.create_database(db_url, encoding="utf8")
+        if sqlalchemy_utils.database_exists(db_url):
+            raise RuntimeError(
+                f"Database {db_url} already exists. Use --drop-existing-db "
+                "to automatically drop existing database before start of test."
+            )
+
+        sqlalchemy_utils.create_database(
+            db_url,
+            encoding="utf8mb4' COLLATE = 'utf8mb4_unicode_ci"
+            if db_url.startswith("mysql://")
+            else "utf8",
+        )
     yield db_url
     if db_url == "sqlite://" and persistent_database:
         rmtree(tmp_path, ignore_errors=True)
-    elif db_url.startswith("mysql://"):
-        import sqlalchemy as sa  # noqa: PLC0415
-
-        made_url = sa.make_url(db_url)
-        db = made_url.database
-        engine = sa.create_engine(db_url)
-        # Check for any open connections to the database before dropping it
-        # to ensure that InnoDB does not deadlock.
-        with engine.begin() as connection:
-            query = sa.text(
-                "select id FROM information_schema.processlist WHERE db=:db and id != CONNECTION_ID()"
-            )
-            rows = connection.execute(query, parameters={"db": db}).fetchall()
-            if rows:
-                raise RuntimeError(
-                    f"Unable to drop database {db} because it is in use by {rows}"
-                )
-        engine.dispose()
-        sqlalchemy_utils.drop_database(db_url)
-    elif db_url.startswith("postgresql://"):
-        sqlalchemy_utils.drop_database(db_url)
+    elif db_url.startswith(("mysql://", "postgresql://")):
+        drop_db()
 
 
 async def _async_init_recorder_component(
@@ -1661,10 +1678,12 @@ async def async_test_recorder(
     migrate_entity_ids = (
         migration.EntityIDMigration.migrate_data if enable_migrate_entity_ids else None
     )
-    legacy_event_id_foreign_key_exists = (
-        migration.EventIDPostMigration._legacy_event_id_foreign_key_exists
+    post_migrate_event_ids = (
+        migration.EventIDPostMigration.needs_migrate_impl
         if enable_migrate_event_ids
-        else lambda _: None
+        else lambda _1, _2, _3: migration.DataMigrationStatus(
+            needs_migrate=False, migration_done=True
+        )
     )
     with (
         patch(
@@ -1703,8 +1722,8 @@ async def async_test_recorder(
             autospec=True,
         ),
         patch(
-            "homeassistant.components.recorder.migration.EventIDPostMigration._legacy_event_id_foreign_key_exists",
-            side_effect=legacy_event_id_foreign_key_exists,
+            "homeassistant.components.recorder.migration.EventIDPostMigration.needs_migrate_impl",
+            side_effect=post_migrate_event_ids,
             autospec=True,
         ),
         patch(

{pytest_homeassistant_custom_component-0.13.289.dist-info → pytest_homeassistant_custom_component-0.13.291.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-homeassistant-custom-component
-Version: 0.13.289
+Version: 0.13.291
 Summary: Experimental package to automatically extract test plugins for Home Assistant custom components
 Home-page: https://github.com/MatthewFlamm/pytest-homeassistant-custom-component
 Author: Matthew Flamm
@@ -21,9 +21,10 @@ Requires-Dist: sqlalchemy
 Requires-Dist: coverage==7.10.6
 Requires-Dist: freezegun==1.5.2
 Requires-Dist: go2rtc-client==0.2.1
+Requires-Dist: librt==0.2.1
 Requires-Dist: license-expression==30.4.3
 Requires-Dist: mock-open==1.4.0
-Requires-Dist: pydantic==2.11.9
+Requires-Dist: pydantic==2.12.2
 Requires-Dist: pylint-per-file-ignores==1.4.0
 Requires-Dist: pipdeptree==2.26.1
 Requires-Dist: pytest-asyncio==1.2.0
@@ -40,9 +41,9 @@ Requires-Dist: pytest-xdist==3.8.0
 Requires-Dist: pytest==8.4.2
 Requires-Dist: requests-mock==1.12.1
 Requires-Dist: respx==0.22.0
-Requires-Dist: syrupy==4.9.1
+Requires-Dist: syrupy==5.0.0
 Requires-Dist: tqdm==4.67.1
-Requires-Dist: homeassistant==2025.10.4
+Requires-Dist: homeassistant==2025.11.0b1
 Requires-Dist: SQLAlchemy==2.0.41
 Requires-Dist: paho-mqtt==2.1.0
 Requires-Dist: numpy==2.3.2
@@ -60,7 +61,7 @@ Dynamic: summary
 
 # pytest-homeassistant-custom-component
 
-![HA core version](https://img.shields.io/static/v1?label=HA+core+version&message=2025.10.4&labelColor=blue)
+![HA core version](https://img.shields.io/static/v1?label=HA+core+version&message=2025.11.0b1&labelColor=blue)
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/MatthewFlamm/pytest-homeassistant-custom-component)
 

{pytest_homeassistant_custom_component-0.13.289.dist-info → pytest_homeassistant_custom_component-0.13.291.dist-info}/RECORD

@@ -1,28 +1,28 @@
 pytest_homeassistant_custom_component/__init__.py,sha256=pUI8j-H-57ncCLnvZSDWZPCtJpvi3ACZqPtH5SbedZA,138
 pytest_homeassistant_custom_component/asyncio_legacy.py,sha256=UdkV2mKqeS21QX9LSdBYsBRbm2h4JCVVZeesaOLKOAE,3886
 pytest_homeassistant_custom_component/common.py,sha256=51NiAKz0WppfuJzZq4d2ljFrXMpWBhvZSwCglw86ahI,65438
-pytest_homeassistant_custom_component/const.py,sha256=awXDQ-f5HuFUAKwTIVxXTOt9xluh3wNLhMFYyytgDGI,440
+pytest_homeassistant_custom_component/const.py,sha256=26IVwahF1Vn0xRHF3twU5nbROhOHL0BRlpjQOS3SDYY,442
 pytest_homeassistant_custom_component/ignore_uncaught_exceptions.py,sha256=rilak_dQGMNhDqST1ZzhjZl_qmytFjkcez0vYmLMQ4Q,1601
 pytest_homeassistant_custom_component/patch_json.py,sha256=hNUeb1yxAr7ONfvX-o_WkI6zhQDCdKl7GglPjkVUiHo,1063
 pytest_homeassistant_custom_component/patch_recorder.py,sha256=lW8N_3ZIKQ5lsVjRc-ROo7d0egUZcpjquWKqe7iEF94,819
-pytest_homeassistant_custom_component/patch_time.py,sha256=G6RcRJNvl8q6qcbvknA21dsZdoF5gfQDh46PptWAwWA,2509
-pytest_homeassistant_custom_component/plugins.py,sha256=9k3BTS1lZXj3OGyMNnWxjw-cVHkIvcmWFoGKiT6_W-A,68922
+pytest_homeassistant_custom_component/patch_time.py,sha256=jdnOAXDxUA0AKqvyeSrRC18rHDGfcpWYuLhmUglebCE,3374
+pytest_homeassistant_custom_component/plugins.py,sha256=B5EXdcXOTZLyfL-Wm5yrK7fgJNmwCP5mopYfqNgSEy0,69609
 pytest_homeassistant_custom_component/syrupy.py,sha256=N_g_90dWqruzUogQi0rJsuN0XRbA6ffJen62r8P9cdo,15588
 pytest_homeassistant_custom_component/typing.py,sha256=zGhdf6U6aRq5cPwIfRUdtZeApLOyPD2EArjznKoIRZM,1734
 pytest_homeassistant_custom_component/components/__init__.py,sha256=0BHCdArl5gPjDJWaZrqvApHvzL_29FbE1RMg_mg__Qs,138
 pytest_homeassistant_custom_component/components/diagnostics/__init__.py,sha256=O_ys8t0iHvRorFr4TrR9k3sa3Xh5qBb4HsylY775UFA,2431
 pytest_homeassistant_custom_component/components/recorder/__init__.py,sha256=ugrLzvjSQFSmYRjy88ZZSiyA-NLgKlLkFp0OKguy6a4,225
-pytest_homeassistant_custom_component/components/recorder/common.py,sha256=SoKcNp_rSWMcMUxkbhZ193L67OYBhUbAX1X8IGvIjbA,17943
+pytest_homeassistant_custom_component/components/recorder/common.py,sha256=8c_oqbQtg7dI-JoOaZrLYKFAjEJvjvSIA1atfui-WpQ,22091
 pytest_homeassistant_custom_component/components/recorder/db_schema_0.py,sha256=0mez9slhL-I286dDAxq06UDvWRU6RzCA2GKOwtj9JOI,5547
 pytest_homeassistant_custom_component/test_util/__init__.py,sha256=ljLmNeblq1vEgP0vhf2P1-SuyGSHvLKVA0APSYA0Xl8,1034
 pytest_homeassistant_custom_component/test_util/aiohttp.py,sha256=oPQaFRgXcAfHj9dE2Rjl1UJCBfhQp80CnQV02rXMYLo,11520
 pytest_homeassistant_custom_component/testing_config/__init__.py,sha256=SRp6h9HJi2I_vA6cPNkMiR0BTYib5XVmL03H-l3BPL0,158
 pytest_homeassistant_custom_component/testing_config/custom_components/__init__.py,sha256=-l6KCBLhwEDkCztlY6S-j53CjmKY6-A_3eX5JVS02NY,173
 pytest_homeassistant_custom_component/testing_config/custom_components/test_constant_deprecation/__init__.py,sha256=2vF_C-VP9tDjZMX7h6iJRAugtH2Bf3b4fE3i9j4vGeY,383
-pytest_homeassistant_custom_component-0.13.289.dist-info/licenses/LICENSE,sha256=7h-vqUxyeQNXiQgRJ8350CSHOy55M07DZuv4KG70AS8,1070
-pytest_homeassistant_custom_component-0.13.289.dist-info/licenses/LICENSE_HA_CORE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pytest_homeassistant_custom_component-0.13.289.dist-info/METADATA,sha256=Ctr87uctwsoCpWceGBh5m8afwAPHiXoWfQa3Vtq2ve4,5930
-pytest_homeassistant_custom_component-0.13.289.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pytest_homeassistant_custom_component-0.13.289.dist-info/entry_points.txt,sha256=bOCTSuP8RSPg0QfwdfurUShvMGWg4MI2F8rxbWx-VtQ,73
-pytest_homeassistant_custom_component-0.13.289.dist-info/top_level.txt,sha256=PR2cize2la22eOO7dQChJWK8dkJnuMmDC-fhafmdOWw,38
-pytest_homeassistant_custom_component-0.13.289.dist-info/RECORD,,
+pytest_homeassistant_custom_component-0.13.291.dist-info/licenses/LICENSE,sha256=7h-vqUxyeQNXiQgRJ8350CSHOy55M07DZuv4KG70AS8,1070
+pytest_homeassistant_custom_component-0.13.291.dist-info/licenses/LICENSE_HA_CORE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pytest_homeassistant_custom_component-0.13.291.dist-info/METADATA,sha256=NitW4dKADWyWswh6h_SsO4DMtBWUDD4f91L8y9V8Hj0,5962
+pytest_homeassistant_custom_component-0.13.291.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pytest_homeassistant_custom_component-0.13.291.dist-info/entry_points.txt,sha256=bOCTSuP8RSPg0QfwdfurUShvMGWg4MI2F8rxbWx-VtQ,73
+pytest_homeassistant_custom_component-0.13.291.dist-info/top_level.txt,sha256=PR2cize2la22eOO7dQChJWK8dkJnuMmDC-fhafmdOWw,38
+pytest_homeassistant_custom_component-0.13.291.dist-info/RECORD,,