mirror of
https://github.com/home-assistant/core.git
synced 2025-04-24 09:17:53 +00:00
Add DHCP discovery support to Axis integration (#45167)
This commit is contained in:
Robert Svensson
GitHub
parent
233f923cd7
commit
2044b33eb6
@ -5,9 +5,11 @@ from ipaddress import ip_address
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.components.dhcp import HOSTNAME, IP_ADDRESS, MAC_ADDRESS
|
||||
from homeassistant.config_entries import SOURCE_IGNORE
|
||||
from homeassistant.const import (
|
||||
CONF_HOST,
|
||||
CONF_MAC,
|
||||
CONF_NAME,
|
||||
CONF_PASSWORD,
|
||||
CONF_PORT,
|
||||
@ -136,36 +138,56 @@ class AxisFlowHandler(config_entries.ConfigFlow, domain=AXIS_DOMAIN):
|
||||
title = f"{model} - {self.unique_id}"
|
||||
return self.async_create_entry(title=title, data=self.device_config)
|
||||
|
||||
async def async_step_zeroconf(self, discovery_info):
|
||||
"""Prepare configuration for a discovered Axis device."""
|
||||
serial_number = format_mac(discovery_info["properties"]["macaddress"])
|
||||
async def async_step_dhcp(self, discovery_info: dict):
|
||||
"""Prepare configuration for a DHCP discovered Axis device."""
|
||||
return await self._process_discovered_device(
|
||||
{
|
||||
CONF_HOST: discovery_info[IP_ADDRESS],
|
||||
CONF_MAC: format_mac(discovery_info.get(MAC_ADDRESS)),
|
||||
CONF_NAME: discovery_info.get(HOSTNAME),
|
||||
CONF_PORT: DEFAULT_PORT,
|
||||
}
|
||||
)
|
||||
|
||||
if serial_number[:8] not in AXIS_OUI:
|
||||
async def async_step_zeroconf(self, discovery_info: dict):
|
||||
"""Prepare configuration for a discovered Axis device."""
|
||||
return await self._process_discovered_device(
|
||||
{
|
||||
CONF_HOST: discovery_info[CONF_HOST],
|
||||
CONF_MAC: format_mac(discovery_info["properties"]["macaddress"]),
|
||||
CONF_NAME: discovery_info["hostname"][:-7],
|
||||
CONF_PORT: discovery_info[CONF_PORT],
|
||||
}
|
||||
)
|
||||
|
||||
async def _process_discovered_device(self, device: dict):
|
||||
"""Prepare configuration for a discovered Axis device."""
|
||||
if device[CONF_MAC][:8] not in AXIS_OUI:
|
||||
return self.async_abort(reason="not_axis_device")
|
||||
|
||||
if is_link_local(ip_address(discovery_info[CONF_HOST])):
|
||||
if is_link_local(ip_address(device[CONF_HOST])):
|
||||
return self.async_abort(reason="link_local_address")
|
||||
|
||||
await self.async_set_unique_id(serial_number)
|
||||
await self.async_set_unique_id(device[CONF_MAC])
|
||||
|
||||
self._abort_if_unique_id_configured(
|
||||
updates={
|
||||
CONF_HOST: discovery_info[CONF_HOST],
|
||||
CONF_PORT: discovery_info[CONF_PORT],
|
||||
CONF_HOST: device[CONF_HOST],
|
||||
CONF_PORT: device[CONF_PORT],
|
||||
}
|
||||
)
|
||||
|
||||
# pylint: disable=no-member # https://github.com/PyCQA/pylint/issues/3167
|
||||
self.context["title_placeholders"] = {
|
||||
CONF_NAME: discovery_info["hostname"][:-7],
|
||||
CONF_HOST: discovery_info[CONF_HOST],
|
||||
CONF_NAME: device[CONF_NAME],
|
||||
CONF_HOST: device[CONF_HOST],
|
||||
}
|
||||
|
||||
self.discovery_schema = {
|
||||
vol.Required(CONF_HOST, default=discovery_info[CONF_HOST]): str,
|
||||
vol.Required(CONF_HOST, default=device[CONF_HOST]): str,
|
||||
vol.Required(CONF_USERNAME): str,
|
||||
vol.Required(CONF_PASSWORD): str,
|
||||
vol.Required(CONF_PORT, default=discovery_info[CONF_PORT]): int,
|
||||
vol.Required(CONF_PORT, default=device[CONF_PORT]): int,
|
||||
}
|
||||
|
||||
return await self.async_step_user()
|
||||
|
||||
@ -9,6 +9,11 @@
|
||||
{ "type": "_axis-video._tcp.local.", "macaddress": "ACCC8E*" },
|
||||
{ "type": "_axis-video._tcp.local.", "macaddress": "B8A44F*" }
|
||||
],
|
||||
"dhcp": [
|
||||
{ "hostname": "axis-00408c*", "macaddress": "00408C*" },
|
||||
{ "hostname": "axis-accc8e*", "macaddress": "ACCC8E*" },
|
||||
{ "hostname": "axis-b8a44f*", "macaddress": "B8A44F*" }
|
||||
],
|
||||
"after_dependencies": ["mqtt"],
|
||||
"codeowners": ["@Kane610"]
|
||||
}
|
||||
|
||||
@ -16,6 +16,21 @@ DHCP = [
|
||||
"hostname": "connect",
|
||||
"macaddress": "B8B7F1*"
|
||||
},
|
||||
{
|
||||
"domain": "axis",
|
||||
"hostname": "axis-00408c*",
|
||||
"macaddress": "00408C*"
|
||||
},
|
||||
{
|
||||
"domain": "axis",
|
||||
"hostname": "axis-accc8e*",
|
||||
"macaddress": "ACCC8E*"
|
||||
},
|
||||
{
|
||||
"domain": "axis",
|
||||
"hostname": "axis-b8a44f*",
|
||||
"macaddress": "B8A44F*"
|
||||
},
|
||||
{
|
||||
"domain": "flume",
|
||||
"hostname": "flume-gw-*",
|
||||
|
||||
@ -12,7 +12,13 @@ from homeassistant.components.axis.const import (
|
||||
DEFAULT_STREAM_PROFILE,
|
||||
DOMAIN as AXIS_DOMAIN,
|
||||
)
|
||||
from homeassistant.config_entries import SOURCE_IGNORE, SOURCE_USER, SOURCE_ZEROCONF
|
||||
from homeassistant.components.dhcp import HOSTNAME, IP_ADDRESS, MAC_ADDRESS
|
||||
from homeassistant.config_entries import (
|
||||
SOURCE_DHCP,
|
||||
SOURCE_IGNORE,
|
||||
SOURCE_USER,
|
||||
SOURCE_ZEROCONF,
|
||||
)
|
||||
from homeassistant.const import (
|
||||
CONF_HOST,
|
||||
CONF_NAME,
|
||||
@ -25,9 +31,9 @@ from homeassistant.data_entry_flow import (
|
||||
RESULT_TYPE_CREATE_ENTRY,
|
||||
RESULT_TYPE_FORM,
|
||||
)
|
||||
from homeassistant.helpers.device_registry import format_mac
|
||||
|
||||
from .test_device import (
|
||||
FORMATTED_MAC,
|
||||
MAC,
|
||||
MODEL,
|
||||
NAME,
|
||||
@ -62,7 +68,7 @@ async def test_flow_manual_configuration(hass):
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == f"M1065-LW - {format_mac(MAC)}"
|
||||
assert result["title"] == f"M1065-LW - {FORMATTED_MAC}"
|
||||
assert result["data"] == {
|
||||
CONF_HOST: "1.2.3.4",
|
||||
CONF_USERNAME: "user",
|
||||
@ -219,7 +225,7 @@ async def test_flow_create_entry_multiple_existing_entries_of_same_model(hass):
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == f"M1065-LW - {format_mac(MAC)}"
|
||||
assert result["title"] == f"M1065-LW - {FORMATTED_MAC}"
|
||||
assert result["data"] == {
|
||||
CONF_HOST: "1.2.3.4",
|
||||
CONF_USERNAME: "user",
|
||||
@ -232,6 +238,139 @@ async def test_flow_create_entry_multiple_existing_entries_of_same_model(hass):
|
||||
assert result["data"][CONF_NAME] == "M1065-LW 2"
|
||||
|
||||
|
||||
async def test_dhcp_flow(hass):
|
||||
"""Test that DHCP discovery for new devices work."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={
|
||||
HOSTNAME: "axis-123",
|
||||
IP_ADDRESS: "1.2.3.4",
|
||||
MAC_ADDRESS: MAC,
|
||||
},
|
||||
context={"source": SOURCE_DHCP},
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["step_id"] == SOURCE_USER
|
||||
|
||||
with respx.mock:
|
||||
mock_default_vapix_requests(respx)
|
||||
result = await hass.config_entries.flow.async_configure(
|
||||
result["flow_id"],
|
||||
user_input={
|
||||
CONF_HOST: "1.2.3.4",
|
||||
CONF_USERNAME: "user",
|
||||
CONF_PASSWORD: "pass",
|
||||
CONF_PORT: 80,
|
||||
},
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == f"M1065-LW - {FORMATTED_MAC}"
|
||||
assert result["data"] == {
|
||||
CONF_HOST: "1.2.3.4",
|
||||
CONF_USERNAME: "user",
|
||||
CONF_PASSWORD: "pass",
|
||||
CONF_PORT: 80,
|
||||
CONF_MODEL: "M1065-LW",
|
||||
CONF_NAME: "M1065-LW 0",
|
||||
}
|
||||
|
||||
assert result["data"][CONF_NAME] == "M1065-LW 0"
|
||||
|
||||
|
||||
async def test_dhcp_flow_already_configured(hass):
|
||||
"""Test that DHCP doesn't setup already configured devices."""
|
||||
config_entry = await setup_axis_integration(hass)
|
||||
device = hass.data[AXIS_DOMAIN][config_entry.unique_id]
|
||||
assert device.host == "1.2.3.4"
|
||||
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={
|
||||
HOSTNAME: "axis-123",
|
||||
IP_ADDRESS: "1.2.3.4",
|
||||
MAC_ADDRESS: MAC,
|
||||
},
|
||||
context={"source": SOURCE_DHCP},
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_ABORT
|
||||
assert result["reason"] == "already_configured"
|
||||
assert device.host == "1.2.3.4"
|
||||
|
||||
|
||||
async def test_dhcp_flow_updated_configuration(hass):
|
||||
"""Test that DHCP update configuration with new parameters."""
|
||||
config_entry = await setup_axis_integration(hass)
|
||||
device = hass.data[AXIS_DOMAIN][config_entry.unique_id]
|
||||
assert device.host == "1.2.3.4"
|
||||
assert device.config_entry.data == {
|
||||
CONF_HOST: "1.2.3.4",
|
||||
CONF_PORT: 80,
|
||||
CONF_USERNAME: "root",
|
||||
CONF_PASSWORD: "pass",
|
||||
CONF_MODEL: MODEL,
|
||||
CONF_NAME: NAME,
|
||||
}
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.axis.async_setup_entry",
|
||||
return_value=True,
|
||||
) as mock_setup_entry, respx.mock:
|
||||
mock_default_vapix_requests(respx, "2.3.4.5")
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={
|
||||
HOSTNAME: "axis-123",
|
||||
IP_ADDRESS: "2.3.4.5",
|
||||
MAC_ADDRESS: MAC,
|
||||
},
|
||||
context={"source": SOURCE_DHCP},
|
||||
)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert result["type"] == RESULT_TYPE_ABORT
|
||||
assert result["reason"] == "already_configured"
|
||||
assert device.config_entry.data == {
|
||||
CONF_HOST: "2.3.4.5",
|
||||
CONF_PORT: 80,
|
||||
CONF_USERNAME: "root",
|
||||
CONF_PASSWORD: "pass",
|
||||
CONF_MODEL: MODEL,
|
||||
CONF_NAME: NAME,
|
||||
}
|
||||
assert len(mock_setup_entry.mock_calls) == 1
|
||||
|
||||
|
||||
async def test_dhcp_flow_ignore_non_axis_device(hass):
|
||||
"""Test that DHCP doesn't setup devices with link local addresses."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={
|
||||
HOSTNAME: "axis-123",
|
||||
IP_ADDRESS: "169.254.3.4",
|
||||
MAC_ADDRESS: "01234567890",
|
||||
},
|
||||
context={"source": SOURCE_DHCP},
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_ABORT
|
||||
assert result["reason"] == "not_axis_device"
|
||||
|
||||
|
||||
async def test_dhcp_flow_ignore_link_local_address(hass):
|
||||
"""Test that DHCP doesn't setup devices with link local addresses."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={HOSTNAME: "axis-123", IP_ADDRESS: "169.254.3.4", MAC_ADDRESS: MAC},
|
||||
context={"source": SOURCE_DHCP},
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_ABORT
|
||||
assert result["reason"] == "link_local_address"
|
||||
|
||||
|
||||
async def test_zeroconf_flow(hass):
|
||||
"""Test that zeroconf discovery for new devices work."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
@ -261,7 +400,7 @@ async def test_zeroconf_flow(hass):
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == f"M1065-LW - {format_mac(MAC)}"
|
||||
assert result["title"] == f"M1065-LW - {FORMATTED_MAC}"
|
||||
assert result["data"] == {
|
||||
CONF_HOST: "1.2.3.4",
|
||||
CONF_USERNAME: "user",
|
||||
@ -344,7 +483,12 @@ async def test_zeroconf_flow_ignore_non_axis_device(hass):
|
||||
"""Test that zeroconf doesn't setup devices with link local addresses."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={CONF_HOST: "169.254.3.4", "properties": {"macaddress": "01234567890"}},
|
||||
data={
|
||||
CONF_HOST: "169.254.3.4",
|
||||
CONF_PORT: 80,
|
||||
"hostname": "",
|
||||
"properties": {"macaddress": "01234567890"},
|
||||
},
|
||||
context={"source": SOURCE_ZEROCONF},
|
||||
)
|
||||
|
||||
@ -356,7 +500,12 @@ async def test_zeroconf_flow_ignore_link_local_address(hass):
|
||||
"""Test that zeroconf doesn't setup devices with link local addresses."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
AXIS_DOMAIN,
|
||||
data={CONF_HOST: "169.254.3.4", "properties": {"macaddress": MAC}},
|
||||
data={
|
||||
CONF_HOST: "169.254.3.4",
|
||||
CONF_PORT: 80,
|
||||
"hostname": "",
|
||||
"properties": {"macaddress": MAC},
|
||||
},
|
||||
context={"source": SOURCE_ZEROCONF},
|
||||
)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user