mirror of
https://github.com/codestable/CodeStable.git
synced 2026-09-19 09:03:09 +08:00
Wyatt Fang
544 lines
19 KiB
Python
544 lines
19 KiB
Python
from __future__ import annotations
|
|
|
|
import importlib.util
|
|
import json
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
|
|
MODULE_PATH = Path(__file__).resolve().parents[1] / "tools/check-plugin-package.py"
|
|
|
|
|
|
def load_checker():
|
|
spec = importlib.util.spec_from_file_location("check_plugin_package", MODULE_PATH)
|
|
assert spec and spec.loader
|
|
module = importlib.util.module_from_spec(spec)
|
|
sys.modules[spec.name] = module
|
|
spec.loader.exec_module(module)
|
|
return module
|
|
|
|
|
|
checker = load_checker()
|
|
|
|
|
|
def write_json(path: Path, payload: object) -> None:
|
|
path.parent.mkdir(parents=True, exist_ok=True)
|
|
path.write_text(json.dumps(payload, indent=2) + "\n", encoding="utf-8")
|
|
|
|
|
|
def init_git(repo: Path) -> None:
|
|
subprocess.run(["git", "init", "-b", "main"], cwd=repo, check=True, stdout=subprocess.PIPE)
|
|
|
|
|
|
def make_repo(tmp_path: Path) -> Path:
|
|
repo = tmp_path / "repo"
|
|
repo.mkdir()
|
|
init_git(repo)
|
|
(repo / "VERSION").write_text("0.1.0\n", encoding="utf-8")
|
|
(repo / "plugins/codestable/skills/cs-onboard").mkdir(parents=True)
|
|
(repo / "plugins/codestable/skills/cs-onboard/VERSION").write_text("0.1.0\n", encoding="utf-8")
|
|
(repo / "CHANGELOG.md").write_text("# Changelog\n\n## 0.1.0\n\n- Initial plugin package.\n", encoding="utf-8")
|
|
(repo / ".gitignore").write_text(
|
|
"/.claude/\n"
|
|
"/dist/\n"
|
|
"__pycache__\n"
|
|
"*.pyc\n"
|
|
".DS_Store\n",
|
|
encoding="utf-8",
|
|
)
|
|
write_json(
|
|
repo / ".agents/plugins/marketplace.json",
|
|
{
|
|
"name": "codestable",
|
|
"plugins": [
|
|
{
|
|
"name": "codestable",
|
|
"version": "0.1.0",
|
|
"source": {"source": "local", "path": "./plugins/codestable"},
|
|
"policy": {"installation": "AVAILABLE", "authentication": "ON_INSTALL"},
|
|
"category": "development",
|
|
"interface": {"displayName": "CodeStable"},
|
|
}
|
|
]
|
|
},
|
|
)
|
|
write_json(
|
|
repo / ".claude-plugin/marketplace.json",
|
|
{
|
|
"name": "codestable",
|
|
"description": "CodeStable AI coding workflow skills.",
|
|
"owner": {"name": "CodeStable"},
|
|
"plugins": [{"name": "codestable", "version": "0.1.0", "source": "./plugins/codestable"}],
|
|
},
|
|
)
|
|
write_json(
|
|
repo / "plugins/codestable/.codex-plugin/plugin.json",
|
|
{
|
|
"name": "codestable",
|
|
"version": "0.1.0",
|
|
"description": "CodeStable AI coding workflow skills.",
|
|
"author": {"name": "CodeStable"},
|
|
"skills": "./skills/",
|
|
"interface": {
|
|
"displayName": "CodeStable",
|
|
"shortDescription": "Stable engineering workflows for AI coding.",
|
|
"longDescription": "Workflow skills for scoped AI-assisted software development.",
|
|
"developerName": "CodeStable",
|
|
"category": "development",
|
|
"capabilities": ["Interactive", "Write"],
|
|
"defaultPrompt": ["Use CodeStable to handle this software task."],
|
|
},
|
|
},
|
|
)
|
|
write_json(
|
|
repo / "plugins/codestable/.claude-plugin/plugin.json",
|
|
{"name": "codestable", "version": "0.1.0", "author": {"name": "CodeStable"}},
|
|
)
|
|
for skill in ["cs", "cs-feat", "cs-onboard"]:
|
|
skill_dir = repo / "plugins/codestable/skills" / skill
|
|
skill_dir.mkdir(parents=True, exist_ok=True)
|
|
(skill_dir / "SKILL.md").write_text(f"---\nname: {skill}\n---\n", encoding="utf-8")
|
|
for readme in ["README.md", "README.en.md"]:
|
|
(repo / readme).write_text(
|
|
"\n".join(
|
|
[
|
|
"codex plugin marketplace add codestable/CodeStable",
|
|
"codex plugin add codestable@codestable",
|
|
"/plugin marketplace add codestable/CodeStable",
|
|
"/plugin install codestable@codestable",
|
|
"npx skills@latest add codestable/CodeStable/plugins/codestable",
|
|
"",
|
|
]
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
for upgrade in ["UPGRADE.md", "UPGRADE.en.md"]:
|
|
(repo / upgrade).write_text(
|
|
"\n".join(
|
|
[
|
|
"codex plugin marketplace upgrade codestable",
|
|
"codex plugin add codestable@codestable",
|
|
"/plugin marketplace update",
|
|
"/plugin update codestable@codestable",
|
|
"npx skills@latest remove cs-old -g -y",
|
|
"npx skills@latest add codestable/CodeStable/plugins/codestable --skill '*' -g",
|
|
"",
|
|
]
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
return repo
|
|
|
|
|
|
def messages(findings: list[object]) -> list[str]:
|
|
return [finding.message for finding in findings]
|
|
|
|
|
|
def test_valid_plugin_package_passes(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
|
|
assert checker.check_repo(repo) == []
|
|
|
|
|
|
def test_skills_only_install_keeps_cs_entrypoints_without_agent_mcp(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
plugin = repo / "plugins/codestable"
|
|
|
|
assert not (plugin / ".mcp.json").exists()
|
|
assert not (plugin / "bin").exists()
|
|
assert (plugin / "skills/cs/SKILL.md").is_file()
|
|
assert (plugin / "skills/cs-feat/SKILL.md").is_file()
|
|
assert checker.check_repo(repo) == []
|
|
|
|
|
|
def test_source_plugin_must_remain_skills_only(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
write_json(repo / "plugins/codestable/.mcp.json", {"mcpServers": {"agent-runtime": {}}})
|
|
bin_dir = repo / "plugins/codestable/bin"
|
|
bin_dir.mkdir()
|
|
(bin_dir / "agent-runtime").write_text("binary placeholder", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
finding_messages = messages(findings)
|
|
|
|
assert any("source plugin must remain skills-only" in message for message in finding_messages)
|
|
assert any("source plugin must not contain bundled runtime binary" in message for message in finding_messages)
|
|
|
|
|
|
def test_source_plugin_manifests_must_not_register_agent_mcp(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
for relative in (
|
|
"plugins/codestable/.codex-plugin/plugin.json",
|
|
"plugins/codestable/.claude-plugin/plugin.json",
|
|
):
|
|
path = repo / relative
|
|
payload = json.loads(path.read_text(encoding="utf-8"))
|
|
payload["mcpServers"] = {"agent-runtime": {"command": "./bin/agent-runtime"}}
|
|
write_json(path, payload)
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert sum("source plugin manifest must remain skills-only" in message for message in messages(findings)) == 2
|
|
|
|
|
|
def test_missing_version_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "VERSION").unlink()
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert "VERSION is missing" in messages(findings)
|
|
|
|
|
|
def test_missing_changelog_version_section_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "CHANGELOG.md").write_text("# Changelog\n\n## 0.0.9\n\n- Older.\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("missing changelog section for 0.1.0" in message for message in messages(findings))
|
|
|
|
|
|
def test_invalid_manifest_contract_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
write_json(repo / "plugins/codestable/.codex-plugin/plugin.json", {"version": "0.1.0", "skills": "./bad/"})
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("skills must equal './skills/'" in message for message in messages(findings))
|
|
|
|
|
|
def test_codex_manifest_requires_ingestion_metadata(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
path = repo / "plugins/codestable/.codex-plugin/plugin.json"
|
|
manifest = json.loads(path.read_text(encoding="utf-8"))
|
|
manifest.pop("author")
|
|
manifest.pop("interface")
|
|
write_json(path, manifest)
|
|
|
|
finding_messages = messages(checker.check_repo(repo))
|
|
|
|
assert "author.name must equal 'CodeStable'" in finding_messages
|
|
assert "interface is required" in finding_messages
|
|
|
|
|
|
def test_codex_manifest_requires_complete_interface_metadata(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
path = repo / "plugins/codestable/.codex-plugin/plugin.json"
|
|
manifest = json.loads(path.read_text(encoding="utf-8"))
|
|
manifest["interface"] = {}
|
|
write_json(path, manifest)
|
|
|
|
finding_messages = messages(checker.check_repo(repo))
|
|
|
|
for field in (
|
|
"displayName",
|
|
"shortDescription",
|
|
"longDescription",
|
|
"developerName",
|
|
"category",
|
|
):
|
|
assert f"interface.{field} is required" in finding_messages
|
|
assert "interface.capabilities must be an array of strings" in finding_messages
|
|
assert "interface.defaultPrompt must be an array of strings" in finding_messages
|
|
|
|
|
|
def test_codex_catalog_contract_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
write_json(
|
|
repo / ".agents/plugins/marketplace.json",
|
|
{
|
|
"name": "wrong",
|
|
"plugins": [
|
|
{
|
|
"name": "codestable",
|
|
"version": "0.1.0",
|
|
"source": {"source": "local", "path": "./wrong"},
|
|
"policy": {"installation": "BLOCKED", "authentication": "NEVER"},
|
|
"category": "",
|
|
"interface": {},
|
|
}
|
|
]
|
|
},
|
|
)
|
|
|
|
findings = checker.check_repo(repo)
|
|
finding_messages = messages(findings)
|
|
|
|
assert "name must equal 'codestable'" in finding_messages
|
|
assert any("source must equal {'source': 'local', 'path': './plugins/codestable'}" in message for message in finding_messages)
|
|
assert any("policy.installation must equal 'AVAILABLE'" in message for message in finding_messages)
|
|
assert any("policy.authentication must equal 'ON_INSTALL'" in message for message in finding_messages)
|
|
assert "plugins.0.category is required" in finding_messages
|
|
assert "plugins.0.interface.displayName is required" in finding_messages
|
|
|
|
|
|
def test_claude_marketplace_source_contract_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
write_json(
|
|
repo / ".claude-plugin/marketplace.json",
|
|
{
|
|
"name": "wrong",
|
|
"description": "",
|
|
"owner": {},
|
|
"plugins": [{"name": "codestable", "version": "0.1.0", "source": "./wrong"}],
|
|
},
|
|
)
|
|
|
|
findings = checker.check_repo(repo)
|
|
finding_messages = messages(findings)
|
|
|
|
assert "name must equal 'codestable'" in finding_messages
|
|
assert "owner.name must equal 'CodeStable'" in finding_messages
|
|
assert any("description must equal" in message for message in finding_messages)
|
|
assert any("source must equal './plugins/codestable'" in message for message in finding_messages)
|
|
|
|
|
|
def test_manifest_version_mismatch_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
write_json(
|
|
repo / "plugins/codestable/.claude-plugin/plugin.json",
|
|
{"name": "codestable", "version": "0.2.0"},
|
|
)
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("version must equal VERSION" in message for message in messages(findings))
|
|
|
|
|
|
def test_standalone_skill_version_missing_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "plugins/codestable/skills/cs-onboard/VERSION").unlink()
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("standalone VERSION is missing" in message for message in messages(findings))
|
|
|
|
|
|
def test_standalone_skill_version_mismatch_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "plugins/codestable/skills/cs-onboard/VERSION").write_text("0.2.0\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("standalone VERSION must equal VERSION" in message for message in messages(findings))
|
|
|
|
|
|
def test_codex_marketplace_version_mismatch_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
marketplace = json.loads((repo / ".agents/plugins/marketplace.json").read_text(encoding="utf-8"))
|
|
marketplace["plugins"][0]["version"] = "0.2.0"
|
|
write_json(repo / ".agents/plugins/marketplace.json", marketplace)
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any(
|
|
finding.path == ".agents/plugins/marketplace.json" and "version must equal VERSION" in finding.message
|
|
for finding in findings
|
|
)
|
|
|
|
|
|
def test_root_cs_skill_residue_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
root_skill = repo / "cs-onboard"
|
|
root_skill.mkdir()
|
|
(root_skill / "SKILL.md").write_text("---\nname: cs-onboard\n---\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("root cs* skill entry" in message for message in messages(findings))
|
|
|
|
|
|
def test_root_standalone_skill_residue_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
root_skill = repo / "other-skill"
|
|
root_skill.mkdir()
|
|
(root_skill / "SKILL.md").write_text("---\nname: other-skill\n---\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("root standalone skill entry" in message for message in messages(findings))
|
|
|
|
|
|
def test_skill_reference_spelling_conflict_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
skill_dir = repo / "plugins/codestable/skills/cs-feat"
|
|
(skill_dir / "reference").mkdir()
|
|
(skill_dir / "references").mkdir()
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("must not contain both reference/ and references/" in message for message in messages(findings))
|
|
|
|
|
|
def test_skill_reference_directory_spelling_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
skill_dir = repo / "plugins/codestable/skills/cs-feat"
|
|
(skill_dir / "reference").mkdir()
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("must use references/, not reference/" in message for message in messages(findings))
|
|
|
|
|
|
def test_nested_references_directory_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
nested = repo / "plugins/codestable/skills/cs-feat/references/design/references"
|
|
nested.mkdir(parents=True)
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("nested references/ directories are not allowed" in message for message in messages(findings))
|
|
|
|
|
|
def test_non_cs_skill_and_generated_artifacts_fail(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
extra_skill = repo / "plugins/codestable/skills/other-skill"
|
|
extra_skill.mkdir()
|
|
(extra_skill / "SKILL.md").write_text("---\nname: other-skill\n---\n", encoding="utf-8")
|
|
cache_dir = repo / "plugins/codestable/__pycache__"
|
|
cache_dir.mkdir()
|
|
(cache_dir / "x.pyc").write_bytes(b"cache")
|
|
(repo / "plugins/codestable/.pytest_cache").mkdir()
|
|
(repo / "dist").mkdir()
|
|
|
|
findings = checker.check_repo(repo)
|
|
finding_messages = messages(findings)
|
|
|
|
assert any("non cs* skill" in message for message in finding_messages)
|
|
assert any("generated or cache artifact" in message for message in finding_messages)
|
|
assert any("temporary dist output" in message for message in finding_messages)
|
|
|
|
|
|
def test_ignored_install_asset_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / ".gitignore").write_text("plugins/\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any("install asset is ignored" in message for message in messages(findings))
|
|
|
|
|
|
def test_ignored_codestable_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / ".gitignore").write_text(".codestable/\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert ".codestable must not be ignored" in messages(findings)
|
|
|
|
|
|
def test_readme_install_commands_stay_current(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "README.md").write_text("codex plugin install codestable\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
finding_messages = messages(findings)
|
|
|
|
assert "obsolete documented command: codex plugin install codestable" in finding_messages
|
|
assert any("missing documented command: codex plugin add codestable@codestable" in message for message in finding_messages)
|
|
|
|
|
|
def test_upgrade_rejects_unqualified_claude_update_command(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "UPGRADE.md").write_text("/plugin update codestable\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
finding_messages = messages(findings)
|
|
|
|
assert "obsolete documented command: /plugin update codestable" in finding_messages
|
|
assert any("missing documented command: /plugin update codestable@codestable" in message for message in finding_messages)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"filename",
|
|
("README.md", "README.en.md", "UPGRADE.md", "UPGRADE.en.md"),
|
|
)
|
|
def test_public_command_docs_reject_unsafe_bare_skills_update(
|
|
tmp_path: Path, filename: str
|
|
) -> None:
|
|
repo = make_repo(tmp_path)
|
|
path = repo / filename
|
|
path.write_text(
|
|
path.read_text(encoding="utf-8") + "npx skills@latest update\n",
|
|
encoding="utf-8",
|
|
)
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any(
|
|
finding.path == filename
|
|
and finding.message == "unsafe documented command: npx skills@latest update"
|
|
for finding in findings
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("command", "message"),
|
|
(
|
|
(
|
|
"npx skills@latest update --all",
|
|
"unsafe documented command: npx skills@latest update",
|
|
),
|
|
(
|
|
"/plugin update codestable --force",
|
|
"obsolete documented command: /plugin update codestable",
|
|
),
|
|
),
|
|
)
|
|
def test_command_docs_reject_unsafe_update_variants(
|
|
tmp_path: Path, command: str, message: str
|
|
) -> None:
|
|
repo = make_repo(tmp_path)
|
|
path = repo / "UPGRADE.md"
|
|
path.write_text(path.read_text(encoding="utf-8") + command + "\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any(
|
|
finding.path == "UPGRADE.md" and finding.message == message
|
|
for finding in findings
|
|
)
|
|
|
|
|
|
def test_missing_upgrade_doc_fails(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
(repo / "UPGRADE.md").unlink()
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any(finding.path == "UPGRADE.md" and "file is missing" in finding.message for finding in findings)
|
|
|
|
|
|
def test_upgrade_commands_do_not_count_when_only_present_in_readme(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
upgrade = (repo / "UPGRADE.md").read_text(encoding="utf-8")
|
|
readme = repo / "README.md"
|
|
readme.write_text(readme.read_text(encoding="utf-8") + upgrade, encoding="utf-8")
|
|
(repo / "UPGRADE.md").write_text("# Upgrade\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any(
|
|
finding.path == "UPGRADE.md" and "missing documented command" in finding.message
|
|
for finding in findings
|
|
)
|
|
|
|
|
|
def test_install_commands_do_not_count_when_only_present_in_upgrade(tmp_path: Path) -> None:
|
|
repo = make_repo(tmp_path)
|
|
readme = (repo / "README.md").read_text(encoding="utf-8")
|
|
upgrade = repo / "UPGRADE.md"
|
|
upgrade.write_text(upgrade.read_text(encoding="utf-8") + readme, encoding="utf-8")
|
|
(repo / "README.md").write_text("# CodeStable\n", encoding="utf-8")
|
|
|
|
findings = checker.check_repo(repo)
|
|
|
|
assert any(
|
|
finding.path == "README.md" and "missing documented command" in finding.message
|
|
for finding in findings
|
|
)
|