cc543b200d
* Configure nest pubsub subscriber automatically Update the config flow to configure the nest pubsub subscriber automatically. After completing the authentication step, the user is now asked for the google cloud console ID, which is needed to create a subscription. Home Assistant manages the lifecycle of a subscription only when it is created by the ConfigFlow. Otherwise (if specified in configuration.yaml) it treats it similarly as before. These are the considerations or failure modes taken into account: - Subscription is created with reasonable default values as previously recommended (e.g. retion only keeps 5-15 minutes of backlog messages) - Subscriptions are created with a naming scheme that makes it clear they came from home assistant, and with a random string - Subscriptions are cleaned up when the ConfigEntry is removed. If removal fails, a subscription that is orphaned will be deleted after 30 days - If the subscription gets into a bad state or deleted, the user can go through the re-auth flow to re-create it. - Users can still specifcy a CONF_SUBSCRIBER_ID in the configuration.yaml, and skip automatic subscriber creation * Remove unnecessary nest config flow diffs and merge in upstream changes * Incorporate review feedback into nest subscription config flow * Update text wording in nest config flow
128 lines
4.2 KiB
Python
128 lines
4.2 KiB
Python
"""Common libraries for test setup."""
|
|
|
|
import time
|
|
from typing import Awaitable, Callable
|
|
from unittest.mock import patch
|
|
|
|
from google_nest_sdm.device_manager import DeviceManager
|
|
from google_nest_sdm.event import EventMessage
|
|
from google_nest_sdm.google_nest_subscriber import GoogleNestSubscriber
|
|
|
|
from homeassistant.components.nest import DOMAIN
|
|
from homeassistant.components.nest.const import SDM_SCOPES
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
from tests.common import MockConfigEntry
|
|
|
|
PROJECT_ID = "some-project-id"
|
|
CLIENT_ID = "some-client-id"
|
|
CLIENT_SECRET = "some-client-secret"
|
|
|
|
CONFIG = {
|
|
"nest": {
|
|
"client_id": CLIENT_ID,
|
|
"client_secret": CLIENT_SECRET,
|
|
# Required fields for using SDM API
|
|
"project_id": PROJECT_ID,
|
|
"subscriber_id": "projects/example/subscriptions/subscriber-id-9876",
|
|
},
|
|
}
|
|
|
|
FAKE_TOKEN = "some-token"
|
|
FAKE_REFRESH_TOKEN = "some-refresh-token"
|
|
|
|
|
|
def create_config_entry(hass, token_expiration_time=None) -> MockConfigEntry:
|
|
"""Create a ConfigEntry and add it to Home Assistant."""
|
|
if token_expiration_time is None:
|
|
token_expiration_time = time.time() + 86400
|
|
config_entry_data = {
|
|
"sdm": {}, # Indicates new SDM API, not legacy API
|
|
"auth_implementation": "nest",
|
|
"token": {
|
|
"access_token": FAKE_TOKEN,
|
|
"refresh_token": FAKE_REFRESH_TOKEN,
|
|
"scope": " ".join(SDM_SCOPES),
|
|
"token_type": "Bearer",
|
|
"expires_at": token_expiration_time,
|
|
},
|
|
}
|
|
config_entry = MockConfigEntry(domain=DOMAIN, data=config_entry_data)
|
|
config_entry.add_to_hass(hass)
|
|
return config_entry
|
|
|
|
|
|
class FakeDeviceManager(DeviceManager):
|
|
"""Fake DeviceManager that can supply a list of devices and structures."""
|
|
|
|
def __init__(self, devices: dict, structures: dict):
|
|
"""Initialize FakeDeviceManager."""
|
|
super().__init__()
|
|
self._devices = devices
|
|
|
|
@property
|
|
def structures(self) -> dict:
|
|
"""Override structures with fake result."""
|
|
return self._structures
|
|
|
|
@property
|
|
def devices(self) -> dict:
|
|
"""Override devices with fake result."""
|
|
return self._devices
|
|
|
|
|
|
class FakeSubscriber(GoogleNestSubscriber):
|
|
"""Fake subscriber that supplies a FakeDeviceManager."""
|
|
|
|
def __init__(self, device_manager: FakeDeviceManager):
|
|
"""Initialize Fake Subscriber."""
|
|
self._device_manager = device_manager
|
|
|
|
def set_update_callback(self, callback: Callable[[EventMessage], Awaitable[None]]):
|
|
"""Capture the callback set by Home Assistant."""
|
|
self._callback = callback
|
|
|
|
async def create_subscription(self):
|
|
"""Create the subscription."""
|
|
return
|
|
|
|
async def delete_subscription(self):
|
|
"""Delete the subscription."""
|
|
return
|
|
|
|
async def start_async(self):
|
|
"""Return the fake device manager."""
|
|
return self._device_manager
|
|
|
|
async def async_get_device_manager(self) -> DeviceManager:
|
|
"""Return the fake device manager."""
|
|
return self._device_manager
|
|
|
|
def stop_async(self):
|
|
"""No-op to stop the subscriber."""
|
|
return None
|
|
|
|
async def async_receive_event(self, event_message: EventMessage):
|
|
"""Simulate a received pubsub message, invoked by tests."""
|
|
# Update device state, then invoke HomeAssistant to refresh
|
|
await self._device_manager.async_handle_event(event_message)
|
|
await self._callback(event_message)
|
|
|
|
|
|
async def async_setup_sdm_platform(
|
|
hass, platform, devices={}, structures={}, with_config=True
|
|
):
|
|
"""Set up the platform and prerequisites."""
|
|
if with_config:
|
|
create_config_entry(hass)
|
|
device_manager = FakeDeviceManager(devices=devices, structures=structures)
|
|
subscriber = FakeSubscriber(device_manager)
|
|
with patch(
|
|
"homeassistant.helpers.config_entry_oauth2_flow.async_get_config_entry_implementation"
|
|
), patch("homeassistant.components.nest.PLATFORMS", [platform]), patch(
|
|
"homeassistant.components.nest.api.GoogleNestSubscriber",
|
|
return_value=subscriber,
|
|
):
|
|
assert await async_setup_component(hass, DOMAIN, CONFIG)
|
|
await hass.async_block_till_done()
|
|
return subscriber
|