Add switch platform to Nintendo Parental controls integration (home-assistant#154179)

Author: pantherale0

homeassistant/components/nintendo_parental_controls/__init__.py

@@ -16,7 +16,7 @@
 from .const import CONF_SESSION_TOKEN, DOMAIN
 from .coordinator import NintendoParentalControlsConfigEntry, NintendoUpdateCoordinator
 
-_PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.TIME]
+_PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.TIME, Platform.SWITCH]
 
 
 async def async_setup_entry(

homeassistant/components/nintendo_parental_controls/strings.json

@@ -43,6 +43,11 @@
       "bedtime_alarm": {
         "name": "Bedtime alarm"
       }
+    },
+    "switch": {
+      "suspend_software": {
+        "name": "Suspend software"
+      }
     }
   },
   "exceptions": {

homeassistant/components/nintendo_parental_controls/switch.py

@@ -0,0 +1,94 @@
+"""Switch platform for Nintendo Parental."""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Coroutine
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Any
+
+from pynintendoparental.enum import RestrictionMode
+
+from homeassistant.components.switch import (
+    SwitchDeviceClass,
+    SwitchEntity,
+    SwitchEntityDescription,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+
+from .coordinator import NintendoParentalControlsConfigEntry, NintendoUpdateCoordinator
+from .entity import Device, NintendoDevice
+
+PARALLEL_UPDATES = 0
+
+
+class NintendoParentalSwitch(StrEnum):
+    """Store keys for Nintendo Parental Controls switches."""
+
+    SUSPEND_SOFTWARE = "suspend_software"
+
+
+@dataclass(kw_only=True, frozen=True)
+class NintendoParentalControlsSwitchEntityDescription(SwitchEntityDescription):
+    """Description for Nintendo Parental Controls switch entities."""
+
+    is_on: Callable[[Device], bool | None]
+    turn_on_fn: Callable[[Device], Coroutine[Any, Any, None]]
+    turn_off_fn: Callable[[Device], Coroutine[Any, Any, None]]
+
+
+SWITCH_DESCRIPTIONS: tuple[NintendoParentalControlsSwitchEntityDescription, ...] = (
+    NintendoParentalControlsSwitchEntityDescription(
+        key=NintendoParentalSwitch.SUSPEND_SOFTWARE,
+        translation_key=NintendoParentalSwitch.SUSPEND_SOFTWARE,
+        device_class=SwitchDeviceClass.SWITCH,
+        is_on=lambda device: device.forced_termination_mode,
+        turn_off_fn=lambda device: device.set_restriction_mode(RestrictionMode.ALARM),
+        turn_on_fn=lambda device: device.set_restriction_mode(
+            RestrictionMode.FORCED_TERMINATION
+        ),
+    ),
+)
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: NintendoParentalControlsConfigEntry,
+    async_add_devices: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up the switch platform."""
+    async_add_devices(
+        NintendoParentalControlsSwitchEntity(entry.runtime_data, device, switch)
+        for device in entry.runtime_data.api.devices.values()
+        for switch in SWITCH_DESCRIPTIONS
+    )
+
+
+class NintendoParentalControlsSwitchEntity(NintendoDevice, SwitchEntity):
+    """Represent a single switch."""
+
+    entity_description: NintendoParentalControlsSwitchEntityDescription
+
+    def __init__(
+        self,
+        coordinator: NintendoUpdateCoordinator,
+        device: Device,
+        description: NintendoParentalControlsSwitchEntityDescription,
+    ) -> None:
+        """Initialize the switch."""
+        super().__init__(coordinator=coordinator, device=device, key=description.key)
+        self.entity_description = description
+
+    @property
+    def is_on(self) -> bool | None:
+        """Return entity state."""
+        return self.entity_description.is_on(self._device)
+
+    async def async_turn_on(self, **kwargs: Any) -> None:
+        """Turn the switch on."""
+        await self.entity_description.turn_on_fn(self._device)
+
+    async def async_turn_off(self, **kwargs: Any) -> None:
+        """Turn the switch off."""
+        await self.entity_description.turn_off_fn(self._device)

tests/components/nintendo_parental_controls/conftest.py

@@ -36,6 +36,7 @@ def mock_nintendo_device() -> Device:
     mock.today_playing_time = 110
     mock.bedtime_alarm = time(hour=19)
     mock.set_bedtime_alarm.return_value = None
+    mock.forced_termination_mode = True
     return mock
 
 

tests/components/nintendo_parental_controls/snapshots/test_switch.ambr

@@ -0,0 +1,50 @@
+# serializer version: 1
+# name: test_switch[switch.home_assistant_test_suspend_software-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': set({
+    }),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'switch',
+    'entity_category': None,
+    'entity_id': 'switch.home_assistant_test_suspend_software',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'options': dict({
+    }),
+    'original_device_class': <SwitchDeviceClass.SWITCH: 'switch'>,
+    'original_icon': None,
+    'original_name': 'Suspend software',
+    'platform': 'nintendo_parental_controls',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': <NintendoParentalSwitch.SUSPEND_SOFTWARE: 'suspend_software'>,
+    'unique_id': 'testdevid_suspend_software',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_switch[switch.home_assistant_test_suspend_software-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'device_class': 'switch',
+      'friendly_name': 'Home Assistant Test Suspend software',
+    }),
+    'context': <ANY>,
+    'entity_id': 'switch.home_assistant_test_suspend_software',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'on',
+  })
+# ---

tests/components/nintendo_parental_controls/test_switch.py

@@ -0,0 +1,64 @@
+"""Test switch platform."""
+
+from unittest.mock import AsyncMock, patch
+
+from syrupy.assertion import SnapshotAssertion
+
+from homeassistant.components.switch import (
+    DOMAIN as SWITCH_DOMAIN,
+    SERVICE_TURN_OFF,
+    SERVICE_TURN_ON,
+)
+from homeassistant.const import ATTR_ENTITY_ID, Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import entity_registry as er
+
+from . import setup_integration
+
+from tests.common import MockConfigEntry, snapshot_platform
+
+
+async def test_switch(
+    hass: HomeAssistant,
+    mock_config_entry: MockConfigEntry,
+    mock_nintendo_client: AsyncMock,
+    entity_registry: er.EntityRegistry,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test switch platform."""
+    with patch(
+        "homeassistant.components.nintendo_parental_controls._PLATFORMS",
+        [Platform.SWITCH],
+    ):
+        await setup_integration(hass, mock_config_entry)
+
+    await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
+
+
+async def test_suspend_software(
+    hass: HomeAssistant,
+    mock_config_entry: MockConfigEntry,
+    mock_nintendo_client: AsyncMock,
+    mock_nintendo_device: AsyncMock,
+) -> None:
+    """Test switch platform."""
+    with patch(
+        "homeassistant.components.nintendo_parental_controls._PLATFORMS",
+        [Platform.SWITCH],
+    ):
+        await setup_integration(hass, mock_config_entry)
+
+    await hass.services.async_call(
+        SWITCH_DOMAIN,
+        SERVICE_TURN_ON,
+        target={ATTR_ENTITY_ID: "switch.home_assistant_test_suspend_software"},
+        blocking=True,
+    )
+    assert len(mock_nintendo_device.set_restriction_mode.mock_calls) == 1
+    await hass.services.async_call(
+        SWITCH_DOMAIN,
+        SERVICE_TURN_OFF,
+        target={ATTR_ENTITY_ID: "switch.home_assistant_test_suspend_software"},
+        blocking=True,
+    )
+    assert len(mock_nintendo_device.set_restriction_mode.mock_calls) == 2