Handle malformed addon map entries gracefully (#6126)

* Handle missing type attribute in add-on map config

Handle missing type attribute in the add-on `map` configuration key.

* Make sure wrong volumes are cleared in any case

Also add warning when string mapping is rejected.

* Add unit tests

* Improve test coverage

Author: agners

supervisor/addons/validate.py

@@ -266,10 +266,23 @@ def _migrate(config: dict[str, Any]):
         volumes = []
         for entry in config.get(ATTR_MAP, []):
             if isinstance(entry, dict):
+                # Validate that dict entries have required 'type' field
+                if ATTR_TYPE not in entry:
+                    _LOGGER.warning(
+                        "Add-on config has invalid map entry missing 'type' field: %s. Skipping invalid entry for %s",
+                        entry,
+                        name,
+                    )
+                    continue
                 volumes.append(entry)
             if isinstance(entry, str):
                 result = RE_VOLUME.match(entry)
                 if not result:
+                    _LOGGER.warning(
+                        "Add-on config has invalid map entry: %s. Skipping invalid entry for %s",
+                        entry,
+                        name,
+                    )
                     continue
                 volumes.append(
                     {
@@ -278,8 +291,8 @@ def _migrate(config: dict[str, Any]):
                     }
                 )
 
-        if volumes:
-            config[ATTR_MAP] = volumes
+        # Always update config to clear potentially malformed ones
+        config[ATTR_MAP] = volumes
 
         # 2023-10 "config" became "homeassistant" so /config can be used for addon's public config
         if any(volume[ATTR_TYPE] == MappingType.CONFIG for volume in volumes):

tests/addons/test_config.py

@@ -140,6 +140,46 @@ def test_valid_map():
     vd.SCHEMA_ADDON_CONFIG(config)
 
 
+def test_malformed_map_entries():
+    """Test that malformed map entries are handled gracefully (issue #6124)."""
+    config = load_json_fixture("basic-addon-config.json")
+
+    # Test case 1: Empty dict in map (should be skipped with warning)
+    config["map"] = [{}]
+    valid_config = vd.SCHEMA_ADDON_CONFIG(config)
+    assert valid_config["map"] == []
+
+    # Test case 2: Dict missing required 'type' field (should be skipped with warning)
+    config["map"] = [{"read_only": False, "path": "/custom"}]
+    valid_config = vd.SCHEMA_ADDON_CONFIG(config)
+    assert valid_config["map"] == []
+
+    # Test case 3: Invalid string format that doesn't match regex
+    config["map"] = ["invalid_format", "not:a:valid:mapping", "share:invalid_mode"]
+    valid_config = vd.SCHEMA_ADDON_CONFIG(config)
+    assert valid_config["map"] == []
+
+    # Test case 4: Mix of valid and invalid entries (invalid should be filtered out)
+    config["map"] = [
+        "share:rw",  # Valid string format
+        "invalid_string",  # Invalid string format
+        {},  # Invalid empty dict
+        {"type": "config", "read_only": True},  # Valid dict format
+        {"read_only": False},  # Invalid - missing type
+    ]
+    valid_config = vd.SCHEMA_ADDON_CONFIG(config)
+    # Should only keep the valid entries
+    assert len(valid_config["map"]) == 2
+    assert any(entry["type"] == "share" for entry in valid_config["map"])
+    assert any(entry["type"] == "config" for entry in valid_config["map"])
+
+    # Test case 5: The specific case from the UplandJacob repo (malformed YAML format)
+    # This simulates what YAML "- addon_config: rw" creates
+    config["map"] = [{"addon_config": "rw"}]  # Wrong structure, missing 'type' key
+    valid_config = vd.SCHEMA_ADDON_CONFIG(config)
+    assert valid_config["map"] == []
+
+
 def test_valid_basic_build():
     """Validate basic build config."""
     config = load_json_fixture("basic-build-config.json")