mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 13:17:32 +00:00
Add configuration flow to Whois (#63069)
Co-authored-by: Dave T <17680170+davet2001@users.noreply.github.com>
This commit is contained in:
parent
9971831b51
commit
b5300fb32e
@ -1268,6 +1268,7 @@ omit =
|
|||||||
homeassistant/components/waze_travel_time/helpers.py
|
homeassistant/components/waze_travel_time/helpers.py
|
||||||
homeassistant/components/waze_travel_time/sensor.py
|
homeassistant/components/waze_travel_time/sensor.py
|
||||||
homeassistant/components/webostv/*
|
homeassistant/components/webostv/*
|
||||||
|
homeassistant/components/whois/__init__.py
|
||||||
homeassistant/components/whois/sensor.py
|
homeassistant/components/whois/sensor.py
|
||||||
homeassistant/components/wiffi/*
|
homeassistant/components/wiffi/*
|
||||||
homeassistant/components/wirelesstag/*
|
homeassistant/components/wirelesstag/*
|
||||||
|
@ -1035,6 +1035,7 @@ tests/components/wemo/* @esev
|
|||||||
homeassistant/components/whirlpool/* @abmantis
|
homeassistant/components/whirlpool/* @abmantis
|
||||||
tests/components/whirlpool/* @abmantis
|
tests/components/whirlpool/* @abmantis
|
||||||
homeassistant/components/whois/* @frenck
|
homeassistant/components/whois/* @frenck
|
||||||
|
tests/components/whois/* @frenck
|
||||||
homeassistant/components/wiffi/* @mampfes
|
homeassistant/components/wiffi/* @mampfes
|
||||||
tests/components/wiffi/* @mampfes
|
tests/components/wiffi/* @mampfes
|
||||||
homeassistant/components/wilight/* @leofig-rj
|
homeassistant/components/wilight/* @leofig-rj
|
||||||
|
@ -1 +1,16 @@
|
|||||||
"""The whois component."""
|
"""The Whois integration."""
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
|
from homeassistant.core import HomeAssistant
|
||||||
|
|
||||||
|
from .const import PLATFORMS
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
|
"""Set up from a config entry."""
|
||||||
|
hass.config_entries.async_setup_platforms(entry, PLATFORMS)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
|
"""Unload a config entry."""
|
||||||
|
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
||||||
|
52
homeassistant/components/whois/config_flow.py
Normal file
52
homeassistant/components/whois/config_flow.py
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
"""Config flow to configure the Whois integration."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import voluptuous as vol
|
||||||
|
|
||||||
|
from homeassistant.config_entries import ConfigFlow
|
||||||
|
from homeassistant.const import CONF_DOMAIN, CONF_NAME
|
||||||
|
from homeassistant.data_entry_flow import FlowResult
|
||||||
|
|
||||||
|
from .const import DOMAIN
|
||||||
|
|
||||||
|
|
||||||
|
class WhoisFlowHandler(ConfigFlow, domain=DOMAIN):
|
||||||
|
"""Config flow for Whois."""
|
||||||
|
|
||||||
|
VERSION = 1
|
||||||
|
|
||||||
|
imported_name: str | None = None
|
||||||
|
|
||||||
|
async def async_step_user(
|
||||||
|
self, user_input: dict[str, Any] | None = None
|
||||||
|
) -> FlowResult:
|
||||||
|
"""Handle a flow initialized by the user."""
|
||||||
|
if user_input is not None:
|
||||||
|
await self.async_set_unique_id(user_input[CONF_DOMAIN].lower())
|
||||||
|
self._abort_if_unique_id_configured()
|
||||||
|
return self.async_create_entry(
|
||||||
|
title=self.imported_name or user_input[CONF_DOMAIN],
|
||||||
|
data={
|
||||||
|
CONF_DOMAIN: user_input[CONF_DOMAIN].lower(),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
return self.async_show_form(
|
||||||
|
step_id="user",
|
||||||
|
data_schema=vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Required(CONF_DOMAIN): str,
|
||||||
|
}
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
async def async_step_import(self, config: dict[str, Any]) -> FlowResult:
|
||||||
|
"""Handle a flow initialized by importing a config."""
|
||||||
|
self.imported_name = config[CONF_NAME]
|
||||||
|
return await self.async_step_user(
|
||||||
|
user_input={
|
||||||
|
CONF_DOMAIN: config[CONF_DOMAIN],
|
||||||
|
}
|
||||||
|
)
|
@ -4,7 +4,10 @@ from __future__ import annotations
|
|||||||
import logging
|
import logging
|
||||||
from typing import Final
|
from typing import Final
|
||||||
|
|
||||||
|
from homeassistant.const import Platform
|
||||||
|
|
||||||
DOMAIN: Final = "whois"
|
DOMAIN: Final = "whois"
|
||||||
|
PLATFORMS = [Platform.SENSOR]
|
||||||
|
|
||||||
LOGGER = logging.getLogger(__package__)
|
LOGGER = logging.getLogger(__package__)
|
||||||
|
|
||||||
|
@ -3,6 +3,7 @@
|
|||||||
"name": "Whois",
|
"name": "Whois",
|
||||||
"documentation": "https://www.home-assistant.io/integrations/whois",
|
"documentation": "https://www.home-assistant.io/integrations/whois",
|
||||||
"requirements": ["python-whois==0.7.3"],
|
"requirements": ["python-whois==0.7.3"],
|
||||||
|
"config_flow": true,
|
||||||
"codeowners": ["@frenck"],
|
"codeowners": ["@frenck"],
|
||||||
"iot_class": "cloud_polling"
|
"iot_class": "cloud_polling"
|
||||||
}
|
}
|
||||||
|
@ -7,6 +7,7 @@ import voluptuous as vol
|
|||||||
import whois
|
import whois
|
||||||
|
|
||||||
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
||||||
|
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
|
||||||
from homeassistant.const import CONF_DOMAIN, CONF_NAME, TIME_DAYS
|
from homeassistant.const import CONF_DOMAIN, CONF_NAME, TIME_DAYS
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
import homeassistant.helpers.config_validation as cv
|
import homeassistant.helpers.config_validation as cv
|
||||||
@ -19,10 +20,11 @@ from .const import (
|
|||||||
ATTR_REGISTRAR,
|
ATTR_REGISTRAR,
|
||||||
ATTR_UPDATED,
|
ATTR_UPDATED,
|
||||||
DEFAULT_NAME,
|
DEFAULT_NAME,
|
||||||
|
DOMAIN,
|
||||||
LOGGER,
|
LOGGER,
|
||||||
)
|
)
|
||||||
|
|
||||||
SCANTERVAL = timedelta(hours=24)
|
SCAN_INTERVAL = timedelta(hours=24)
|
||||||
|
|
||||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
||||||
{
|
{
|
||||||
@ -39,21 +41,40 @@ def setup_platform(
|
|||||||
discovery_info: DiscoveryInfoType | None = None,
|
discovery_info: DiscoveryInfoType | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Set up the WHOIS sensor."""
|
"""Set up the WHOIS sensor."""
|
||||||
domain = config[CONF_DOMAIN]
|
LOGGER.warning(
|
||||||
name = config[CONF_NAME]
|
"Configuration of the Whois platform in YAML is deprecated and will be "
|
||||||
|
"removed in Home Assistant 2022.4; Your existing configuration "
|
||||||
|
"has been imported into the UI automatically and can be safely removed "
|
||||||
|
"from your configuration.yaml file"
|
||||||
|
)
|
||||||
|
hass.async_create_task(
|
||||||
|
hass.config_entries.flow.async_init(
|
||||||
|
DOMAIN,
|
||||||
|
context={"source": SOURCE_IMPORT},
|
||||||
|
data={CONF_DOMAIN: config[CONF_DOMAIN], CONF_NAME: config[CONF_NAME]},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
entry: ConfigEntry,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
) -> None:
|
||||||
|
"""Set up the platform from config_entry."""
|
||||||
|
domain = entry.data[CONF_DOMAIN]
|
||||||
try:
|
try:
|
||||||
if "expiration_date" in whois.whois(domain):
|
info = await hass.async_add_executor_job(whois.whois, domain)
|
||||||
add_entities([WhoisSensor(name, domain)], True)
|
|
||||||
else:
|
|
||||||
LOGGER.error(
|
|
||||||
"WHOIS lookup for %s didn't contain an expiration date", domain
|
|
||||||
)
|
|
||||||
return
|
|
||||||
except whois.BaseException as ex: # pylint: disable=broad-except
|
except whois.BaseException as ex: # pylint: disable=broad-except
|
||||||
LOGGER.error("Exception %s occurred during WHOIS lookup for %s", ex, domain)
|
LOGGER.error("Exception %s occurred during WHOIS lookup for %s", ex, domain)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
if "expiration_date" not in info:
|
||||||
|
LOGGER.error("WHOIS lookup for %s didn't contain an expiration date", domain)
|
||||||
|
return
|
||||||
|
|
||||||
|
async_add_entities([WhoisSensor(domain)], True)
|
||||||
|
|
||||||
|
|
||||||
class WhoisSensor(SensorEntity):
|
class WhoisSensor(SensorEntity):
|
||||||
"""Implementation of a WHOIS sensor."""
|
"""Implementation of a WHOIS sensor."""
|
||||||
@ -61,11 +82,11 @@ class WhoisSensor(SensorEntity):
|
|||||||
_attr_icon = "mdi:calendar-clock"
|
_attr_icon = "mdi:calendar-clock"
|
||||||
_attr_native_unit_of_measurement = TIME_DAYS
|
_attr_native_unit_of_measurement = TIME_DAYS
|
||||||
|
|
||||||
def __init__(self, name: str, domain: str) -> None:
|
def __init__(self, domain: str) -> None:
|
||||||
"""Initialize the sensor."""
|
"""Initialize the sensor."""
|
||||||
|
self._attr_name = domain
|
||||||
self.whois = whois.whois
|
self.whois = whois.whois
|
||||||
self._domain = domain
|
self._domain = domain
|
||||||
self._attr_name = name
|
|
||||||
|
|
||||||
def _empty_value_and_attributes(self) -> None:
|
def _empty_value_and_attributes(self) -> None:
|
||||||
"""Empty the state and attributes on an error."""
|
"""Empty the state and attributes on an error."""
|
||||||
|
14
homeassistant/components/whois/strings.json
Normal file
14
homeassistant/components/whois/strings.json
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"config": {
|
||||||
|
"step": {
|
||||||
|
"user": {
|
||||||
|
"data": {
|
||||||
|
"domain": "Domain name"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"abort": {
|
||||||
|
"already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
14
homeassistant/components/whois/translations/en.json
Normal file
14
homeassistant/components/whois/translations/en.json
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"config": {
|
||||||
|
"abort": {
|
||||||
|
"already_configured": "Service is already configured"
|
||||||
|
},
|
||||||
|
"step": {
|
||||||
|
"user": {
|
||||||
|
"data": {
|
||||||
|
"domain": "Domain name"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -347,6 +347,7 @@ FLOWS = [
|
|||||||
"waze_travel_time",
|
"waze_travel_time",
|
||||||
"wemo",
|
"wemo",
|
||||||
"whirlpool",
|
"whirlpool",
|
||||||
|
"whois",
|
||||||
"wiffi",
|
"wiffi",
|
||||||
"wilight",
|
"wilight",
|
||||||
"withings",
|
"withings",
|
||||||
|
@ -1193,6 +1193,9 @@ python-tado==0.12.0
|
|||||||
# homeassistant.components.twitch
|
# homeassistant.components.twitch
|
||||||
python-twitch-client==0.6.0
|
python-twitch-client==0.6.0
|
||||||
|
|
||||||
|
# homeassistant.components.whois
|
||||||
|
python-whois==0.7.3
|
||||||
|
|
||||||
# homeassistant.components.awair
|
# homeassistant.components.awair
|
||||||
python_awair==0.2.1
|
python_awair==0.2.1
|
||||||
|
|
||||||
|
1
tests/components/whois/__init__.py
Normal file
1
tests/components/whois/__init__.py
Normal file
@ -0,0 +1 @@
|
|||||||
|
"""Tests for the Whois integration."""
|
34
tests/components/whois/conftest.py
Normal file
34
tests/components/whois/conftest.py
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
"""Fixtures for Whois integration tests."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections.abc import Generator
|
||||||
|
from unittest.mock import AsyncMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from homeassistant.components.whois.const import DOMAIN
|
||||||
|
from homeassistant.const import CONF_DOMAIN
|
||||||
|
|
||||||
|
from tests.common import MockConfigEntry
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_config_entry() -> MockConfigEntry:
|
||||||
|
"""Return the default mocked config entry."""
|
||||||
|
return MockConfigEntry(
|
||||||
|
title="Home Assistant",
|
||||||
|
domain=DOMAIN,
|
||||||
|
data={
|
||||||
|
CONF_DOMAIN: "Home-Assistant.io",
|
||||||
|
},
|
||||||
|
unique_id="home-assistant.io",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_setup_entry() -> Generator[AsyncMock, None, None]:
|
||||||
|
"""Mock setting up a config entry."""
|
||||||
|
with patch(
|
||||||
|
"homeassistant.components.whois.async_setup_entry", return_value=True
|
||||||
|
) as mock_setup:
|
||||||
|
yield mock_setup
|
80
tests/components/whois/test_config_flow.py
Normal file
80
tests/components/whois/test_config_flow.py
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
"""Tests for the Whois config flow."""
|
||||||
|
|
||||||
|
from unittest.mock import AsyncMock
|
||||||
|
|
||||||
|
from homeassistant.components.whois.const import DOMAIN
|
||||||
|
from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER
|
||||||
|
from homeassistant.const import CONF_DOMAIN, CONF_NAME
|
||||||
|
from homeassistant.core import HomeAssistant
|
||||||
|
from homeassistant.data_entry_flow import (
|
||||||
|
RESULT_TYPE_ABORT,
|
||||||
|
RESULT_TYPE_CREATE_ENTRY,
|
||||||
|
RESULT_TYPE_FORM,
|
||||||
|
)
|
||||||
|
|
||||||
|
from tests.common import MockConfigEntry
|
||||||
|
|
||||||
|
|
||||||
|
async def test_full_user_flow(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
mock_setup_entry: AsyncMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test the full user configuration flow."""
|
||||||
|
result = await hass.config_entries.flow.async_init(
|
||||||
|
DOMAIN, context={"source": SOURCE_USER}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result.get("type") == RESULT_TYPE_FORM
|
||||||
|
assert result.get("step_id") == SOURCE_USER
|
||||||
|
assert "flow_id" in result
|
||||||
|
|
||||||
|
result2 = await hass.config_entries.flow.async_configure(
|
||||||
|
result["flow_id"],
|
||||||
|
user_input={CONF_DOMAIN: "Example.com"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result2.get("type") == RESULT_TYPE_CREATE_ENTRY
|
||||||
|
assert result2.get("title") == "Example.com"
|
||||||
|
assert result2.get("data") == {CONF_DOMAIN: "example.com"}
|
||||||
|
|
||||||
|
assert len(mock_setup_entry.mock_calls) == 1
|
||||||
|
|
||||||
|
|
||||||
|
async def test_already_configured(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
mock_setup_entry: AsyncMock,
|
||||||
|
mock_config_entry: MockConfigEntry,
|
||||||
|
) -> None:
|
||||||
|
"""Test we abort if already configured."""
|
||||||
|
mock_config_entry.add_to_hass(hass)
|
||||||
|
|
||||||
|
result = await hass.config_entries.flow.async_init(
|
||||||
|
DOMAIN,
|
||||||
|
context={"source": SOURCE_USER},
|
||||||
|
data={CONF_DOMAIN: "HOME-Assistant.io"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result.get("type") == RESULT_TYPE_ABORT
|
||||||
|
assert result.get("reason") == "already_configured"
|
||||||
|
|
||||||
|
assert len(mock_setup_entry.mock_calls) == 0
|
||||||
|
|
||||||
|
|
||||||
|
async def test_import_flow(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
mock_setup_entry: AsyncMock,
|
||||||
|
) -> None:
|
||||||
|
"""Test the import configuration flow."""
|
||||||
|
result = await hass.config_entries.flow.async_init(
|
||||||
|
DOMAIN,
|
||||||
|
context={"source": SOURCE_IMPORT},
|
||||||
|
data={CONF_DOMAIN: "Example.com", CONF_NAME: "My Example Domain"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result.get("type") == RESULT_TYPE_CREATE_ENTRY
|
||||||
|
assert result.get("title") == "My Example Domain"
|
||||||
|
assert result.get("data") == {
|
||||||
|
CONF_DOMAIN: "example.com",
|
||||||
|
}
|
||||||
|
|
||||||
|
assert len(mock_setup_entry.mock_calls) == 1
|
Loading…
x
Reference in New Issue
Block a user