Add switch platform to UptimeRobot (#65394)

* Add switch platfor mto UptimeRobot * Add tests * Apply review comment * review comments part 2 * review comments part 3 * Fix tests after swapping logic on/off * Fix reauth test * Check for read-only key * Fix reauth for switch platform * mypy * cleanup * cleanup part 2 * Fixes + review comments * Tests * Apply more review comments * Required changes * fix test * Remove if * 100% tests coverage * Check readonly key in config_flow * Fix strings & translation * Add guard for 'monitor' keys * allign tests * Wrong API key message reworded
2025-12-24 21:06:19 +00:00 · 2022-03-18 12:18:19 +01:00
parent 5bb271c9fb
commit 35261a9089
13 changed files with 357 additions and 42 deletions
--- a/tests/components/uptimerobot/test_switch.py
+++ b/tests/components/uptimerobot/test_switch.py
@@ -0,0 +1,160 @@
+"""Test UptimeRobot switch."""
+
+from unittest.mock import patch
+
+from pyuptimerobot import UptimeRobotAuthenticationException
+
+from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
+from homeassistant.const import (
+    ATTR_ENTITY_ID,
+    SERVICE_TURN_OFF,
+    SERVICE_TURN_ON,
+    STATE_OFF,
+    STATE_ON,
+)
+from homeassistant.core import HomeAssistant
+
+from .common import (
+    MOCK_UPTIMEROBOT_CONFIG_ENTRY_DATA,
+    MOCK_UPTIMEROBOT_MONITOR,
+    MOCK_UPTIMEROBOT_MONITOR_PAUSED,
+    UPTIMEROBOT_SWITCH_TEST_ENTITY,
+    MockApiResponseKey,
+    mock_uptimerobot_api_response,
+    setup_uptimerobot_integration,
+)
+
+from tests.common import MockConfigEntry
+
+
+async def test_presentation(hass: HomeAssistant) -> None:
+    """Test the presenstation of UptimeRobot sensors."""
+    await setup_uptimerobot_integration(hass)
+
+    entity = hass.states.get(UPTIMEROBOT_SWITCH_TEST_ENTITY)
+
+    assert entity.state == STATE_ON
+    assert entity.attributes["icon"] == "mdi:cog"
+    assert entity.attributes["target"] == MOCK_UPTIMEROBOT_MONITOR["url"]
+
+
+async def test_switch_off(hass: HomeAssistant) -> None:
+    """Test entity unaviable on update failure."""
+
+    mock_entry = MockConfigEntry(**MOCK_UPTIMEROBOT_CONFIG_ENTRY_DATA)
+    mock_entry.add_to_hass(hass)
+
+    with patch(
+        "pyuptimerobot.UptimeRobot.async_get_monitors",
+        return_value=mock_uptimerobot_api_response(
+            data=[MOCK_UPTIMEROBOT_MONITOR_PAUSED]
+        ),
+    ), patch(
+        "pyuptimerobot.UptimeRobot.async_edit_monitor",
+        return_value=mock_uptimerobot_api_response(),
+    ):
+
+        assert await hass.config_entries.async_setup(mock_entry.entry_id)
+        await hass.async_block_till_done()
+
+        await hass.services.async_call(
+            SWITCH_DOMAIN,
+            SERVICE_TURN_OFF,
+            {ATTR_ENTITY_ID: UPTIMEROBOT_SWITCH_TEST_ENTITY},
+            blocking=True,
+        )
+
+    entity = hass.states.get(UPTIMEROBOT_SWITCH_TEST_ENTITY)
+    assert entity.state == STATE_OFF
+
+
+async def test_switch_on(hass: HomeAssistant) -> None:
+    """Test entity unaviable on update failure."""
+
+    mock_entry = MockConfigEntry(**MOCK_UPTIMEROBOT_CONFIG_ENTRY_DATA)
+    mock_entry.add_to_hass(hass)
+
+    with patch(
+        "pyuptimerobot.UptimeRobot.async_get_monitors",
+        return_value=mock_uptimerobot_api_response(data=[MOCK_UPTIMEROBOT_MONITOR]),
+    ), patch(
+        "pyuptimerobot.UptimeRobot.async_edit_monitor",
+        return_value=mock_uptimerobot_api_response(),
+    ):
+
+        assert await hass.config_entries.async_setup(mock_entry.entry_id)
+        await hass.async_block_till_done()
+
+        await hass.services.async_call(
+            SWITCH_DOMAIN,
+            SERVICE_TURN_ON,
+            {ATTR_ENTITY_ID: UPTIMEROBOT_SWITCH_TEST_ENTITY},
+            blocking=True,
+        )
+
+        entity = hass.states.get(UPTIMEROBOT_SWITCH_TEST_ENTITY)
+        assert entity.state == STATE_ON
+
+
+async def test_authentication_error(hass: HomeAssistant, caplog) -> None:
+    """Test authentication error turning switch on/off."""
+    await setup_uptimerobot_integration(hass)
+
+    entity = hass.states.get(UPTIMEROBOT_SWITCH_TEST_ENTITY)
+    assert entity.state == STATE_ON
+
+    with patch(
+        "pyuptimerobot.UptimeRobot.async_edit_monitor",
+        side_effect=UptimeRobotAuthenticationException,
+    ), patch(
+        "homeassistant.config_entries.ConfigEntry.async_start_reauth"
+    ) as config_entry_reauth:
+        await hass.services.async_call(
+            SWITCH_DOMAIN,
+            SERVICE_TURN_ON,
+            {ATTR_ENTITY_ID: UPTIMEROBOT_SWITCH_TEST_ENTITY},
+            blocking=True,
+        )
+
+        assert config_entry_reauth.assert_called
+
+
+async def test_refresh_data(hass: HomeAssistant, caplog) -> None:
+    """Test authentication error turning switch on/off."""
+    await setup_uptimerobot_integration(hass)
+
+    entity = hass.states.get(UPTIMEROBOT_SWITCH_TEST_ENTITY)
+    assert entity.state == STATE_ON
+
+    with patch(
+        "homeassistant.helpers.update_coordinator.DataUpdateCoordinator.async_request_refresh"
+    ) as coordinator_refresh:
+        await hass.services.async_call(
+            SWITCH_DOMAIN,
+            SERVICE_TURN_ON,
+            {ATTR_ENTITY_ID: UPTIMEROBOT_SWITCH_TEST_ENTITY},
+            blocking=True,
+        )
+
+        assert coordinator_refresh.assert_called
+
+
+async def test_switch_api_failure(hass: HomeAssistant, caplog) -> None:
+    """Test general exception turning switch on/off."""
+    await setup_uptimerobot_integration(hass)
+
+    entity = hass.states.get(UPTIMEROBOT_SWITCH_TEST_ENTITY)
+    assert entity.state == STATE_ON
+
+    with patch(
+        "pyuptimerobot.UptimeRobot.async_edit_monitor",
+        return_value=mock_uptimerobot_api_response(key=MockApiResponseKey.ERROR),
+    ):
+        await hass.services.async_call(
+            SWITCH_DOMAIN,
+            SERVICE_TURN_OFF,
+            {ATTR_ENTITY_ID: UPTIMEROBOT_SWITCH_TEST_ENTITY},
+            blocking=True,
+        )
+
+        assert "API exception" in caplog.text