mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-12-03 14:38:15 +00:00
* Improve D-Bus error handling for NetworkManager There are quite some errors captured which are related by seemingly a suddenly missing NetworkManager. Errors appear as: 23-11-21 17:42:50 ERROR (MainThread) [supervisor.dbus.network] Error while processing /org/freedesktop/NetworkManager/Devices/10: Remote peer disconnected ... 23-11-21 17:42:50 ERROR (MainThread) [supervisor.dbus.network] Error while processing /org/freedesktop/NetworkManager/Devices/35: The name is not activatable Both errors seem to already happen at introspection time, however the current code doesn't converts these errors to Supervisor issues. This PR uses the already existing `DBus.from_dbus_error()`. Furthermore this adds a new Exception `DBusNoReplyError` for the `ErrorType.NO_REPLY` (or `org.freedesktop.DBus.Error.NoReply` in D-Bus terms, which is the type of the first of the two issues above). And finally it separates the `ErrorType.SERVICE_UNKNOWN` (or `org.freedesktop.DBus.Error.ServiceUnknown` in D-Bus terms, which is the second of the above issue) from `DBusInterfaceError` into a new `DBusServiceUnkownError`. This allows to handle errors more specifically. To avoid too much churn, all instances where `DBusInterfaceError` got handled, we are now also handling `DBusServiceUnkownError`. The `DBusNoReplyError` and `DBusServiceUnkownError` appear when the NetworkManager service stops or crashes. Instead of retrying every interface we know, just give up if one of these issues appear. This should significantly lower error messages users are seeing and Sentry events. * Remove unnecessary statement * Fix pytests * Make sure error strings are compared correctly * Fix typo/remove unnecessary pylint exception * Fix DBusError typing * Add pytest for from_dbus_error * Revert "Make sure error strings are compared correctly" This reverts commit 10dc2e4c3887532921414b4291fe3987186db408. * Add test cases --------- Co-authored-by: Mike Degatano <michael.degatano@gmail.com>
73 lines
2.4 KiB
Python
73 lines
2.4 KiB
Python
"""Test hostname dbus interface."""
|
|
# pylint: disable=import-error
|
|
from dbus_fast.aio.message_bus import MessageBus
|
|
import pytest
|
|
|
|
from supervisor.dbus.hostname import Hostname
|
|
from supervisor.exceptions import DBusNotConnectedError
|
|
|
|
from tests.common import mock_dbus_services
|
|
from tests.dbus_service_mocks.hostname import Hostname as HostnameService
|
|
|
|
|
|
@pytest.fixture(name="hostname_service")
|
|
async def fixture_hostname_service(dbus_session_bus: MessageBus) -> HostnameService:
|
|
"""Mock hostname dbus service."""
|
|
yield (await mock_dbus_services({"hostname": None}, dbus_session_bus))["hostname"]
|
|
|
|
|
|
async def test_dbus_hostname_info(
|
|
hostname_service: HostnameService, dbus_session_bus: MessageBus
|
|
):
|
|
"""Test hostname properties."""
|
|
hostname = Hostname()
|
|
|
|
assert hostname.hostname is None
|
|
|
|
await hostname.connect(dbus_session_bus)
|
|
|
|
assert hostname.hostname == "homeassistant-n2"
|
|
assert hostname.kernel == "5.10.33"
|
|
assert (
|
|
hostname.cpe
|
|
== "cpe:2.3:o:home-assistant:haos:6.0.dev20210504:*:development:*:*:*:odroid-n2:*"
|
|
)
|
|
assert hostname.operating_system == "Home Assistant OS 6.0.dev20210504"
|
|
|
|
hostname_service.emit_properties_changed({"StaticHostname": "test"})
|
|
await hostname_service.ping()
|
|
assert hostname.hostname == "test"
|
|
|
|
hostname_service.emit_properties_changed({}, ["StaticHostname"])
|
|
await hostname_service.ping()
|
|
await hostname_service.ping() # To process the follow-up get all properties call
|
|
assert hostname.hostname == "homeassistant-n2"
|
|
|
|
|
|
async def test_dbus_sethostname(
|
|
hostname_service: HostnameService, dbus_session_bus: MessageBus
|
|
):
|
|
"""Set hostname on backend."""
|
|
hostname_service.SetStaticHostname.calls.clear()
|
|
hostname = Hostname()
|
|
|
|
with pytest.raises(DBusNotConnectedError):
|
|
await hostname.set_static_hostname("StarWars")
|
|
|
|
await hostname.connect(dbus_session_bus)
|
|
|
|
assert hostname.hostname == "homeassistant-n2"
|
|
await hostname.set_static_hostname("StarWars")
|
|
assert hostname_service.SetStaticHostname.calls == [("StarWars", False)]
|
|
await hostname_service.ping()
|
|
assert hostname.hostname == "StarWars"
|
|
|
|
|
|
async def test_dbus_hostname_connect_error(
|
|
dbus_session_bus: MessageBus, caplog: pytest.LogCaptureFixture
|
|
):
|
|
"""Test connecting to hostname error."""
|
|
hostname = Hostname()
|
|
await hostname.connect(dbus_session_bus)
|
|
assert "No hostname support on the host" in caplog.text
|