Add diagnostic to V2C (#118823)

* add diagnostic platform

* add diagnostic platform

* add diagnostic platform

homeassistant/components/v2c/diagnostics.py

@@ -0,0 +1,35 @@
+"""Diagnostics support for V2C."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from homeassistant.components.diagnostics import async_redact_data
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_HOST
+from homeassistant.core import HomeAssistant
+
+from .const import DOMAIN
+from .coordinator import V2CUpdateCoordinator
+
+TO_REDACT = {CONF_HOST, "title"}
+
+
+async def async_get_config_entry_diagnostics(
+    hass: HomeAssistant, entry: ConfigEntry
+) -> dict[str, Any]:
+    """Return diagnostics for a config entry."""
+    coordinator: V2CUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
+
+    if TYPE_CHECKING:
+        assert coordinator.evse
+
+    coordinator_data = coordinator.evse.data
+    evse_raw_data = coordinator.evse.raw_data
+
+    return {
+        "config_entry": async_redact_data(entry.as_dict(), TO_REDACT),
+        "data": str(coordinator_data),
+        "raw_data": evse_raw_data["content"].decode("utf-8"),  # type: ignore[attr-defined]
+        "host_status": evse_raw_data["status_code"],
+    }

tests/components/v2c/conftest.py

@@ -8,6 +8,7 @@ from pytrydan.models.trydan import TrydanData
 
 from homeassistant.components.v2c import DOMAIN
 from homeassistant.const import CONF_HOST
+from homeassistant.helpers.json import json_dumps
 
 from tests.common import MockConfigEntry, load_json_object_fixture
 
@@ -47,6 +48,11 @@ def mock_v2c_client() -> Generator[AsyncMock, None, None]:
     ):
         client = mock_client.return_value
         get_data_json = load_json_object_fixture("get_data.json", DOMAIN)
+        client.raw_data = {
+            "content": json_dumps(get_data_json).encode("utf-8"),
+            "status_code": 200,
+        }
         client.get_data.return_value = TrydanData.from_api(get_data_json)
+        client.data = client.get_data.return_value
         client.firmware_version = get_data_json["FirmwareVersion"]
         yield client

tests/components/v2c/snapshots/test_diagnostics.ambr

@@ -0,0 +1,25 @@
+# serializer version: 1
+# name: test_entry_diagnostics
+  dict({
+    'config_entry': dict({
+      'data': dict({
+        'host': '**REDACTED**',
+      }),
+      'disabled_by': None,
+      'domain': 'v2c',
+      'entry_id': 'da58ee91f38c2406c2a36d0a1a7f8569',
+      'minor_version': 1,
+      'options': dict({
+      }),
+      'pref_disable_new_entities': False,
+      'pref_disable_polling': False,
+      'source': 'user',
+      'title': '**REDACTED**',
+      'unique_id': 'ABC123',
+      'version': 1,
+    }),
+    'data': "TrydanData(ID='ABC123', charge_state=<ChargeState.CONNECTED_CHARGING: 2>, ready_state=<ReadyState.NOT_READY: 0>, charge_power=1500.27, charge_energy=1.8, slave_error=<SlaveCommunicationState.WAITING_WIFI: 4>, charge_time=4355, house_power=0.0, fv_power=0.0, battery_power=0.0, paused=<PauseState.NOT_PAUSED: 0>, locked=<LockState.DISABLED: 0>, timer=<ChargePointTimerState.TIMER_OFF: 0>, intensity=6, dynamic=<DynamicState.DISABLED: 0>, min_intensity=6, max_intensity=16, pause_dynamic=<PauseDynamicState.MODULATING: 0>, dynamic_power_mode=<DynamicPowerMode.TIMED_POWER_DISABLED_AND_EXCLUSIVE_MODE_SETTED: 2>, contracted_power=4600, firmware_version='2.1.7')",
+    'host_status': 200,
+    'raw_data': '{"ID":"ABC123","ChargeState":2,"ReadyState":0,"ChargePower":1500.27,"ChargeEnergy":1.8,"SlaveError":4,"ChargeTime":4355,"HousePower":0.0,"FVPower":0.0,"BatteryPower":0.0,"Paused":0,"Locked":0,"Timer":0,"Intensity":6,"Dynamic":0,"MinIntensity":6,"MaxIntensity":16,"PauseDynamic":0,"FirmwareVersion":"2.1.7","DynamicPowerMode":2,"ContractedPower":4600}',
+  })
+# ---

tests/components/v2c/test_diagnostics.py

@@ -0,0 +1,30 @@
+"""Test V2C diagnostics."""
+
+from unittest.mock import AsyncMock
+
+from syrupy import SnapshotAssertion
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+
+from . import init_integration
+
+from tests.components.diagnostics import get_diagnostics_for_config_entry
+from tests.typing import ClientSessionGenerator
+
+
+async def test_entry_diagnostics(
+    hass: HomeAssistant,
+    mock_config_entry: ConfigEntry,
+    mock_v2c_client: AsyncMock,
+    hass_client: ClientSessionGenerator,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test config entry diagnostics."""
+
+    await init_integration(hass, mock_config_entry)
+
+    assert (
+        await get_diagnostics_for_config_entry(hass, hass_client, mock_config_entry)
+        == snapshot()
+    )