Add device diagnostics to onewire (home-assistant#154617)

Co-authored-by: Copilot <[email protected]>

Author: epenet

homeassistant/components/onewire/diagnostics.py

@@ -8,6 +8,7 @@
 from homeassistant.components.diagnostics import async_redact_data
 from homeassistant.const import CONF_HOST
 from homeassistant.core import HomeAssistant
+from homeassistant.helpers import device_registry as dr
 
 from .onewirehub import OneWireConfigEntry
 
@@ -26,7 +27,28 @@ async def async_get_config_entry_diagnostics(
             "data": async_redact_data(entry.data, TO_REDACT),
             "options": {**entry.options},
         },
-        "devices": [asdict(device_details) for device_details in onewire_hub.devices]
-        if onewire_hub.devices
-        else [],
+        "devices": [asdict(device_details) for device_details in onewire_hub.devices],
+    }
+
+
+async def async_get_device_diagnostics(
+    hass: HomeAssistant, entry: OneWireConfigEntry, device_entry: dr.DeviceEntry
+) -> dict[str, Any]:
+    """Return diagnostics for a device."""
+
+    onewire_hub = entry.runtime_data
+
+    return {
+        "entry": {
+            "title": entry.title,
+            "data": async_redact_data(entry.data, TO_REDACT),
+            "options": {**entry.options},
+        },
+        "device": asdict(
+            next(
+                device_details
+                for device_details in onewire_hub.devices
+                if device_details.id[3:] == device_entry.serial_number
+            )
+        ),
     }

homeassistant/components/onewire/quality_scale.yaml

@@ -59,9 +59,7 @@ rules:
     comment: >
       Manual removal, as it is not possible to distinguish
       between a flaky device and a device that has been removed
-  diagnostics:
-    status: todo
-    comment: config-entry diagnostics level available, might be nice to have device-level diagnostics
+  diagnostics: done
   exception-translations:
     status: todo
     comment: Under review

tests/components/onewire/snapshots/test_diagnostics.ambr

@@ -1,4 +1,45 @@
 # serializer version: 1
+# name: test_device_diagnostics[EF.111111111113]
+  dict({
+    'device': dict({
+      'device_info': dict({
+        'identifiers': list([
+          list([
+            'onewire',
+            'EF.111111111113',
+          ]),
+        ]),
+        'manufacturer': 'Hobby Boards',
+        'model': None,
+        'model_id': 'HB_HUB',
+        'name': 'EF.111111111113',
+        'serial_number': '111111111113',
+        'sw_version': '3.2',
+      }),
+      'family': 'EF',
+      'id': 'EF.111111111113',
+      'path': '/EF.111111111113/',
+      'type': 'HB_HUB',
+    }),
+    'entry': dict({
+      'data': dict({
+        'host': '**REDACTED**',
+        'port': 1234,
+      }),
+      'options': dict({
+        'device_options': dict({
+          '28.222222222222': dict({
+            'precision': 'temperature9',
+          }),
+          '28.222222222223': dict({
+            'precision': 'temperature5',
+          }),
+        }),
+      }),
+      'title': 'Mock Title',
+    }),
+  })
+# ---
 # name: test_entry_diagnostics[EF.111111111113]
   dict({
     'devices': list([

tests/components/onewire/test_diagnostics.py

@@ -6,13 +6,18 @@
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
+from homeassistant.components.onewire import DOMAIN
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
+from homeassistant.helpers import device_registry as dr
 
 from . import setup_owproxy_mock_devices
 
 from tests.common import MockConfigEntry
-from tests.components.diagnostics import get_diagnostics_for_config_entry
+from tests.components.diagnostics import (
+    get_diagnostics_for_config_entry,
+    get_diagnostics_for_device,
+)
 from tests.typing import ClientSessionGenerator
 
 
@@ -41,3 +46,27 @@ async def test_entry_diagnostics(
         await get_diagnostics_for_config_entry(hass, hass_client, config_entry)
         == snapshot
     )
+
+
+@pytest.mark.parametrize("device_id", ["EF.111111111113"], indirect=True)
+async def test_device_diagnostics(
+    hass: HomeAssistant,
+    config_entry: MockConfigEntry,
+    device_registry: dr.DeviceRegistry,
+    hass_client: ClientSessionGenerator,
+    owproxy: MagicMock,
+    device_id: str,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test device diagnostics."""
+    setup_owproxy_mock_devices(owproxy, [device_id])
+    await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    device = device_registry.async_get_device(identifiers={(DOMAIN, "EF.111111111113")})
+    assert device is not None
+
+    assert (
+        await get_diagnostics_for_device(hass, hass_client, config_entry, device)
+        == snapshot
+    )