handle invalid plugin metadata gracefully

Author: zouyonghe

scripts/validate_plugins/run.py

@@ -24,6 +24,11 @@
 
 REQUIRED_METADATA_FIELDS = ("name", "desc", "version", "author")
 DEFAULT_CLONE_TIMEOUT = 120
+CONFLICT_MARKERS = ("<<<<<<<", "=======", ">>>>>>>")
+
+
+class MetadataLoadError(ValueError):
+    pass
 
 
 def build_result(
@@ -104,8 +109,17 @@ def _parse_simple_yaml(path: Path) -> dict:
 
 
 def load_metadata(path: Path) -> dict:
+    text = path.read_text(encoding="utf-8")
+    if any(marker in text for marker in CONFLICT_MARKERS):
+        raise MetadataLoadError(
+            "could not find expected ':' (merge conflict markers found in metadata.yaml)"
+        )
+
     if yaml is not None:
-        loaded = yaml.safe_load(path.read_text(encoding="utf-8"))
+        try:
+            loaded = yaml.safe_load(text)
+        except yaml.YAMLError as exc:
+            raise MetadataLoadError(str(exc)) from exc
         if isinstance(loaded, dict):
             return loaded
         return {}
@@ -121,7 +135,16 @@ def precheck_plugin_directory(plugin_dir: Path) -> dict:
             "message": "missing metadata.yaml",
         }
 
-    metadata = load_metadata(metadata_path)
+    try:
+        metadata = load_metadata(metadata_path)
+    except MetadataLoadError as exc:
+        return {
+            "ok": False,
+            "stage": "metadata",
+            "message": "invalid metadata.yaml",
+            "details": str(exc),
+        }
+
     missing = [
         field
         for field in REQUIRED_METADATA_FIELDS
@@ -367,6 +390,7 @@ def validate_plugin(
             ok=False,
             stage=precheck["stage"],
             message=precheck["message"],
+            details=precheck.get("details"),
         )
 
     plugin_dir_name = precheck["plugin_dir_name"]

tests/test_validate_plugins.py

@@ -215,6 +215,24 @@ def test_reports_missing_required_metadata_fields(self):
         self.assertIn("desc", result["message"])
         self.assertIn("version", result["message"])
 
+    def test_reports_invalid_metadata_yaml_without_raising(self):
+        module = load_validator_module()
+
+        with tempfile.TemporaryDirectory() as tmp_dir:
+            plugin_dir = Path(tmp_dir)
+            (plugin_dir / "metadata.yaml").write_text(
+                "name: demo_plugin\n<<<<<<< HEAD\ndesc: broken\n=======\ndesc: fixed\n>>>>>>> branch\n",
+                encoding="utf-8",
+            )
+            (plugin_dir / "main.py").write_text("print('hello')\n", encoding="utf-8")
+
+            result = module.precheck_plugin_directory(plugin_dir)
+
+        self.assertFalse(result["ok"])
+        self.assertEqual(result["stage"], "metadata")
+        self.assertIn("invalid metadata.yaml", result["message"])
+        self.assertIn("could not find expected ':'", result["details"])
+
 
 class WorkerCommandTests(unittest.TestCase):
     def test_build_worker_command_contains_required_arguments(self):