Make additional methods of google_assistant.AbstractConfig abstract (#109811)

homeassistant/components/google_assistant/helpers.py

@@ -129,19 +129,19 @@ class AbstractConfig(ABC):
             self._on_deinitialize.pop()()
 
     @property
+    @abstractmethod
     def enabled(self):
         """Return if Google is enabled."""
-        return False
 
     @property
+    @abstractmethod
     def entity_config(self):
         """Return entity config."""
-        return {}
 
     @property
+    @abstractmethod
     def secure_devices_pin(self):
         """Return entity config."""
-        return None
 
     @property
     def is_reporting_state(self):
@@ -154,9 +154,9 @@ class AbstractConfig(ABC):
         return self._local_sdk_active
 
     @property
+    @abstractmethod
     def should_report_state(self):
         """Return if states should be proactively reported."""
-        return False
 
     @property
     def is_local_connected(self) -> bool:
@@ -167,6 +167,7 @@ class AbstractConfig(ABC):
             and self._local_last_active > utcnow() - timedelta(seconds=70)
         )
 
+    @abstractmethod
     def get_local_user_id(self, webhook_id):
         """Map webhook ID to a Home Assistant user ID.
 
@@ -175,21 +176,10 @@ class AbstractConfig(ABC):
 
         Return None if no user id is found for the webhook_id.
         """
-        # Note: The manually setup Google Assistant currently returns the Google agent
-        # user ID instead of a valid Home Assistant user ID
-        found_agent_user_id = None
-        for agent_user_id, agent_user_data in self._store.agent_user_ids.items():
-            if agent_user_data[STORE_GOOGLE_LOCAL_WEBHOOK_ID] == webhook_id:
-                found_agent_user_id = agent_user_id
-                break
-
-        return found_agent_user_id
 
+    @abstractmethod
     def get_local_webhook_id(self, agent_user_id):
         """Return the webhook ID to be used for actions for a given agent user id via the local SDK."""
-        if data := self._store.agent_user_ids.get(agent_user_id):
-            return data[STORE_GOOGLE_LOCAL_WEBHOOK_ID]
-        return None
 
     @abstractmethod
     def get_agent_user_id(self, context):
@@ -199,15 +189,15 @@ class AbstractConfig(ABC):
     def should_expose(self, state) -> bool:
         """Return if entity should be exposed."""
 
+    @abstractmethod
     def should_2fa(self, state):
         """If an entity should have 2FA checked."""
-        return True
 
+    @abstractmethod
     async def async_report_state(
         self, message: dict[str, Any], agent_user_id: str, event_id: str | None = None
     ) -> HTTPStatus | None:
         """Send a state report to Google."""
-        raise NotImplementedError
 
     async def async_report_state_all(self, message):
         """Send a state report to Google for all previously synced users."""

homeassistant/components/google_assistant/http.py

@@ -36,6 +36,7 @@ from .const import (
     REPORT_STATE_BASE_URL,
     REQUEST_SYNC_BASE_URL,
     SOURCE_CLOUD,
+    STORE_GOOGLE_LOCAL_WEBHOOK_ID,
 )
 from .helpers import AbstractConfig
 from .smart_home import async_handle_message
@@ -110,6 +111,34 @@ class GoogleConfig(AbstractConfig):
         """Return if states should be proactively reported."""
         return self._config.get(CONF_REPORT_STATE)
 
+    def get_local_user_id(self, webhook_id):
+        """Map webhook ID to a Home Assistant user ID.
+
+        Any action inititated by Google Assistant via the local SDK will be attributed
+        to the returned user ID.
+
+        Return None if no user id is found for the webhook_id.
+        """
+        # Note: The manually setup Google Assistant currently returns the Google agent
+        # user ID instead of a valid Home Assistant user ID
+        found_agent_user_id = None
+        for agent_user_id, agent_user_data in self._store.agent_user_ids.items():
+            if agent_user_data[STORE_GOOGLE_LOCAL_WEBHOOK_ID] == webhook_id:
+                found_agent_user_id = agent_user_id
+                break
+
+        return found_agent_user_id
+
+    def get_local_webhook_id(self, agent_user_id):
+        """Return the webhook ID to be used for actions for a given agent user id via the local SDK."""
+        if data := self._store.agent_user_ids.get(agent_user_id):
+            return data[STORE_GOOGLE_LOCAL_WEBHOOK_ID]
+        return None
+
+    def get_agent_user_id(self, context):
+        """Get agent user ID making request."""
+        return context.user_id
+
     def should_expose(self, state) -> bool:
         """Return if entity should be exposed."""
         expose_by_default = self._config.get(CONF_EXPOSE_BY_DEFAULT)
@@ -149,10 +178,6 @@ class GoogleConfig(AbstractConfig):
 
         return is_default_exposed or explicit_expose
 
-    def get_agent_user_id(self, context):
-        """Get agent user ID making request."""
-        return context.user_id
-
     def should_2fa(self, state):
         """If an entity should have 2FA checked."""
         return True

tests/components/google_assistant/__init__.py

@@ -1,7 +1,7 @@
 """Tests for the Google Assistant integration."""
 from unittest.mock import MagicMock
 
-from homeassistant.components.google_assistant import helpers
+from homeassistant.components.google_assistant import helpers, http
 
 
 def mock_google_config_store(agent_user_ids=None):
@@ -14,7 +14,7 @@ def mock_google_config_store(agent_user_ids=None):
     return store
 
 
-class MockConfig(helpers.AbstractConfig):
+class MockConfig(http.GoogleConfig):
     """Fake config that always exposes everything."""
 
     def __init__(
@@ -30,7 +30,7 @@ class MockConfig(helpers.AbstractConfig):
         should_report_state=False,
     ):
         """Initialize config."""
-        super().__init__(hass)
+        helpers.AbstractConfig.__init__(self, hass)
         self._enabled = enabled
         self._entity_config = entity_config or {}
         self._secure_devices_pin = secure_devices_pin