Updated test cases and scripts around releasing

Author: signalkraft

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2023 Philipp Dörner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,7 @@
 # myPyllant Home Assistant Component
 
 [![GitHub Release](https://img.shields.io/github/release/signalkraft/mypyllant-component.svg)](https://github.com/signalkraft/mypyllant-component/releases)
-[![License](https://img.shields.io/github/license/signalkraft/mypyllant-component.svg)](LICENSE)
+[![License](https://img.shields.io/github/license/signalkraft/mypyllant-component.svg)](https://github.com/signalkraft/mypyllant-component/blob/main/LICENSE)
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/signalkraft/mypyllant-component/build-test.yaml)
 
 Home Assistant component that interfaces with the myVAILLANT API (and branded versions of it, such as the MiGo Link app

custom_components/mypyllant/manifest.json

@@ -10,7 +10,7 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/signalkraft/mypyllant-component/issues",
   "requirements": [
-    "myPyllant==0.9.0b1"
+    "myPyllant==0.9.0"
   ],
-  "version": "v0.9.0b3"
+  "version": "v0.9.0"
 }

dev-requirements.txt

@@ -10,8 +10,8 @@ PyYAML~=6.0.1
 types-PyYAML~=6.0.12.20240311
 
 # Need specific versions
-pytest-homeassistant-custom-component==0.13.200
-myPyllant==0.9.0b1
+pytest-homeassistant-custom-component==0.13.202
+myPyllant==0.9.0
 
 # Versions handled by pytest-homeassistant-custom-component
 freezegun

hacs.json

@@ -1,5 +1,8 @@
 {
   "name": "MyVaillant",
   "render_readme": true,
-  "homeassistant": "2025.1.0b0"
+  "homeassistant": "2025.1.0",
+  "iot_class": "Cloud Polling",
+  "zip_release": true,
+  "filename": "mypyllant-component.zip"
 }

pyproject.toml

@@ -19,6 +19,7 @@ addopts = """
 --cov=custom_components"""
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
+filterwarnings = ["ignore:Inheritance class CountingClientSession from ClientSession is discouraged:DeprecationWarning"]
 
 [tool.mypy]
 python_version = "3.12"

scripts/release

@@ -4,5 +4,7 @@ set -e
 
 version="$(jq -r .version custom_components/mypyllant/manifest.json)"
 
-git push
-gh release create "$version" --draft --generate-notes
+git tag "$version"
+git push origin "$version"
+
+echo "Open release job: $(gh run list -w release --json url --limit 1 | jq -r '.[].url')"

tests/conftest.py

@@ -1,9 +1,7 @@
-import uuid
 from datetime import timedelta
 from unittest import mock
 
 import pytest
-from homeassistant import config_entries
 
 from custom_components.mypyllant.coordinator import (
     SystemCoordinator,
@@ -106,57 +104,3 @@ async def daily_data_coordinator_mock(hass, mocked_api) -> DailyDataCoordinator:
     ) as entry:
         hass.data = {DOMAIN: {entry.entry_id: {}}}
         return DailyDataCoordinator(hass, mocked_api, entry, timedelta(seconds=10))
-
-
-class MockConfigEntry(config_entries.ConfigEntry):
-    """Helper for creating config entries that adds some defaults."""
-
-    def __init__(
-        self,
-        *,
-        domain="test",
-        data=None,
-        version=1,
-        entry_id=None,
-        source=config_entries.SOURCE_USER,
-        title="Mock Title",
-        state=None,
-        options={},
-        discovery_keys={},
-        pref_disable_new_entities=None,
-        pref_disable_polling=None,
-        unique_id=None,
-        disabled_by=None,
-        reason=None,
-        minor_version=None,
-    ):
-        """Initialize a mock config entry."""
-        kwargs = {
-            "entry_id": entry_id or str(uuid.uuid4()),
-            "domain": domain,
-            "data": data or {},
-            "pref_disable_new_entities": pref_disable_new_entities,
-            "pref_disable_polling": pref_disable_polling,
-            "options": options,
-            "discovery_keys": discovery_keys,
-            "version": version,
-            "title": title,
-            "unique_id": unique_id,
-            "disabled_by": disabled_by,
-            "minor_version": minor_version,
-        }
-        if source is not None:
-            kwargs["source"] = source
-        if state is not None:
-            kwargs["state"] = state
-        super().__init__(**kwargs)
-        if reason is not None:
-            self.reason = reason
-
-    def add_to_hass(self, hass):
-        """Test helper to add entry to hass."""
-        hass.config_entries._entries[self.entry_id] = self
-
-    def add_to_manager(self, manager):
-        """Test helper to add entry to entry manager."""
-        manager._entries[self.entry_id] = self

tests/test_binary_sensor.py

@@ -20,8 +20,7 @@
 )
 from custom_components.mypyllant.utils import CircuitEntity
 from custom_components.mypyllant.const import DOMAIN
-from tests.conftest import MockConfigEntry, TEST_OPTIONS
-from tests.test_init import test_user_input
+from tests.utils import get_config_entry
 
 
 @pytest.mark.parametrize("test_data", list_test_data())
@@ -36,12 +35,7 @@ async def test_async_setup_binary_sensors(
     hass.data[DATA_INTEGRATIONS] = {}
     hass.data[DATA_REGISTRY] = EntityRegistry(hass)
     with mypyllant_aioresponses(test_data) as _:
-        config_entry = MockConfigEntry(
-            domain=DOMAIN,
-            title="Mock Title",
-            data=test_user_input,
-            options=TEST_OPTIONS,
-        )
+        config_entry = get_config_entry()
         system_coordinator_mock.data = (
             await system_coordinator_mock._async_update_data()
         )

tests/test_calendar.py

@@ -18,8 +18,7 @@
     DomesticHotWaterCirculationCalendar,
     AmbisenseCalendar,
 )
-from tests.conftest import MockConfigEntry, TEST_OPTIONS
-from tests.test_init import test_user_input
+from tests.utils import get_config_entry
 
 
 @pytest.mark.parametrize("test_data", list_test_data())
@@ -34,12 +33,7 @@ async def test_async_setup_calendar(
     hass.data[DATA_INTEGRATIONS] = {}
     hass.data[DATA_REGISTRY] = EntityRegistry(hass)
     with mypyllant_aioresponses(test_data) as _:
-        config_entry = MockConfigEntry(
-            domain=DOMAIN,
-            title="Mock Title",
-            data=test_user_input,
-            options=TEST_OPTIONS,
-        )
+        config_entry = get_config_entry()
         system_coordinator_mock.data = (
             await system_coordinator_mock._async_update_data()
         )

tests/test_climate.py

@@ -22,8 +22,6 @@
 )
 from custom_components.mypyllant.ventilation_climate import VentilationClimate
 from tests.utils import get_config_entry
-from tests.conftest import MockConfigEntry, TEST_OPTIONS
-from tests.test_init import test_user_input
 
 
 @pytest.mark.parametrize("test_data", list_test_data())
@@ -38,12 +36,7 @@ async def test_async_setup_climate(
     hass.data[DATA_INTEGRATIONS] = {}
     hass.data[DATA_REGISTRY] = EntityRegistry(hass)
     with mypyllant_aioresponses(test_data) as _:
-        config_entry = MockConfigEntry(
-            domain=DOMAIN,
-            title="Mock Title",
-            data=test_user_input,
-            options=TEST_OPTIONS,
-        )
+        config_entry = get_config_entry()
         system_coordinator_mock.data = (
             await system_coordinator_mock._async_update_data()
         )
@@ -93,7 +86,6 @@ async def test_zone_climate(
         await climate.async_set_preset_mode(preset_mode=PRESET_NONE)
         system_coordinator_mock._debounced_refresh.async_cancel()
 
-        print(system_coordinator_mock.data[0].state["zones"])
         zone_state = system_coordinator_mock.data[0].state["zones"][0]
         if "currentRoomTemperature" in zone_state:
             assert isinstance(climate.current_temperature, float)

tests/test_init.py

@@ -2,29 +2,21 @@
 import logging
 from unittest import mock
 
-import pytest
 from homeassistant import data_entry_flow
 from homeassistant.config_entries import SOURCE_USER
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.entity_registry import DATA_REGISTRY, EntityRegistry
-from homeassistant.loader import DATA_COMPONENTS, DATA_INTEGRATIONS
+
 from myPyllant.api import MyPyllantAPI
-from myPyllant.tests.utils import list_test_data
+from myPyllant.tests.generate_test_data import DATA_DIR
+from myPyllant.tests.utils import load_test_data
 
 from custom_components.mypyllant.const import DOMAIN
 from custom_components.mypyllant import async_setup_entry, async_unload_entry
 from custom_components.mypyllant.config_flow import DATA_SCHEMA
-from tests.conftest import TEST_OPTIONS, MockConfigEntry
+from tests.utils import get_config_entry, test_user_input
 
 _LOGGER = logging.getLogger(__name__)
 
-test_user_input = {
-    "username": "username",
-    "password": "password",
-    "country": "germany",
-    "brand": "vaillant",
-}
-
 
 async def test_flow_init(hass):
     """Test the initial flow."""
@@ -63,26 +55,18 @@ async def test_user_flow_minimum_fields(hass: HomeAssistant):
     assert result["type"] == data_entry_flow.FlowResultType.FORM
 
 
-@pytest.mark.parametrize("test_data", list_test_data())
-@pytest.mark.skip(
-    "Broke with upgrade to pytest-homeassistant-custom-component==0.13.142"
-)
 async def test_async_setup(
     hass,
     mypyllant_aioresponses,
     mocked_api: MyPyllantAPI,
-    test_data,
 ):
-    hass.data[DATA_COMPONENTS] = {}
-    hass.data[DATA_INTEGRATIONS] = {}
-    hass.data[DATA_REGISTRY] = EntityRegistry(hass)
+    test_data = load_test_data(DATA_DIR / "heatpump_heat_curve")
     with mypyllant_aioresponses(test_data) as _:
-        config_entry = MockConfigEntry(
-            domain=DOMAIN,
-            title="Mock Title",
-            data=test_user_input,
-            options=TEST_OPTIONS,
-        )
+        config_entry = get_config_entry()
+        config_entry.add_to_hass(hass)
+        await hass.config_entries.async_setup(config_entry.entry_id)
+        await hass.async_block_till_done()
+
         mock.patch("myPyllant.api.MyPyllantAPI", mocked_api)
         result = await async_setup_entry(hass, config_entry)
         assert result, "Component did not setup successfully"

tests/test_sensor.py

@@ -34,8 +34,7 @@
     SystemDeviceCurrentPowerSensor,
 )
 from custom_components.mypyllant.const import DOMAIN
-from tests.conftest import MockConfigEntry, TEST_OPTIONS
-from tests.test_init import test_user_input
+from tests.utils import get_config_entry
 
 
 @pytest.mark.parametrize("test_data", list_test_data())
@@ -50,12 +49,7 @@ async def test_create_system_sensors(
     hass.data[DATA_INTEGRATIONS] = {}
     hass.data[DATA_REGISTRY] = EntityRegistry(hass)
     with mypyllant_aioresponses(test_data) as _:
-        config_entry = MockConfigEntry(
-            domain=DOMAIN,
-            title="Mock Title",
-            data=test_user_input,
-            options=TEST_OPTIONS,
-        )
+        config_entry = get_config_entry()
         system_coordinator_mock.data = (
             await system_coordinator_mock._async_update_data()
         )