Add diagnostics platform, config-flow gap warning, issue template
Completes the device-capability-diagnostics spec: - diagnostics.py: the standard HA diagnostics hook, returning device type, one_ui_version, unbound hrefs, and the redacted raw resource tree, plus integration and smartthings-local version numbers. This is what the Repairs issue (added in the previous commit) points users at, and what they attach to a device-support issue. - config_flow.py: _probe_and_validate now also reports oneUiVersion and whether the device type is recognized. Recognized types are unaffected; an unrecognized type shows a new confirm_unknown_type step explaining that only common capabilities will be available before creating the entry, so expectations are set at setup time rather than only after the fact via Repairs. - .github/ISSUE_TEMPLATE/device-support.yml: structured template for filing a capability gap, linked from both the Repairs issue and the config-flow confirmation step. - README: short section pointing at this whole mechanism.
This commit is contained in:
1 parent
ca754cbb01
commit
d2699f0f5b
9 files changed
+221
-12
No files matched your search
@@ -69,7 +69,7 @@ def fridge_resources():
|
||||
|
||||
@pytest.fixture
|
||||
def mock_probe():
|
||||
"""Patch _probe_and_validate to succeed without a real DTLS connection."""
|
||||
"""Patch _probe_and_validate to succeed (recognized type) without a real DTLS connection."""
|
||||
with patch(
|
||||
'custom_components.localthings.config_flow._probe_and_validate',
|
||||
return_value={
|
||||
@@ -77,6 +77,25 @@ def mock_probe():
|
||||
'serial': MOCK_SERIAL,
|
||||
'leaf_cert_pem': MOCK_LEAF_CERT_PEM,
|
||||
'leaf_key_pem': MOCK_LEAF_KEY_PEM,
|
||||
'one_ui_version': '7.0 Refrigerator',
|
||||
'device_type_recognized': True,
|
||||
},
|
||||
) as m:
|
||||
yield m
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_probe_unknown_type():
|
||||
"""Patch _probe_and_validate to succeed, but with an unrecognized device type."""
|
||||
with patch(
|
||||
'custom_components.localthings.config_flow._probe_and_validate',
|
||||
return_value={
|
||||
'port': MOCK_PORT,
|
||||
'serial': MOCK_SERIAL,
|
||||
'leaf_cert_pem': MOCK_LEAF_CERT_PEM,
|
||||
'leaf_key_pem': MOCK_LEAF_KEY_PEM,
|
||||
'one_ui_version': '9.0 Space Heater',
|
||||
'device_type_recognized': False,
|
||||
},
|
||||
) as m:
|
||||
yield m
|
||||
|
||||
@@ -75,6 +75,42 @@ async def test_cannot_connect(hass: HomeAssistant) -> None:
|
||||
assert result['errors']['base'] == 'cannot_connect'
|
||||
|
||||
|
||||
async def test_recognized_type_skips_confirmation_step(
|
||||
hass: HomeAssistant, mock_probe
|
||||
) -> None:
|
||||
"""A recognized device type creates the entry with no extra step."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={'source': 'user'}
|
||||
)
|
||||
result = await hass.config_entries.flow.async_configure(
|
||||
result['flow_id'],
|
||||
{CONF_HOST: MOCK_HOST, CONF_CA_CERT_PEM: MOCK_CA_CERT_PEM, CONF_CA_KEY_PEM: MOCK_CA_KEY_PEM},
|
||||
)
|
||||
assert result['type'] == FlowResultType.CREATE_ENTRY
|
||||
|
||||
|
||||
async def test_unknown_type_shows_confirmation_step(
|
||||
hass: HomeAssistant, mock_probe_unknown_type
|
||||
) -> None:
|
||||
"""An unrecognized device type shows a confirmation step before creating the entry."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={'source': 'user'}
|
||||
)
|
||||
result = await hass.config_entries.flow.async_configure(
|
||||
result['flow_id'],
|
||||
{CONF_HOST: MOCK_HOST, CONF_CA_CERT_PEM: MOCK_CA_CERT_PEM, CONF_CA_KEY_PEM: MOCK_CA_KEY_PEM},
|
||||
)
|
||||
assert result['type'] == FlowResultType.FORM
|
||||
assert result['step_id'] == 'confirm_unknown_type'
|
||||
assert result['description_placeholders']['one_ui_version'] == '9.0 Space Heater'
|
||||
|
||||
result = await hass.config_entries.flow.async_configure(
|
||||
result['flow_id'], {},
|
||||
)
|
||||
assert result['type'] == FlowResultType.CREATE_ENTRY
|
||||
assert result['data'][CONF_HOST] == MOCK_HOST
|
||||
|
||||
|
||||
async def test_duplicate_device_aborted(hass: HomeAssistant, mock_probe) -> None:
|
||||
"""Second add of same serial: flow aborts.
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
"""Tests for the diagnostics platform."""
|
||||
from __future__ import annotations
|
||||
|
||||
from homeassistant.core import HomeAssistant
|
||||
|
||||
from custom_components.localthings.const import DOMAIN
|
||||
from custom_components.localthings.diagnostics import async_get_config_entry_diagnostics
|
||||
from custom_components.localthings.registry.redact import REDACTED
|
||||
|
||||
|
||||
async def test_diagnostics_shape_and_redaction(
|
||||
hass: HomeAssistant, mock_entry, mock_coordinator_session
|
||||
) -> None:
|
||||
await hass.config_entries.async_setup(mock_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
diagnostics = await async_get_config_entry_diagnostics(hass, mock_entry)
|
||||
|
||||
assert diagnostics["device_type"] == 'refrigerator'
|
||||
assert diagnostics["one_ui_version"] == '7.0 Refrigerator'
|
||||
assert '/bespoke/vs/0' in diagnostics["unbound_hrefs"]
|
||||
assert diagnostics["integration_version"] == '0.1.0'
|
||||
assert diagnostics["smartthings_local_version"]
|
||||
|
||||
resources = diagnostics["resources"]
|
||||
assert resources['/information/vs/0']['x.com.samsung.da.serialNum'] == REDACTED
|
||||
assert resources['/wirelessinfo/vs/0']['macaddressWiFi'] == REDACTED
|
||||
# Ordinary state survives.
|
||||
assert resources['/status/lock/vs/0']['x.com.samsung.da.ado.devicecontrol'] == 'On'
|
||||
Reference in new issue
Block a user