Skip to content

Make discovery on unsupported devices less noisy #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sdb9696 merged 6 commits into from
Nov 21, 2024
Merged

Make discovery on unsupported devices less noisy #1291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cc883ae
Make discovery on unsupported devices less noisy
rytilahti Nov 20, 2024
5e8eaa6
Add some newlines to improve readability
rytilahti Nov 20, 2024
3d742a7
Noise-- for devicefactory with smart fallback
rytilahti Nov 20, 2024
7190ac3
Fix tests
rytilahti Nov 20, 2024
ac08b63
Add unknown_iot_device_family to unupported devices fixture
rytilahti Nov 20, 2024
820bb4c
Fix coverage
sdb9696 Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion kasa/device_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ def get_device_class_from_family(
and device_type.startswith("SMART.")
and not require_exact
):
_LOGGER.warning("Unknown SMART device with %s, using SmartDevice", device_type)
_LOGGER.debug("Unknown SMART device with %s, using SmartDevice", device_type)
cls = SmartDevice

return cls
Expand Down
11 changes: 9 additions & 2 deletions kasa/discover.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,6 +715,7 @@ def _get_device_instance(
raise KasaException(
f"Unable to read response from device: {config.host}: {ex}"
) from ex

try:
discovery_result = DiscoveryResult.from_dict(info["result"])
except Exception as ex:
Expand All @@ -733,6 +734,7 @@ def _get_device_instance(
f"Unable to parse discovery from device: {config.host}: {ex}",
host=config.host,
) from ex

# Decrypt the data
if (
encrypt_info := discovery_result.encrypt_info
Expand All @@ -746,11 +748,13 @@ def _get_device_instance(

type_ = discovery_result.device_type
encrypt_schm = discovery_result.mgt_encrypt_schm

try:
if not (encrypt_type := encrypt_schm.encrypt_type) and (
encrypt_info := discovery_result.encrypt_info
):
encrypt_type = encrypt_info.sym_schm

if not encrypt_type:
raise UnsupportedDeviceError(
f"Unsupported device {config.host} of type {type_} "
Expand All @@ -771,19 +775,21 @@ def _get_device_instance(
discovery_result=discovery_result.to_dict(),
host=config.host,
) from ex

if (
device_class := get_device_class_from_family(
type_, https=encrypt_schm.is_support_https
)
) is None:
_LOGGER.warning("Got unsupported device type: %s", type_)
_LOGGER.debug("Got unsupported device type: %s", type_)
raise UnsupportedDeviceError(
f"Unsupported device {config.host} of type {type_}: {info}",
discovery_result=discovery_result.to_dict(),
host=config.host,
)

if (protocol := get_protocol(config)) is None:
_LOGGER.warning(
_LOGGER.debug(
"Got unsupported connection type: %s", config.connection_type.to_dict()
)
raise UnsupportedDeviceError(
Expand All @@ -800,6 +806,7 @@ def _get_device_instance(
else info
)
_LOGGER.debug("[DISCOVERY] %s << %s", config.host, pf(data))

device = device_class(config.host, protocol=protocol)

di = discovery_result.to_dict()
Expand Down
24 changes: 21 additions & 3 deletions tests/discovery_fixtures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import copy
from dataclasses import dataclass
from json import dumps as json_dumps
from typing import Any, TypedDict

import pytest

Expand All @@ -16,10 +17,21 @@
DISCOVERY_MOCK_IP = "127.0.0.123"


def _make_unsupported(device_family, encrypt_type, *, omit_keys=None):
class DiscoveryResponse(TypedDict):
result: dict[str, Any]
error_code: int


def _make_unsupported(
device_family,
encrypt_type,
*,
https: bool = False,
omit_keys: dict[str, Any] | None = None,
) -> DiscoveryResponse:
if omit_keys is None:
omit_keys = {"encrypt_info": None}
result = {
result: DiscoveryResponse = {
"result": {
"device_id": "xx",
"owner": "xx",
Expand All @@ -31,7 +43,7 @@ def _make_unsupported(device_family, encrypt_type, *, omit_keys=None):
"obd_src": "tplink",
"factory_default": False,
"mgt_encrypt_schm": {
"is_support_https": False,
"is_support_https": https,
"encrypt_type": encrypt_type,
"http_port": 80,
"lv": 2,
Expand All @@ -51,6 +63,7 @@ def _make_unsupported(device_family, encrypt_type, *, omit_keys=None):

UNSUPPORTED_DEVICES = {
"unknown_device_family": _make_unsupported("SMART.TAPOXMASTREE", "AES"),
"unknown_iot_device_family": _make_unsupported("IOT.IOTXMASTREE", "AES"),
"wrong_encryption_iot": _make_unsupported("IOT.SMARTPLUGSWITCH", "AES"),
"wrong_encryption_smart": _make_unsupported("SMART.TAPOBULB", "IOT"),
"unknown_encryption": _make_unsupported("IOT.SMARTPLUGSWITCH", "FOO"),
Expand All @@ -64,6 +77,11 @@ def _make_unsupported(device_family, encrypt_type, *, omit_keys=None):
"FOO",
omit_keys={"mgt_encrypt_schm": None},
),
"invalidinstance": _make_unsupported(
"IOT.SMARTPLUGSWITCH",
"KLAP",
https=True,
),
}


Expand Down
2 changes: 1 addition & 1 deletion tests/test_device_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,6 @@ async def test_device_types(dev: Device):
async def test_device_class_from_unknown_family(caplog):
"""Verify that unknown SMART devices yield a warning and fallback to SmartDevice."""
dummy_name = "SMART.foo"
with caplog.at_level(logging.WARNING):
with caplog.at_level(logging.DEBUG):
assert get_device_class_from_family(dummy_name, https=False) == SmartDevice
assert f"Unknown SMART device with {dummy_name}" in caplog.text
Loading