Raise issue "does not support platform setup" (#93585)

* Raise issue on platform missing * Modify issue * Remove deprecation * Fix strings * Strings * Last strings * strings to common
home-assistant · May 28, 2023 · c6feb30 · c6feb30
1 parent 68c646b
commit c6feb30
Show file tree

Hide file tree

Showing 29 changed files with 184 additions and 1 deletion.
diff --git a/homeassistant/components/alarm_control_panel/strings.json b/homeassistant/components/alarm_control_panel/strings.json
@@ -62,5 +62,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/binary_sensor/strings.json b/homeassistant/components/binary_sensor/strings.json
@@ -314,5 +314,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/button/strings.json b/homeassistant/components/button/strings.json
@@ -18,5 +18,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/calendar/strings.json b/homeassistant/components/calendar/strings.json
@@ -32,5 +32,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/camera/strings.json b/homeassistant/components/camera/strings.json
@@ -34,5 +34,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/climate/strings.json b/homeassistant/components/climate/strings.json
@@ -103,5 +103,11 @@
         "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/cover/strings.json b/homeassistant/components/cover/strings.json
@@ -76,5 +76,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/date/strings.json b/homeassistant/components/date/strings.json
@@ -4,5 +4,11 @@
     "_": {
       "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/device_tracker/strings.json b/homeassistant/components/device_tracker/strings.json
@@ -41,5 +41,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/fan/strings.json b/homeassistant/components/fan/strings.json
@@ -52,5 +52,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/humidifier/strings.json b/homeassistant/components/humidifier/strings.json
@@ -62,5 +62,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/light/strings.json b/homeassistant/components/light/strings.json
@@ -86,5 +86,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/lock/strings.json b/homeassistant/components/lock/strings.json
@@ -34,5 +34,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/media_player/strings.json b/homeassistant/components/media_player/strings.json
@@ -159,5 +159,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/number/strings.json b/homeassistant/components/number/strings.json
@@ -154,5 +154,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/remote/strings.json b/homeassistant/components/remote/strings.json
@@ -24,5 +24,11 @@
         "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/select/strings.json b/homeassistant/components/select/strings.json
@@ -24,5 +24,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/sensor/strings.json b/homeassistant/components/sensor/strings.json
@@ -267,5 +267,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/siren/strings.json b/homeassistant/components/siren/strings.json
@@ -13,5 +13,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/switch/strings.json b/homeassistant/components/switch/strings.json
@@ -30,5 +30,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/text/strings.json b/homeassistant/components/text/strings.json
@@ -27,5 +27,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/components/time/strings.json b/homeassistant/components/time/strings.json
@@ -4,5 +4,11 @@
     "_": {
       "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/update/strings.json b/homeassistant/components/update/strings.json
@@ -14,5 +14,11 @@
     "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/vacuum/strings.json b/homeassistant/components/vacuum/strings.json
@@ -28,5 +28,11 @@
         "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/water_heater/strings.json b/homeassistant/components/water_heater/strings.json
@@ -18,5 +18,11 @@
         "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%]"
+    }
   }
 }
diff --git a/homeassistant/components/weather/strings.json b/homeassistant/components/weather/strings.json
@@ -62,5 +62,11 @@
         }
       }
     }
+  },
+  "issues": {
+    "platform_integration_no_support": {
+      "title": "[%key:common::issues::platform_integration_no_support_title%]",
+      "description": "[%key:common::issues::platform_integration_no_support_description%]"
+    }
   }
 }
diff --git a/homeassistant/helpers/entity_platform.py b/homeassistant/helpers/entity_platform.py
@@ -44,6 +44,7 @@
 from .device_registry import DeviceRegistry
 from .entity_registry import EntityRegistry, RegistryEntryDisabler, RegistryEntryHider
 from .event import async_call_later, async_track_time_interval
+from .issue_registry import IssueSeverity, async_create_issue
 from .typing import ConfigType, DiscoveryInfoType
 
 if TYPE_CHECKING:
@@ -211,6 +212,19 @@ async def async_setup(
                 self.platform_name,
                 self.domain,
             )
+            async_create_issue(
+                self.hass,
+                self.domain,
+                f"platform_integration_no_support_{self.domain}_{self.platform_name}",
+                is_fixable=False,
+                severity=IssueSeverity.ERROR,
+                translation_key="platform_integration_no_support",
+                translation_placeholders={
+                    "domain": self.domain,
+                    "platform": self.platform_name,
+                },
+            )
+
             return
 
         @callback

diff --git a/homeassistant/strings.json b/homeassistant/strings.json
@@ -87,6 +87,10 @@
         "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."
     }
   }
 }
diff --git a/tests/helpers/test_entity_platform.py b/tests/helpers/test_entity_platform.py
@@ -14,6 +14,7 @@
     device_registry as dr,
     entity_platform,
     entity_registry as er,
+    issue_registry as ir,
 )
 from homeassistant.helpers.entity import (
     DeviceInfo,
@@ -1458,7 +1459,9 @@ async def test_override_restored_entities(
 
 
 async def test_platform_with_no_setup(
-    hass: HomeAssistant, caplog: pytest.LogCaptureFixture
+    hass: HomeAssistant,
+    caplog: pytest.LogCaptureFixture,
+    issue_registry: ir.IssueRegistry,
 ) -> None:
     """Test setting up a platform that does not support setup."""
     entity_platform = MockEntityPlatform(
@@ -1471,6 +1474,12 @@ async def test_platform_with_no_setup(
         "The mock-platform platform for the mock-integration integration does not support platform setup."
         in caplog.text
     )
+    issue = issue_registry.async_get_issue(
+        domain="mock-integration",
+        issue_id="platform_integration_no_support_mock-integration_mock-platform",
+    )
+    assert issue
+    assert issue.translation_key == "platform_integration_no_support"
 
 
 async def test_platforms_sharing_services(hass: HomeAssistant) -> None: