Validate devices connected to Nintendo Parental Controls accounts (#154873)

Co-authored-by: Josef Zweck <josef@zweck.dev>

Author: pantherale0

homeassistant/components/nintendo_parental_controls/config_flow.py

@@ -7,14 +7,15 @@
 from typing import TYPE_CHECKING, Any
 
 from pynintendoparental import Authenticator
+from pynintendoparental.api import Api
 from pynintendoparental.exceptions import HttpException, InvalidSessionTokenException
 import voluptuous as vol
 
 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
 from homeassistant.const import CONF_API_TOKEN
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
-from .const import CONF_SESSION_TOKEN, DOMAIN
+from .const import APP_SETUP_URL, CONF_SESSION_TOKEN, DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -37,6 +38,9 @@ async def async_step_user(
             )
 
         if user_input is not None:
+            nintendo_api = Api(
+                self.auth, self.hass.config.time_zone, self.hass.config.language
+            )
             try:
                 await self.auth.complete_login(
                     self.auth, user_input[CONF_API_TOKEN], False
@@ -48,12 +52,24 @@ async def async_step_user(
                     assert self.auth.account_id
                 await self.async_set_unique_id(self.auth.account_id)
                 self._abort_if_unique_id_configured()
-                return self.async_create_entry(
-                    title=self.auth.account_id,
-                    data={
-                        CONF_SESSION_TOKEN: self.auth.get_session_token,
-                    },
-                )
+            try:
+                if "base" not in errors:
+                    await nintendo_api.async_get_account_devices()
+            except HttpException as err:
+                if err.status_code == 404:
+                    return self.async_abort(
+                        reason="no_devices_found",
+                        description_placeholders={"more_info_url": APP_SETUP_URL},
+                    )
+                errors["base"] = "cannot_connect"
+            else:
+                if "base" not in errors:
+                    return self.async_create_entry(
+                        title=self.auth.account_id,
+                        data={
+                            CONF_SESSION_TOKEN: self.auth.get_session_token,
+                        },
+                    )
         return self.async_show_form(
             step_id="user",
             description_placeholders={"link": self.auth.login_url},

homeassistant/components/nintendo_parental_controls/const.py

@@ -8,4 +8,7 @@
 BEDTIME_ALARM_MAX = "23:00"
 BEDTIME_ALARM_DISABLE = "00:00"
 
+APP_SETUP_URL = (
+    "https://www.nintendo.com/my/support/switch/parentalcontrols/app/setup.html"
+)
 ATTR_BONUS_TIME = "bonus_time"

homeassistant/components/nintendo_parental_controls/coordinator.py

@@ -6,7 +6,10 @@
 import logging
 
 from pynintendoparental import Authenticator, NintendoParental
-from pynintendoparental.exceptions import InvalidOAuthConfigurationException
+from pynintendoparental.exceptions import (
+    InvalidOAuthConfigurationException,
+    NoDevicesFoundException,
+)
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
@@ -24,6 +27,8 @@
 class NintendoUpdateCoordinator(DataUpdateCoordinator[None]):
     """Nintendo data update coordinator."""
 
+    config_entry: NintendoParentalControlsConfigEntry
+
     def __init__(
         self,
         hass: HomeAssistant,
@@ -50,3 +55,8 @@ async def _async_update_data(self) -> None:
             raise ConfigEntryError(
                 err, translation_domain=DOMAIN, translation_key="invalid_auth"
             ) from err
+        except NoDevicesFoundException as err:
+            raise ConfigEntryError(
+                translation_domain=DOMAIN,
+                translation_key="no_devices_found",
+            ) from err

homeassistant/components/nintendo_parental_controls/strings.json

@@ -2,6 +2,7 @@
   "config": {
     "abort": {
       "already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
+      "no_devices_found": "There are no devices paired with this Nintendo account, go to [Nintendo Support]({more_info_url}) for further assistance.",
       "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
     },
     "error": {
@@ -67,6 +68,9 @@
     },
     "device_not_found": {
       "message": "Device not found."
+    },
+    "no_devices_found": {
+      "message": "No Nintendo devices found for this account."
     }
   },
   "services": {

tests/components/nintendo_parental_controls/conftest.py

@@ -76,6 +76,20 @@ def mock_nintendo_authenticator() -> Generator[MagicMock]:
         yield mock_auth
 
 
+@pytest.fixture
+def mock_nintendo_api() -> Generator[AsyncMock]:
+    """Mock Nintendo API."""
+    with patch(
+        "homeassistant.components.nintendo_parental_controls.config_flow.Api",
+        autospec=True,
+    ) as mock_api_class:
+        mock_api_instance = MagicMock()
+        # patch async_get_account_devices as an AsyncMock
+        mock_api_instance.async_get_account_devices = AsyncMock()
+        mock_api_class.return_value = mock_api_instance
+        yield mock_api_instance
+
+
 @pytest.fixture
 def mock_failed_nintendo_authenticator() -> Generator[MagicMock]:
     """Mock a failed Nintendo Authenticator."""

tests/components/nintendo_parental_controls/test_config_flow.py

@@ -2,7 +2,7 @@
 
 from unittest.mock import AsyncMock
 
-from pynintendoparental.exceptions import InvalidSessionTokenException
+from pynintendoparental.exceptions import HttpException, InvalidSessionTokenException
 
 from homeassistant import config_entries
 from homeassistant.components.nintendo_parental_controls.const import (
@@ -22,6 +22,7 @@ async def test_full_flow(
     hass: HomeAssistant,
     mock_setup_entry: AsyncMock,
     mock_nintendo_authenticator: AsyncMock,
+    mock_nintendo_api: AsyncMock,
 ) -> None:
     """Test a full and successful config flow."""
     result = await hass.config_entries.flow.async_init(
@@ -47,6 +48,7 @@ async def test_already_configured(
     hass: HomeAssistant,
     mock_config_entry: MockConfigEntry,
     mock_nintendo_authenticator: AsyncMock,
+    mock_nintendo_api: AsyncMock,
 ) -> None:
     """Test that the flow aborts if the account is already configured."""
     mock_config_entry.add_to_hass(hass)
@@ -68,6 +70,7 @@ async def test_already_configured(
 async def test_invalid_auth(
     hass: HomeAssistant,
     mock_nintendo_authenticator: AsyncMock,
+    mock_nintendo_api: AsyncMock,
 ) -> None:
     """Test handling of invalid authentication."""
     result = await hass.config_entries.flow.async_init(
@@ -104,6 +107,75 @@ async def test_invalid_auth(
     assert result["result"].unique_id == ACCOUNT_ID
 
 
+async def test_missing_devices(
+    hass: HomeAssistant,
+    mock_nintendo_authenticator: AsyncMock,
+    mock_nintendo_api: AsyncMock,
+) -> None:
+    """Test handling of no devices found."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": config_entries.SOURCE_USER}
+    )
+    assert result is not None
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert "link" in result["description_placeholders"]
+
+    mock_nintendo_authenticator.complete_login.side_effect = None
+
+    mock_nintendo_api.async_get_account_devices.side_effect = HttpException(
+        status_code=404, message="TEST"
+    )
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], user_input={CONF_API_TOKEN: API_TOKEN}
+    )
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "no_devices_found"
+
+
+async def test_cannot_connect(
+    hass: HomeAssistant,
+    mock_nintendo_authenticator: AsyncMock,
+    mock_nintendo_api: AsyncMock,
+) -> None:
+    """Test handling of connection errors during device discovery."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": config_entries.SOURCE_USER}
+    )
+    assert result is not None
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert "link" in result["description_placeholders"]
+
+    mock_nintendo_authenticator.complete_login.side_effect = None
+
+    mock_nintendo_api.async_get_account_devices.side_effect = HttpException(
+        status_code=500, message="TEST"
+    )
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], user_input={CONF_API_TOKEN: API_TOKEN}
+    )
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert result["errors"] == {"base": "cannot_connect"}
+
+    # Test we can recover from the error
+    mock_nintendo_api.async_get_account_devices.side_effect = None
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], user_input={CONF_API_TOKEN: API_TOKEN}
+    )
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["title"] == ACCOUNT_ID
+    assert result["data"][CONF_SESSION_TOKEN] == API_TOKEN
+    assert result["result"].unique_id == ACCOUNT_ID
+
+
 async def test_reauthentication_success(
     hass: HomeAssistant,
     mock_config_entry: MockConfigEntry,

tests/components/nintendo_parental_controls/test_coordinator.py

@@ -2,7 +2,10 @@
 
 from unittest.mock import AsyncMock
 
-from pynintendoparental.exceptions import InvalidOAuthConfigurationException
+from pynintendoparental.exceptions import (
+    InvalidOAuthConfigurationException,
+    NoDevicesFoundException,
+)
 
 from homeassistant.config_entries import ConfigEntryState
 from homeassistant.core import HomeAssistant
@@ -33,3 +36,23 @@ async def test_invalid_authentication(
     assert len(entries) == 0
     # Ensure the config entry is marked as error
     assert mock_config_entry.state == ConfigEntryState.SETUP_ERROR
+
+
+async def test_no_devices(
+    hass: HomeAssistant,
+    mock_config_entry: MockConfigEntry,
+    mock_nintendo_client: AsyncMock,
+    entity_registry: er.EntityRegistry,
+) -> None:
+    """Test handling of invalid authentication."""
+    mock_nintendo_client.update.side_effect = NoDevicesFoundException()
+
+    await setup_integration(hass, mock_config_entry)
+
+    # Ensure no entities are created
+    entries = er.async_entries_for_config_entry(
+        entity_registry, mock_config_entry.entry_id
+    )
+    assert len(entries) == 0
+    # Ensure the config entry is marked as error
+    assert mock_config_entry.state == ConfigEntryState.SETUP_ERROR