Cleanup deprecated YAML import from datadog (home-assistant#161870)

Author: epenet

homeassistant/components/datadog/__init__.py

@@ -3,9 +3,8 @@
 import logging
 
 from datadog import DogStatsd, initialize
-import voluptuous as vol
 
-from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     CONF_HOST,
     CONF_PORT,
@@ -16,53 +15,15 @@
 )
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import config_validation as cv, state as state_helper
-from homeassistant.helpers.typing import ConfigType
 
 from . import config_flow as config_flow
-from .const import (
-    CONF_RATE,
-    DEFAULT_HOST,
-    DEFAULT_PORT,
-    DEFAULT_PREFIX,
-    DEFAULT_RATE,
-    DOMAIN,
-)
+from .const import CONF_RATE, DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
 type DatadogConfigEntry = ConfigEntry[DogStatsd]
 
-CONFIG_SCHEMA = vol.Schema(
-    {
-        DOMAIN: vol.Schema(
-            {
-                vol.Required(CONF_HOST, default=DEFAULT_HOST): cv.string,
-                vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
-                vol.Optional(CONF_PREFIX, default=DEFAULT_PREFIX): cv.string,
-                vol.Optional(CONF_RATE, default=DEFAULT_RATE): vol.All(
-                    vol.Coerce(int), vol.Range(min=1)
-                ),
-            }
-        )
-    },
-    extra=vol.ALLOW_EXTRA,
-)
-
-
-async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
-    """Set up the Datadog integration from YAML, initiating config flow import."""
-    if DOMAIN not in config:
-        return True
-
-    hass.async_create_task(
-        hass.config_entries.flow.async_init(
-            DOMAIN,
-            context={"source": SOURCE_IMPORT},
-            data=config[DOMAIN],
-        )
-    )
-
-    return True
+CONFIG_SCHEMA = cv.removed(DOMAIN, raise_if_present=False)
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: DatadogConfigEntry) -> bool:

homeassistant/components/datadog/config_flow.py

@@ -12,8 +12,7 @@
     OptionsFlow,
 )
 from homeassistant.const import CONF_HOST, CONF_PORT, CONF_PREFIX
-from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant, callback
-from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
+from homeassistant.core import HomeAssistant, callback
 
 from .const import (
     CONF_RATE,
@@ -71,22 +70,6 @@ async def async_step_user(
             errors=errors,
         )
 
-    async def async_step_import(self, user_input: dict[str, Any]) -> ConfigFlowResult:
-        """Handle import from configuration.yaml."""
-        # Check for duplicates
-        self._async_abort_entries_match(
-            {CONF_HOST: user_input[CONF_HOST], CONF_PORT: user_input[CONF_PORT]}
-        )
-
-        result = await self.async_step_user(user_input)
-
-        if errors := result.get("errors"):
-            await deprecate_yaml_issue(self.hass, False)
-            return self.async_abort(reason=errors["base"])
-
-        await deprecate_yaml_issue(self.hass, True)
-        return result
-
     @staticmethod
     @callback
     def async_get_options_flow(config_entry: ConfigEntry) -> OptionsFlow:
@@ -163,41 +146,3 @@ async def validate_datadog_connection(
         return False
     else:
         return True
-
-
-async def deprecate_yaml_issue(
-    hass: HomeAssistant,
-    import_success: bool,
-) -> None:
-    """Create an issue to deprecate YAML config."""
-    if import_success:
-        async_create_issue(
-            hass,
-            HOMEASSISTANT_DOMAIN,
-            f"deprecated_yaml_{DOMAIN}",
-            is_fixable=False,
-            issue_domain=DOMAIN,
-            breaks_in_ha_version="2026.2.0",
-            severity=IssueSeverity.WARNING,
-            translation_key="deprecated_yaml",
-            translation_placeholders={
-                "domain": DOMAIN,
-                "integration_title": "Datadog",
-            },
-        )
-    else:
-        async_create_issue(
-            hass,
-            DOMAIN,
-            "deprecated_yaml_import_connection_error",
-            breaks_in_ha_version="2026.2.0",
-            is_fixable=False,
-            issue_domain=DOMAIN,
-            severity=IssueSeverity.WARNING,
-            translation_key="deprecated_yaml_import_connection_error",
-            translation_placeholders={
-                "domain": DOMAIN,
-                "integration_title": "Datadog",
-                "url": f"/config/integrations/dashboard/add?domain={DOMAIN}",
-            },
-        )

homeassistant/components/datadog/strings.json

@@ -25,12 +25,6 @@
       }
     }
   },
-  "issues": {
-    "deprecated_yaml_import_connection_error": {
-      "description": "There was an error connecting to the Datadog Agent when trying to import the YAML configuration.\n\nEnsure the YAML configuration is correct and restart Home Assistant to try again or remove the {domain} configuration from your `configuration.yaml` file and continue to [set up the integration]({url}) manually.",
-      "title": "{domain} YAML configuration import failed"
-    }
-  },
   "options": {
     "abort": {
       "already_configured": "[%key:common::config_flow::abort::already_configured_service%]",

tests/components/datadog/common.py

@@ -14,14 +14,6 @@
 
 MOCK_CONFIG = {**MOCK_DATA, **MOCK_OPTIONS}
 
-MOCK_YAML_INVALID = {
-    "host": "127.0.0.1",
-    "port": 65535,
-    "prefix": "failtest",
-    "rate": 1,
-}
-
-
 CONNECTION_TEST_METRIC = "connection_test"
 
 

tests/components/datadog/test_config_flow.py

@@ -2,13 +2,12 @@
 
 from unittest.mock import MagicMock, patch
 
-from homeassistant.components import datadog
-from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER
-from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant
+from homeassistant.components.datadog.const import DOMAIN
+from homeassistant.config_entries import SOURCE_USER
+from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResultType
-import homeassistant.helpers.issue_registry as ir
 
-from .common import MOCK_CONFIG, MOCK_DATA, MOCK_OPTIONS, MOCK_YAML_INVALID
+from .common import MOCK_CONFIG, MOCK_DATA, MOCK_OPTIONS
 
 from tests.common import MockConfigEntry
 
@@ -22,7 +21,7 @@ async def test_user_flow_success(hass: HomeAssistant) -> None:
         mock_dogstatsd.return_value = mock_instance
 
         result = await hass.config_entries.flow.async_init(
-            datadog.DOMAIN, context={"source": SOURCE_USER}
+            DOMAIN, context={"source": SOURCE_USER}
         )
         assert result["type"] is FlowResultType.FORM
 
@@ -42,7 +41,7 @@ async def test_user_flow_retry_after_connection_fail(hass: HomeAssistant) -> Non
         side_effect=OSError("Connection failed"),
     ):
         result = await hass.config_entries.flow.async_init(
-            datadog.DOMAIN, context={"source": SOURCE_USER}
+            DOMAIN, context={"source": SOURCE_USER}
         )
 
         result2 = await hass.config_entries.flow.async_configure(
@@ -67,14 +66,14 @@ async def test_user_flow_abort_already_configured_service(
 ) -> None:
     """Abort user-initiated config flow if the same host/port is already configured."""
     existing_entry = MockConfigEntry(
-        domain=datadog.DOMAIN,
+        domain=DOMAIN,
         data=MOCK_DATA,
         options=MOCK_OPTIONS,
     )
     existing_entry.add_to_hass(hass)
 
     result = await hass.config_entries.flow.async_init(
-        datadog.DOMAIN,
+        DOMAIN,
         context={"source": SOURCE_USER},
     )
 
@@ -93,7 +92,7 @@ async def test_user_flow_abort_already_configured_service(
 async def test_options_flow_cannot_connect(hass: HomeAssistant) -> None:
     """Test that the options flow shows an error when connection fails."""
     mock_entry = MockConfigEntry(
-        domain=datadog.DOMAIN,
+        domain=DOMAIN,
         data=MOCK_DATA,
         options=MOCK_OPTIONS,
     )
@@ -123,67 +122,10 @@ async def test_options_flow_cannot_connect(hass: HomeAssistant) -> None:
         assert result3["data"] == MOCK_OPTIONS
 
 
-async def test_import_flow(
-    hass: HomeAssistant, issue_registry: ir.IssueRegistry
-) -> None:
-    """Test import triggers config flow and is accepted."""
-    with (
-        patch(
-            "homeassistant.components.datadog.config_flow.DogStatsd"
-        ) as mock_dogstatsd,
-    ):
-        mock_instance = MagicMock()
-        mock_dogstatsd.return_value = mock_instance
-
-        result = await hass.config_entries.flow.async_init(
-            datadog.DOMAIN,
-            context={"source": SOURCE_IMPORT},
-            data=MOCK_CONFIG,
-        )
-
-        assert result["type"] is FlowResultType.CREATE_ENTRY
-        assert result["data"] == MOCK_DATA
-        assert result["options"] == MOCK_OPTIONS
-
-        await hass.async_block_till_done()
-
-        # Deprecation issue should be created
-        issue = issue_registry.async_get_issue(
-            HOMEASSISTANT_DOMAIN, "deprecated_yaml_datadog"
-        )
-        assert issue is not None
-        assert issue.translation_key == "deprecated_yaml"
-        assert issue.severity == ir.IssueSeverity.WARNING
-
-
-async def test_import_connection_error(
-    hass: HomeAssistant, issue_registry: ir.IssueRegistry
-) -> None:
-    """Test import triggers connection error issue."""
-    with patch(
-        "homeassistant.components.datadog.config_flow.DogStatsd",
-        side_effect=OSError("connection refused"),
-    ):
-        result = await hass.config_entries.flow.async_init(
-            datadog.DOMAIN,
-            context={"source": SOURCE_IMPORT},
-            data=MOCK_YAML_INVALID,
-        )
-        assert result["type"] == "abort"
-        assert result["reason"] == "cannot_connect"
-
-        issue = issue_registry.async_get_issue(
-            datadog.DOMAIN, "deprecated_yaml_import_connection_error"
-        )
-        assert issue is not None
-        assert issue.translation_key == "deprecated_yaml_import_connection_error"
-        assert issue.severity == ir.IssueSeverity.WARNING
-
-
 async def test_options_flow(hass: HomeAssistant) -> None:
     """Test updating options after setup."""
     mock_entry = MockConfigEntry(
-        domain=datadog.DOMAIN,
+        domain=DOMAIN,
         data=MOCK_DATA,
         options=MOCK_OPTIONS,
     )
@@ -234,24 +176,3 @@ async def test_options_flow(hass: HomeAssistant) -> None:
         assert result["type"] is FlowResultType.CREATE_ENTRY
         assert result["data"] == new_options
         mock_instance.increment.assert_called_once_with("connection_test")
-
-
-async def test_import_flow_abort_already_configured_service(
-    hass: HomeAssistant,
-) -> None:
-    """Abort import if the same host/port is already configured."""
-    existing_entry = MockConfigEntry(
-        domain=datadog.DOMAIN,
-        data=MOCK_DATA,
-        options=MOCK_OPTIONS,
-    )
-    existing_entry.add_to_hass(hass)
-
-    result = await hass.config_entries.flow.async_init(
-        datadog.DOMAIN,
-        context={"source": SOURCE_IMPORT},
-        data=MOCK_CONFIG,
-    )
-
-    assert result["type"] is FlowResultType.ABORT
-    assert result["reason"] == "already_configured"