evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add diagnostics support to UniFi Network integration (#64640)

Browse source 
* Add diagnostics support to UniFi Network integration

* Remove system info

* Add test data before trying to redact sensitive information

* Redact sensitive information from config_entry.data

* Redact a lot of different parts of the device descriptions
Redact mac addresses in such a way its possible to still view topology
This commit is contained in:
Robert Svensson 2022-01-23 13:44:43 +01:00 • committed by GitHub
parent 02df6eb10e
commit 20072140c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 334 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

235
tests/components/unifi/test_diagnostics.py Normal file
View file

@ -0,0 +1,235 @@
"""Test UniFi Network diagnostics."""
from homeassistant.components.unifi.const import (
CONF_ALLOW_BANDWIDTH_SENSORS,
CONF_ALLOW_UPTIME_SENSORS,
CONF_BLOCK_CLIENT,
)
from homeassistant.components.unifi.device_tracker import CLIENT_TRACKER, DEVICE_TRACKER
from homeassistant.components.unifi.sensor import RX_SENSOR, TX_SENSOR, UPTIME_SENSOR
from homeassistant.components.unifi.switch import BLOCK_SWITCH, DPI_SWITCH, POE_SWITCH
from homeassistant.const import Platform
from .test_controller import setup_unifi_integration
from tests.components.diagnostics import get_diagnostics_for_config_entry
async def test_entry_diagnostics(hass, hass_client, aioclient_mock):
"""Test config entry diagnostics."""
client = {
"blocked": False,
"hostname": "client_1",
"ip": "10.0.0.1",
"is_wired": True,
"last_seen": 1562600145,
"mac": "00:00:00:00:00:01",
"name": "POE Client 1",
"oui": "Producer",
"sw_mac": "00:00:00:00:01:01",
"sw_port": 1,
"wired-rx_bytes": 1234000000,
"wired-tx_bytes": 5678000000,
}
device = {
"ethernet_table": [
{
"mac": "22:22:22:22:22:22",
"num_port": 2,
"name": "eth0",
}
],
"device_id": "mock-id",
"ip": "10.0.1.1",
"mac": "00:00:00:00:01:01",
"last_seen": 1562600145,
"model": "US16P150",
"name": "mock-name",
"port_overrides": [],
"port_table": [
{
"mac_table": [
{
"age": 1,
"mac": "00:00:00:00:00:01",
"static": False,
"uptime": 3971792,
"vlan": 1,
},
{
"age": 1,
"mac": "11:11:11:11:11:11",
"static": True,
"uptime": 0,
"vlan": 0,
},
],
"media": "GE",
"name": "Port 1",
"port_idx": 1,
"poe_class": "Class 4",
"poe_enable": True,
"poe_mode": "auto",
"poe_power": "2.56",
"poe_voltage": "53.40",
"portconf_id": "1a1",
"port_poe": True,
"up": True,
},
],
"state": 1,
"type": "usw",
"version": "4.0.42.10433",
}
dpi_app = {
"_id": "5f976f62e3c58f018ec7e17d",
"apps": [],
"blocked": True,
"cats": ["4"],
"enabled": True,
"log": True,
"site_id": "name",
}
dpi_group = {
"_id": "5f976f4ae3c58f018ec7dff6",
"name": "Block Media Streaming",
"site_id": "name",
"dpiapp_ids": ["5f976f62e3c58f018ec7e17d"],
}
options = {
CONF_ALLOW_BANDWIDTH_SENSORS: True,
CONF_ALLOW_UPTIME_SENSORS: True,
CONF_BLOCK_CLIENT: ["00:00:00:00:00:01"],
}
config_entry = await setup_unifi_integration(
hass,
aioclient_mock,
options=options,
clients_response=[client],
devices_response=[device],
dpiapp_response=[dpi_app],
dpigroup_response=[dpi_group],
)
assert await get_diagnostics_for_config_entry(hass, hass_client, config_entry) == {
"config": {
"controller": "**REDACTED**",
"host": "1.2.3.4",
"password": "**REDACTED**",
"port": 1234,
"site": "site_id",
"username": "username",
"verify_ssl": False,
},
"options": {
"allow_bandwidth_sensors": True,
"allow_uptime_sensors": True,
"block_client": ["00:00:00:00:00:00"],
},
"site_role": "admin",
"entities": {
str(Platform.DEVICE_TRACKER): {
CLIENT_TRACKER: ["00:00:00:00:00:00"],
DEVICE_TRACKER: ["00:00:00:00:00:01"],
},
str(Platform.SENSOR): {
RX_SENSOR: ["00:00:00:00:00:00"],
TX_SENSOR: ["00:00:00:00:00:00"],
UPTIME_SENSOR: ["00:00:00:00:00:00"],
},
str(Platform.SWITCH): {
BLOCK_SWITCH: ["00:00:00:00:00:00"],
DPI_SWITCH: ["5f976f4ae3c58f018ec7dff6"],
POE_SWITCH: ["00:00:00:00:00:00"],
},
},
"clients": {
"00:00:00:00:00:00": {
"blocked": False,
"hostname": "client_1",
"ip": "10.0.0.1",
"is_wired": True,
"last_seen": 1562600145,
"mac": "00:00:00:00:00:00",
"name": "POE Client 1",
"oui": "Producer",
"sw_mac": "00:00:00:00:00:01",
"sw_port": 1,
"wired-rx_bytes": 1234000000,
"wired-tx_bytes": 5678000000,
}
},
"devices": {
"00:00:00:00:00:01": {
"ethernet_table": [
{
"mac": "00:00:00:00:00:02",
"num_port": 2,
"name": "eth0",
}
],
"device_id": "mock-id",
"ip": "10.0.1.1",
"mac": "00:00:00:00:00:01",
"last_seen": 1562600145,
"model": "US16P150",
"name": "mock-name",
"port_overrides": [],
"port_table": [
{
"mac_table": [
{
"age": 1,
"mac": "00:00:00:00:00:00",
"static": False,
"uptime": 3971792,
"vlan": 1,
},
{
"age": 1,
"mac": "**REDACTED**",
"static": True,
"uptime": 0,
"vlan": 0,
},
],
"media": "GE",
"name": "Port 1",
"port_idx": 1,
"poe_class": "Class 4",
"poe_enable": True,
"poe_mode": "auto",
"poe_power": "2.56",
"poe_voltage": "53.40",
"portconf_id": "1a1",
"port_poe": True,
"up": True,
},
],
"state": 1,
"type": "usw",
"version": "4.0.42.10433",
}
},
"dpi_apps": {
"5f976f62e3c58f018ec7e17d": {
"_id": "5f976f62e3c58f018ec7e17d",
"apps": [],
"blocked": True,
"cats": ["4"],
"enabled": True,
"log": True,
"site_id": "name",
}
},
"dpi_groups": {
"5f976f4ae3c58f018ec7dff6": {
"_id": "5f976f4ae3c58f018ec7dff6",
"name": "Block Media Streaming",
"site_id": "name",
"dpiapp_ids": ["5f976f62e3c58f018ec7e17d"],
}
},
"wlans": {},
}