UniFi - Add block network access control to config option (#32004)
* Add block network access control to config option * Clean up
This commit is contained in:
1 parent
1615a5ee81
commit
d216c1f2ac
9 files changed
+314
-104
No files matched your search
@@ -5,7 +5,18 @@ from asynctest import patch
|
||||
from homeassistant import data_entry_flow
|
||||
from homeassistant.components import unifi
|
||||
from homeassistant.components.unifi import config_flow
|
||||
from homeassistant.components.unifi.const import CONF_CONTROLLER, CONF_SITE_ID
|
||||
from homeassistant.components.unifi.config_flow import CONF_NEW_CLIENT
|
||||
from homeassistant.components.unifi.const import (
|
||||
CONF_ALLOW_BANDWIDTH_SENSORS,
|
||||
CONF_BLOCK_CLIENT,
|
||||
CONF_CONTROLLER,
|
||||
CONF_DETECTION_TIME,
|
||||
CONF_SITE_ID,
|
||||
CONF_SSID_FILTER,
|
||||
CONF_TRACK_CLIENTS,
|
||||
CONF_TRACK_DEVICES,
|
||||
CONF_TRACK_WIRED_CLIENTS,
|
||||
)
|
||||
from homeassistant.const import (
|
||||
CONF_HOST,
|
||||
CONF_PASSWORD,
|
||||
@@ -18,6 +29,8 @@ from .test_controller import setup_unifi_integration
|
||||
|
||||
from tests.common import MockConfigEntry
|
||||
|
||||
CLIENTS = [{"mac": "00:00:00:00:00:01"}]
|
||||
|
||||
WLANS = [{"name": "SSID 1"}, {"name": "SSID 2"}]
|
||||
|
||||
|
||||
@@ -28,7 +41,7 @@ async def test_flow_works(hass, aioclient_mock, mock_discovery):
|
||||
config_flow.DOMAIN, context={"source": "user"}
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "user"
|
||||
assert result["data_schema"]({CONF_USERNAME: "", CONF_PASSWORD: ""}) == {
|
||||
CONF_HOST: "unifi",
|
||||
@@ -64,7 +77,7 @@ async def test_flow_works(hass, aioclient_mock, mock_discovery):
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == "create_entry"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == "Site name"
|
||||
assert result["data"] == {
|
||||
CONF_CONTROLLER: {
|
||||
@@ -84,7 +97,7 @@ async def test_flow_works_multiple_sites(hass, aioclient_mock):
|
||||
config_flow.DOMAIN, context={"source": "user"}
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "user"
|
||||
|
||||
aioclient_mock.post(
|
||||
@@ -116,7 +129,7 @@ async def test_flow_works_multiple_sites(hass, aioclient_mock):
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "site"
|
||||
assert result["data_schema"]({"site": "site name"})
|
||||
assert result["data_schema"]({"site": "site2 name"})
|
||||
@@ -133,7 +146,7 @@ async def test_flow_fails_site_already_configured(hass, aioclient_mock):
|
||||
config_flow.DOMAIN, context={"source": "user"}
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "user"
|
||||
|
||||
aioclient_mock.post(
|
||||
@@ -162,7 +175,7 @@ async def test_flow_fails_site_already_configured(hass, aioclient_mock):
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == "abort"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||||
|
||||
|
||||
async def test_flow_fails_user_credentials_faulty(hass, aioclient_mock):
|
||||
@@ -171,7 +184,7 @@ async def test_flow_fails_user_credentials_faulty(hass, aioclient_mock):
|
||||
config_flow.DOMAIN, context={"source": "user"}
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "user"
|
||||
|
||||
with patch("aiounifi.Controller.login", side_effect=aiounifi.errors.Unauthorized):
|
||||
@@ -186,7 +199,7 @@ async def test_flow_fails_user_credentials_faulty(hass, aioclient_mock):
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "faulty_credentials"}
|
||||
|
||||
|
||||
@@ -196,7 +209,7 @@ async def test_flow_fails_controller_unavailable(hass, aioclient_mock):
|
||||
config_flow.DOMAIN, context={"source": "user"}
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "user"
|
||||
|
||||
with patch("aiounifi.Controller.login", side_effect=aiounifi.errors.RequestError):
|
||||
@@ -211,7 +224,7 @@ async def test_flow_fails_controller_unavailable(hass, aioclient_mock):
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "service_unavailable"}
|
||||
|
||||
|
||||
@@ -221,7 +234,7 @@ async def test_flow_fails_unknown_problem(hass, aioclient_mock):
|
||||
config_flow.DOMAIN, context={"source": "user"}
|
||||
)
|
||||
|
||||
assert result["type"] == "form"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "user"
|
||||
|
||||
with patch("aiounifi.Controller.login", side_effect=Exception):
|
||||
@@ -236,12 +249,14 @@ async def test_flow_fails_unknown_problem(hass, aioclient_mock):
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == "abort"
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||||
|
||||
|
||||
async def test_option_flow(hass):
|
||||
"""Test config flow options."""
|
||||
controller = await setup_unifi_integration(hass, wlans_response=WLANS)
|
||||
controller = await setup_unifi_integration(
|
||||
hass, clients_response=CLIENTS, wlans_response=WLANS
|
||||
)
|
||||
|
||||
result = await hass.config_entries.options.async_init(
|
||||
controller.config_entry.entry_id
|
||||
@@ -253,27 +268,64 @@ async def test_option_flow(hass):
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input={
|
||||
config_flow.CONF_TRACK_CLIENTS: False,
|
||||
config_flow.CONF_TRACK_WIRED_CLIENTS: False,
|
||||
config_flow.CONF_TRACK_DEVICES: False,
|
||||
config_flow.CONF_SSID_FILTER: ["SSID 1"],
|
||||
config_flow.CONF_DETECTION_TIME: 100,
|
||||
CONF_TRACK_CLIENTS: False,
|
||||
CONF_TRACK_WIRED_CLIENTS: False,
|
||||
CONF_TRACK_DEVICES: False,
|
||||
CONF_SSID_FILTER: ["SSID 1"],
|
||||
CONF_DETECTION_TIME: 100,
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "client_control"
|
||||
|
||||
clients_to_block = hass.config_entries.options._progress[result["flow_id"]].options[
|
||||
CONF_BLOCK_CLIENT
|
||||
]
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input={
|
||||
CONF_BLOCK_CLIENT: clients_to_block,
|
||||
CONF_NEW_CLIENT: "00:00:00:00:00:01",
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "client_control"
|
||||
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"],
|
||||
user_input={
|
||||
CONF_BLOCK_CLIENT: clients_to_block,
|
||||
CONF_NEW_CLIENT: "00:00:00:00:00:02",
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "client_control"
|
||||
assert result["errors"] == {"base": "unknown_client_mac"}
|
||||
|
||||
clients_to_block = hass.config_entries.options._progress[result["flow_id"]].options[
|
||||
CONF_BLOCK_CLIENT
|
||||
]
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"], user_input={CONF_BLOCK_CLIENT: clients_to_block},
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result["step_id"] == "statistics_sensors"
|
||||
|
||||
result = await hass.config_entries.options.async_configure(
|
||||
result["flow_id"], user_input={config_flow.CONF_ALLOW_BANDWIDTH_SENSORS: True}
|
||||
result["flow_id"], user_input={CONF_ALLOW_BANDWIDTH_SENSORS: True}
|
||||
)
|
||||
|
||||
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["data"] == {
|
||||
config_flow.CONF_TRACK_CLIENTS: False,
|
||||
config_flow.CONF_TRACK_WIRED_CLIENTS: False,
|
||||
config_flow.CONF_TRACK_DEVICES: False,
|
||||
config_flow.CONF_DETECTION_TIME: 100,
|
||||
config_flow.CONF_SSID_FILTER: ["SSID 1"],
|
||||
config_flow.CONF_ALLOW_BANDWIDTH_SENSORS: True,
|
||||
CONF_TRACK_CLIENTS: False,
|
||||
CONF_TRACK_WIRED_CLIENTS: False,
|
||||
CONF_TRACK_DEVICES: False,
|
||||
CONF_DETECTION_TIME: 100,
|
||||
CONF_SSID_FILTER: ["SSID 1"],
|
||||
CONF_BLOCK_CLIENT: ["00:00:00:00:00:01"],
|
||||
CONF_ALLOW_BANDWIDTH_SENSORS: True,
|
||||
}
|
||||
@@ -166,7 +166,7 @@ async def test_controller_setup(hass):
|
||||
controller.option_allow_bandwidth_sensors
|
||||
== unifi.const.DEFAULT_ALLOW_BANDWIDTH_SENSORS
|
||||
)
|
||||
assert controller.option_block_clients == unifi.const.DEFAULT_BLOCK_CLIENTS
|
||||
assert isinstance(controller.option_block_clients, list)
|
||||
assert controller.option_track_clients == unifi.const.DEFAULT_TRACK_CLIENTS
|
||||
assert controller.option_track_devices == unifi.const.DEFAULT_TRACK_DEVICES
|
||||
assert (
|
||||
@@ -175,7 +175,7 @@ async def test_controller_setup(hass):
|
||||
assert controller.option_detection_time == timedelta(
|
||||
seconds=unifi.const.DEFAULT_DETECTION_TIME
|
||||
)
|
||||
assert controller.option_ssid_filter == unifi.const.DEFAULT_SSID_FILTER
|
||||
assert isinstance(controller.option_ssid_filter, list)
|
||||
|
||||
assert controller.mac is None
|
||||
|
||||
@@ -235,7 +235,7 @@ async def test_reset_after_successful_setup(hass):
|
||||
"""Calling reset when the entry has been setup."""
|
||||
controller = await setup_unifi_integration(hass)
|
||||
|
||||
assert len(controller.listeners) == 5
|
||||
assert len(controller.listeners) == 6
|
||||
|
||||
result = await controller.async_reset()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
@@ -4,6 +4,11 @@ from copy import deepcopy
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.components import unifi
|
||||
import homeassistant.components.switch as switch
|
||||
from homeassistant.components.unifi.const import (
|
||||
CONF_BLOCK_CLIENT,
|
||||
CONF_TRACK_CLIENTS,
|
||||
CONF_TRACK_DEVICES,
|
||||
)
|
||||
from homeassistant.helpers import entity_registry
|
||||
from homeassistant.setup import async_setup_component
|
||||
|
||||
@@ -200,11 +205,7 @@ async def test_platform_manually_configured(hass):
|
||||
async def test_no_clients(hass):
|
||||
"""Test the update_clients function when no clients are found."""
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
hass, options={CONF_TRACK_CLIENTS: False, CONF_TRACK_DEVICES: False},
|
||||
)
|
||||
|
||||
assert len(controller.mock_requests) == 4
|
||||
@@ -215,10 +216,7 @@ async def test_controller_not_client(hass):
|
||||
"""Test that the controller doesn't become a switch."""
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
options={CONF_TRACK_CLIENTS: False, CONF_TRACK_DEVICES: False},
|
||||
clients_response=[CONTROLLER_HOST],
|
||||
devices_response=[DEVICE_1],
|
||||
)
|
||||
@@ -235,10 +233,7 @@ async def test_not_admin(hass):
|
||||
sites["Site name"]["role"] = "not admin"
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
options={CONF_TRACK_CLIENTS: False, CONF_TRACK_DEVICES: False},
|
||||
sites=sites,
|
||||
clients_response=[CLIENT_1],
|
||||
devices_response=[DEVICE_1],
|
||||
@@ -253,9 +248,9 @@ async def test_switches(hass):
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.CONF_BLOCK_CLIENT: [BLOCKED["mac"], UNBLOCKED["mac"]],
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
CONF_BLOCK_CLIENT: [BLOCKED["mac"], UNBLOCKED["mac"]],
|
||||
CONF_TRACK_CLIENTS: False,
|
||||
CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
clients_response=[CLIENT_1, CLIENT_4],
|
||||
devices_response=[DEVICE_1],
|
||||
@@ -284,34 +279,10 @@ async def test_switches(hass):
|
||||
assert unblocked is not None
|
||||
assert unblocked.state == "on"
|
||||
|
||||
|
||||
async def test_new_client_discovered_on_block_control(hass):
|
||||
"""Test if 2nd update has a new client."""
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.CONF_BLOCK_CLIENT: [BLOCKED["mac"]],
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
clients_all_response=[BLOCKED],
|
||||
)
|
||||
|
||||
assert len(controller.mock_requests) == 4
|
||||
assert len(hass.states.async_all()) == 2
|
||||
|
||||
controller.api.websocket._data = {
|
||||
"meta": {"message": "sta:sync"},
|
||||
"data": [BLOCKED],
|
||||
}
|
||||
controller.api.session_handler("data")
|
||||
|
||||
# Calling a service will trigger the updates to run
|
||||
await hass.services.async_call(
|
||||
"switch", "turn_off", {"entity_id": "switch.block_client_1"}, blocking=True
|
||||
)
|
||||
assert len(controller.mock_requests) == 5
|
||||
assert len(hass.states.async_all()) == 2
|
||||
assert controller.mock_requests[4] == {
|
||||
"json": {"mac": "00:00:00:00:01:01", "cmd": "block-sta"},
|
||||
"method": "post",
|
||||
@@ -329,14 +300,79 @@ async def test_new_client_discovered_on_block_control(hass):
|
||||
}
|
||||
|
||||
|
||||
async def test_new_client_discovered_on_poe_control(hass):
|
||||
async def test_new_client_discovered_on_block_control(hass):
|
||||
"""Test if 2nd update has a new client."""
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
CONF_BLOCK_CLIENT: [BLOCKED["mac"]],
|
||||
CONF_TRACK_CLIENTS: False,
|
||||
CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
)
|
||||
|
||||
assert len(controller.mock_requests) == 4
|
||||
assert len(hass.states.async_all()) == 1
|
||||
|
||||
blocked = hass.states.get("switch.block_client_1")
|
||||
assert blocked is None
|
||||
|
||||
controller.api.websocket._data = {
|
||||
"meta": {"message": "sta:sync"},
|
||||
"data": [BLOCKED],
|
||||
}
|
||||
controller.api.session_handler("data")
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert len(hass.states.async_all()) == 2
|
||||
blocked = hass.states.get("switch.block_client_1")
|
||||
assert blocked is not None
|
||||
|
||||
|
||||
async def test_option_block_clients(hass):
|
||||
"""Test the changes to option reflects accordingly."""
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={CONF_BLOCK_CLIENT: [BLOCKED["mac"]]},
|
||||
clients_all_response=[BLOCKED, UNBLOCKED],
|
||||
)
|
||||
assert len(hass.states.async_all()) == 2
|
||||
|
||||
# Add a second switch
|
||||
hass.config_entries.async_update_entry(
|
||||
controller.config_entry,
|
||||
options={CONF_BLOCK_CLIENT: [BLOCKED["mac"], UNBLOCKED["mac"]]},
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
assert len(hass.states.async_all()) == 3
|
||||
|
||||
# Remove the second switch again
|
||||
hass.config_entries.async_update_entry(
|
||||
controller.config_entry, options={CONF_BLOCK_CLIENT: [BLOCKED["mac"]]},
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
assert len(hass.states.async_all()) == 2
|
||||
|
||||
# Enable one and remove another one
|
||||
hass.config_entries.async_update_entry(
|
||||
controller.config_entry, options={CONF_BLOCK_CLIENT: [UNBLOCKED["mac"]]},
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
assert len(hass.states.async_all()) == 2
|
||||
|
||||
# Remove one
|
||||
hass.config_entries.async_update_entry(
|
||||
controller.config_entry, options={CONF_BLOCK_CLIENT: []},
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
assert len(hass.states.async_all()) == 1
|
||||
|
||||
|
||||
async def test_new_client_discovered_on_poe_control(hass):
|
||||
"""Test if 2nd update has a new client."""
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={CONF_TRACK_CLIENTS: False, CONF_TRACK_DEVICES: False},
|
||||
clients_response=[CLIENT_1],
|
||||
devices_response=[DEVICE_1],
|
||||
)
|
||||
@@ -435,9 +471,9 @@ async def test_restoring_client(hass):
|
||||
controller = await setup_unifi_integration(
|
||||
hass,
|
||||
options={
|
||||
unifi.CONF_BLOCK_CLIENT: ["random mac"],
|
||||
unifi.const.CONF_TRACK_CLIENTS: False,
|
||||
unifi.const.CONF_TRACK_DEVICES: False,
|
||||
CONF_BLOCK_CLIENT: ["random mac"],
|
||||
CONF_TRACK_CLIENTS: False,
|
||||
CONF_TRACK_DEVICES: False,
|
||||
},
|
||||
clients_response=[CLIENT_2],
|
||||
devices_response=[DEVICE_1],
|
||||
|
||||
Reference in new issue
Block a user