Normalize input for Droplet pairing code (home-assistant#157361)

Author: sarahseidman

homeassistant/components/droplet/config_flow.py

@@ -15,6 +15,11 @@
 from .const import DOMAIN
 
 
+def normalize_pairing_code(code: str) -> str:
+    """Normalize pairing code by removing spaces and capitalizing."""
+    return code.replace(" ", "").upper()
+
+
 class DropletConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle Droplet config flow."""
 
@@ -52,14 +57,13 @@ async def async_step_confirm(
         if user_input is not None:
             # Test if we can connect before returning
             session = async_get_clientsession(self.hass)
-            if await self._droplet_discovery.try_connect(
-                session, user_input[CONF_CODE]
-            ):
+            code = normalize_pairing_code(user_input[CONF_CODE])
+            if await self._droplet_discovery.try_connect(session, code):
                 device_data = {
                     CONF_IP_ADDRESS: self._droplet_discovery.host,
                     CONF_PORT: self._droplet_discovery.port,
                     CONF_DEVICE_ID: device_id,
-                    CONF_CODE: user_input[CONF_CODE],
+                    CONF_CODE: code,
                 }
 
                 return self.async_create_entry(
@@ -90,14 +94,15 @@ async def async_step_user(
                 user_input[CONF_IP_ADDRESS], DropletConnection.DEFAULT_PORT, ""
             )
             session = async_get_clientsession(self.hass)
-            if await self._droplet_discovery.try_connect(
-                session, user_input[CONF_CODE]
-            ) and (device_id := await self._droplet_discovery.get_device_id()):
+            code = normalize_pairing_code(user_input[CONF_CODE])
+            if await self._droplet_discovery.try_connect(session, code) and (
+                device_id := await self._droplet_discovery.get_device_id()
+            ):
                 device_data = {
                     CONF_IP_ADDRESS: self._droplet_discovery.host,
                     CONF_PORT: self._droplet_discovery.port,
                     CONF_DEVICE_ID: device_id,
-                    CONF_CODE: user_input[CONF_CODE],
+                    CONF_CODE: code,
                 }
                 await self.async_set_unique_id(device_id, raise_on_progress=False)
                 self._abort_if_unique_id_configured(

tests/components/droplet/test_config_flow.py

@@ -23,8 +23,22 @@
 from tests.common import MockConfigEntry
 
 
+@pytest.mark.parametrize(
+    ("pre_normalized_code", "normalized_code"),
+    [
+        (
+            "abc 123",
+            "ABC123",
+        ),
+        (" 123456 ", "123456"),
+        ("123ABC", "123ABC"),
+    ],
+    ids=["alphanumeric_lower_space", "numeric_space", "alphanumeric_no_space"],
+)
 async def test_user_setup(
     hass: HomeAssistant,
+    pre_normalized_code: str,
+    normalized_code: str,
     mock_droplet_discovery: AsyncMock,
     mock_droplet_connection: AsyncMock,
     mock_droplet: AsyncMock,
@@ -39,12 +53,12 @@ async def test_user_setup(
 
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
-        user_input={CONF_CODE: MOCK_CODE, CONF_IP_ADDRESS: "192.168.1.2"},
+        user_input={CONF_CODE: pre_normalized_code, CONF_IP_ADDRESS: "192.168.1.2"},
     )
     assert result is not None
     assert result.get("type") is FlowResultType.CREATE_ENTRY
     assert result.get("data") == {
-        CONF_CODE: MOCK_CODE,
+        CONF_CODE: normalized_code,
         CONF_DEVICE_ID: MOCK_DEVICE_ID,
         CONF_IP_ADDRESS: MOCK_HOST,
         CONF_PORT: MOCK_PORT,
@@ -133,8 +147,22 @@ async def test_user_setup_already_configured(
     assert result.get("reason") == "already_configured"
 
 
+@pytest.mark.parametrize(
+    ("pre_normalized_code", "normalized_code"),
+    [
+        (
+            "abc 123",
+            "ABC123",
+        ),
+        (" 123456 ", "123456"),
+        ("123ABC", "123ABC"),
+    ],
+    ids=["alphanumeric_lower_space", "numeric_space", "alphanumeric_no_space"],
+)
 async def test_zeroconf_setup(
     hass: HomeAssistant,
+    pre_normalized_code: str,
+    normalized_code: str,
     mock_droplet_discovery: AsyncMock,
     mock_droplet: AsyncMock,
     mock_droplet_connection: AsyncMock,
@@ -159,15 +187,15 @@ async def test_zeroconf_setup(
     assert result.get("step_id") == "confirm"
 
     result = await hass.config_entries.flow.async_configure(
-        result["flow_id"], user_input={CONF_CODE: MOCK_CODE}
+        result["flow_id"], user_input={CONF_CODE: pre_normalized_code}
     )
     assert result is not None
     assert result.get("type") is FlowResultType.CREATE_ENTRY
     assert result.get("data") == {
         CONF_DEVICE_ID: MOCK_DEVICE_ID,
         CONF_IP_ADDRESS: MOCK_HOST,
         CONF_PORT: MOCK_PORT,
-        CONF_CODE: MOCK_CODE,
+        CONF_CODE: normalized_code,
     }
     assert result.get("context") is not None
     assert result.get("context", {}).get("unique_id") == MOCK_DEVICE_ID