Bump version

Author: MatthewFlamm

README.md

@@ -1,6 +1,6 @@
 # pytest-homeassistant-custom-component
 
-![HA core version](https://img.shields.io/static/v1?label=HA+core+version&message=2022.10.5&labelColor=blue)
+![HA core version](https://img.shields.io/static/v1?label=HA+core+version&message=2022.11.0b0&labelColor=blue)
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/MatthewFlamm/pytest-homeassistant-custom-component)
 

ha_version

@@ -1 +1 @@
-2022.10.5
+2022.11.0b0

pytest_homeassistant_custom_component/common.py

@@ -25,6 +25,7 @@
 from unittest.mock import AsyncMock, Mock, patch
 
 from aiohttp.test_utils import unused_port as get_test_instance_port  # noqa: F401
+import voluptuous as vol
 
 from homeassistant import auth, config_entries, core as ha, loader
 from homeassistant.auth import (
@@ -47,7 +48,7 @@
     STATE_OFF,
     STATE_ON,
 )
-from homeassistant.core import BLOCK_LOG_TIMEOUT, HomeAssistant
+from homeassistant.core import BLOCK_LOG_TIMEOUT, HomeAssistant, ServiceCall, State
 from homeassistant.helpers import (
     area_registry,
     device_registry,
@@ -62,6 +63,7 @@
 )
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.json import JSONEncoder
+from homeassistant.helpers.typing import ConfigType
 from homeassistant.setup import setup_component
 from homeassistant.util.async_ import run_callback_threadsafe
 import homeassistant.util.dt as date_util
@@ -333,7 +335,9 @@ def clear_instance(event):
     return hass
 
 
-def async_mock_service(hass, domain, service, schema=None):
+def async_mock_service(
+    hass: HomeAssistant, domain: str, service: str, schema: vol.Schema | None = None
+) -> list[ServiceCall]:
     """Set up a fake service & return a calls log list to this service."""
     calls = []
 
@@ -423,18 +427,20 @@ def get_fixture_path(filename: str, integration: str | None = None) -> pathlib.P
 
     if integration is None:
         return pathlib.Path(start_path).parent.joinpath("fixtures", filename)
-    else:
-        return pathlib.Path(start_path).parent.joinpath(
-            "components", integration, "fixtures", filename
-        )
+
+    return pathlib.Path(start_path).parent.joinpath(
+        "components", integration, "fixtures", filename
+    )
 
 
-def load_fixture(filename, integration=None):
+def load_fixture(filename: str, integration: str | None = None) -> str:
     """Load a fixture."""
     return get_fixture_path(filename, integration).read_text()
 
 
-def mock_state_change_event(hass, new_state, old_state=None):
+def mock_state_change_event(
+    hass: HomeAssistant, new_state: State, old_state: State | None = None
+) -> None:
     """Mock state change envent."""
     event_data = {"entity_id": new_state.entity_id, "new_state": new_state}
 
@@ -445,15 +451,18 @@ def mock_state_change_event(hass, new_state, old_state=None):
 
 
 @ha.callback
-def mock_component(hass, component):
+def mock_component(hass: HomeAssistant, component: str) -> None:
     """Mock a component is setup."""
     if component in hass.config.components:
         AssertionError(f"Integration {component} is already setup")
 
     hass.config.components.add(component)
 
 
-def mock_registry(hass, mock_entries=None):
+def mock_registry(
+    hass: HomeAssistant,
+    mock_entries: dict[str, entity_registry.RegistryEntry] | None = None,
+) -> entity_registry.EntityRegistry:
     """Mock the Entity Registry."""
     registry = entity_registry.EntityRegistry(hass)
     if mock_entries is None:
@@ -466,7 +475,9 @@ def mock_registry(hass, mock_entries=None):
     return registry
 
 
-def mock_area_registry(hass, mock_entries=None):
+def mock_area_registry(
+    hass: HomeAssistant, mock_entries: dict[str, area_registry.AreaEntry] | None = None
+) -> area_registry.AreaRegistry:
     """Mock the Area Registry."""
     registry = area_registry.AreaRegistry(hass)
     registry.areas = mock_entries or OrderedDict()
@@ -475,7 +486,10 @@ def mock_area_registry(hass, mock_entries=None):
     return registry
 
 
-def mock_device_registry(hass, mock_entries=None):
+def mock_device_registry(
+    hass: HomeAssistant,
+    mock_entries: dict[str, device_registry.DeviceEntry] | None = None,
+) -> device_registry.DeviceRegistry:
     """Mock the Device Registry."""
     registry = device_registry.DeviceRegistry(hass)
     registry.devices = device_registry.DeviceRegistryItems()
@@ -551,7 +565,9 @@ def mock_policy(self, policy):
         self._permissions = auth_permissions.PolicyPermissions(policy, self.perm_lookup)
 
 
-async def register_auth_provider(hass, config):
+async def register_auth_provider(
+    hass: HomeAssistant, config: ConfigType
+) -> auth_providers.AuthProvider:
     """Register an auth provider."""
     provider = await auth_providers.auth_provider_from_config(
         hass, hass.auth._store, config
@@ -915,17 +931,15 @@ async def mock_psc(hass, config_input, integration):
 SetupRecorderInstanceT = Callable[..., Awaitable[recorder.Recorder]]
 
 
-def init_recorder_component(hass, add_config=None):
+def init_recorder_component(hass, add_config=None, db_url="sqlite://"):
     """Initialize the recorder."""
     config = dict(add_config) if add_config else {}
     if recorder.CONF_DB_URL not in config:
-        config[recorder.CONF_DB_URL] = "sqlite://"  # In memory DB
+        config[recorder.CONF_DB_URL] = db_url
         if recorder.CONF_COMMIT_INTERVAL not in config:
             config[recorder.CONF_COMMIT_INTERVAL] = 0
 
-    with patch("homeassistant.components.recorder.ALLOW_IN_MEMORY_DB", True), patch(
-        "homeassistant.components.recorder.migration.migrate_schema"
-    ):
+    with patch("homeassistant.components.recorder.ALLOW_IN_MEMORY_DB", True):
         if recorder.DOMAIN not in hass.data:
             recorder_helper.async_initialize_recorder(hass)
         assert setup_component(hass, recorder.DOMAIN, {recorder.DOMAIN: config})

pytest_homeassistant_custom_component/components/recorder/common.py

@@ -7,7 +7,7 @@
 
 import asyncio
 from dataclasses import dataclass
-from datetime import datetime, timedelta
+from datetime import datetime
 import time
 from typing import Any, cast
 
@@ -25,8 +25,6 @@
 
 from . import db_schema_0
 
-from ...common import async_fire_time_changed, fire_time_changed
-
 DEFAULT_PURGE_TASKS = 3
 
 
@@ -73,9 +71,7 @@ def wait_recording_done(hass: HomeAssistant) -> None:
 
 def trigger_db_commit(hass: HomeAssistant) -> None:
     """Force the recorder to commit."""
-    for _ in range(recorder.DEFAULT_COMMIT_INTERVAL):
-        # We only commit on time change
-        fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=1))
+    recorder.get_instance(hass)._async_commit(dt_util.utcnow())
 
 
 async def async_wait_recording_done(hass: HomeAssistant) -> None:
@@ -104,8 +100,7 @@ async def async_wait_purge_done(hass: HomeAssistant, max: int = None) -> None:
 @ha.callback
 def async_trigger_db_commit(hass: HomeAssistant) -> None:
     """Force the recorder to commit. Async friendly."""
-    for _ in range(recorder.DEFAULT_COMMIT_INTERVAL):
-        async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=1))
+    recorder.get_instance(hass)._async_commit(dt_util.utcnow())
 
 
 async def async_recorder_block_till_done(hass: HomeAssistant) -> None:

pytest_homeassistant_custom_component/const.py

@@ -10,8 +10,8 @@
 
 APPLICATION_NAME: Final = "HomeAssistant"
 MAJOR_VERSION: Final = 2022
-MINOR_VERSION: Final = 10
-PATCH_VERSION: Final = "5"
+MINOR_VERSION: Final = 11
+PATCH_VERSION: Final = "0b0"
 __short_version__: Final = f"{MAJOR_VERSION}.{MINOR_VERSION}"
 __version__: Final = f"{__short_version__}.{PATCH_VERSION}"
 REQUIRED_PYTHON_VER: Final[tuple[int, int, int]] = (3, 9, 0)

pytest_homeassistant_custom_component/plugins.py

@@ -83,6 +83,11 @@
 asyncio.set_event_loop_policy = lambda policy: None
 
 
+def pytest_addoption(parser):
+    """Register custom pytest options."""
+    parser.addoption("--dburl", action="store", default="sqlite://")
+
+
 def pytest_configure(config):
     """Register marker for tests that log exceptions."""
     config.addinivalue_line(
@@ -112,8 +117,19 @@ def pytest_runtest_setup():
     def adapt_datetime(val):
         return val.isoformat(" ")
 
+    # Setup HAFakeDatetime converter for sqlite3
     sqlite3.register_adapter(HAFakeDatetime, adapt_datetime)
 
+    # Setup HAFakeDatetime converter for pymysql
+    try:
+        import MySQLdb.converters as MySQLdb_converters
+    except ImportError:
+        pass
+    else:
+        MySQLdb_converters.conversions[
+            HAFakeDatetime
+        ] = MySQLdb_converters.DateTime2literal
+
 
 def ha_datetime_to_fakedatetime(datetime):
     """Convert datetime to FakeDatetime.
@@ -316,9 +332,17 @@ async def finalize() -> None:
 
 
 @pytest.fixture
-def hass(loop, load_registries, hass_storage, request):
+def hass_fixture_setup():
+    """Fixture whichis truthy if the hass fixture has been setup."""
+    return []
+
+
+@pytest.fixture
+def hass(hass_fixture_setup, loop, load_registries, hass_storage, request):
     """Fixture to provide a test instance of Home Assistant."""
 
+    hass_fixture_setup.append(True)
+
     orig_tz = dt_util.DEFAULT_TIME_ZONE
 
     def exc_handle(loop, context):
@@ -861,7 +885,29 @@ def recorder_config():
 
 
 @pytest.fixture
-def hass_recorder(enable_nightly_purge, enable_statistics, hass_storage):
+def recorder_db_url(pytestconfig):
+    """Prepare a default database for tests and return a connection URL."""
+    db_url: str = pytestconfig.getoption("dburl")
+    if db_url.startswith("mysql://"):
+        import sqlalchemy_utils
+
+        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://"):
+        pass
+    yield db_url
+    if db_url.startswith("mysql://"):
+        sqlalchemy_utils.drop_database(db_url)
+
+
+@pytest.fixture
+def hass_recorder(
+    recorder_db_url,
+    enable_nightly_purge,
+    enable_statistics,
+    hass_storage,
+):
     """Home Assistant fixture with in-memory recorder."""
     original_tz = dt_util.DEFAULT_TIME_ZONE
 
@@ -880,7 +926,7 @@ def hass_recorder(enable_nightly_purge, enable_statistics, hass_storage):
 
         def setup_recorder(config=None):
             """Set up with params."""
-            init_recorder_component(hass, config)
+            init_recorder_component(hass, config, recorder_db_url)
             hass.start()
             hass.block_till_done()
             hass.data[recorder.DATA_INSTANCE].block_till_done()
@@ -893,17 +939,15 @@ def setup_recorder(config=None):
     dt_util.DEFAULT_TIME_ZONE = original_tz
 
 
-async def _async_init_recorder_component(hass, add_config=None):
+async def _async_init_recorder_component(hass, add_config=None, db_url=None):
     """Initialize the recorder asynchronously."""
     config = dict(add_config) if add_config else {}
     if recorder.CONF_DB_URL not in config:
-        config[recorder.CONF_DB_URL] = "sqlite://"  # In memory DB
+        config[recorder.CONF_DB_URL] = db_url
         if recorder.CONF_COMMIT_INTERVAL not in config:
             config[recorder.CONF_COMMIT_INTERVAL] = 0
 
-    with patch("homeassistant.components.recorder.ALLOW_IN_MEMORY_DB", True), patch(
-        "homeassistant.components.recorder.migration.migrate_schema"
-    ):
+    with patch("homeassistant.components.recorder.ALLOW_IN_MEMORY_DB", True):
         if recorder.DOMAIN not in hass.data:
             recorder_helper.async_initialize_recorder(hass)
         assert await async_setup_component(
@@ -918,9 +962,13 @@ async def _async_init_recorder_component(hass, add_config=None):
 
 @pytest.fixture
 async def async_setup_recorder_instance(
-    enable_nightly_purge, enable_statistics
+    recorder_db_url,
+    hass_fixture_setup,
+    enable_nightly_purge,
+    enable_statistics,
 ) -> AsyncGenerator[SetupRecorderInstanceT, None]:
     """Yield callable to setup recorder instance."""
+    assert not hass_fixture_setup
 
     nightly = recorder.Recorder.async_nightly_tasks if enable_nightly_purge else None
     stats = recorder.Recorder.async_periodic_statistics if enable_statistics else None
@@ -938,7 +986,7 @@ async def async_setup_recorder(
             hass: HomeAssistant, config: ConfigType | None = None
         ) -> recorder.Recorder:
             """Setup and return recorder instance."""  # noqa: D401
-            await _async_init_recorder_component(hass, config)
+            await _async_init_recorder_component(hass, config, recorder_db_url)
             await hass.async_block_till_done()
             instance = hass.data[recorder.DATA_INSTANCE]
             # The recorder's worker is not started until Home Assistant is running

requirements_dev.txt

@@ -1,9 +1,9 @@
 # This file is originally from homeassistant/core and modified by pytest-homeassistant-custom-component.
-astroid==2.12.5
+astroid==2.12.12
 codecov==2.1.12
-mypy==0.981
+mypy==0.982
 pre-commit==2.20.0
-pylint==2.15.0
+pylint==2.15.5
 types-atomicwrites==1.4.1
 types-croniter==1.0.0
 types-backports==0.1.3

requirements_test.txt

@@ -9,7 +9,7 @@
 -c homeassistant/package_constraints.txt
 -r requirements_test_pre_commit.txt
 coverage==6.4.4
-freezegun==1.2.1
+freezegun==1.2.2
 mock-open==1.4.0
 pipdeptree==2.3.1
 pytest-aiohttp==0.3.0
@@ -26,8 +26,8 @@ respx==0.19.2
 stdlib-list==0.7.0
 tomli==2.0.1;python_version<"3.11"
 tqdm==4.64.0
-homeassistant==2022.10.5
-sqlalchemy==1.4.41
+homeassistant==2022.11.0b0
+sqlalchemy==1.4.42
 
 paho-mqtt==1.6.1
 

version

@@ -1 +1 @@
-0.12.10
+0.12.11