222 lines
8.1 KiB
Python
222 lines
8.1 KiB
Python
"""Tests for the Minecraft Server integration."""
|
|
from unittest.mock import patch
|
|
|
|
from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
|
|
from homeassistant.components.minecraft_server.api import MinecraftServerAddressError
|
|
from homeassistant.components.minecraft_server.const import DEFAULT_NAME, DOMAIN
|
|
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
|
from homeassistant.const import CONF_ADDRESS, CONF_HOST, CONF_NAME, CONF_PORT
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
|
|
from .const import TEST_ADDRESS, TEST_HOST, TEST_JAVA_DATA, TEST_PORT
|
|
|
|
from tests.common import MockConfigEntry
|
|
|
|
TEST_UNIQUE_ID = f"{TEST_HOST}-{TEST_PORT}"
|
|
|
|
SENSOR_KEYS = [
|
|
{"v1": "Latency Time", "v2": "latency"},
|
|
{"v1": "Players Max", "v2": "players_max"},
|
|
{"v1": "Players Online", "v2": "players_online"},
|
|
{"v1": "Protocol Version", "v2": "protocol_version"},
|
|
{"v1": "Version", "v2": "version"},
|
|
{"v1": "World Message", "v2": "motd"},
|
|
]
|
|
|
|
BINARY_SENSOR_KEYS = {"v1": "Status", "v2": "status"}
|
|
|
|
|
|
def create_v1_mock_config_entry(hass: HomeAssistant) -> int:
|
|
"""Create mock config entry."""
|
|
config_entry_v1 = MockConfigEntry(
|
|
domain=DOMAIN,
|
|
unique_id=TEST_UNIQUE_ID,
|
|
data={
|
|
CONF_NAME: DEFAULT_NAME,
|
|
CONF_HOST: TEST_HOST,
|
|
CONF_PORT: TEST_PORT,
|
|
},
|
|
version=1,
|
|
)
|
|
config_entry_id = config_entry_v1.entry_id
|
|
config_entry_v1.add_to_hass(hass)
|
|
|
|
return config_entry_id
|
|
|
|
|
|
def create_v1_mock_device_entry(hass: HomeAssistant, config_entry_id: int) -> int:
|
|
"""Create mock device entry."""
|
|
device_registry = dr.async_get(hass)
|
|
device_entry_v1 = device_registry.async_get_or_create(
|
|
config_entry_id=config_entry_id,
|
|
identifiers={(DOMAIN, TEST_UNIQUE_ID)},
|
|
)
|
|
device_entry_id = device_entry_v1.id
|
|
|
|
assert device_entry_v1
|
|
assert device_entry_id
|
|
|
|
return device_entry_id
|
|
|
|
|
|
def create_v1_mock_sensor_entity_entries(
|
|
hass: HomeAssistant, config_entry_id: int, device_entry_id: int
|
|
) -> list[dict]:
|
|
"""Create mock sensor entity entries."""
|
|
sensor_entity_id_key_mapping_list = []
|
|
config_entry = hass.config_entries.async_get_entry(config_entry_id)
|
|
entity_registry = er.async_get(hass)
|
|
|
|
for sensor_key in SENSOR_KEYS:
|
|
entity_unique_id = f"{TEST_UNIQUE_ID}-{sensor_key['v1']}"
|
|
entity_entry_v1 = entity_registry.async_get_or_create(
|
|
SENSOR_DOMAIN,
|
|
DOMAIN,
|
|
unique_id=entity_unique_id,
|
|
config_entry=config_entry,
|
|
device_id=device_entry_id,
|
|
)
|
|
assert entity_entry_v1.unique_id == entity_unique_id
|
|
sensor_entity_id_key_mapping_list.append(
|
|
{"entity_id": entity_entry_v1.entity_id, "key": sensor_key["v2"]}
|
|
)
|
|
|
|
return sensor_entity_id_key_mapping_list
|
|
|
|
|
|
def create_v1_mock_binary_sensor_entity_entry(
|
|
hass: HomeAssistant, config_entry_id: int, device_entry_id: int
|
|
) -> dict:
|
|
"""Create mock binary sensor entity entry."""
|
|
config_entry = hass.config_entries.async_get_entry(config_entry_id)
|
|
entity_registry = er.async_get(hass)
|
|
entity_unique_id = f"{TEST_UNIQUE_ID}-{BINARY_SENSOR_KEYS['v1']}"
|
|
entity_entry = entity_registry.async_get_or_create(
|
|
BINARY_SENSOR_DOMAIN,
|
|
DOMAIN,
|
|
unique_id=entity_unique_id,
|
|
config_entry=config_entry,
|
|
device_id=device_entry_id,
|
|
)
|
|
assert entity_entry.unique_id == entity_unique_id
|
|
binary_sensor_entity_id_key_mapping = {
|
|
"entity_id": entity_entry.entity_id,
|
|
"key": BINARY_SENSOR_KEYS["v2"],
|
|
}
|
|
|
|
return binary_sensor_entity_id_key_mapping
|
|
|
|
|
|
async def test_entry_migration(hass: HomeAssistant) -> None:
|
|
"""Test entry migration from version 1 to 3, where host and port is required for the connection to the server."""
|
|
config_entry_id = create_v1_mock_config_entry(hass)
|
|
device_entry_id = create_v1_mock_device_entry(hass, config_entry_id)
|
|
sensor_entity_id_key_mapping_list = create_v1_mock_sensor_entity_entries(
|
|
hass, config_entry_id, device_entry_id
|
|
)
|
|
binary_sensor_entity_id_key_mapping = create_v1_mock_binary_sensor_entity_entry(
|
|
hass, config_entry_id, device_entry_id
|
|
)
|
|
|
|
# Trigger migration.
|
|
with patch(
|
|
"homeassistant.components.minecraft_server.api.MinecraftServer.__init__",
|
|
side_effect=[
|
|
MinecraftServerAddressError, # async_migrate_entry
|
|
None, # async_migrate_entry
|
|
None, # async_setup_entry
|
|
],
|
|
return_value=None,
|
|
), patch(
|
|
"homeassistant.components.minecraft_server.api.MinecraftServer.async_get_data",
|
|
return_value=TEST_JAVA_DATA,
|
|
):
|
|
assert await hass.config_entries.async_setup(config_entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Test migrated config entry.
|
|
config_entry = hass.config_entries.async_get_entry(config_entry_id)
|
|
assert config_entry.unique_id is None
|
|
assert config_entry.data == {
|
|
CONF_NAME: DEFAULT_NAME,
|
|
CONF_ADDRESS: TEST_ADDRESS,
|
|
}
|
|
|
|
assert config_entry.version == 3
|
|
|
|
# Test migrated device entry.
|
|
device_registry = dr.async_get(hass)
|
|
device_entry = device_registry.async_get(device_entry_id)
|
|
assert device_entry.identifiers == {(DOMAIN, config_entry_id)}
|
|
|
|
# Test migrated sensor entity entries.
|
|
entity_registry = er.async_get(hass)
|
|
for mapping in sensor_entity_id_key_mapping_list:
|
|
entity_entry = entity_registry.async_get(mapping["entity_id"])
|
|
assert entity_entry.unique_id == f"{config_entry_id}-{mapping['key']}"
|
|
|
|
# Test migrated binary sensor entity entry.
|
|
entity_entry = entity_registry.async_get(
|
|
binary_sensor_entity_id_key_mapping["entity_id"]
|
|
)
|
|
assert (
|
|
entity_entry.unique_id
|
|
== f"{config_entry_id}-{binary_sensor_entity_id_key_mapping['key']}"
|
|
)
|
|
|
|
|
|
async def test_entry_migration_host_only(hass: HomeAssistant) -> None:
|
|
"""Test entry migration from version 1 to 3, where host alone is sufficient for the connection to the server."""
|
|
config_entry_id = create_v1_mock_config_entry(hass)
|
|
device_entry_id = create_v1_mock_device_entry(hass, config_entry_id)
|
|
create_v1_mock_sensor_entity_entries(hass, config_entry_id, device_entry_id)
|
|
create_v1_mock_binary_sensor_entity_entry(hass, config_entry_id, device_entry_id)
|
|
|
|
# Trigger migration.
|
|
with patch(
|
|
"homeassistant.components.minecraft_server.api.MinecraftServer.__init__",
|
|
side_effect=[
|
|
None, # async_migrate_entry
|
|
None, # async_setup_entry
|
|
],
|
|
return_value=None,
|
|
), patch(
|
|
"homeassistant.components.minecraft_server.api.MinecraftServer.async_get_data",
|
|
return_value=TEST_JAVA_DATA,
|
|
):
|
|
assert await hass.config_entries.async_setup(config_entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Test migrated config entry.
|
|
config_entry = hass.config_entries.async_get_entry(config_entry_id)
|
|
assert config_entry.unique_id is None
|
|
assert config_entry.data == {
|
|
CONF_NAME: DEFAULT_NAME,
|
|
CONF_ADDRESS: TEST_HOST,
|
|
}
|
|
assert config_entry.version == 3
|
|
|
|
|
|
async def test_entry_migration_v3_failure(hass: HomeAssistant) -> None:
|
|
"""Test failed entry migration from version 2 to 3."""
|
|
config_entry_id = create_v1_mock_config_entry(hass)
|
|
device_entry_id = create_v1_mock_device_entry(hass, config_entry_id)
|
|
create_v1_mock_sensor_entity_entries(hass, config_entry_id, device_entry_id)
|
|
create_v1_mock_binary_sensor_entity_entry(hass, config_entry_id, device_entry_id)
|
|
|
|
# Trigger migration.
|
|
with patch(
|
|
"homeassistant.components.minecraft_server.api.MinecraftServer.__init__",
|
|
side_effect=[
|
|
MinecraftServerAddressError, # async_migrate_entry
|
|
MinecraftServerAddressError, # async_migrate_entry
|
|
],
|
|
return_value=None,
|
|
):
|
|
assert not await hass.config_entries.async_setup(config_entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Test config entry.
|
|
config_entry = hass.config_entries.async_get_entry(config_entry_id)
|
|
assert config_entry.version == 2
|