Cleanup homelink config flow (home-assistant#158479)

Author: joostlek

homeassistant/components/gentex_homelink/config_flow.py

@@ -7,7 +7,7 @@
 from homelink.auth.srp_auth import SRPAuth
 import voluptuous as vol
 
-from homeassistant import config_entries
+from homeassistant.config_entries import ConfigFlowResult
 from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
 from homeassistant.helpers.config_entry_oauth2_flow import AbstractOAuth2FlowHandler
 
@@ -34,7 +34,7 @@ def logger(self):
 
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
-    ) -> config_entries.ConfigFlowResult:
+    ) -> ConfigFlowResult:
         """Ask for username and password."""
         errors: dict[str, str] = {}
         if user_input is not None:

tests/components/gentex_homelink/conftest.py

@@ -0,0 +1,33 @@
+"""Fixtures for Gentex HomeLink tests."""
+
+from collections.abc import Generator
+from unittest.mock import AsyncMock, patch
+
+import pytest
+
+
+@pytest.fixture
+def mock_srp_auth() -> Generator[AsyncMock]:
+    """Mock SRP authentication."""
+    with patch(
+        "homeassistant.components.gentex_homelink.config_flow.SRPAuth"
+    ) as mock_srp_auth:
+        instance = mock_srp_auth.return_value
+        instance.async_get_access_token.return_value = {
+            "AuthenticationResult": {
+                "AccessToken": "access",
+                "RefreshToken": "refresh",
+                "TokenType": "bearer",
+                "ExpiresIn": 3600,
+            }
+        }
+        yield instance
+
+
+@pytest.fixture
+def mock_setup_entry() -> Generator[AsyncMock]:
+    """Mock setup entry."""
+    with patch(
+        "homeassistant.components.gentex_homelink.async_setup_entry", return_value=True
+    ) as mock_setup_entry:
+        yield mock_setup_entry

tests/components/gentex_homelink/test_config_flow.py

@@ -1,91 +1,84 @@
 """Test the homelink config flow."""
 
-from unittest.mock import patch
+from unittest.mock import AsyncMock
 
 import botocore.exceptions
+import pytest
 
-from homeassistant import config_entries
 from homeassistant.components.gentex_homelink.const import DOMAIN
+from homeassistant.config_entries import SOURCE_USER
+from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
 from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResultType
 
 
-async def test_show_user_form(hass: HomeAssistant) -> None:
-    """Test that the user set up form is served."""
+async def test_full_flow(
+    hass: HomeAssistant, mock_srp_auth: AsyncMock, mock_setup_entry: AsyncMock
+) -> None:
+    """Check full flow."""
     result = await hass.config_entries.flow.async_init(
-        DOMAIN,
-        context={"source": config_entries.SOURCE_USER},
+        DOMAIN, context={"source": SOURCE_USER}
     )
 
+    assert result["type"] is FlowResultType.FORM
     assert result["step_id"] == "user"
-    assert result["type"] == FlowResultType.FORM
-
-
-async def test_full_flow(hass: HomeAssistant) -> None:
-    """Check full flow."""
-    with patch(
-        "homeassistant.components.gentex_homelink.config_flow.SRPAuth"
-    ) as MockSRPAuth:
-        instance = MockSRPAuth.return_value
-        instance.async_get_access_token.return_value = {
-            "AuthenticationResult": {
-                "AccessToken": "access",
-                "RefreshToken": "refresh",
-                "TokenType": "bearer",
-                "ExpiresIn": 3600,
-            }
-        }
-        result = await hass.config_entries.flow.async_init(
-            DOMAIN, context={"source": config_entries.SOURCE_USER}
-        )
-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
-            user_input={"email": "[email protected]", "password": "SomePassword"},
-        )
-        assert result["type"] == FlowResultType.CREATE_ENTRY
-        assert result["data"]
-        assert result["data"]["token"]
-        assert result["data"]["token"]["access_token"] == "access"
-        assert result["data"]["token"]["refresh_token"] == "refresh"
-        assert result["data"]["token"]["expires_in"] == 3600
-        assert result["data"]["token"]["expires_at"]
-
+    assert not result["errors"]
 
-async def test_boto_error(hass: HomeAssistant) -> None:
-    """Test exceptions from boto are handled correctly."""
-    with patch(
-        "homeassistant.components.gentex_homelink.config_flow.SRPAuth"
-    ) as MockSRPAuth:
-        instance = MockSRPAuth.return_value
-        instance.async_get_access_token.side_effect = botocore.exceptions.ClientError(
-            {"Error": {}}, "Some operation"
-        )
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input={CONF_EMAIL: "[email protected]", CONF_PASSWORD: "SomePassword"},
+    )
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["data"] == {
+        "auth_implementation": "gentex_homelink",
+        "token": {
+            "access_token": "access",
+            "refresh_token": "refresh",
+            "expires_in": 3600,
+            "token_type": "bearer",
+            "expires_at": result["data"]["token"]["expires_at"],
+        },
+    }
+    assert result["title"] == "SRPAuth"
+
+
+@pytest.mark.parametrize(
+    ("exception", "error"),
+    [
+        (
+            botocore.exceptions.ClientError({"Error": {}}, "Some operation"),
+            "srp_auth_failed",
+        ),
+        (Exception("Some error"), "unknown"),
+    ],
+)
+async def test_exceptions(
+    hass: HomeAssistant,
+    mock_srp_auth: AsyncMock,
+    mock_setup_entry: AsyncMock,
+    exception: Exception,
+    error: str,
+) -> None:
+    """Test exceptions are handled correctly."""
 
-        result = await hass.config_entries.flow.async_init(
-            DOMAIN, context={"source": config_entries.SOURCE_USER}
-        )
-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
-            user_input={"email": "[email protected]", "password": "SomePassword"},
-        )
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
 
-    assert len(hass.config_entries.async_entries(DOMAIN)) == 0
+    mock_srp_auth.async_get_access_token.side_effect = exception
 
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input={CONF_EMAIL: "[email protected]", CONF_PASSWORD: "SomePassword"},
+    )
 
-async def test_generic_error(hass: HomeAssistant) -> None:
-    """Test exceptions from boto are handled correctly."""
-    with patch(
-        "homeassistant.components.gentex_homelink.config_flow.SRPAuth"
-    ) as MockSRPAuth:
-        instance = MockSRPAuth.return_value
-        instance.async_get_access_token.side_effect = Exception("Some error")
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {"base": error}
 
-        result = await hass.config_entries.flow.async_init(
-            DOMAIN, context={"source": config_entries.SOURCE_USER}
-        )
-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
-            user_input={"email": "[email protected]", "password": "SomePassword"},
-        )
+    mock_srp_auth.async_get_access_token.side_effect = None
 
-    assert len(hass.config_entries.async_entries(DOMAIN)) == 0
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input={CONF_EMAIL: "[email protected]", CONF_PASSWORD: "SomePassword"},
+    )
+    assert result["type"] is FlowResultType.CREATE_ENTRY