Files
diagram-design/scripts/verify-plugin-package.py
T
Cathryn LaveryandGitHub 8154ec97bf feat(factory): add native Droid plugin packaging (#120)
* feat(factory): add native Droid plugin packaging

* test(factory): guard documented install contract

* fix(factory): enforce install command order
2026-08-19 17:46:46 -07:00

320 lines
12 KiB
Python
Executable File

#!/usr/bin/env python3
"""Verify synchronized version bumps and native marketplace packaging."""
from __future__ import annotations
import json
import re
import subprocess
import sys
from pathlib import Path
from typing import Any
ROOT = Path(__file__).resolve().parent.parent
PLUGIN_NAME = "diagram-design"
MANIFEST_PATHS = {
"Claude": Path(".claude-plugin/plugin.json"),
"Codex": Path(".codex-plugin/plugin.json"),
"Factory": Path(".factory-plugin/plugin.json"),
}
CLAUDE_MARKETPLACE = Path(".claude-plugin/marketplace.json")
CODEX_MARKETPLACE = Path(".agents/plugins/marketplace.json")
FACTORY_MARKETPLACE = Path(".factory-plugin/marketplace.json")
SHARED_MANIFEST_FIELDS = (
"name",
"description",
"version",
"author",
"homepage",
"repository",
"license",
"keywords",
)
SEMVER = re.compile(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$")
def load_json(path: Path, errors: list[str]) -> dict[str, Any] | None:
try:
payload = json.loads(path.read_text(encoding="utf-8"))
except OSError as exc:
errors.append(f"could not read {path}: {exc}")
return None
except json.JSONDecodeError as exc:
errors.append(f"{path} is not valid JSON: {exc}")
return None
if not isinstance(payload, dict):
errors.append(f"{path} must contain a JSON object")
return None
return payload
def base_path_exists(root: Path, base_ref: str, relative: Path) -> bool:
result = subprocess.run(
["git", "cat-file", "-e", f"{base_ref}:{relative.as_posix()}"],
cwd=root,
check=False,
capture_output=True,
text=True,
)
return result.returncode == 0
def load_base_json(
root: Path, base_ref: str, relative: Path, errors: list[str]
) -> dict[str, Any] | None:
result = subprocess.run(
["git", "show", f"{base_ref}:{relative.as_posix()}"],
cwd=root,
check=False,
capture_output=True,
text=True,
)
if result.returncode != 0:
detail = result.stderr.strip() or "file not found"
errors.append(f"could not read {relative} from {base_ref}: {detail}")
return None
try:
payload = json.loads(result.stdout)
except json.JSONDecodeError as exc:
errors.append(f"{relative} at {base_ref} is not valid JSON: {exc}")
return None
if not isinstance(payload, dict):
errors.append(f"{relative} at {base_ref} must contain a JSON object")
return None
return payload
def parse_semver(value: object, label: str, errors: list[str]) -> tuple[int, int, int] | None:
if not isinstance(value, str) or (match := SEMVER.fullmatch(value)) is None:
errors.append(
f"{label} version must be strict MAJOR.MINOR.PATCH semver; got {value!r}"
)
return None
return tuple(int(part) for part in match.groups()) # type: ignore[return-value]
def resolve_local_path(root: Path, raw_path: object, label: str, errors: list[str]) -> Path | None:
if not isinstance(raw_path, str) or not raw_path:
errors.append(f"{label} must be a non-empty local path string")
return None
if raw_path not in {".", "./"} and not raw_path.startswith("./"):
errors.append(f"{label} must be '.' or start with './'; got {raw_path!r}")
return None
relative = raw_path[2:] if raw_path.startswith("./") else ""
relative_path = Path(relative)
if relative_path.is_absolute() or ".." in relative_path.parts:
errors.append(f"{label} must stay inside the marketplace root; got {raw_path!r}")
return None
resolved_root = root.resolve()
resolved = (root / relative_path).resolve()
if not resolved.is_relative_to(resolved_root):
errors.append(f"{label} resolves outside the marketplace root: {raw_path!r}")
return None
if not resolved.is_dir():
errors.append(f"{label} target does not exist or is not a directory: {raw_path!r}")
return None
return resolved
def find_plugin_entry(
marketplace: dict[str, Any], label: str, errors: list[str]
) -> dict[str, Any] | None:
if marketplace.get("name") != PLUGIN_NAME:
errors.append(
f"{label} marketplace name must remain {PLUGIN_NAME!r}; "
f"got {marketplace.get('name')!r}"
)
plugins = marketplace.get("plugins")
if not isinstance(plugins, list):
errors.append(f"{label} marketplace plugins must be an array")
return None
matches = [entry for entry in plugins if isinstance(entry, dict) and entry.get("name") == PLUGIN_NAME]
if len(matches) != 1:
errors.append(
f"{label} marketplace must contain exactly one {PLUGIN_NAME!r} entry; "
f"found {len(matches)}"
)
return None
return matches[0]
def verify_versions(
root: Path,
base_ref: str,
manifests: dict[str, dict[str, Any]],
errors: list[str],
) -> None:
current_versions = {label: payload.get("version") for label, payload in manifests.items()}
version_values = list(current_versions.values())
if any(version != version_values[0] for version in version_values[1:]):
rendered = ", ".join(f"{label}={value!r}" for label, value in current_versions.items())
errors.append(f"plugin manifest versions must match: {rendered}")
base_check = subprocess.run(
["git", "rev-parse", "--verify", f"{base_ref}^{{commit}}"],
cwd=root,
check=False,
capture_output=True,
text=True,
)
if base_check.returncode != 0:
detail = base_check.stderr.strip() or "not a commit"
errors.append(f"could not resolve base ref {base_ref!r}: {detail}")
return
base_manifest_count = 0
for label, relative in MANIFEST_PATHS.items():
current = parse_semver(current_versions.get(label), f"current {label}", errors)
if not base_path_exists(root, base_ref, relative):
continue
base_manifest_count += 1
base_manifest = load_base_json(root, base_ref, relative, errors)
if base_manifest is None:
continue
base = parse_semver(base_manifest.get("version"), f"{label} at {base_ref}", errors)
if current is not None and base is not None and current <= base:
errors.append(
f"{label} manifest version must increase relative to {base_ref}: "
f"{base_manifest.get('version')} -> {current_versions.get(label)}"
)
if base_manifest_count == 0:
errors.append(
f"no synchronized plugin manifest exists at {base_ref}; "
"cannot establish that the package version advanced"
)
def verify_manifest_identity(manifests: dict[str, dict[str, Any]], errors: list[str]) -> None:
for label, payload in manifests.items():
if payload.get("name") != PLUGIN_NAME:
errors.append(
f"{label} manifest name must remain {PLUGIN_NAME!r}; got {payload.get('name')!r}"
)
reference_label = next(iter(MANIFEST_PATHS))
reference = manifests[reference_label]
for label, payload in manifests.items():
if label == reference_label:
continue
for field in SHARED_MANIFEST_FIELDS:
if payload.get(field) != reference.get(field):
errors.append(
f"{label} manifest {field!r} must match {reference_label}; "
f"got {payload.get(field)!r}"
)
def verify_marketplaces(root: Path, errors: list[str]) -> None:
claude_marketplace = load_json(root / CLAUDE_MARKETPLACE, errors)
codex_marketplace = load_json(root / CODEX_MARKETPLACE, errors)
factory_marketplace = load_json(root / FACTORY_MARKETPLACE, errors)
if (
claude_marketplace is None
or codex_marketplace is None
or factory_marketplace is None
):
return
claude_entry = find_plugin_entry(claude_marketplace, "Claude", errors)
codex_entry = find_plugin_entry(codex_marketplace, "Codex", errors)
factory_entry = find_plugin_entry(factory_marketplace, "Factory", errors)
if claude_entry is None or codex_entry is None or factory_entry is None:
return
claude_root = resolve_local_path(root, claude_entry.get("source"), "Claude plugin source", errors)
factory_root = resolve_local_path(
root, factory_entry.get("source"), "Factory plugin source", errors
)
codex_source = codex_entry.get("source")
if not isinstance(codex_source, dict) or codex_source.get("source") != "local":
errors.append("Codex plugin source must be an object with source='local'")
codex_root = None
else:
codex_root = resolve_local_path(root, codex_source.get("path"), "Codex plugin source.path", errors)
policy = codex_entry.get("policy")
if not isinstance(policy, dict):
errors.append("Codex marketplace entry must include a policy object")
else:
if policy.get("installation") != "AVAILABLE":
errors.append("Codex policy.installation must be 'AVAILABLE'")
if policy.get("authentication") != "ON_INSTALL":
errors.append("Codex policy.authentication must be 'ON_INSTALL'")
if not isinstance(codex_entry.get("category"), str) or not codex_entry.get("category"):
errors.append("Codex marketplace entry must include a category")
if claude_root is not None and not (claude_root / MANIFEST_PATHS["Claude"]).is_file():
errors.append("Claude marketplace target does not contain .claude-plugin/plugin.json")
if codex_root is not None and not (codex_root / MANIFEST_PATHS["Codex"]).is_file():
errors.append("Codex marketplace target does not contain .codex-plugin/plugin.json")
if factory_root is not None and not (factory_root / MANIFEST_PATHS["Factory"]).is_file():
errors.append("Factory marketplace target does not contain .factory-plugin/plugin.json")
plugin_roots = [
plugin_root
for plugin_root in (claude_root, codex_root, factory_root)
if plugin_root is not None
]
if plugin_roots and any(plugin_root != plugin_roots[0] for plugin_root in plugin_roots[1:]):
errors.append("Claude, Codex, and Factory marketplaces must package the same plugin root")
plugin_root = codex_root or claude_root or factory_root
if plugin_root is None:
return
skill = plugin_root / "skills" / PLUGIN_NAME / "SKILL.md"
if not skill.is_file():
errors.append(f"packaged skill is missing: {skill.relative_to(root)}")
commands = plugin_root / "commands"
if not commands.is_dir() or not any(commands.glob("*.md")):
errors.append("packaged commands are missing from the shared plugin root")
def verify_codex_skill_path(root: Path, codex_manifest: dict[str, Any], errors: list[str]) -> None:
skills_root = resolve_local_path(root, codex_manifest.get("skills"), "Codex manifest skills", errors)
if skills_root is None:
return
skill = skills_root / PLUGIN_NAME / "SKILL.md"
if not skill.is_file():
errors.append(f"Codex skills path does not contain {PLUGIN_NAME}/SKILL.md")
def verify_package(root: Path, base_ref: str) -> list[str]:
errors: list[str] = []
manifests: dict[str, dict[str, Any]] = {}
for label, relative in MANIFEST_PATHS.items():
payload = load_json(root / relative, errors)
if payload is not None:
manifests[label] = payload
if len(manifests) == len(MANIFEST_PATHS):
verify_versions(root, base_ref, manifests, errors)
verify_manifest_identity(manifests, errors)
verify_codex_skill_path(root, manifests["Codex"], errors)
verify_marketplaces(root, errors)
return errors
def main() -> int:
if len(sys.argv) != 2:
print(f"Usage: {Path(sys.argv[0]).name} <base-ref>", file=sys.stderr)
return 2
base_ref = sys.argv[1]
errors = verify_package(ROOT, base_ref)
if errors:
print("FAIL plugin package")
for error in errors:
print(f" - {error}")
return 1
versions = load_json(ROOT / MANIFEST_PATHS["Claude"], [])["version"]
print(
f"OK plugin package: Claude, Codex, and Factory {versions}, "
f"marketplace paths, and packaged skill"
)
return 0
if __name__ == "__main__":
raise SystemExit(main())