Migrate is_connected to aiohasupervisor

Author: mdegat01

homeassistant/components/hassio/__init__.py

@@ -10,6 +10,7 @@
 import re
 from typing import Any, NamedTuple
 
+from aiohasupervisor import SupervisorError
 import voluptuous as vol
 
 from homeassistant.auth.const import GROUP_ID_ADMIN
@@ -306,8 +307,11 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:  # noqa:
     host = os.environ["SUPERVISOR"]
     websession = async_get_clientsession(hass)
     hass.data[DOMAIN] = hassio = HassIO(hass.loop, websession, host)
+    supervisor_client = get_supervisor_client(hass)
 
-    if not await hassio.is_connected():
+    try:
+        await supervisor_client.supervisor.ping()
+    except SupervisorError:
         _LOGGER.warning("Not connected with the supervisor / system too busy!")
 
     store = Store[dict[str, str]](hass, STORAGE_VERSION, STORAGE_KEY)

homeassistant/components/hassio/handler.py

@@ -173,14 +173,6 @@ def base_url(self) -> URL:
         """Return base url for Supervisor."""
         return self._base_url
 
-    @_api_bool
-    def is_connected(self) -> Coroutine:
-        """Return true if it connected to Hass.io supervisor.
-
-        This method returns a coroutine.
-        """
-        return self.send_command("/supervisor/ping", method="get", timeout=15)
-
     @api_data
     def get_info(self) -> Coroutine:
         """Return generic Supervisor information.

tests/components/conftest.py

@@ -464,6 +464,13 @@ def addon_changelog_fixture(supervisor_client: AsyncMock) -> AsyncMock:
     return supervisor_client.store.addon_changelog
 
 
+@pytest.fixture(name="supervisor_is_connected")
+def supervisor_is_connected_fixture(supervisor_client: AsyncMock) -> AsyncMock:
+    """Mock supervisor is connected."""
+    supervisor_client.supervisor.ping.return_value = None
+    return supervisor_client.supervisor.ping
+
+
 @pytest.fixture(name="supervisor_client")
 def supervisor_client() -> Generator[AsyncMock]:
     """Mock the supervisor client."""

tests/components/hassio/conftest.py

@@ -32,14 +32,10 @@ def disable_security_filter() -> Generator[None]:
 
 
 @pytest.fixture
-def hassio_env() -> Generator[None]:
+def hassio_env(supervisor_is_connected: AsyncMock) -> Generator[None]:
     """Fixture to inject hassio env."""
     with (
         patch.dict(os.environ, {"SUPERVISOR": "127.0.0.1"}),
-        patch(
-            "homeassistant.components.hassio.HassIO.is_connected",
-            return_value={"result": "ok", "data": {}},
-        ),
         patch.dict(os.environ, {"SUPERVISOR_TOKEN": SUPERVISOR_TOKEN}),
         patch(
             "homeassistant.components.hassio.HassIO.get_info",

tests/components/hassio/test_handler.py

@@ -4,7 +4,6 @@
 
 from typing import Any, Literal
 
-import aiohttp
 from aiohttp import hdrs, web
 import pytest
 
@@ -16,36 +15,6 @@
 from tests.test_util.aiohttp import AiohttpClientMocker
 
 
-async def test_api_ping(
-    hassio_handler: HassIO, aioclient_mock: AiohttpClientMocker
-) -> None:
-    """Test setup with API ping."""
-    aioclient_mock.get("http://127.0.0.1/supervisor/ping", json={"result": "ok"})
-
-    assert await hassio_handler.is_connected()
-    assert aioclient_mock.call_count == 1
-
-
-async def test_api_ping_error(
-    hassio_handler: HassIO, aioclient_mock: AiohttpClientMocker
-) -> None:
-    """Test setup with API ping error."""
-    aioclient_mock.get("http://127.0.0.1/supervisor/ping", json={"result": "error"})
-
-    assert not (await hassio_handler.is_connected())
-    assert aioclient_mock.call_count == 1
-
-
-async def test_api_ping_exeption(
-    hassio_handler: HassIO, aioclient_mock: AiohttpClientMocker
-) -> None:
-    """Test setup with API ping exception."""
-    aioclient_mock.get("http://127.0.0.1/supervisor/ping", exc=aiohttp.ClientError())
-
-    assert not (await hassio_handler.is_connected())
-    assert aioclient_mock.call_count == 1
-
-
 async def test_api_info(
     hassio_handler: HassIO, aioclient_mock: AiohttpClientMocker
 ) -> None:

tests/components/hassio/test_init.py

@@ -5,6 +5,7 @@
 from typing import Any
 from unittest.mock import AsyncMock, patch
 
+from aiohasupervisor import SupervisorError
 from aiohasupervisor.models import AddonsStats
 import pytest
 from voluptuous import Invalid
@@ -282,9 +283,9 @@ async def test_setup_api_push_api_data(
 
     assert result
     assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 20
-    assert not aioclient_mock.mock_calls[1][2]["ssl"]
-    assert aioclient_mock.mock_calls[1][2]["port"] == 9999
-    assert "watchdog" not in aioclient_mock.mock_calls[1][2]
+    assert not aioclient_mock.mock_calls[0][2]["ssl"]
+    assert aioclient_mock.mock_calls[0][2]["port"] == 9999
+    assert "watchdog" not in aioclient_mock.mock_calls[0][2]
 
 
 async def test_setup_api_push_api_data_server_host(
@@ -303,9 +304,9 @@ async def test_setup_api_push_api_data_server_host(
 
     assert result
     assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 20
-    assert not aioclient_mock.mock_calls[1][2]["ssl"]
-    assert aioclient_mock.mock_calls[1][2]["port"] == 9999
-    assert not aioclient_mock.mock_calls[1][2]["watchdog"]
+    assert not aioclient_mock.mock_calls[0][2]["ssl"]
+    assert aioclient_mock.mock_calls[0][2]["port"] == 9999
+    assert not aioclient_mock.mock_calls[0][2]["watchdog"]
 
 
 async def test_setup_api_push_api_data_default(
@@ -321,9 +322,9 @@ async def test_setup_api_push_api_data_default(
 
     assert result
     assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 20
-    assert not aioclient_mock.mock_calls[1][2]["ssl"]
-    assert aioclient_mock.mock_calls[1][2]["port"] == 8123
-    refresh_token = aioclient_mock.mock_calls[1][2]["refresh_token"]
+    assert not aioclient_mock.mock_calls[0][2]["ssl"]
+    assert aioclient_mock.mock_calls[0][2]["port"] == 8123
+    refresh_token = aioclient_mock.mock_calls[0][2]["refresh_token"]
     hassio_user = await hass.auth.async_get_user(
         hass_storage[STORAGE_KEY]["data"]["hassio_user"]
     )
@@ -402,9 +403,9 @@ async def test_setup_api_existing_hassio_user(
 
     assert result
     assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 20
-    assert not aioclient_mock.mock_calls[1][2]["ssl"]
-    assert aioclient_mock.mock_calls[1][2]["port"] == 8123
-    assert aioclient_mock.mock_calls[1][2]["refresh_token"] == token.token
+    assert not aioclient_mock.mock_calls[0][2]["ssl"]
+    assert aioclient_mock.mock_calls[0][2]["port"] == 8123
+    assert aioclient_mock.mock_calls[0][2]["refresh_token"] == token.token
 
 
 async def test_setup_core_push_timezone(
@@ -421,7 +422,7 @@ async def test_setup_core_push_timezone(
 
     assert result
     assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 20
-    assert aioclient_mock.mock_calls[2][2]["timezone"] == "testzone"
+    assert aioclient_mock.mock_calls[1][2]["timezone"] == "testzone"
 
     with patch("homeassistant.util.dt.set_default_time_zone"):
         await hass.config.async_update(time_zone="America/New_York")
@@ -455,16 +456,13 @@ async def test_fail_setup_without_environ_var(hass: HomeAssistant) -> None:
 
 
 async def test_warn_when_cannot_connect(
-    hass: HomeAssistant, caplog: pytest.LogCaptureFixture
+    hass: HomeAssistant,
+    caplog: pytest.LogCaptureFixture,
+    supervisor_is_connected: AsyncMock,
 ) -> None:
     """Fail warn when we cannot connect."""
-    with (
-        patch.dict(os.environ, MOCK_ENVIRON),
-        patch(
-            "homeassistant.components.hassio.HassIO.is_connected",
-            return_value=None,
-        ),
-    ):
+    supervisor_is_connected.side_effect = SupervisorError
+    with patch.dict(os.environ, MOCK_ENVIRON):
         result = await async_setup_component(hass, "hassio", {})
         assert result
 
@@ -496,17 +494,13 @@ async def test_service_calls(
     aioclient_mock: AiohttpClientMocker,
     caplog: pytest.LogCaptureFixture,
     supervisor_client: AsyncMock,
-    addon_installed,
+    addon_installed: AsyncMock,
+    supervisor_is_connected: AsyncMock,
     issue_registry: ir.IssueRegistry,
 ) -> None:
     """Call service and check the API calls behind that."""
-    with (
-        patch.dict(os.environ, MOCK_ENVIRON),
-        patch(
-            "homeassistant.components.hassio.HassIO.is_connected",
-            return_value=None,
-        ),
-    ):
+    supervisor_is_connected.side_effect = SupervisorError
+    with patch.dict(os.environ, MOCK_ENVIRON):
         assert await async_setup_component(hass, "hassio", {})
         await hass.async_block_till_done()
 
@@ -536,14 +530,14 @@ async def test_service_calls(
     )
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 24
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 25
     assert aioclient_mock.mock_calls[-1][2] == "test"
 
     await hass.services.async_call("hassio", "host_shutdown", {})
     await hass.services.async_call("hassio", "host_reboot", {})
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 26
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 27
 
     await hass.services.async_call("hassio", "backup_full", {})
     await hass.services.async_call(
@@ -558,7 +552,7 @@ async def test_service_calls(
     )
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 28
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 29
     assert aioclient_mock.mock_calls[-1][2] == {
         "name": "2021-11-13 03:48:00",
         "homeassistant": True,
@@ -583,7 +577,7 @@ async def test_service_calls(
     )
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 30
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 31
     assert aioclient_mock.mock_calls[-1][2] == {
         "addons": ["test"],
         "folders": ["ssl"],
@@ -602,7 +596,7 @@ async def test_service_calls(
     )
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 31
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 32
     assert aioclient_mock.mock_calls[-1][2] == {
         "name": "backup_name",
         "location": "backup_share",
@@ -618,7 +612,7 @@ async def test_service_calls(
     )
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 32
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 33
     assert aioclient_mock.mock_calls[-1][2] == {
         "name": "2021-11-13 03:48:00",
         "location": None,
@@ -637,7 +631,7 @@ async def test_service_calls(
     )
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 34
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 35
     assert aioclient_mock.mock_calls[-1][2] == {
         "name": "2021-11-13 11:48:00",
         "location": None,
@@ -647,15 +641,11 @@ async def test_service_calls(
 async def test_invalid_service_calls(
     hass: HomeAssistant,
     aioclient_mock: AiohttpClientMocker,
+    supervisor_is_connected: AsyncMock,
 ) -> None:
     """Call service with invalid input and check that it raises."""
-    with (
-        patch.dict(os.environ, MOCK_ENVIRON),
-        patch(
-            "homeassistant.components.hassio.HassIO.is_connected",
-            return_value=None,
-        ),
-    ):
+    supervisor_is_connected.side_effect = SupervisorError
+    with patch.dict(os.environ, MOCK_ENVIRON):
         assert await async_setup_component(hass, "hassio", {})
         await hass.async_block_till_done()
 
@@ -672,6 +662,7 @@ async def test_invalid_service_calls(
 async def test_addon_service_call_with_complex_slug(
     hass: HomeAssistant,
     aioclient_mock: AiohttpClientMocker,
+    supervisor_is_connected: AsyncMock,
 ) -> None:
     """Addon slugs can have ., - and _, confirm that passes validation."""
     supervisor_mock_data = {
@@ -691,12 +682,9 @@ async def test_addon_service_call_with_complex_slug(
             },
         ],
     }
+    supervisor_is_connected.side_effect = SupervisorError
     with (
         patch.dict(os.environ, MOCK_ENVIRON),
-        patch(
-            "homeassistant.components.hassio.HassIO.is_connected",
-            return_value=None,
-        ),
         patch(
             "homeassistant.components.hassio.HassIO.get_supervisor_info",
             return_value=supervisor_mock_data,
@@ -724,12 +712,12 @@ async def test_service_calls_core(
     await hass.services.async_call("homeassistant", "stop")
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 5
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 6
 
     await hass.services.async_call("homeassistant", "check_config")
     await hass.async_block_till_done()
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 5
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 6
 
     with patch(
         "homeassistant.config.async_check_ha_config_file", return_value=None
@@ -738,7 +726,7 @@ async def test_service_calls_core(
         await hass.async_block_till_done()
         assert mock_check_config.called
 
-    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 6
+    assert aioclient_mock.call_count + len(supervisor_client.mock_calls) == 7
 
 
 @pytest.mark.usefixtures("addon_installed")