Redact secret zwave values in diagnostics (#90389)

* redact secret zwave values from diagnostics

* shhrink

* rename
This commit is contained in:
Raman Gupta 2023-03-28 03:59:01 -04:00 committed by GitHub
parent 14ffda9758
commit c51ed4b328
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 56 additions and 6 deletions

View file

@ -1,10 +1,14 @@
"""Test the Z-Wave JS diagnostics."""
import copy
from unittest.mock import patch
import pytest
from zwave_js_server.const import CommandClass
from zwave_js_server.event import Event
from zwave_js_server.model.node import Node
from homeassistant.components.zwave_js.diagnostics import (
REDACTED,
ZwaveValueMatcher,
async_get_device_diagnostics,
)
@ -179,3 +183,41 @@ async def test_device_diagnostics_missing_primary_value(
assert air_entity["value_id"] == value.value_id
assert air_entity["primary_value"] is None
async def test_device_diagnostics_secret_value(
hass: HomeAssistant,
client,
multisensor_6_state,
integration,
hass_client: ClientSessionGenerator,
version_state,
) -> None:
"""Test that secret value in device level diagnostics gets redacted."""
def _find_ultraviolet_val(data: dict) -> dict:
"""Find ultraviolet property value in data."""
return next(
val
for val in data["values"]
if val["commandClass"] == CommandClass.SENSOR_MULTILEVEL
and val["property"] == PROPERTY_ULTRAVIOLET
)
node_state = copy.deepcopy(multisensor_6_state)
# Force a value to be secret so we can check if it gets redacted
secret_value = _find_ultraviolet_val(node_state)
secret_value["metadata"]["secret"] = True
node = Node(client, node_state)
client.driver.controller.nodes[node.node_id] = node
client.driver.controller.emit("node added", {"node": node})
await hass.async_block_till_done()
dev_reg = async_get_dev_reg(hass)
device = dev_reg.async_get_device({get_device_id(client.driver, node)})
assert device
diagnostics_data = await get_diagnostics_for_device(
hass, hass_client, integration, device
)
test_value = _find_ultraviolet_val(diagnostics_data["state"])
assert test_value["value"] == REDACTED