Replace name and friendly name in full adopted configs (#4456)

esphome/components/dashboard_import/__init__.py

@@ -2,8 +2,10 @@ import base64
 import secrets
 from pathlib import Path
 from typing import Optional
+import re
 
 import requests
+from ruamel.yaml import YAML
 
 import esphome.codegen as cg
 import esphome.config_validation as cv
@@ -11,7 +13,6 @@ import esphome.final_validate as fv
 from esphome import git
 from esphome.components.packages import validate_source_shorthand
 from esphome.const import CONF_REF, CONF_WIFI, CONF_ESPHOME, CONF_PROJECT
-from esphome.wizard import wizard_file
 from esphome.yaml_util import dump
 
 dashboard_import_ns = cg.esphome_ns.namespace("dashboard_import")
@@ -94,75 +95,74 @@ def import_config(
     if p.exists():
         raise FileExistsError
 
-    if project_name == "esphome.web":
+    git_file = git.GitFile.from_shorthand(import_url)
-        if "esp32c3" in import_url:
-            board = "esp32-c3-devkitm-1"
-            platform = "ESP32"
-        elif "esp32s2" in import_url:
-            board = "esp32-s2-saola-1"
-            platform = "ESP32"
-        elif "esp32s3" in import_url:
-            board = "esp32-s3-devkitc-1"
-            platform = "ESP32"
-        elif "esp32" in import_url:
-            board = "esp32dev"
-            platform = "ESP32"
-        elif "esp8266" in import_url:
-            board = "esp01_1m"
-            platform = "ESP8266"
-        elif "pico-w" in import_url:
-            board = "pico-w"
-            platform = "RP2040"
 
-        kwargs = {
+    if git_file.query and "full_config" in git_file.query:
-            "name": name,
+        url = git_file.raw_url
-            "friendly_name": friendly_name,
+        try:
-            "platform": platform,
+            req = requests.get(url, timeout=30)
-            "board": board,
+            req.raise_for_status()
-            "ssid": "!secret wifi_ssid",
+        except requests.exceptions.RequestException as e:
-            "psk": "!secret wifi_password",
+            raise ValueError(f"Error while fetching {url}: {e}") from e
+
+        contents = req.text
+        yaml = YAML()
+        loaded_yaml = yaml.load(contents)
+        if (
+            "name_add_mac_suffix" in loaded_yaml["esphome"]
+            and loaded_yaml["esphome"]["name_add_mac_suffix"]
+        ):
+            loaded_yaml["esphome"]["name_add_mac_suffix"] = False
+            name_val = loaded_yaml["esphome"]["name"]
+            sub_pattern = re.compile(r"\$\{?([a-zA-Z-_]+)\}?")
+            if match := sub_pattern.match(name_val):
+                name_sub = match.group(1)
+                if name_sub in loaded_yaml["substitutions"]:
+                    loaded_yaml["substitutions"][name_sub] = name
+                else:
+                    raise ValueError(
+                        f"Name substitution {name_sub} not found in substitutions"
+                    )
+            else:
+                loaded_yaml["esphome"]["name"] = name
+            if friendly_name is not None:
+                friendly_name_val = loaded_yaml["esphome"]["friendly_name"]
+                if match := sub_pattern.match(friendly_name_val):
+                    friendly_name_sub = match.group(1)
+                    if friendly_name_sub in loaded_yaml["substitutions"]:
+                        loaded_yaml["substitutions"][friendly_name_sub] = friendly_name
+                    else:
+                        raise ValueError(
+                            f"Friendly name substitution {friendly_name_sub} not found in substitutions"
+                        )
+                else:
+                    loaded_yaml["esphome"]["friendly_name"] = friendly_name
+
+            with p.open("w", encoding="utf8") as f:
+                yaml.dump(loaded_yaml, f)
+        else:
+            with p.open("w", encoding="utf8") as f:
+                f.write(contents)
+
+    else:
+        substitutions = {"name": name}
+        esphome_core = {"name": "${name}", "name_add_mac_suffix": False}
+        if friendly_name:
+            substitutions["friendly_name"] = friendly_name
+            esphome_core["friendly_name"] = "${friendly_name}"
+        config = {
+            "substitutions": substitutions,
+            "packages": {project_name: import_url},
+            "esphome": esphome_core,
         }
         if encryption:
             noise_psk = secrets.token_bytes(32)
             key = base64.b64encode(noise_psk).decode()
-            kwargs["api_encryption_key"] = key
+            config["api"] = {"encryption": {"key": key}}
 
-        p.write_text(
+        output = dump(config)
-            wizard_file(**kwargs),
-            encoding="utf8",
-        )
-    else:
-        git_file = git.GitFile.from_shorthand(import_url)
 
-        if git_file.query and "full_config" in git_file.query:
+        if network == CONF_WIFI:
-            url = git_file.raw_url
+            output += WIFI_CONFIG
-            try:
-                req = requests.get(url, timeout=30)
-                req.raise_for_status()
-            except requests.exceptions.RequestException as e:
-                raise ValueError(f"Error while fetching {url}: {e}") from e
 
-            p.write_text(req.text, encoding="utf8")
+        p.write_text(output, encoding="utf8")
-
-        else:
-            substitutions = {"name": name}
-            esphome_core = {"name": "${name}", "name_add_mac_suffix": False}
-            if friendly_name:
-                substitutions["friendly_name"] = friendly_name
-                esphome_core["friendly_name"] = "${friendly_name}"
-            config = {
-                "substitutions": substitutions,
-                "packages": {project_name: import_url},
-                "esphome": esphome_core,
-            }
-            if encryption:
-                noise_psk = secrets.token_bytes(32)
-                key = base64.b64encode(noise_psk).decode()
-                config["api"] = {"encryption": {"key": key}}
-
-            output = dump(config)
-
-            if network == CONF_WIFI:
-                output += WIFI_CONFIG
-
-            p.write_text(output, encoding="utf8")

esphome/dashboard/web_server.py

@@ -516,7 +516,8 @@ class ImportRequestHandler(BaseHandler):
             self.set_status(500)
             self.write("File already exists")
             return
-        except ValueError:
+        except ValueError as e:
+            _LOGGER.error(e)
             self.set_status(422)
             self.write("Invalid package url")
             return

requirements.txt

@@ -16,6 +16,7 @@ esphome-dashboard==20231107.0
 aioesphomeapi==23.1.1
 zeroconf==0.131.0
 python-magic==0.4.27
+ruamel.yaml==0.18.6 # dashboard_import
 
 # esp-idf requires this, but doesn't bundle it by default
 # https://github.com/espressif/esp-idf/blob/220590d599e134d7a5e7f1e683cc4550349ffbf8/requirements.txt#L24