Fix hardcoded exception strings in uptimerobot (#171744)

homeassistant/components/uptimerobot/__init__.py

@@ -7,7 +7,7 @@ from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryAuthFailed
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
-from .const import PLATFORMS
+from .const import DOMAIN, PLATFORMS
 from .coordinator import UptimeRobotConfigEntry, UptimeRobotDataUpdateCoordinator
 
 
@@ -15,9 +15,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: UptimeRobotConfigEntry)
     """Set up UptimeRobot from a config entry."""
     key: str = entry.data[CONF_API_KEY]
     if key.startswith(("ur", "m")):
-        # pylint: disable-next=home-assistant-exception-not-translated
         raise ConfigEntryAuthFailed(
-            "Wrong API key type detected, use the 'main' API key"
+            translation_domain=DOMAIN,
+            translation_key="api_key_wrong_type",
         )
     uptime_robot_api = UptimeRobot(key, async_get_clientsession(hass))
 

homeassistant/components/uptimerobot/coordinator.py

@@ -48,11 +48,16 @@ class UptimeRobotDataUpdateCoordinator(
         try:
             response = await self.api.async_get_monitors()
         except UptimeRobotAuthenticationException as exception:
-            # pylint: disable-next=home-assistant-exception-not-translated
-            raise ConfigEntryAuthFailed(exception) from exception
+            raise ConfigEntryAuthFailed(
+                translation_domain=DOMAIN,
+                translation_key="api_authentication_exception",
+            ) from exception
         except UptimeRobotException as exception:
-            # pylint: disable-next=home-assistant-exception-not-translated
-            raise UpdateFailed(exception) from exception
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="api_generic_exception",
+                translation_placeholders={"error": "Generic UptimeRobot exception"},
+            ) from exception
 
         if TYPE_CHECKING:
             assert isinstance(response.data, list)

homeassistant/components/uptimerobot/strings.json

@@ -57,7 +57,16 @@
     }
   },
   "exceptions": {
-    "api_exception": {
+    "api_authentication_exception": {
+      "message": "API authentication failed, please check your API key"
+    },
+    "api_generic_exception": {
+      "message": "API error: {error}"
+    },
+    "api_key_wrong_type": {
+      "message": "Wrong API key type detected, use the 'main' API key"
+    },
+    "api_switch_exception": {
       "message": "Could not turn on/off monitoring: {error}"
     }
   }

homeassistant/components/uptimerobot/utils.py

@@ -33,7 +33,7 @@ def uptimerobot_api_call[_T: UptimeRobotEntity, **_P](
         except UptimeRobotException as exception:
             raise HomeAssistantError(
                 translation_domain=DOMAIN,
-                translation_key="api_exception",
+                translation_key="api_switch_exception",
                 translation_placeholders={"error": "Generic UptimeRobot exception"},
             ) from exception
 

tests/components/uptimerobot/test_init.py

@@ -45,7 +45,10 @@ async def test_reauthentication_trigger_in_setup(
     flows = hass.config_entries.flow.async_progress()
 
     assert mock_config_entry.state is ConfigEntryState.SETUP_ERROR
-    assert mock_config_entry.reason == "could not authenticate"
+    assert (
+        mock_config_entry.reason
+        == "API authentication failed, please check your API key"
+    )
 
     assert len(flows) == 1
     flow = flows[0]

tests/components/uptimerobot/test_switch.py

@@ -158,7 +158,7 @@ async def test_action_execution_failure(hass: HomeAssistant) -> None:
         )
 
     assert exc_info.value.translation_domain == "uptimerobot"
-    assert exc_info.value.translation_key == "api_exception"
+    assert exc_info.value.translation_key == "api_switch_exception"
     assert exc_info.value.translation_placeholders == {
         "error": "Generic UptimeRobot exception"
     }
@@ -186,7 +186,7 @@ async def test_switch_api_failure(hass: HomeAssistant) -> None:
         )
 
     assert exc_info.value.translation_domain == "uptimerobot"
-    assert exc_info.value.translation_key == "api_exception"
+    assert exc_info.value.translation_key == "api_switch_exception"
     assert exc_info.value.translation_placeholders == {
         "error": "Generic UptimeRobot exception"
     }