Move platform_integration_no_support issue to the homeassistant integration (#95927)

* Move platform_integration_no_support issue to the homeassistant integration * Update test * Improve repair text * Update test
2025-04-23 08:47:57 +00:00 · 2023-07-07 13:31:54 +02:00 · 2023-07-07 13:31:54 +02:00 · 86a397720f
commit 86a397720f
parent 84979f8e92
30 changed files with 28 additions and 164 deletions
--- a/homeassistant/components/alarm_control_panel/strings.json
+++ b/homeassistant/components/alarm_control_panel/strings.json
@ -62,11 +62,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/binary_sensor/strings.json
+++ b/homeassistant/components/binary_sensor/strings.json
@ -314,11 +314,5 @@
    "smoke": "smoke",
    "sound": "sound",
    "vibration": "vibration"
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/button/strings.json
+++ b/homeassistant/components/button/strings.json
@ -21,11 +21,5 @@
    "update": {
      "name": "Update"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/calendar/strings.json
+++ b/homeassistant/components/calendar/strings.json
@ -32,11 +32,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/camera/strings.json
+++ b/homeassistant/components/camera/strings.json
@ -34,11 +34,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/climate/strings.json
+++ b/homeassistant/components/climate/strings.json
@ -104,11 +104,5 @@
        "temperature": { "name": "Target temperature" }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/cover/strings.json
+++ b/homeassistant/components/cover/strings.json
@ -76,11 +76,5 @@
    "window": {
      "name": "Window"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/date/strings.json
+++ b/homeassistant/components/date/strings.json
@ -4,11 +4,5 @@
    "_": {
      "name": "[%key:component::date::title%]"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/device_tracker/strings.json
+++ b/homeassistant/components/device_tracker/strings.json
@ -41,11 +41,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/fan/strings.json
+++ b/homeassistant/components/fan/strings.json
@ -52,11 +52,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/homeassistant/strings.json
+++ b/homeassistant/components/homeassistant/strings.json
@ -19,6 +19,10 @@
    "platform_only": {
      "title": "The {domain} integration does not support YAML configuration under its own key",
      "description": "The {domain} integration does not support configuration under its own key, it must be configured under its supported platforms.\n\nTo resolve this:\n\n1. Remove `{domain}:` from your YAML configuration file.\n\n2. Restart Home Assistant."
+    },
+    "no_platform_setup": {
+      "title": "Unused YAML configuration for the {platform} integration",
+      "description": "It's not possible to configure {platform} {domain} by adding `{platform_key}` to the {domain} configuration. Please check the documentation for more information on how to set up this integration.\n\nTo resolve this:\n1. Remove `{platform_key}` occurences from the `{domain}:` configuration in your YAML configuration file.\n2. Restart Home Assistant.\n\nExample that should be removed:\n{yaml_example}\n"
    }
  },
  "system_health": {
--- a/homeassistant/components/humidifier/strings.json
+++ b/homeassistant/components/humidifier/strings.json
@ -74,11 +74,5 @@
    "humidifier": {
      "name": "[%key:component::humidifier::entity_component::_::name%]"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/light/strings.json
+++ b/homeassistant/components/light/strings.json
@ -86,11 +86,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/lock/strings.json
+++ b/homeassistant/components/lock/strings.json
@ -34,11 +34,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/media_player/strings.json
+++ b/homeassistant/components/media_player/strings.json
@ -159,11 +159,5 @@
    "receiver": {
      "name": "Receiver"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/number/strings.json
+++ b/homeassistant/components/number/strings.json
@ -154,11 +154,5 @@
    "wind_speed": {
      "name": "[%key:component::sensor::entity_component::wind_speed::name%]"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/remote/strings.json
+++ b/homeassistant/components/remote/strings.json
@ -24,11 +24,5 @@
        "on": "[%key:common::state::on%]"
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/select/strings.json
+++ b/homeassistant/components/select/strings.json
@ -24,11 +24,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/sensor/strings.json
+++ b/homeassistant/components/sensor/strings.json
@ -267,11 +267,5 @@
    "wind_speed": {
      "name": "Wind speed"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/siren/strings.json
+++ b/homeassistant/components/siren/strings.json
@ -13,11 +13,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/switch/strings.json
+++ b/homeassistant/components/switch/strings.json
@ -30,11 +30,5 @@
    "outlet": {
      "name": "Outlet"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/text/strings.json
+++ b/homeassistant/components/text/strings.json
@ -27,11 +27,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/time/strings.json
+++ b/homeassistant/components/time/strings.json
@ -4,11 +4,5 @@
    "_": {
      "name": "[%key:component::time::title%]"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/update/strings.json
+++ b/homeassistant/components/update/strings.json
@ -14,11 +14,5 @@
    "firmware": {
      "name": "Firmware"
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/vacuum/strings.json
+++ b/homeassistant/components/vacuum/strings.json
@ -28,11 +28,5 @@
        "returning": "Returning to dock"
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/water_heater/strings.json
+++ b/homeassistant/components/water_heater/strings.json
@ -18,11 +18,5 @@
        "performance": "Performance"
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/components/weather/strings.json
+++ b/homeassistant/components/weather/strings.json
@ -74,11 +74,5 @@
        }
      }
    }
-  },
-  "issues": {
-    "platform_integration_no_support": {
-      "title": "[%key:common::issues::platform_integration_no_support_title%]",
-      "description": "[%key:common::issues::platform_integration_no_support_description%]"
-    }
  }
 }
--- a/homeassistant/helpers/entity_platform.py
+++ b/homeassistant/helpers/entity_platform.py
@ -19,6 +19,7 @@ from homeassistant.const import (
 )
 from homeassistant.core import (
    CALLBACK_TYPE,
+    DOMAIN as HOMEASSISTANT_DOMAIN,
    CoreState,
    HomeAssistant,
    ServiceCall,
@ -216,16 +217,27 @@ class EntityPlatform:
                self.platform_name,
                self.domain,
            )
+            learn_more_url = None
+            if self.platform and "custom_components" not in self.platform.__file__:  # type: ignore[attr-defined]
+                learn_more_url = (
+                    f"https://www.home-assistant.io/integrations/{self.platform_name}/"
+                )
+            platform_key = f"platform: {self.platform_name}"
+            yaml_example = f"```yaml\n{self.domain}:\n  - {platform_key}\n```"
            async_create_issue(
                self.hass,
-                self.domain,
+                HOMEASSISTANT_DOMAIN,
                f"platform_integration_no_support_{self.domain}_{self.platform_name}",
                is_fixable=False,
+                issue_domain=self.platform_name,
+                learn_more_url=learn_more_url,
                severity=IssueSeverity.ERROR,
-                translation_key="platform_integration_no_support",
+                translation_key="no_platform_setup",
                translation_placeholders={
                    "domain": self.domain,
                    "platform": self.platform_name,
+                    "platform_key": platform_key,
+                    "yaml_example": yaml_example,
                },
            )

--- a/homeassistant/strings.json
+++ b/homeassistant/strings.json
@ -87,10 +87,6 @@
        "unknown_authorize_url_generation": "Unknown error generating an authorize URL.",
        "cloud_not_connected": "Not connected to Home Assistant Cloud."
      }
-    },
-    "issues": {
-      "platform_integration_no_support_title": "Platform support not supported",
-      "platform_integration_no_support_description": "The {platform} platform for the {domain} integration does not support platform setup.\n\nPlease remove it from your configuration and restart Home Assistant to fix this issue."
    }
  }
 }
--- a/tests/helpers/test_entity_platform.py
+++ b/tests/helpers/test_entity_platform.py
@ -1477,11 +1477,19 @@ async def test_platform_with_no_setup(
        in caplog.text
    )
    issue = issue_registry.async_get_issue(
-        domain="mock-integration",
+        domain="homeassistant",
        issue_id="platform_integration_no_support_mock-integration_mock-platform",
    )
    assert issue
-    assert issue.translation_key == "platform_integration_no_support"
+    assert issue.issue_domain == "mock-platform"
+    assert issue.learn_more_url is None
+    assert issue.translation_key == "no_platform_setup"
+    assert issue.translation_placeholders == {
+        "domain": "mock-integration",
+        "platform": "mock-platform",
+        "platform_key": "platform: mock-platform",
+        "yaml_example": "```yaml\nmock-integration:\n  - platform: mock-platform\n```",
+    }


 async def test_platforms_sharing_services(hass: HomeAssistant) -> None: