Add support for Minecraft SRV records (#32372)
* Added support for Minecraft SRV records * Switched from dnspython to aiodns, improved server ping and log messages, use address instead of host and port in config flow * Updated component requirements
This commit is contained in:
1 parent
cd57b764ce
commit
45241e57ca
10 files changed
+245
-96
No files matched your search
@@ -1,5 +1,8 @@
|
||||
"""Test the Minecraft Server config flow."""
|
||||
|
||||
import asyncio
|
||||
|
||||
import aiodns
|
||||
from asynctest import patch
|
||||
from mcstatus.pinger import PingResponse
|
||||
|
||||
@@ -19,6 +22,19 @@ from homeassistant.helpers.typing import HomeAssistantType
|
||||
|
||||
from tests.common import MockConfigEntry
|
||||
|
||||
|
||||
class QueryMock:
|
||||
"""Mock for result of aiodns.DNSResolver.query."""
|
||||
|
||||
def __init__(self):
|
||||
"""Set up query result mock."""
|
||||
self.host = "mc.dummyserver.com"
|
||||
self.port = 23456
|
||||
self.priority = 1
|
||||
self.weight = 1
|
||||
self.ttl = None
|
||||
|
||||
|
||||
STATUS_RESPONSE_RAW = {
|
||||
"description": {"text": "Dummy Description"},
|
||||
"version": {"name": "Dummy Version", "protocol": 123},
|
||||
@@ -35,34 +51,34 @@ STATUS_RESPONSE_RAW = {
|
||||
|
||||
USER_INPUT = {
|
||||
CONF_NAME: DEFAULT_NAME,
|
||||
CONF_HOST: "mc.dummyserver.com",
|
||||
CONF_PORT: DEFAULT_PORT,
|
||||
CONF_HOST: f"mc.dummyserver.com:{DEFAULT_PORT}",
|
||||
}
|
||||
|
||||
USER_INPUT_SRV = {CONF_NAME: DEFAULT_NAME, CONF_HOST: "dummyserver.com"}
|
||||
|
||||
USER_INPUT_IPV4 = {
|
||||
CONF_NAME: DEFAULT_NAME,
|
||||
CONF_HOST: "1.1.1.1",
|
||||
CONF_PORT: DEFAULT_PORT,
|
||||
CONF_HOST: f"1.1.1.1:{DEFAULT_PORT}",
|
||||
}
|
||||
|
||||
USER_INPUT_IPV6 = {
|
||||
CONF_NAME: DEFAULT_NAME,
|
||||
CONF_HOST: "::ffff:0101:0101",
|
||||
CONF_PORT: DEFAULT_PORT,
|
||||
CONF_HOST: f"[::ffff:0101:0101]:{DEFAULT_PORT}",
|
||||
}
|
||||
|
||||
USER_INPUT_PORT_TOO_SMALL = {
|
||||
CONF_NAME: DEFAULT_NAME,
|
||||
CONF_HOST: "mc.dummyserver.com",
|
||||
CONF_PORT: 1023,
|
||||
CONF_HOST: f"mc.dummyserver.com:1023",
|
||||
}
|
||||
|
||||
USER_INPUT_PORT_TOO_LARGE = {
|
||||
CONF_NAME: DEFAULT_NAME,
|
||||
CONF_HOST: "mc.dummyserver.com",
|
||||
CONF_PORT: 65536,
|
||||
CONF_HOST: f"mc.dummyserver.com:65536",
|
||||
}
|
||||
|
||||
SRV_RECORDS = asyncio.Future()
|
||||
SRV_RECORDS.set_result([QueryMock()])
|
||||
|
||||
|
||||
async def test_show_config_form(hass: HomeAssistantType) -> None:
|
||||
"""Test if initial configuration form is shown."""
|
||||
@@ -87,54 +103,96 @@ async def test_invalid_ip(hass: HomeAssistantType) -> None:
|
||||
|
||||
async def test_same_host(hass: HomeAssistantType) -> None:
|
||||
"""Test abort in case of same host name."""
|
||||
unique_id = f"{USER_INPUT[CONF_HOST]}-{USER_INPUT[CONF_PORT]}"
|
||||
mock_config_entry = MockConfigEntry(
|
||||
domain=DOMAIN, unique_id=unique_id, data=USER_INPUT
|
||||
)
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
with patch(
|
||||
"mcstatus.server.MinecraftServer.status",
|
||||
return_value=PingResponse(STATUS_RESPONSE_RAW),
|
||||
):
|
||||
unique_id = "mc.dummyserver.com-25565"
|
||||
config_data = {
|
||||
CONF_NAME: DEFAULT_NAME,
|
||||
CONF_HOST: "mc.dummyserver.com",
|
||||
CONF_PORT: DEFAULT_PORT,
|
||||
}
|
||||
mock_config_entry = MockConfigEntry(
|
||||
domain=DOMAIN, unique_id=unique_id, data=config_data
|
||||
)
|
||||
mock_config_entry.add_to_hass(hass)
|
||||
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT
|
||||
)
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_ABORT
|
||||
assert result["reason"] == "already_configured"
|
||||
assert result["type"] == RESULT_TYPE_ABORT
|
||||
assert result["reason"] == "already_configured"
|
||||
|
||||
|
||||
async def test_port_too_small(hass: HomeAssistantType) -> None:
|
||||
"""Test error in case of a too small port."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT_PORT_TOO_SMALL
|
||||
)
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT_PORT_TOO_SMALL
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "invalid_port"}
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "invalid_port"}
|
||||
|
||||
|
||||
async def test_port_too_large(hass: HomeAssistantType) -> None:
|
||||
"""Test error in case of a too large port."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT_PORT_TOO_LARGE
|
||||
)
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT_PORT_TOO_LARGE
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "invalid_port"}
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "invalid_port"}
|
||||
|
||||
|
||||
async def test_connection_failed(hass: HomeAssistantType) -> None:
|
||||
"""Test error in case of a failed connection."""
|
||||
with patch("mcstatus.server.MinecraftServer.ping", side_effect=OSError):
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT
|
||||
)
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
with patch("mcstatus.server.MinecraftServer.status", side_effect=OSError):
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "cannot_connect"}
|
||||
assert result["type"] == RESULT_TYPE_FORM
|
||||
assert result["errors"] == {"base": "cannot_connect"}
|
||||
|
||||
|
||||
async def test_connection_succeeded_with_srv_record(hass: HomeAssistantType) -> None:
|
||||
"""Test config entry in case of a successful connection with a SRV record."""
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", return_value=SRV_RECORDS,
|
||||
):
|
||||
with patch(
|
||||
"mcstatus.server.MinecraftServer.status",
|
||||
return_value=PingResponse(STATUS_RESPONSE_RAW),
|
||||
):
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_USER}, data=USER_INPUT_SRV
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == USER_INPUT_SRV[CONF_HOST]
|
||||
assert result["data"][CONF_NAME] == USER_INPUT_SRV[CONF_NAME]
|
||||
assert result["data"][CONF_HOST] == USER_INPUT_SRV[CONF_HOST]
|
||||
|
||||
|
||||
async def test_connection_succeeded_with_host(hass: HomeAssistantType) -> None:
|
||||
"""Test config entry in case of a successful connection with a host name."""
|
||||
with patch("mcstatus.server.MinecraftServer.ping", return_value=50):
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
with patch(
|
||||
"mcstatus.server.MinecraftServer.status",
|
||||
return_value=PingResponse(STATUS_RESPONSE_RAW),
|
||||
@@ -144,16 +202,17 @@ async def test_connection_succeeded_with_host(hass: HomeAssistantType) -> None:
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert result["title"] == f"{USER_INPUT[CONF_HOST]}:{USER_INPUT[CONF_PORT]}"
|
||||
assert result["title"] == USER_INPUT[CONF_HOST]
|
||||
assert result["data"][CONF_NAME] == USER_INPUT[CONF_NAME]
|
||||
assert result["data"][CONF_HOST] == USER_INPUT[CONF_HOST]
|
||||
assert result["data"][CONF_PORT] == USER_INPUT[CONF_PORT]
|
||||
assert result["data"][CONF_HOST] == "mc.dummyserver.com"
|
||||
|
||||
|
||||
async def test_connection_succeeded_with_ip4(hass: HomeAssistantType) -> None:
|
||||
"""Test config entry in case of a successful connection with an IPv4 address."""
|
||||
with patch("getmac.get_mac_address", return_value="01:23:45:67:89:ab"):
|
||||
with patch("mcstatus.server.MinecraftServer.ping", return_value=50):
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
with patch(
|
||||
"mcstatus.server.MinecraftServer.status",
|
||||
return_value=PingResponse(STATUS_RESPONSE_RAW),
|
||||
@@ -163,19 +222,17 @@ async def test_connection_succeeded_with_ip4(hass: HomeAssistantType) -> None:
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert (
|
||||
result["title"]
|
||||
== f"{USER_INPUT_IPV4[CONF_HOST]}:{USER_INPUT_IPV4[CONF_PORT]}"
|
||||
)
|
||||
assert result["title"] == USER_INPUT_IPV4[CONF_HOST]
|
||||
assert result["data"][CONF_NAME] == USER_INPUT_IPV4[CONF_NAME]
|
||||
assert result["data"][CONF_HOST] == USER_INPUT_IPV4[CONF_HOST]
|
||||
assert result["data"][CONF_PORT] == USER_INPUT_IPV4[CONF_PORT]
|
||||
assert result["data"][CONF_HOST] == "1.1.1.1"
|
||||
|
||||
|
||||
async def test_connection_succeeded_with_ip6(hass: HomeAssistantType) -> None:
|
||||
"""Test config entry in case of a successful connection with an IPv6 address."""
|
||||
with patch("getmac.get_mac_address", return_value="01:23:45:67:89:ab"):
|
||||
with patch("mcstatus.server.MinecraftServer.ping", return_value=50):
|
||||
with patch(
|
||||
"aiodns.DNSResolver.query", side_effect=aiodns.error.DNSError,
|
||||
):
|
||||
with patch(
|
||||
"mcstatus.server.MinecraftServer.status",
|
||||
return_value=PingResponse(STATUS_RESPONSE_RAW),
|
||||
@@ -185,10 +242,6 @@ async def test_connection_succeeded_with_ip6(hass: HomeAssistantType) -> None:
|
||||
)
|
||||
|
||||
assert result["type"] == RESULT_TYPE_CREATE_ENTRY
|
||||
assert (
|
||||
result["title"]
|
||||
== f"{USER_INPUT_IPV6[CONF_HOST]}:{USER_INPUT_IPV6[CONF_PORT]}"
|
||||
)
|
||||
assert result["title"] == USER_INPUT_IPV6[CONF_HOST]
|
||||
assert result["data"][CONF_NAME] == USER_INPUT_IPV6[CONF_NAME]
|
||||
assert result["data"][CONF_HOST] == USER_INPUT_IPV6[CONF_HOST]
|
||||
assert result["data"][CONF_PORT] == USER_INPUT_IPV6[CONF_PORT]
|
||||
assert result["data"][CONF_HOST] == "::ffff:0101:0101"
|
||||
Reference in new issue
Block a user