diff --git a/homeassistant/components/airq/config_flow.py b/homeassistant/components/airq/config_flow.py index 0c57b399b1b..f87b73b5283 100644 --- a/homeassistant/components/airq/config_flow.py +++ b/homeassistant/components/airq/config_flow.py @@ -83,6 +83,7 @@ class AirQConfigFlow(ConfigFlow, domain=DOMAIN): await self.async_set_unique_id(device_info["id"]) self._abort_if_unique_id_configured() + _LOGGER.debug("Creating an entry for %s", device_info["name"]) return self.async_create_entry(title=device_info["name"], data=user_input) return self.async_show_form( diff --git a/homeassistant/components/airq/coordinator.py b/homeassistant/components/airq/coordinator.py index b48d8047910..743d12d40e5 100644 --- a/homeassistant/components/airq/coordinator.py +++ b/homeassistant/components/airq/coordinator.py @@ -5,7 +5,7 @@ from __future__ import annotations from datetime import timedelta import logging -from aioairq import AirQ +from aioairq.core import AirQ, identify_warming_up_sensors from homeassistant.config_entries import ConfigEntry from homeassistant.const import CONF_IP_ADDRESS, CONF_PASSWORD @@ -55,6 +55,9 @@ class AirQCoordinator(DataUpdateCoordinator): async def _async_update_data(self) -> dict: """Fetch the data from the device.""" if "name" not in self.device_info: + _LOGGER.debug( + "'name' not found in AirQCoordinator.device_info, fetching from the device" + ) info = await self.airq.fetch_device_info() self.device_info.update( DeviceInfo( @@ -64,7 +67,16 @@ class AirQCoordinator(DataUpdateCoordinator): hw_version=info["hw_version"], ) ) - return await self.airq.get_latest_data( # type: ignore[no-any-return] + _LOGGER.debug( + "Updated AirQCoordinator.device_info for 'name' %s", + self.device_info.get("name"), + ) + data: dict = await self.airq.get_latest_data( return_average=self.return_average, clip_negative_values=self.clip_negative, ) + if warming_up_sensors := identify_warming_up_sensors(data): + _LOGGER.debug( + "Following sensors are still warming up: %s", warming_up_sensors + ) + return data diff --git a/tests/components/airq/test_config_flow.py b/tests/components/airq/test_config_flow.py index d70c1526510..09da6343e05 100644 --- a/tests/components/airq/test_config_flow.py +++ b/tests/components/airq/test_config_flow.py @@ -1,5 +1,6 @@ """Test the air-Q config flow.""" +import logging from unittest.mock import patch from aioairq import DeviceInfo, InvalidAuth @@ -37,8 +38,9 @@ DEFAULT_OPTIONS = { } -async def test_form(hass: HomeAssistant) -> None: +async def test_form(hass: HomeAssistant, caplog: pytest.LogCaptureFixture) -> None: """Test we get the form.""" + caplog.set_level(logging.DEBUG) result = await hass.config_entries.flow.async_init( DOMAIN, context={"source": config_entries.SOURCE_USER} ) @@ -54,6 +56,7 @@ async def test_form(hass: HomeAssistant) -> None: TEST_USER_DATA, ) await hass.async_block_till_done() + assert f"Creating an entry for {TEST_DEVICE_INFO['name']}" in caplog.text assert result2["type"] is FlowResultType.CREATE_ENTRY assert result2["title"] == TEST_DEVICE_INFO["name"] diff --git a/tests/components/airq/test_coordinator.py b/tests/components/airq/test_coordinator.py new file mode 100644 index 00000000000..69f7c9dee17 --- /dev/null +++ b/tests/components/airq/test_coordinator.py @@ -0,0 +1,129 @@ +"""Test the air-Q coordinator.""" + +import logging +from unittest.mock import patch + +from aioairq import DeviceInfo as AirQDeviceInfo +import pytest + +from homeassistant.components.airq import AirQCoordinator +from homeassistant.components.airq.const import DOMAIN +from homeassistant.const import CONF_IP_ADDRESS, CONF_PASSWORD +from homeassistant.core import HomeAssistant +from homeassistant.helpers.device_registry import DeviceInfo + +from tests.common import MockConfigEntry + +pytestmark = pytest.mark.usefixtures("mock_setup_entry") +MOCKED_ENTRY = MockConfigEntry( + domain=DOMAIN, + data={ + CONF_IP_ADDRESS: "192.168.0.0", + CONF_PASSWORD: "password", + }, + unique_id="123-456", +) + +TEST_DEVICE_INFO = AirQDeviceInfo( + id="id", + name="name", + model="model", + sw_version="sw", + hw_version="hw", +) +TEST_DEVICE_DATA = {"co2": 500.0, "Status": "OK"} +STATUS_WARMUP = { + "co": "co sensor still in warm up phase; waiting time = 18 s", + "tvoc": "tvoc sensor still in warm up phase; waiting time = 18 s", + "so2": "so2 sensor still in warm up phase; waiting time = 17 s", +} + + +async def test_logging_in_coordinator_first_update_data( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture +) -> None: + """Test that the first AirQCoordinator._async_update_data call logs necessary setup. + + The fields of AirQCoordinator.device_info that are specific to the device are only + populated upon the first call to AirQCoordinator._async_update_data. The one field + which is actually necessary is 'name', and its absence is checked and logged, + as well as its being set. + """ + caplog.set_level(logging.DEBUG) + coordinator = AirQCoordinator(hass, MOCKED_ENTRY) + + # check that the name _is_ missing + assert "name" not in coordinator.device_info + + # First call: fetch missing device info + with ( + patch("aioairq.AirQ.fetch_device_info", return_value=TEST_DEVICE_INFO), + patch("aioairq.AirQ.get_latest_data", return_value=TEST_DEVICE_DATA), + ): + await coordinator._async_update_data() + + # check that the missing name is logged... + assert ( + "'name' not found in AirQCoordinator.device_info, fetching from the device" + in caplog.text + ) + # ...and fixed + assert coordinator.device_info.get("name") == TEST_DEVICE_INFO["name"] + assert ( + f"Updated AirQCoordinator.device_info for 'name' {TEST_DEVICE_INFO['name']}" + in caplog.text + ) + + # Also that no warming up sensors is found as none are mocked + assert "Following sensors are still warming up" not in caplog.text + + +async def test_logging_in_coordinator_subsequent_update_data( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture +) -> None: + """Test that the second AirQCoordinator._async_update_data call has nothing to log. + + The second call is emulated by setting up AirQCoordinator.device_info correctly, + instead of actually calling the _async_update_data, which would populate the log + with the messages we want to see not being repeated. + """ + caplog.set_level(logging.DEBUG) + coordinator = AirQCoordinator(hass, MOCKED_ENTRY) + coordinator.device_info.update(DeviceInfo(**TEST_DEVICE_INFO)) + + with ( + patch("aioairq.AirQ.fetch_device_info", return_value=TEST_DEVICE_INFO), + patch("aioairq.AirQ.get_latest_data", return_value=TEST_DEVICE_DATA), + ): + await coordinator._async_update_data() + # check that the name _is not_ missing + assert "name" in coordinator.device_info + # and that nothing of the kind is logged + assert ( + "'name' not found in AirQCoordinator.device_info, fetching from the device" + not in caplog.text + ) + assert ( + f"Updated AirQCoordinator.device_info for 'name' {TEST_DEVICE_INFO['name']}" + not in caplog.text + ) + + +async def test_logging_when_warming_up_sensor_present( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture +) -> None: + """Test that warming up sensors are logged.""" + caplog.set_level(logging.DEBUG) + coordinator = AirQCoordinator(hass, MOCKED_ENTRY) + with ( + patch("aioairq.AirQ.fetch_device_info", return_value=TEST_DEVICE_INFO), + patch( + "aioairq.AirQ.get_latest_data", + return_value=TEST_DEVICE_DATA | {"Status": STATUS_WARMUP}, + ), + ): + await coordinator._async_update_data() + assert ( + f"Following sensors are still warming up: {set(STATUS_WARMUP.keys())}" + in caplog.text + )