mirror of
https://github.com/github/spec-kit.git
synced 2026-07-04 04:45:43 +08:00
52c0a5f88f
* fix: resolve command references per integration type (dot vs hyphen) Replace hardcoded /speckit.<cmd> references in templates with __SPECKIT_COMMAND_<NAME>__ placeholders that are resolved at setup time based on the integration type: - Markdown/TOML/YAML agents: separator='.' → /speckit.plan - Skills agents: separator='-' → /speckit-plan Changes: - Add resolve_command_refs() static method to IntegrationBase - Add invoke_separator class attribute (. for base, - for skills) - Wire into process_template() as step 8 - Update _install_shared_infra() to process page templates - Replace /speckit.* in 5 command templates and 3 page templates - Add unit tests for resolve_command_refs (positive + negative) - Add integration tests verifying on-disk content for all agents - Add end-to-end CLI tests for Claude (skills) and Copilot (markdown) Fixes #2347 * review: use effective_invoke_separator() for Copilot skills mode Address PR review feedback: instead of bleeding _skills_mode knowledge into the CLI layer, add effective_invoke_separator() method to IntegrationBase that accepts parsed_options. CopilotIntegration overrides it to return "-" when skills mode is requested. The CLI layer simply asks the integration for its separator — no hasattr or _skills_mode coupling. Also adds tests for the new method on both base and Copilot, plus an end-to-end test for 'specify init --integration copilot --integration-options --skills' verifying page templates get hyphen refs. * fix: build_command_invocation preserves full suffix for extension commands Previously rsplit('.', 1)[-1] on 'speckit.git.commit' yielded just 'commit', producing /speckit.commit instead of /speckit.git.commit (or /speckit-git-commit for skills). Fix: strip only the 'speckit.' prefix when present, then join remaining segments with the appropriate separator. Updated in IntegrationBase, SkillsIntegration, and CopilotIntegration. Added tests for extension commands in build_command_invocation across all three. * fix: Copilot dispatch_command() preserves full extension command suffix dispatch_command() had the same rsplit('.', 1)[-1] bug as build_command_invocation() — speckit.git.commit would dispatch as /speckit-commit instead of /speckit-git-commit in skills mode, or --agent speckit.commit instead of speckit.git.commit in default mode.
404 lines
18 KiB
Python
404 lines
18 KiB
Python
"""Tests for ForgeIntegration."""
|
|
|
|
from specify_cli.integrations import get_integration
|
|
from specify_cli.integrations.manifest import IntegrationManifest
|
|
from specify_cli.integrations.forge import format_forge_command_name
|
|
|
|
|
|
class TestForgeCommandNameFormatter:
|
|
"""Test the centralized Forge command name formatter."""
|
|
|
|
def test_simple_name_without_prefix(self):
|
|
"""Test formatting a simple name without 'speckit.' prefix."""
|
|
assert format_forge_command_name("plan") == "speckit-plan"
|
|
assert format_forge_command_name("tasks") == "speckit-tasks"
|
|
assert format_forge_command_name("specify") == "speckit-specify"
|
|
|
|
def test_name_with_speckit_prefix(self):
|
|
"""Test formatting a name that already has 'speckit.' prefix."""
|
|
assert format_forge_command_name("speckit.plan") == "speckit-plan"
|
|
assert format_forge_command_name("speckit.tasks") == "speckit-tasks"
|
|
|
|
def test_extension_command_name(self):
|
|
"""Test formatting extension command names with dots."""
|
|
assert format_forge_command_name("speckit.my-extension.example") == "speckit-my-extension-example"
|
|
assert format_forge_command_name("my-extension.example") == "speckit-my-extension-example"
|
|
|
|
def test_complex_nested_name(self):
|
|
"""Test formatting deeply nested command names."""
|
|
assert format_forge_command_name("speckit.jira.sync-status") == "speckit-jira-sync-status"
|
|
assert format_forge_command_name("speckit.foo.bar.baz") == "speckit-foo-bar-baz"
|
|
|
|
def test_name_with_hyphens_preserved(self):
|
|
"""Test that existing hyphens are preserved."""
|
|
assert format_forge_command_name("my-extension") == "speckit-my-extension"
|
|
assert format_forge_command_name("speckit.my-ext.test-cmd") == "speckit-my-ext-test-cmd"
|
|
|
|
def test_alias_formatting(self):
|
|
"""Test formatting alias names."""
|
|
assert format_forge_command_name("speckit.my-extension.example-short") == "speckit-my-extension-example-short"
|
|
|
|
def test_idempotent_already_hyphenated(self):
|
|
"""Test that already-hyphenated names are returned unchanged (idempotent)."""
|
|
assert format_forge_command_name("speckit-plan") == "speckit-plan"
|
|
assert format_forge_command_name("speckit-my-extension-example") == "speckit-my-extension-example"
|
|
assert format_forge_command_name("speckit-jira-sync-status") == "speckit-jira-sync-status"
|
|
|
|
|
|
class TestForgeIntegration:
|
|
def test_forge_key_and_config(self):
|
|
forge = get_integration("forge")
|
|
assert forge is not None
|
|
assert forge.key == "forge"
|
|
assert forge.config["folder"] == ".forge/"
|
|
assert forge.config["commands_subdir"] == "commands"
|
|
assert forge.config["requires_cli"] is True
|
|
assert forge.registrar_config["args"] == "{{parameters}}"
|
|
assert forge.registrar_config["extension"] == ".md"
|
|
assert forge.context_file == "AGENTS.md"
|
|
|
|
def test_command_filename_md(self):
|
|
forge = get_integration("forge")
|
|
assert forge.command_filename("plan") == "speckit.plan.md"
|
|
|
|
def test_setup_creates_md_files(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
created = forge.setup(tmp_path, m)
|
|
assert len(created) > 0
|
|
# Separate command files from scripts
|
|
command_files = [f for f in created if f.parent == tmp_path / ".forge" / "commands"]
|
|
assert len(command_files) > 0
|
|
for f in command_files:
|
|
assert f.name.endswith(".md")
|
|
|
|
def test_setup_upserts_context_section(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
ctx_path = tmp_path / forge.context_file
|
|
assert ctx_path.exists()
|
|
content = ctx_path.read_text(encoding="utf-8")
|
|
assert "<!-- SPECKIT START -->" in content
|
|
assert "<!-- SPECKIT END -->" in content
|
|
|
|
def test_all_created_files_tracked_in_manifest(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
created = forge.setup(tmp_path, m)
|
|
for f in created:
|
|
rel = f.resolve().relative_to(tmp_path.resolve()).as_posix()
|
|
assert rel in m.files, f"Created file {rel} not tracked in manifest"
|
|
|
|
def test_install_uninstall_roundtrip(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
created = forge.install(tmp_path, m)
|
|
assert len(created) > 0
|
|
m.save()
|
|
for f in created:
|
|
assert f.exists()
|
|
removed, skipped = forge.uninstall(tmp_path, m)
|
|
assert len(removed) == len(created)
|
|
assert skipped == []
|
|
|
|
def test_modified_file_survives_uninstall(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
created = forge.install(tmp_path, m)
|
|
m.save()
|
|
# Modify a command file (not a script)
|
|
command_files = [f for f in created if f.parent == tmp_path / ".forge" / "commands"]
|
|
modified_file = command_files[0]
|
|
modified_file.write_text("user modified this", encoding="utf-8")
|
|
removed, skipped = forge.uninstall(tmp_path, m)
|
|
assert modified_file.exists()
|
|
assert modified_file in skipped
|
|
|
|
def test_directory_structure(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
commands_dir = tmp_path / ".forge" / "commands"
|
|
assert commands_dir.is_dir()
|
|
|
|
# Derive expected command names from the Forge command templates so the test
|
|
# stays in sync if templates are added/removed.
|
|
templates = forge.list_command_templates()
|
|
expected_commands = {t.stem for t in templates}
|
|
assert len(expected_commands) > 0, "No command templates found"
|
|
|
|
# Check generated files match templates
|
|
command_files = sorted(commands_dir.glob("speckit.*.md"))
|
|
assert len(command_files) == len(expected_commands)
|
|
actual_commands = {f.name.removeprefix("speckit.").removesuffix(".md") for f in command_files}
|
|
assert actual_commands == expected_commands
|
|
|
|
def test_templates_are_processed(self, tmp_path):
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
commands_dir = tmp_path / ".forge" / "commands"
|
|
for cmd_file in commands_dir.glob("speckit.*.md"):
|
|
content = cmd_file.read_text(encoding="utf-8")
|
|
# Check standard replacements
|
|
assert "{SCRIPT}" not in content, f"{cmd_file.name} has unprocessed {{SCRIPT}}"
|
|
assert "__AGENT__" not in content, f"{cmd_file.name} has unprocessed __AGENT__"
|
|
assert "{ARGS}" not in content, f"{cmd_file.name} has unprocessed {{ARGS}}"
|
|
assert "__SPECKIT_COMMAND_" not in content, f"{cmd_file.name} has unprocessed __SPECKIT_COMMAND_*__"
|
|
# Check Forge-specific: $ARGUMENTS should be replaced with {{parameters}}
|
|
assert "$ARGUMENTS" not in content, f"{cmd_file.name} has unprocessed $ARGUMENTS"
|
|
# Frontmatter sections should be stripped
|
|
assert "\nscripts:\n" not in content
|
|
|
|
def test_plan_references_correct_context_file(self, tmp_path):
|
|
"""The generated plan command must reference forge's context file."""
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
plan_file = tmp_path / ".forge" / "commands" / "speckit.plan.md"
|
|
assert plan_file.exists()
|
|
content = plan_file.read_text(encoding="utf-8")
|
|
assert forge.context_file in content, (
|
|
f"Plan command should reference {forge.context_file!r}"
|
|
)
|
|
assert "__CONTEXT_FILE__" not in content
|
|
|
|
def test_forge_specific_transformations(self, tmp_path):
|
|
"""Test Forge-specific processing: name injection and handoffs stripping."""
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
from specify_cli.agents import CommandRegistrar
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
commands_dir = tmp_path / ".forge" / "commands"
|
|
|
|
registrar = CommandRegistrar()
|
|
for cmd_file in commands_dir.glob("speckit.*.md"):
|
|
content = cmd_file.read_text(encoding="utf-8")
|
|
frontmatter, _ = registrar.parse_frontmatter(content)
|
|
|
|
# Check that name field is injected in frontmatter
|
|
assert "name" in frontmatter, f"{cmd_file.name} missing injected 'name' field in frontmatter"
|
|
|
|
# Check that handoffs frontmatter key is stripped
|
|
assert "handoffs" not in frontmatter, f"{cmd_file.name} has unstripped 'handoffs' key in frontmatter"
|
|
|
|
def test_uses_parameters_placeholder(self, tmp_path):
|
|
"""Verify Forge replaces $ARGUMENTS with {{parameters}} in generated files."""
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
forge = ForgeIntegration()
|
|
|
|
# The registrar_config should specify {{parameters}}
|
|
assert forge.registrar_config["args"] == "{{parameters}}"
|
|
|
|
# Generate files and verify $ARGUMENTS is replaced with {{parameters}}
|
|
from specify_cli.integrations.manifest import IntegrationManifest
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
commands_dir = tmp_path / ".forge" / "commands"
|
|
|
|
# Check all generated command files
|
|
for cmd_file in commands_dir.glob("speckit.*.md"):
|
|
content = cmd_file.read_text(encoding="utf-8")
|
|
# $ARGUMENTS should be replaced with {{parameters}}
|
|
assert "$ARGUMENTS" not in content, (
|
|
f"{cmd_file.name} still contains $ARGUMENTS - it should be replaced with {{{{parameters}}}}"
|
|
)
|
|
# At least some files should have {{parameters}} (those with user input sections)
|
|
# We'll check the checklist file specifically as it has a User Input section
|
|
|
|
# Verify checklist specifically has {{parameters}} in the User Input section
|
|
checklist = commands_dir / "speckit.checklist.md"
|
|
if checklist.exists():
|
|
content = checklist.read_text(encoding="utf-8")
|
|
assert "{{parameters}}" in content, (
|
|
"checklist should contain {{parameters}} in User Input section"
|
|
)
|
|
|
|
def test_name_field_uses_hyphenated_format(self, tmp_path):
|
|
"""Verify that injected name fields use hyphenated format (speckit-plan, not speckit.plan)."""
|
|
from specify_cli.integrations.forge import ForgeIntegration
|
|
from specify_cli.agents import CommandRegistrar
|
|
forge = ForgeIntegration()
|
|
m = IntegrationManifest("forge", tmp_path)
|
|
forge.setup(tmp_path, m)
|
|
commands_dir = tmp_path / ".forge" / "commands"
|
|
|
|
# Check that name fields use hyphenated format
|
|
registrar = CommandRegistrar()
|
|
for cmd_file in commands_dir.glob("speckit.*.md"):
|
|
content = cmd_file.read_text(encoding="utf-8")
|
|
# Extract the name field from frontmatter using the parser
|
|
frontmatter, _ = registrar.parse_frontmatter(content)
|
|
assert "name" in frontmatter, (
|
|
f"{cmd_file.name} missing injected 'name' field in frontmatter"
|
|
)
|
|
name_value = frontmatter["name"]
|
|
# Name should use hyphens, not dots
|
|
assert "." not in name_value, (
|
|
f"{cmd_file.name} has name field with dots: {name_value} "
|
|
f"(should use hyphens for Forge/ZSH compatibility)"
|
|
)
|
|
assert name_value.startswith("speckit-"), (
|
|
f"{cmd_file.name} name field should start with 'speckit-': {name_value}"
|
|
)
|
|
|
|
|
|
class TestForgeCommandRegistrar:
|
|
"""Test CommandRegistrar's Forge-specific name formatting."""
|
|
|
|
def test_registrar_formats_extension_command_names_for_forge(self, tmp_path):
|
|
"""Verify CommandRegistrar converts dot notation to hyphens for Forge."""
|
|
from specify_cli.agents import CommandRegistrar
|
|
|
|
# Create a mock extension command file
|
|
ext_dir = tmp_path / "extension"
|
|
ext_dir.mkdir()
|
|
cmd_dir = ext_dir / "commands"
|
|
cmd_dir.mkdir()
|
|
|
|
# Create a test command with dot notation name
|
|
cmd_file = cmd_dir / "example.md"
|
|
cmd_file.write_text(
|
|
"---\n"
|
|
"description: Test extension command\n"
|
|
"---\n\n"
|
|
"Test content with $ARGUMENTS\n",
|
|
encoding="utf-8"
|
|
)
|
|
|
|
# Register with Forge
|
|
registrar = CommandRegistrar()
|
|
commands = [
|
|
{
|
|
"name": "speckit.my-extension.example",
|
|
"file": "commands/example.md"
|
|
}
|
|
]
|
|
|
|
registered = registrar.register_commands(
|
|
"forge",
|
|
commands,
|
|
"test-extension",
|
|
ext_dir,
|
|
tmp_path
|
|
)
|
|
|
|
# Verify registration succeeded
|
|
assert "speckit.my-extension.example" in registered
|
|
|
|
# Check the generated file has hyphenated name in frontmatter
|
|
forge_cmd = tmp_path / ".forge" / "commands" / "speckit.my-extension.example.md"
|
|
assert forge_cmd.exists()
|
|
|
|
content = forge_cmd.read_text(encoding="utf-8")
|
|
# Parse frontmatter to validate name field precisely
|
|
frontmatter, _ = registrar.parse_frontmatter(content)
|
|
assert "name" in frontmatter, "name field should be injected in frontmatter"
|
|
# Name field should use hyphens, not dots
|
|
assert frontmatter["name"] == "speckit-my-extension-example"
|
|
|
|
def test_registrar_formats_alias_names_for_forge(self, tmp_path):
|
|
"""Verify CommandRegistrar converts alias names to hyphens for Forge."""
|
|
from specify_cli.agents import CommandRegistrar
|
|
|
|
# Create a mock extension command file
|
|
ext_dir = tmp_path / "extension"
|
|
ext_dir.mkdir()
|
|
cmd_dir = ext_dir / "commands"
|
|
cmd_dir.mkdir()
|
|
|
|
cmd_file = cmd_dir / "example.md"
|
|
cmd_file.write_text(
|
|
"---\n"
|
|
"description: Test command with alias\n"
|
|
"---\n\n"
|
|
"Test content\n",
|
|
encoding="utf-8"
|
|
)
|
|
|
|
# Register with Forge including an alias
|
|
registrar = CommandRegistrar()
|
|
commands = [
|
|
{
|
|
"name": "speckit.my-extension.example",
|
|
"file": "commands/example.md",
|
|
"aliases": ["speckit.my-extension.ex"]
|
|
}
|
|
]
|
|
|
|
registrar.register_commands(
|
|
"forge",
|
|
commands,
|
|
"test-extension",
|
|
ext_dir,
|
|
tmp_path
|
|
)
|
|
|
|
# Check the alias file has hyphenated name in frontmatter
|
|
alias_file = tmp_path / ".forge" / "commands" / "speckit.my-extension.ex.md"
|
|
assert alias_file.exists()
|
|
|
|
content = alias_file.read_text(encoding="utf-8")
|
|
# Parse frontmatter to validate alias name field precisely
|
|
frontmatter, _ = registrar.parse_frontmatter(content)
|
|
assert "name" in frontmatter, "name field should be injected in alias frontmatter"
|
|
# Alias name field should also use hyphens
|
|
assert frontmatter["name"] == "speckit-my-extension-ex"
|
|
|
|
def test_registrar_does_not_affect_other_agents(self, tmp_path):
|
|
"""Verify format_name callback is Forge-specific and doesn't affect other agents."""
|
|
from specify_cli.agents import CommandRegistrar
|
|
|
|
# Create a mock extension command file
|
|
ext_dir = tmp_path / "extension"
|
|
ext_dir.mkdir()
|
|
cmd_dir = ext_dir / "commands"
|
|
cmd_dir.mkdir()
|
|
|
|
cmd_file = cmd_dir / "example.md"
|
|
cmd_file.write_text(
|
|
"---\n"
|
|
"description: Test command\n"
|
|
"---\n\n"
|
|
"Test content with $ARGUMENTS\n",
|
|
encoding="utf-8"
|
|
)
|
|
|
|
# Register with Windsurf (standard markdown agent without inject_name)
|
|
registrar = CommandRegistrar()
|
|
commands = [
|
|
{
|
|
"name": "speckit.my-extension.example",
|
|
"file": "commands/example.md"
|
|
}
|
|
]
|
|
|
|
registrar.register_commands(
|
|
"windsurf",
|
|
commands,
|
|
"test-extension",
|
|
ext_dir,
|
|
tmp_path
|
|
)
|
|
|
|
# Windsurf uses standard markdown format without name injection.
|
|
# The format_name callback should not be invoked for non-Forge agents.
|
|
windsurf_cmd = tmp_path / ".windsurf" / "workflows" / "speckit.my-extension.example.md"
|
|
assert windsurf_cmd.exists()
|
|
|
|
content = windsurf_cmd.read_text(encoding="utf-8")
|
|
# Windsurf should NOT have a name field injected
|
|
assert "name:" not in content, (
|
|
"Windsurf should not inject name field - format_name callback should be Forge-only"
|
|
)
|