mirror of
https://github.com/home-assistant/core.git
synced 2025-07-22 20:57:21 +00:00
Remove deprecated YAML configuration from Whois (#67163)
* Remove deprecated YAML configuration from Whois * Clean up platform schema
This commit is contained in:
parent
6bd21f05dc
commit
1d03313bf5
@ -13,7 +13,7 @@ from whois.exceptions import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
from homeassistant.config_entries import ConfigFlow
|
from homeassistant.config_entries import ConfigFlow
|
||||||
from homeassistant.const import CONF_DOMAIN, CONF_NAME
|
from homeassistant.const import CONF_DOMAIN
|
||||||
from homeassistant.data_entry_flow import FlowResult
|
from homeassistant.data_entry_flow import FlowResult
|
||||||
|
|
||||||
from .const import DOMAIN
|
from .const import DOMAIN
|
||||||
@ -69,12 +69,3 @@ class WhoisFlowHandler(ConfigFlow, domain=DOMAIN):
|
|||||||
),
|
),
|
||||||
errors=errors,
|
errors=errors,
|
||||||
)
|
)
|
||||||
|
|
||||||
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],
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
@ -14,8 +14,6 @@ LOGGER = logging.getLogger(__package__)
|
|||||||
|
|
||||||
SCAN_INTERVAL = timedelta(hours=24)
|
SCAN_INTERVAL = timedelta(hours=24)
|
||||||
|
|
||||||
DEFAULT_NAME = "Whois"
|
|
||||||
|
|
||||||
ATTR_EXPIRES = "expires"
|
ATTR_EXPIRES = "expires"
|
||||||
ATTR_NAME_SERVERS = "name_servers"
|
ATTR_NAME_SERVERS = "name_servers"
|
||||||
ATTR_REGISTRAR = "registrar"
|
ATTR_REGISTRAR = "registrar"
|
||||||
|
@ -6,44 +6,25 @@ from dataclasses import dataclass
|
|||||||
from datetime import datetime, timezone
|
from datetime import datetime, timezone
|
||||||
from typing import cast
|
from typing import cast
|
||||||
|
|
||||||
import voluptuous as vol
|
|
||||||
from whois import Domain
|
from whois import Domain
|
||||||
|
|
||||||
from homeassistant.components.sensor import (
|
from homeassistant.components.sensor import (
|
||||||
PLATFORM_SCHEMA,
|
|
||||||
SensorDeviceClass,
|
SensorDeviceClass,
|
||||||
SensorEntity,
|
SensorEntity,
|
||||||
SensorEntityDescription,
|
SensorEntityDescription,
|
||||||
)
|
)
|
||||||
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_DOMAIN, CONF_NAME, TIME_DAYS
|
from homeassistant.const import CONF_DOMAIN, TIME_DAYS
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
import homeassistant.helpers.config_validation as cv
|
|
||||||
from homeassistant.helpers.device_registry import DeviceEntryType
|
from homeassistant.helpers.device_registry import DeviceEntryType
|
||||||
from homeassistant.helpers.entity import DeviceInfo, EntityCategory
|
from homeassistant.helpers.entity import DeviceInfo, EntityCategory
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
||||||
from homeassistant.helpers.update_coordinator import (
|
from homeassistant.helpers.update_coordinator import (
|
||||||
CoordinatorEntity,
|
CoordinatorEntity,
|
||||||
DataUpdateCoordinator,
|
DataUpdateCoordinator,
|
||||||
)
|
)
|
||||||
|
|
||||||
from .const import (
|
from .const import ATTR_EXPIRES, ATTR_NAME_SERVERS, ATTR_REGISTRAR, ATTR_UPDATED, DOMAIN
|
||||||
ATTR_EXPIRES,
|
|
||||||
ATTR_NAME_SERVERS,
|
|
||||||
ATTR_REGISTRAR,
|
|
||||||
ATTR_UPDATED,
|
|
||||||
DEFAULT_NAME,
|
|
||||||
DOMAIN,
|
|
||||||
LOGGER,
|
|
||||||
)
|
|
||||||
|
|
||||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
||||||
{
|
|
||||||
vol.Required(CONF_DOMAIN): cv.string,
|
|
||||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@ -152,28 +133,6 @@ SENSORS: tuple[WhoisSensorEntityDescription, ...] = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_platform(
|
|
||||||
hass: HomeAssistant,
|
|
||||||
config: ConfigType,
|
|
||||||
async_add_entities: AddEntitiesCallback,
|
|
||||||
discovery_info: DiscoveryInfoType | None = None,
|
|
||||||
) -> None:
|
|
||||||
"""Set up the WHOIS sensor."""
|
|
||||||
LOGGER.warning(
|
|
||||||
"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(
|
async def async_setup_entry(
|
||||||
hass: HomeAssistant,
|
hass: HomeAssistant,
|
||||||
entry: ConfigEntry,
|
entry: ConfigEntry,
|
||||||
|
@ -10,8 +10,8 @@ from whois.exceptions import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
from homeassistant.components.whois.const import DOMAIN
|
from homeassistant.components.whois.const import DOMAIN
|
||||||
from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER
|
from homeassistant.config_entries import SOURCE_USER
|
||||||
from homeassistant.const import CONF_DOMAIN, CONF_NAME
|
from homeassistant.const import CONF_DOMAIN
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.data_entry_flow import (
|
from homeassistant.data_entry_flow import (
|
||||||
RESULT_TYPE_ABORT,
|
RESULT_TYPE_ABORT,
|
||||||
@ -124,24 +124,3 @@ async def test_already_configured(
|
|||||||
assert result.get("reason") == "already_configured"
|
assert result.get("reason") == "already_configured"
|
||||||
|
|
||||||
assert len(mock_setup_entry.mock_calls) == 0
|
assert len(mock_setup_entry.mock_calls) == 0
|
||||||
|
|
||||||
|
|
||||||
async def test_import_flow(
|
|
||||||
hass: HomeAssistant,
|
|
||||||
mock_setup_entry: AsyncMock,
|
|
||||||
mock_whois_config_flow: MagicMock,
|
|
||||||
) -> 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
|
|
||||||
|
@ -9,12 +9,9 @@ from whois.exceptions import (
|
|||||||
WhoisCommandFailed,
|
WhoisCommandFailed,
|
||||||
)
|
)
|
||||||
|
|
||||||
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
|
||||||
from homeassistant.components.whois.const import DOMAIN
|
from homeassistant.components.whois.const import DOMAIN
|
||||||
from homeassistant.config_entries import ConfigEntryState
|
from homeassistant.config_entries import ConfigEntryState
|
||||||
from homeassistant.const import CONF_DOMAIN
|
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.setup import async_setup_component
|
|
||||||
|
|
||||||
from tests.common import MockConfigEntry
|
from tests.common import MockConfigEntry
|
||||||
|
|
||||||
@ -59,22 +56,3 @@ async def test_error_handling(
|
|||||||
|
|
||||||
assert mock_config_entry.state is ConfigEntryState.SETUP_RETRY
|
assert mock_config_entry.state is ConfigEntryState.SETUP_RETRY
|
||||||
assert len(mock_whois.mock_calls) == 1
|
assert len(mock_whois.mock_calls) == 1
|
||||||
|
|
||||||
|
|
||||||
async def test_import_config(
|
|
||||||
hass: HomeAssistant,
|
|
||||||
mock_whois: MagicMock,
|
|
||||||
mock_whois_config_flow: MagicMock,
|
|
||||||
caplog: pytest.LogCaptureFixture,
|
|
||||||
) -> None:
|
|
||||||
"""Test the Whois being set up from config via import."""
|
|
||||||
assert await async_setup_component(
|
|
||||||
hass,
|
|
||||||
SENSOR_DOMAIN,
|
|
||||||
{SENSOR_DOMAIN: {"platform": DOMAIN, CONF_DOMAIN: "home-assistant.io"}},
|
|
||||||
)
|
|
||||||
await hass.async_block_till_done()
|
|
||||||
|
|
||||||
assert len(hass.config_entries.async_entries(DOMAIN)) == 1
|
|
||||||
assert len(mock_whois.mock_calls) == 1
|
|
||||||
assert "the Whois platform in YAML is deprecated" in caplog.text
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user