Add diagnostics to Saunum integration (home-assistant#156623)

Author: mettolen

homeassistant/components/saunum/diagnostics.py

@@ -0,0 +1,49 @@
+"""Diagnostics support for Saunum Leil Sauna Control Unit integration."""
+
+from __future__ import annotations
+
+from dataclasses import asdict
+from typing import Any
+
+from homeassistant.components.diagnostics import async_redact_data
+from homeassistant.const import CONF_HOST
+from homeassistant.core import HomeAssistant
+
+from . import LeilSaunaConfigEntry
+
+REDACT_CONFIG = {CONF_HOST}
+
+
+async def async_get_config_entry_diagnostics(
+    hass: HomeAssistant, entry: LeilSaunaConfigEntry
+) -> dict[str, Any]:
+    """Return diagnostics for a config entry."""
+    coordinator = entry.runtime_data
+
+    # Build diagnostics data
+    diagnostics_data: dict[str, Any] = {
+        "config": async_redact_data(entry.data, REDACT_CONFIG),
+        "client_info": {"connected": coordinator.client.is_connected},
+        "coordinator_info": {
+            "last_update_success": coordinator.last_update_success,
+            "update_interval": str(coordinator.update_interval),
+            "last_exception": str(coordinator.last_exception)
+            if coordinator.last_exception
+            else None,
+        },
+    }
+
+    # Add coordinator data if available
+    if coordinator.data:
+        data_dict = asdict(coordinator.data)
+        diagnostics_data["coordinator_data"] = data_dict
+
+        # Add alarm summary
+        alarm_fields = [
+            key
+            for key, value in data_dict.items()
+            if key.startswith("alarm_") and value is True
+        ]
+        diagnostics_data["active_alarms"] = alarm_fields
+
+    return diagnostics_data

homeassistant/components/saunum/quality_scale.yaml

@@ -41,15 +41,15 @@ rules:
 
   # Gold tier
   devices: done
-  diagnostics: todo
+  diagnostics: done
   discovery:
     status: exempt
     comment: Device uses generic Espressif hardware with no unique identifying information (MAC OUI or hostname) that would distinguish it from other Espressif-based devices on the network.
   discovery-update-info: todo
   docs-data-update: done
   docs-examples: todo
   docs-known-limitations: done
-  docs-supported-devices: todo
+  docs-supported-devices: done
   docs-supported-functions: done
   docs-troubleshooting: done
   docs-use-cases: done

tests/components/saunum/snapshots/test_diagnostics.ambr

@@ -0,0 +1,37 @@
+# serializer version: 1
+# name: test_entry_diagnostics
+  dict({
+    'active_alarms': list([
+    ]),
+    'client_info': dict({
+      'connected': True,
+    }),
+    'config': dict({
+      'host': '**REDACTED**',
+    }),
+    'coordinator_data': dict({
+      'alarm_door_open': False,
+      'alarm_door_sensor': False,
+      'alarm_internal_temp': False,
+      'alarm_temp_sensor_open': False,
+      'alarm_temp_sensor_short': False,
+      'alarm_thermal_cutoff': False,
+      'current_temperature': 75.0,
+      'door_open': False,
+      'fan_duration': 10,
+      'fan_speed': 2,
+      'heater_elements_active': 0,
+      'light_on': False,
+      'on_time': 3600,
+      'sauna_duration': 120,
+      'sauna_type': 0,
+      'session_active': False,
+      'target_temperature': 80,
+    }),
+    'coordinator_info': dict({
+      'last_exception': None,
+      'last_update_success': True,
+      'update_interval': '0:01:00',
+    }),
+  })
+# ---

tests/components/saunum/test_diagnostics.py

@@ -0,0 +1,22 @@
+"""Test Saunum Leil Sauna diagnostics."""
+
+from syrupy.assertion import SnapshotAssertion
+
+from homeassistant.core import HomeAssistant
+
+from tests.common import MockConfigEntry
+from tests.components.diagnostics import get_diagnostics_for_config_entry
+from tests.typing import ClientSessionGenerator
+
+
+async def test_entry_diagnostics(
+    hass: HomeAssistant,
+    hass_client: ClientSessionGenerator,
+    init_integration: MockConfigEntry,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test config entry diagnostics."""
+    assert (
+        await get_diagnostics_for_config_entry(hass, hass_client, init_integration)
+        == snapshot
+    )