307 lines
11 KiB
Python
307 lines
11 KiB
Python
|
"""Tests for the IPP config flow."""
|
||
|
|
import aiohttp
|
||
|
|
from pyipp import IPPConnectionUpgradeRequired
|
||
|
|
|
||
|
|
from homeassistant import data_entry_flow
|
||
|
|
from homeassistant.components.ipp import config_flow
|
||
|
|
from homeassistant.components.ipp.const import CONF_BASE_PATH, CONF_UUID
|
||
|
|
from homeassistant.config_entries import SOURCE_USER, SOURCE_ZEROCONF
|
||
|
|
from homeassistant.const import CONF_HOST, CONF_NAME, CONF_SSL
|
||
|
|
from homeassistant.core import HomeAssistant
|
||
|
|
|
||
|
|
from . import (
|
||
|
|
MOCK_USER_INPUT,
|
||
|
|
MOCK_ZEROCONF_IPP_SERVICE_INFO,
|
||
|
|
MOCK_ZEROCONF_IPPS_SERVICE_INFO,
|
||
|
|
init_integration,
|
||
|
|
load_fixture_binary,
|
||
|
|
)
|
||
|
|
|
||
|
|
from tests.test_util.aiohttp import AiohttpClientMocker
|
||
|
|
|
||
|
|
|
||
|
|
async def test_show_user_form(hass: HomeAssistant) -> None:
|
||
|
|
"""Test that the user set up form is served."""
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_USER},
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["step_id"] == "user"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
|
||
|
|
|
||
|
|
async def test_show_zeroconf_confirm_form(hass: HomeAssistant) -> None:
|
||
|
|
"""Test that the zeroconf confirmation form is served."""
|
||
|
|
flow = config_flow.IPPFlowHandler()
|
||
|
|
flow.hass = hass
|
||
|
|
flow.context = {"source": SOURCE_ZEROCONF}
|
||
|
|
flow.discovery_info = {CONF_NAME: "EPSON123456"}
|
||
|
|
|
||
|
|
result = await flow.async_step_zeroconf_confirm()
|
||
|
|
|
||
|
|
assert result["step_id"] == "zeroconf_confirm"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
assert result["description_placeholders"] == {CONF_NAME: "EPSON123456"}
|
||
|
|
|
||
|
|
|
||
|
|
async def test_show_zeroconf_form(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test that the zeroconf confirmation form is served."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"http://EPSON123456.local:631/ipp/print",
|
||
|
|
content=load_fixture_binary("ipp/get-printer-attributes.bin"),
|
||
|
|
headers={"Content-Type": "application/ipp"},
|
||
|
|
)
|
||
|
|
|
||
|
|
flow = config_flow.IPPFlowHandler()
|
||
|
|
flow.hass = hass
|
||
|
|
flow.context = {"source": SOURCE_ZEROCONF}
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
result = await flow.async_step_zeroconf(discovery_info)
|
||
|
|
|
||
|
|
assert flow.discovery_info[CONF_HOST] == "EPSON123456.local"
|
||
|
|
assert flow.discovery_info[CONF_NAME] == "EPSON123456"
|
||
|
|
|
||
|
|
assert result["step_id"] == "zeroconf_confirm"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
assert result["description_placeholders"] == {CONF_NAME: "EPSON123456"}
|
||
|
|
|
||
|
|
|
||
|
|
async def test_connection_error(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we show user form on IPP connection error."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"http://EPSON123456.local:631/ipp/print", exc=aiohttp.ClientError
|
||
|
|
)
|
||
|
|
|
||
|
|
user_input = MOCK_USER_INPUT.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_USER}, data=user_input,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["step_id"] == "user"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
assert result["errors"] == {"base": "connection_error"}
|
||
|
|
|
||
|
|
|
||
|
|
async def test_zeroconf_connection_error(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we abort zeroconf flow on IPP connection error."""
|
||
|
|
aioclient_mock.post("http://EPSON123456.local/ipp/print", exc=aiohttp.ClientError)
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_ZEROCONF}, data=discovery_info,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||
|
|
assert result["reason"] == "connection_error"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_zeroconf_confirm_connection_error(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we abort zeroconf flow on IPP connection error."""
|
||
|
|
aioclient_mock.post("http://EPSON123456.local/ipp/print", exc=aiohttp.ClientError)
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN,
|
||
|
|
context={
|
||
|
|
"source": SOURCE_ZEROCONF,
|
||
|
|
CONF_HOST: "EPSON123456.local",
|
||
|
|
CONF_NAME: "EPSON123456",
|
||
|
|
},
|
||
|
|
data=discovery_info,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||
|
|
assert result["reason"] == "connection_error"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_user_connection_upgrade_required(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we show the user form if connection upgrade required by server."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"http://EPSON123456.local:631/ipp/print", exc=IPPConnectionUpgradeRequired
|
||
|
|
)
|
||
|
|
|
||
|
|
user_input = MOCK_USER_INPUT.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_USER}, data=user_input,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["step_id"] == "user"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
assert result["errors"] == {"base": "connection_upgrade"}
|
||
|
|
|
||
|
|
|
||
|
|
async def test_zeroconf_connection_upgrade_required(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we abort zeroconf flow on IPP connection error."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"http://EPSON123456.local/ipp/print", exc=IPPConnectionUpgradeRequired
|
||
|
|
)
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_ZEROCONF}, data=discovery_info,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||
|
|
assert result["reason"] == "connection_upgrade"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_user_device_exists_abort(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we abort user flow if printer already configured."""
|
||
|
|
await init_integration(hass, aioclient_mock)
|
||
|
|
|
||
|
|
user_input = MOCK_USER_INPUT.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_USER}, data=user_input,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||
|
|
assert result["reason"] == "already_configured"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_zeroconf_device_exists_abort(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we abort zeroconf flow if printer already configured."""
|
||
|
|
await init_integration(hass, aioclient_mock)
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_ZEROCONF}, data=discovery_info,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||
|
|
assert result["reason"] == "already_configured"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_zeroconf_with_uuid_device_exists_abort(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test we abort zeroconf flow if printer already configured."""
|
||
|
|
await init_integration(hass, aioclient_mock)
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
discovery_info["properties"]["UUID"] = "cfe92100-67c4-11d4-a45f-f8d027761251"
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_ZEROCONF}, data=discovery_info,
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
||
|
|
assert result["reason"] == "already_configured"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_full_user_flow_implementation(
|
||
|
|
hass: HomeAssistant, aioclient_mock
|
||
|
|
) -> None:
|
||
|
|
"""Test the full manual user flow from start to finish."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"http://EPSON123456.local:631/ipp/print",
|
||
|
|
content=load_fixture_binary("ipp/get-printer-attributes.bin"),
|
||
|
|
headers={"Content-Type": "application/ipp"},
|
||
|
|
)
|
||
|
|
|
||
|
|
result = await hass.config_entries.flow.async_init(
|
||
|
|
config_flow.DOMAIN, context={"source": SOURCE_USER},
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["step_id"] == "user"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
|
||
|
|
result = await hass.config_entries.flow.async_configure(
|
||
|
|
result["flow_id"],
|
||
|
|
user_input={CONF_HOST: "EPSON123456.local", CONF_BASE_PATH: "/ipp/print"},
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||
|
|
assert result["title"] == "EPSON123456.local"
|
||
|
|
|
||
|
|
assert result["data"]
|
||
|
|
assert result["data"][CONF_HOST] == "EPSON123456.local"
|
||
|
|
assert result["data"][CONF_UUID] == "cfe92100-67c4-11d4-a45f-f8d027761251"
|
||
|
|
|
||
|
|
|
||
|
|
async def test_full_zeroconf_flow_implementation(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test the full manual user flow from start to finish."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"http://EPSON123456.local:631/ipp/print",
|
||
|
|
content=load_fixture_binary("ipp/get-printer-attributes.bin"),
|
||
|
|
headers={"Content-Type": "application/ipp"},
|
||
|
|
)
|
||
|
|
|
||
|
|
flow = config_flow.IPPFlowHandler()
|
||
|
|
flow.hass = hass
|
||
|
|
flow.context = {"source": SOURCE_ZEROCONF}
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPP_SERVICE_INFO.copy()
|
||
|
|
result = await flow.async_step_zeroconf(discovery_info)
|
||
|
|
|
||
|
|
assert flow.discovery_info
|
||
|
|
assert flow.discovery_info[CONF_HOST] == "EPSON123456.local"
|
||
|
|
assert flow.discovery_info[CONF_NAME] == "EPSON123456"
|
||
|
|
|
||
|
|
assert result["step_id"] == "zeroconf_confirm"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
|
||
|
|
result = await flow.async_step_zeroconf_confirm(
|
||
|
|
user_input={CONF_HOST: "EPSON123456.local"}
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||
|
|
assert result["title"] == "EPSON123456"
|
||
|
|
|
||
|
|
assert result["data"]
|
||
|
|
assert result["data"][CONF_HOST] == "EPSON123456.local"
|
||
|
|
assert result["data"][CONF_UUID] == "cfe92100-67c4-11d4-a45f-f8d027761251"
|
||
|
|
assert not result["data"][CONF_SSL]
|
||
|
|
|
||
|
|
|
||
|
|
async def test_full_zeroconf_tls_flow_implementation(
|
||
|
|
hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
|
||
|
|
) -> None:
|
||
|
|
"""Test the full manual user flow from start to finish."""
|
||
|
|
aioclient_mock.post(
|
||
|
|
"https://EPSON123456.local:631/ipp/print",
|
||
|
|
content=load_fixture_binary("ipp/get-printer-attributes.bin"),
|
||
|
|
headers={"Content-Type": "application/ipp"},
|
||
|
|
)
|
||
|
|
|
||
|
|
flow = config_flow.IPPFlowHandler()
|
||
|
|
flow.hass = hass
|
||
|
|
flow.context = {"source": SOURCE_ZEROCONF}
|
||
|
|
|
||
|
|
discovery_info = MOCK_ZEROCONF_IPPS_SERVICE_INFO.copy()
|
||
|
|
result = await flow.async_step_zeroconf(discovery_info)
|
||
|
|
|
||
|
|
assert result["step_id"] == "zeroconf_confirm"
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
||
|
|
assert result["description_placeholders"] == {CONF_NAME: "EPSON123456"}
|
||
|
|
|
||
|
|
result = await flow.async_step_zeroconf_confirm(
|
||
|
|
user_input={CONF_HOST: "EPSON123456.local"}
|
||
|
|
)
|
||
|
|
|
||
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||
|
|
assert result["title"] == "EPSON123456"
|
||
|
|
|
||
|
|
assert result["data"]
|
||
|
|
assert result["data"][CONF_HOST] == "EPSON123456.local"
|
||
|
|
assert result["data"][CONF_NAME] == "EPSON123456"
|
||
|
|
assert result["data"][CONF_UUID] == "cfe92100-67c4-11d4-a45f-f8d027761251"
|
||
|
|
assert result["data"][CONF_SSL]
|