mirror of
https://github.com/home-assistant/core.git
synced 2026-09-17 14:08:42 +01:00
339 lines
11 KiB
Python
339 lines
11 KiB
Python
"""Test the LibreNMS config flow."""
|
|
|
|
from unittest.mock import AsyncMock, Mock
|
|
|
|
from aiohttp import ClientError
|
|
from aiolibrenms.exceptions import LibrenmsUnauthenticatedError
|
|
import pytest
|
|
|
|
from homeassistant.components.librenms.const import DOMAIN
|
|
from homeassistant.config_entries import SOURCE_USER
|
|
from homeassistant.const import (
|
|
CONF_API_KEY,
|
|
CONF_HOST,
|
|
CONF_PORT,
|
|
CONF_SSL,
|
|
CONF_URL,
|
|
CONF_VERIFY_SSL,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResultType
|
|
|
|
from .const import MOCK_CONFIG_ENTRY_DATA, MOCK_USER_DATA
|
|
|
|
from tests.common import MockConfigEntry
|
|
|
|
|
|
async def test_step_user(
|
|
hass: HomeAssistant, mock_setup_entry: AsyncMock, mock_librenms: Mock
|
|
) -> None:
|
|
"""Test a user initiated config flow."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
MOCK_USER_DATA,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["title"] == "librenms"
|
|
assert result["data"] == MOCK_CONFIG_ENTRY_DATA
|
|
assert len(mock_setup_entry.mock_calls) == 1
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("exception", "error"),
|
|
[
|
|
(
|
|
LibrenmsUnauthenticatedError({"message": "Unauthenticated."}),
|
|
"invalid_auth",
|
|
),
|
|
(ClientError, "cannot_connect"),
|
|
(Exception, "unknown"),
|
|
],
|
|
)
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_step_user_error_handling(
|
|
hass: HomeAssistant, mock_librenms: Mock, exception: Exception, error: str
|
|
) -> None:
|
|
"""Test a user initiated config flow with errors."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
|
|
mock_librenms.system.async_get_system_info.side_effect = exception
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
MOCK_USER_DATA,
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {"base": error}
|
|
|
|
mock_librenms.system.async_get_system_info.side_effect = None
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
MOCK_USER_DATA,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("invalid_url"),
|
|
["hts://invalid", "hts://invalid:123"],
|
|
)
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_step_user_invalid_url(
|
|
hass: HomeAssistant, mock_librenms: Mock, invalid_url: str
|
|
) -> None:
|
|
"""Test a user initiated config flow with errors."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{**MOCK_USER_DATA, CONF_URL: invalid_url},
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {CONF_URL: "invalid_url"}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
MOCK_USER_DATA,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
|
|
|
|
async def test_user_already_configured(
|
|
hass: HomeAssistant, mock_librenms: Mock, mock_config_entry: MockConfigEntry
|
|
) -> None:
|
|
"""Test starting a flow by user when already configured."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
MOCK_USER_DATA,
|
|
)
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_reauth_flow(
|
|
hass: HomeAssistant, mock_librenms: Mock, mock_config_entry: MockConfigEntry
|
|
) -> None:
|
|
"""Test reauthentication flow."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await mock_config_entry.start_reauth_flow(hass)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reauth_confirm"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_API_KEY: "other_fake_api_key",
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reauth_successful"
|
|
assert mock_config_entry.data[CONF_API_KEY] == "other_fake_api_key"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("exception", "error"),
|
|
[
|
|
(
|
|
LibrenmsUnauthenticatedError({"message": "Unauthenticated."}),
|
|
"invalid_auth",
|
|
),
|
|
(ClientError, "cannot_connect"),
|
|
(Exception, "unknown"),
|
|
],
|
|
)
|
|
async def test_reauth_flow_error_handling(
|
|
hass: HomeAssistant,
|
|
mock_setup_entry: AsyncMock,
|
|
mock_librenms: Mock,
|
|
mock_config_entry: MockConfigEntry,
|
|
exception: Exception,
|
|
error: str,
|
|
) -> None:
|
|
"""Test reauthentication flow with errors."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await mock_config_entry.start_reauth_flow(hass)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reauth_confirm"
|
|
|
|
mock_librenms.system.async_get_system_info.side_effect = exception
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_API_KEY: "other_fake_api_key",
|
|
},
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reauth_confirm"
|
|
assert result["errors"] == {"base": error}
|
|
|
|
mock_librenms.system.async_get_system_info.side_effect = None
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_API_KEY: "other_fake_api_key",
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reauth_successful"
|
|
assert mock_config_entry.data[CONF_API_KEY] == "other_fake_api_key"
|
|
assert len(mock_setup_entry.mock_calls) == 1
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_reconfigure_flow(
|
|
hass: HomeAssistant, mock_librenms: Mock, mock_config_entry: MockConfigEntry
|
|
) -> None:
|
|
"""Test reconfigure flow."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={CONF_URL: "https://librenms:8443", CONF_VERIFY_SSL: True},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
assert mock_config_entry.data[CONF_HOST] == "librenms"
|
|
assert mock_config_entry.data[CONF_PORT] == 8443
|
|
assert mock_config_entry.data[CONF_SSL] is True
|
|
assert mock_config_entry.data[CONF_VERIFY_SSL] is True
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("exception", "error"),
|
|
[
|
|
(
|
|
LibrenmsUnauthenticatedError({"message": "Unauthenticated."}),
|
|
"invalid_auth",
|
|
),
|
|
(ClientError, "cannot_connect"),
|
|
(Exception, "unknown"),
|
|
],
|
|
)
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_step_reconfigure_error_handling(
|
|
hass: HomeAssistant,
|
|
mock_librenms: Mock,
|
|
mock_config_entry: MockConfigEntry,
|
|
exception: Exception,
|
|
error: str,
|
|
) -> None:
|
|
"""Test a user initiated config flow with errors."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
mock_librenms.system.async_get_system_info.side_effect = exception
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={CONF_URL: "https://librenms:8443", CONF_VERIFY_SSL: True},
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
assert result["errors"] == {"base": error}
|
|
|
|
mock_librenms.system.async_get_system_info.side_effect = None
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={CONF_URL: "https://librenms:8443", CONF_VERIFY_SSL: True},
|
|
)
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_step_reconfigure_invalid_url(
|
|
hass: HomeAssistant, mock_librenms: Mock, mock_config_entry: MockConfigEntry
|
|
) -> None:
|
|
"""Test a user initiated config flow with errors."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={CONF_URL: "hts://invalid"},
|
|
)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
assert result["errors"] == {CONF_URL: "invalid_url"}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={CONF_URL: "https://librenms:8443", CONF_VERIFY_SSL: True},
|
|
)
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
|
|
|
|
async def test_reconfigure_already_configured(
|
|
hass: HomeAssistant, mock_librenms: Mock, mock_config_entry: MockConfigEntry
|
|
) -> None:
|
|
"""Test duplicate-reconfiguration guard."""
|
|
mock_config_entry2 = MockConfigEntry(
|
|
domain=DOMAIN,
|
|
data={
|
|
CONF_HOST: "librenms2",
|
|
CONF_API_KEY: "abcdef0123456789",
|
|
CONF_PORT: 8443,
|
|
CONF_SSL: True,
|
|
CONF_VERIFY_SSL: True,
|
|
},
|
|
title="librenms2",
|
|
)
|
|
|
|
mock_config_entry.add_to_hass(hass)
|
|
mock_config_entry2.add_to_hass(hass)
|
|
|
|
result = await mock_config_entry2.start_reconfigure_flow(hass)
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={CONF_URL: "https://librenms:443", CONF_VERIFY_SSL: True},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|