Remove name in Minecraft Server config entry (#139113)

* Remove CONF_NAME in config entry * Revert config entry version from 4 back to 3 * Add data_description for address in strings.json * Use config entry title as coordinator name * Use constant as mock config entry title
home-assistant · Feb 24, 2025 · 6047936 · 6047936
1 parent ec3f556
commit 6047936
Show file tree

Hide file tree

Showing 14 changed files with 118 additions and 123 deletions.
diff --git a/homeassistant/components/minecraft_server/config_flow.py b/homeassistant/components/minecraft_server/config_flow.py
@@ -8,10 +8,10 @@
 import voluptuous as vol
 
 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
-from homeassistant.const import CONF_ADDRESS, CONF_NAME, CONF_TYPE
+from homeassistant.const import CONF_ADDRESS, CONF_TYPE
 
 from .api import MinecraftServer, MinecraftServerAddressError, MinecraftServerType
-from .const import DEFAULT_NAME, DOMAIN
+from .const import DOMAIN
 
 DEFAULT_ADDRESS = "localhost:25565"
 
@@ -37,7 +37,6 @@ async def async_step_user(
 
             # Prepare config entry data.
             config_data = {
-                CONF_NAME: user_input[CONF_NAME],
                 CONF_ADDRESS: address,
             }
 
@@ -78,9 +77,6 @@ def _show_config_form(
             step_id="user",
             data_schema=vol.Schema(
                 {
-                    vol.Required(
-                        CONF_NAME, default=user_input.get(CONF_NAME, DEFAULT_NAME)
-                    ): str,
                     vol.Required(
                         CONF_ADDRESS,
                         default=user_input.get(CONF_ADDRESS, DEFAULT_ADDRESS),

diff --git a/homeassistant/components/minecraft_server/const.py b/homeassistant/components/minecraft_server/const.py
@@ -1,7 +1,5 @@
 """Constants for the Minecraft Server integration."""
 
-DEFAULT_NAME = "Minecraft Server"
-
 DOMAIN = "minecraft_server"
 
 KEY_LATENCY = "latency"

diff --git a/homeassistant/components/minecraft_server/coordinator.py b/homeassistant/components/minecraft_server/coordinator.py
@@ -6,7 +6,7 @@
 import logging
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import CONF_ADDRESS, CONF_NAME, CONF_TYPE
+from homeassistant.const import CONF_ADDRESS, CONF_TYPE
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryNotReady
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
@@ -42,7 +42,7 @@ def __init__(
 
         super().__init__(
             hass=hass,
-            name=config_entry.data[CONF_NAME],
+            name=config_entry.title,
             config_entry=config_entry,
             logger=_LOGGER,
             update_interval=SCAN_INTERVAL,

diff --git a/homeassistant/components/minecraft_server/diagnostics.py b/homeassistant/components/minecraft_server/diagnostics.py
@@ -5,12 +5,12 @@
 from typing import Any
 
 from homeassistant.components.diagnostics import async_redact_data
-from homeassistant.const import CONF_ADDRESS, CONF_NAME
+from homeassistant.const import CONF_ADDRESS
 from homeassistant.core import HomeAssistant
 
 from .coordinator import MinecraftServerConfigEntry
 
-TO_REDACT: Iterable[Any] = {CONF_ADDRESS, CONF_NAME, "players_list"}
+TO_REDACT: Iterable[Any] = {CONF_ADDRESS, "players_list"}
 
 
 async def async_get_config_entry_diagnostics(

diff --git a/homeassistant/components/minecraft_server/quality_scale.yaml b/homeassistant/components/minecraft_server/quality_scale.yaml
@@ -6,9 +6,7 @@ rules:
   appropriate-polling: done
   brands: done
   common-modules: done
-  config-flow:
-    status: todo
-    comment: Check removal and replacement of name in config flow with the title (server address).
+  config-flow: done
   config-flow-test-coverage:
     status: todo
     comment: |

diff --git a/homeassistant/components/minecraft_server/strings.json b/homeassistant/components/minecraft_server/strings.json
@@ -2,12 +2,14 @@
   "config": {
     "step": {
       "user": {
-        "title": "Link your Minecraft Server",
-        "description": "Set up your Minecraft Server instance to allow monitoring.",
         "data": {
-          "name": "[%key:common::config_flow::data::name%]",
           "address": "Server address"
-        }
+        },
+        "data_description": {
+          "address": "The hostname, IP address or SRV record of your Minecraft server, optionally including the port."
+        },
+        "title": "Link your Minecraft Server",
+        "description": "Set up your Minecraft Server instance to allow monitoring."
       }
     },
     "abort": {

diff --git a/tests/components/minecraft_server/conftest.py b/tests/components/minecraft_server/conftest.py
@@ -3,8 +3,8 @@
 import pytest
 
 from homeassistant.components.minecraft_server.api import MinecraftServerType
-from homeassistant.components.minecraft_server.const import DEFAULT_NAME, DOMAIN
-from homeassistant.const import CONF_ADDRESS, CONF_NAME, CONF_TYPE
+from homeassistant.components.minecraft_server.const import DOMAIN
+from homeassistant.const import CONF_ADDRESS, CONF_TYPE
 
 from .const import TEST_ADDRESS, TEST_CONFIG_ENTRY_ID
 
@@ -18,8 +18,8 @@ def java_mock_config_entry() -> MockConfigEntry:
         domain=DOMAIN,
         unique_id=None,
         entry_id=TEST_CONFIG_ENTRY_ID,
+        title=TEST_ADDRESS,
         data={
-            CONF_NAME: DEFAULT_NAME,
             CONF_ADDRESS: TEST_ADDRESS,
             CONF_TYPE: MinecraftServerType.JAVA_EDITION,
         },
@@ -34,8 +34,8 @@ def bedrock_mock_config_entry() -> MockConfigEntry:
         domain=DOMAIN,
         unique_id=None,
         entry_id=TEST_CONFIG_ENTRY_ID,
+        title=TEST_ADDRESS,
         data={
-            CONF_NAME: DEFAULT_NAME,
             CONF_ADDRESS: TEST_ADDRESS,
             CONF_TYPE: MinecraftServerType.BEDROCK_EDITION,
         },

diff --git a/tests/components/minecraft_server/snapshots/test_binary_sensor.ambr b/tests/components/minecraft_server/snapshots/test_binary_sensor.ambr
@@ -3,10 +3,10 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'connectivity',
-      'friendly_name': 'Minecraft Server Status',
+      'friendly_name': 'mc.dummyserver.com:25566 Status',
     }),
     'context': <ANY>,
-    'entity_id': 'binary_sensor.minecraft_server_status',
+    'entity_id': 'binary_sensor.mc_dummyserver_com_25566_status',
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
@@ -17,10 +17,10 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'connectivity',
-      'friendly_name': 'Minecraft Server Status',
+      'friendly_name': 'mc.dummyserver.com:25566 Status',
     }),
     'context': <ANY>,
-    'entity_id': 'binary_sensor.minecraft_server_status',
+    'entity_id': 'binary_sensor.mc_dummyserver_com_25566_status',
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
@@ -31,10 +31,10 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'connectivity',
-      'friendly_name': 'Minecraft Server Status',
+      'friendly_name': 'mc.dummyserver.com:25566 Status',
     }),
     'context': <ANY>,
-    'entity_id': 'binary_sensor.minecraft_server_status',
+    'entity_id': 'binary_sensor.mc_dummyserver_com_25566_status',
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,
@@ -45,10 +45,10 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'connectivity',
-      'friendly_name': 'Minecraft Server Status',
+      'friendly_name': 'mc.dummyserver.com:25566 Status',
     }),
     'context': <ANY>,
-    'entity_id': 'binary_sensor.minecraft_server_status',
+    'entity_id': 'binary_sensor.mc_dummyserver_com_25566_status',
     'last_changed': <ANY>,
     'last_reported': <ANY>,
     'last_updated': <ANY>,

diff --git a/tests/components/minecraft_server/snapshots/test_diagnostics.ambr b/tests/components/minecraft_server/snapshots/test_diagnostics.ambr
@@ -8,7 +8,6 @@
     }),
     'config_entry_data': dict({
       'address': '**REDACTED**',
-      'name': '**REDACTED**',
       'type': 'Bedrock Edition',
     }),
     'config_entry_options': dict({
@@ -36,7 +35,6 @@
     }),
     'config_entry_data': dict({
       'address': '**REDACTED**',
-      'name': '**REDACTED**',
       'type': 'Java Edition',
     }),
     'config_entry_options': dict({