Fix NINA flow tests to end a final state (home-assistant#156664)

Author: DeerMaximum

homeassistant/components/nina/config_flow.py

@@ -21,7 +21,6 @@
 
 from .const import (
     _LOGGER,
-    ALL_MATCH_REGEX,
     CONF_AREA_FILTER,
     CONF_FILTERS,
     CONF_HEADLINE_FILTER,
@@ -86,6 +85,34 @@ def prepare_user_input(
     return user_input
 
 
+def create_schema(regions: dict[str, dict[str, Any]]) -> vol.Schema:
+    """Create the schema for the flows."""
+    schema_dict: VolDictType = {
+        **{
+            vol.Optional(region): cv.multi_select(regions[region])
+            for region in CONST_REGIONS
+        },
+        vol.Required(
+            CONF_MESSAGE_SLOTS,
+            default=5,
+        ): vol.All(int, vol.Range(min=1, max=20)),
+        vol.Required(CONF_FILTERS): section(
+            vol.Schema(
+                {
+                    vol.Optional(
+                        CONF_HEADLINE_FILTER,
+                    ): cv.string,
+                    vol.Optional(
+                        CONF_AREA_FILTER,
+                    ): cv.string,
+                }
+            )
+        ),
+    }
+
+    return vol.Schema(schema_dict)
+
+
 class NinaConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for NINA."""
 
@@ -116,10 +143,10 @@ async def async_step_user(
                     await nina.getAllRegionalCodes()
                 )
             except ApiError:
-                errors["base"] = "cannot_connect"
-            except Exception as err:  # noqa: BLE001
-                _LOGGER.exception("Unexpected exception: %s", err)
-                errors["base"] = "unknown"
+                return self.async_abort(reason="no_fetch")
+            except Exception:  # noqa: BLE001
+                _LOGGER.exception("Unexpected exception")
+                return self.async_abort(reason="unknown")
 
             self.regions = split_regions(self._all_region_codes_sorted, self.regions)
 
@@ -141,33 +168,9 @@ async def async_step_user(
 
             errors["base"] = "no_selection"
 
-        regions_schema: VolDictType = {
-            vol.Optional(region): cv.multi_select(self.regions[region])
-            for region in CONST_REGIONS
-        }
-
         return self.async_show_form(
             step_id="user",
-            data_schema=vol.Schema(
-                {
-                    **regions_schema,
-                    vol.Required(CONF_MESSAGE_SLOTS, default=5): vol.All(
-                        int, vol.Range(min=1, max=20)
-                    ),
-                    vol.Required(CONF_FILTERS): section(
-                        vol.Schema(
-                            {
-                                vol.Optional(
-                                    CONF_HEADLINE_FILTER, default=NO_MATCH_REGEX
-                                ): cv.string,
-                                vol.Optional(
-                                    CONF_AREA_FILTER, default=ALL_MATCH_REGEX
-                                ): cv.string,
-                            }
-                        )
-                    ),
-                }
-            ),
+            data_schema=create_schema(self.regions),
             errors=errors,
         )
 
@@ -209,10 +212,10 @@ async def async_step_init(
                     await nina.getAllRegionalCodes()
                 )
             except ApiError:
-                errors["base"] = "cannot_connect"
-            except Exception as err:  # noqa: BLE001
-                _LOGGER.exception("Unexpected exception: %s", err)
-                errors["base"] = "unknown"
+                return self.async_abort(reason="no_fetch")
+            except Exception:  # noqa: BLE001
+                _LOGGER.exception("Unexpected exception")
+                return self.async_abort(reason="unknown")
 
             self.regions = split_regions(self._all_region_codes_sorted, self.regions)
 
@@ -263,35 +266,12 @@ async def async_step_init(
 
             errors["base"] = "no_selection"
 
-        schema: VolDictType = {
-            **{
-                vol.Optional(region, default=self.data[region]): cv.multi_select(
-                    self.regions[region]
-                )
-                for region in CONST_REGIONS
-            },
-            vol.Required(
-                CONF_MESSAGE_SLOTS,
-                default=self.data[CONF_MESSAGE_SLOTS],
-            ): vol.All(int, vol.Range(min=1, max=20)),
-            vol.Required(CONF_FILTERS): section(
-                vol.Schema(
-                    {
-                        vol.Optional(
-                            CONF_HEADLINE_FILTER,
-                            default=self.data[CONF_FILTERS][CONF_HEADLINE_FILTER],
-                        ): cv.string,
-                        vol.Optional(
-                            CONF_AREA_FILTER,
-                            default=self.data[CONF_FILTERS][CONF_AREA_FILTER],
-                        ): cv.string,
-                    }
-                )
-            ),
-        }
+        schema_with_suggested = self.add_suggested_values_to_schema(
+            create_schema(self.regions), self.data
+        )
 
         return self.async_show_form(
             step_id="init",
-            data_schema=vol.Schema(schema),
+            data_schema=schema_with_suggested,
             errors=errors,
         )

homeassistant/components/nina/strings.json

@@ -1,10 +1,12 @@
 {
   "config": {
-    "error": {
-      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
-      "no_selection": "Please select at least one city/county",
+    "abort": {
+      "no_fetch": "Cannot connect to NINA service to fetch city or counties. Please try again later.",
       "unknown": "[%key:common::config_flow::error::unknown%]"
     },
+    "error": {
+      "no_selection": "Please select at least one city/county"
+    },
     "step": {
       "user": {
         "data": {
@@ -44,11 +46,13 @@
     }
   },
   "options": {
-    "error": {
-      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
-      "no_selection": "[%key:component::nina::config::error::no_selection%]",
+    "abort": {
+      "no_fetch": "[%key:component::nina::config::abort::no_fetch%]",
       "unknown": "[%key:common::config_flow::error::unknown%]"
     },
+    "error": {
+      "no_selection": "[%key:component::nina::config::error::no_selection%]"
+    },
     "step": {
       "init": {
         "data": {