Test fixes from environment/dep updates

Author: legrego

poetry.lock

@@ -24,8 +24,8 @@ mkdocs-material = ">=9.5.17"
 
 [tool.poetry.group.test.dependencies]
 syrupy = ">=4.6.0"
-pytest = ">=8.2.0"
-pytest-asyncio = ">=0.23.0"
+pytest = ">=8.3.5"
+pytest-asyncio = ">=0.26.0"
 pytest-cov = ">=5.0.0"
 pytest-homeassistant-custom-component = "==0.13.251"
 mock = ">4.0.0"

pyproject.toml

@@ -29,7 +29,6 @@
 import attr
 import pytest
 from aiohttp import ClientSession, TCPConnector
-from custom_components.elasticsearch.config_flow import ElasticFlowHandler
 from freezegun.api import FrozenDateTimeFactory
 
 # import custom_components.elasticsearch  # noqa: F401
@@ -49,6 +48,7 @@
     AiohttpClientMocker,
 )
 
+from custom_components.elasticsearch.config_flow import ElasticFlowHandler
 from tests import const as testconst
 from tests.test_util.es_mocker import es_mocker
 
@@ -187,7 +187,9 @@ async def add_to_hass() -> bool:
 def mock_loop_handler_fixture():
     """Return a mock loop handler that will return."""
     with (
-        patch("custom_components.elasticsearch.es_publish_pipeline.LoopHandler") as loop_handler,
+        patch(
+            "custom_components.elasticsearch.es_publish_pipeline.LoopHandler"
+        ) as loop_handler,
     ):
         loop_handler.start = AsyncMock()
 
@@ -197,7 +199,9 @@ def mock_loop_handler_fixture():
 @pytest.fixture(autouse=True, name="fix_system_info")
 def fix_system_info_fixture():
     """Return a mock system info."""
-    with mock.patch("custom_components.elasticsearch.es_publish_pipeline.SystemInfo") as system_info:
+    with mock.patch(
+        "custom_components.elasticsearch.es_publish_pipeline.SystemInfo"
+    ) as system_info:
         system_info_instance = system_info.return_value
         system_info_instance.async_get_system_info = mock.AsyncMock(
             return_value=mock.Mock(
@@ -366,7 +370,9 @@ async def device(
         device_registry.async_update_device(device_id=device.id, area_id=device_area.id)
 
     if device_labels is not None and len(device_labels) > 0:
-        device_registry.async_update_device(device_id=device.id, labels={*device_labels})
+        device_registry.async_update_device(
+            device_id=device.id, labels={*device_labels}
+        )
 
     return device_registry.async_get(device.id)
 
@@ -515,8 +521,8 @@ async def entity(
     entity_unit_of_measurement,
     entity_original_name: str,
     entity_name: str,
-    device_id: str,
-    request,
+    attach_device: bool,
+    device: DeviceEntry,
 ):
     """Mock an entity."""
     entity_registry.async_get_or_create(
@@ -534,16 +540,21 @@ async def entity(
         entity_registry.async_update_entity(entity_id=entity_id, name=entity_name)
 
     if entity_device_class is not None:
-        entity_registry.async_update_entity(entity_id=entity_id, device_class=entity_device_class)
+        entity_registry.async_update_entity(
+            entity_id=entity_id, device_class=entity_device_class
+        )
 
     if entity_labels is not None and len(entity_labels) > 0:
-        entity_registry.async_update_entity(entity_id=entity_id, labels={*entity_labels})
+        entity_registry.async_update_entity(
+            entity_id=entity_id, labels={*entity_labels}
+        )
 
     if entity_area is not None:
         entity_registry.async_update_entity(entity_id=entity_id, area_id=entity_area.id)
 
-    if device_id is not None:
-        entity_registry.async_update_entity(entity_id=entity_id, device_id=device_id)
+    # Only attach device if requested and device is available
+    if attach_device and device is not None:
+        entity_registry.async_update_entity(entity_id=entity_id, device_id=device.id)
 
     return entity_registry.async_get(entity_id)
 

tests/conftest.py

@@ -600,7 +600,23 @@
       'id': 'entity_area',
       'name': 'entity area',
     }),
-    'device': None,
+    'device': dict({
+      'area': dict({
+        'floor': dict({
+          'id': 'device_floor',
+          'name': 'device floor',
+        }),
+        'id': 'device_area',
+        'name': 'device area',
+      }),
+      'id': 'very_unique_device_id',
+      'labels': list([
+        'device label 1',
+        'device label 2',
+        'device label 3',
+      ]),
+      'name': 'device name',
+    }),
     'device_class': 'user-modified entity device class',
     'domain': 'counter',
     'friendly_name': 'entity object id',

tests/snapshots/test_es_publish_pipeline.ambr

@@ -4,15 +4,15 @@
 from unittest.mock import MagicMock, patch
 
 import pytest
+from homeassistant.core import HomeAssistant
+
 from custom_components.elasticsearch import const as compconst
 from custom_components.elasticsearch import utils
 from custom_components.elasticsearch.entity_details import (
     ExtendedDeviceEntry,
     ExtendedEntityDetails,
     ExtendedRegistryEntry,
 )
-from homeassistant.core import HomeAssistant
-
 from tests import const as testconst
 
 
@@ -53,17 +53,24 @@ async def test_init(self, hass: HomeAssistant, details):
         assert details.device_registry is not None
         assert details.entity_registry is not None
 
+    @pytest.mark.parametrize("attach_device", [False])
     async def test_get_entity(self, entity, entity_id, details, mock_extended_registry):
         """Test retrieving extended details on an entity with no device."""
         details.async_get(entity_id)
 
-        mock_extended_registry.assert_called_once_with(details=details, entity=entity, device=None)
+        mock_extended_registry.assert_called_once_with(
+            details=details, entity=entity, device=None
+        )
 
-    async def test_get_entity_with_device(self, entity, entity_id, device, details, mock_extended_registry):
+    async def test_get_entity_with_device(
+        self, entity, entity_id, device, details, mock_extended_registry
+    ):
         """Test retrieving extended details on an entity with a device attached."""
         details.async_get(entity_id)
 
-        mock_extended_registry.assert_called_once_with(details=details, entity=entity, device=device)
+        mock_extended_registry.assert_called_once_with(
+            details=details, entity=entity, device=device
+        )
 
     async def test_get_entity_with_missing_device(
         self, entity, entity_id, device, details, mock_extended_registry
@@ -79,7 +86,9 @@ async def test_get_entity_with_missing_device(
             entity_id,
         )
 
-        mock_extended_registry.assert_called_once_with(details=details, entity=entity, device=None)
+        mock_extended_registry.assert_called_once_with(
+            details=details, entity=entity, device=None
+        )
 
     async def test_get_entity_missing(self, details, mock_extended_registry):
         """Test retrieving extended details on an entity which is missing from the registry."""
@@ -117,7 +126,9 @@ async def test_init(
         device_labels,
     ):
         """Create an ExtendedRegistryEntry instance."""
-        extended_entity = ExtendedRegistryEntry(details=details, entity=entity, device=device)
+        extended_entity = ExtendedRegistryEntry(
+            details=details, entity=entity, device=device
+        )
 
         assert extended_entity is not None
         assert extended_entity._entity == entity
@@ -184,7 +195,9 @@ async def test_init_entity_with_device(
         device_labels,
     ):
         """Create an ExtendedRegistryEntry instance."""
-        extended_entity = ExtendedRegistryEntry(details=details, entity=entity, device=device)
+        extended_entity = ExtendedRegistryEntry(
+            details=details, entity=entity, device=device
+        )
 
         assert extended_entity is not None
         assert extended_entity._entity == entity
@@ -207,7 +220,9 @@ async def test_init_entity_with_device(
 
     async def test_to_dict(self, details, entity, device, snapshot):
         """Create an ExtendedRegistryEntry instance."""
-        extended_entity = ExtendedRegistryEntry(details=details, entity=entity, device=device)
+        extended_entity = ExtendedRegistryEntry(
+            details=details, entity=entity, device=device
+        )
 
         assert extended_entity is not None
 
@@ -229,19 +244,31 @@ async def test_to_dict(self, details, entity, device, snapshot):
         ],
     )
     async def test_name_handling(
-        self, entity_registry, details, entity, entity_original_name, entity_name, expected_name
+        self,
+        entity_registry,
+        details,
+        entity,
+        entity_original_name,
+        entity_name,
+        expected_name,
     ):
         """Test our handling of the name and original_name properties."""
 
-        extended_entity = ExtendedRegistryEntry(details=details, entity=entity, device=None)
+        extended_entity = ExtendedRegistryEntry(
+            details=details, entity=entity, device=None
+        )
 
         assert extended_entity._entity.original_name == entity_original_name
         assert extended_entity._entity.name == entity_name
 
         assert extended_entity.name == expected_name
 
     @pytest.mark.parametrize(
-        ("entity_original_device_class", "entity_device_class", "expected_device_class"),
+        (
+            "entity_original_device_class",
+            "entity_device_class",
+            "expected_device_class",
+        ),
         [
             ("Original", "New", "New"),
             ("Original", None, "Original"),
@@ -266,9 +293,14 @@ async def test_device_class_handling(
     ):
         """Test our handling of the device_class and original_device_class properties."""
 
-        extended_entity = ExtendedRegistryEntry(details=details, entity=entity, device=None)
+        extended_entity = ExtendedRegistryEntry(
+            details=details, entity=entity, device=None
+        )
 
-        assert extended_entity._entity.original_device_class == entity_original_device_class
+        assert (
+            extended_entity._entity.original_device_class
+            == entity_original_device_class
+        )
         assert extended_entity._entity.device_class == entity_device_class
 
         assert extended_entity.device_class == expected_device_class
@@ -296,7 +328,9 @@ async def test_entity_device_combinations(
         device_labels,
     ):
         """Test the entity details edge cases."""
-        entry_dict = ExtendedRegistryEntry(details=details, entity=entity, device=device).to_dict()
+        entry_dict = ExtendedRegistryEntry(
+            details=details, entity=entity, device=device
+        ).to_dict()
 
         document = utils.flatten_dict(entry_dict)
 
@@ -327,7 +361,9 @@ def name_to_id(name):
         assert document.pop("device.area.name", None) == device_area_name
         assert document.pop("device.area.id", None) == name_to_id(device_area_name)
         assert document.pop("device.area.floor.name", None) == device_floor_name
-        assert document.pop("device.area.floor.id", None) == name_to_id(device_floor_name)
+        assert document.pop("device.area.floor.id", None) == name_to_id(
+            device_floor_name
+        )
         assert document.pop("device.labels", None) == device_labels
 
         # Ensure that remaining keys are trimmable