mirror of
https://github.com/github/spec-kit.git
synced 2026-04-03 03:03:09 +00:00
3899dcc0d4
* feat: Stage 2a — CopilotIntegration with shared template primitives - base.py: added granular primitives (shared_commands_dir, shared_templates_dir, list_command_templates, command_filename, commands_dest, copy_command_to_directory, record_file_in_manifest, write_file_and_record, process_template) - CopilotIntegration: uses primitives to produce .agent.md commands, companion .prompt.md files, and .vscode/settings.json - Verified byte-for-byte parity with old release script output - Copilot auto-registered in INTEGRATION_REGISTRY - 70 tests (22 new: base primitives + copilot integration) Part of #1924 * feat: Stage 2b — --integration flag, routing, agent.json, shared infra - Added --integration flag to init() (mutually exclusive with --ai) - --ai copilot auto-promotes to integration path with migration nudge - Integration setup writes .specify/agent.json with integration key - _install_shared_infra() copies scripts and templates to .specify/ - init-options.json records 'integration' key when used - 4 new CLI tests: mutual exclusivity, unknown rejection, copilot end-to-end, auto-promote (74 total integration tests) Part of #1924 * feat: Stage 2 completion — integration scripts, integration.json, shared manifest - Added copilot/scripts/update-context.sh and .ps1 (thin wrappers that delegate to the shared update-agent-context script) - CopilotIntegration.setup() installs integration scripts to .specify/integrations/copilot/scripts/ - Renamed agent.json → integration.json with script paths - _install_shared_infra() now tracks files in integration-shared.manifest.json - Updated tests: scripts installed, integration.json has script paths, shared manifest recorded (74 tests) Part of #1924 * refactor: rename shared manifest to speckit.manifest.json Cleaner naming — the shared infrastructure (scripts, templates) belongs to spec-kit itself, not to any specific integration. * fix: copilot update-context scripts reflect target architecture Scripts now source shared functions (via SPECKIT_SOURCE_ONLY=1) and call update_agent_file directly with .github/copilot-instructions.md, rather than delegating back to the shared case statement. * fix: simplify copilot scripts — dispatcher sources common functions Integration scripts now contain only copilot-specific logic (target path + agent name). The dispatcher is responsible for sourcing shared functions before calling the integration script. * fix: copilot update-context scripts are self-contained implementations These scripts ARE the implementation — the dispatcher calls them. They source common.sh + update-agent-context functions, gather feature/plan data, then call update_agent_file with the copilot target path (.github/copilot-instructions.md). * docs: add Stage 7 activation note to copilot update-context scripts * test: add complete file inventory test for copilot integration Validates every single file (37 total) produced by specify init --integration copilot --script sh --no-git. * test: add PowerShell file inventory test for copilot integration Validates all 37 files produced by --script ps variant, including .specify/scripts/powershell/ instead of bash. * refactor: split test_integrations.py into tests/integrations/ directory - test_base.py: IntegrationOption, IntegrationBase, MarkdownIntegration, primitives - test_manifest.py: IntegrationManifest, path traversal, persistence, validation - test_registry.py: INTEGRATION_REGISTRY - test_copilot.py: CopilotIntegration unit tests - test_cli.py: --integration flag, auto-promote, file inventories (sh + ps) - conftest.py: shared StubIntegration helper 76 integration tests + 48 consistency tests = 124 total, all passing. * refactor: move file inventory tests from test_cli to test_copilot File inventories are copilot-specific. test_cli.py now only tests CLI flag mechanics (mutual exclusivity, unknown rejection, auto-promote). * fix: skip JSONC merge to preserve user settings, fix docstring - _merge_vscode_settings() now returns early (skips merge) when existing settings.json can't be parsed (e.g. JSONC with comments), instead of overwriting with empty settings - Updated _install_shared_infra() docstring to match implementation (scripts + templates, speckit.manifest.json) * fix: warn user when JSONC settings merge is skipped * fix: show template content when JSONC merge is skipped User now sees the exact settings they should add manually. * fix: document process_template requirement, merge scripts without rmtree - base.py setup() docstring now explicitly states raw copy behavior and directs to CopilotIntegration for process_template example - _install_shared_infra() uses merge/overwrite instead of rmtree to preserve user-added files under .specify/scripts/ * fix: don't overwrite pre-existing shared scripts or templates Only write files that don't already exist — preserves any user modifications to shared scripts (common.sh etc.) and templates. * fix: warn user about skipped pre-existing shared files Lists all shared scripts and templates that were not copied because they already existed in the project. * test: add test for shared infra skip behavior on pre-existing files Verifies that _install_shared_infra() preserves user-modified scripts and templates while still installing missing ones. * fix: address review — containment check, deterministic prompts, manifest accuracy - CopilotIntegration.setup() adds dest containment check (relative_to) - Companion prompts generated from templates list, not directory glob - _install_shared_infra() only records files actually copied (not pre-existing) - VS Code settings tests made unconditional (assert template exists) - Inventory tests use .as_posix() for cross-platform paths * fix: correct PS1 function names, document SPECKIT_SOURCE_ONLY prerequisite - Fixed Get-FeaturePaths → Get-FeaturePathsEnv, Read-PlanData → Parse-PlanData - Documented that shared scripts must guard Main with SPECKIT_SOURCE_ONLY before these integration scripts can be activated (Stage 7) * fix: add dict type check for settings merge, simplify PS1 to subprocess - _merge_vscode_settings() skips merge with warning if parsed JSON is not a dict (array, null, etc.) - PS1 update-context.ps1 uses & invocation instead of dot-sourcing since the shared script runs Main unconditionally * fix: skip-write on no-op merge, bash subprocess, dynamic integration list - _merge_vscode_settings() only writes when keys were actually added - update-context.sh uses exec subprocess like PS1 version - Unknown integration error lists available integrations dynamically * fix: align path rewriting with release script, add .specify/.specify/ fix Path rewrite regex matches the release script's rewrite_paths() exactly (verified byte-identical output). Added .specify/.specify/ double-prefix fix for additional safety.
267 lines
12 KiB
Python
267 lines
12 KiB
Python
"""Tests for CopilotIntegration."""
|
|
|
|
import json
|
|
import os
|
|
|
|
from specify_cli.integrations import get_integration
|
|
from specify_cli.integrations.manifest import IntegrationManifest
|
|
|
|
|
|
class TestCopilotIntegration:
|
|
def test_copilot_key_and_config(self):
|
|
copilot = get_integration("copilot")
|
|
assert copilot is not None
|
|
assert copilot.key == "copilot"
|
|
assert copilot.config["folder"] == ".github/"
|
|
assert copilot.config["commands_subdir"] == "agents"
|
|
assert copilot.registrar_config["extension"] == ".agent.md"
|
|
assert copilot.context_file == ".github/copilot-instructions.md"
|
|
|
|
def test_command_filename_agent_md(self):
|
|
copilot = get_integration("copilot")
|
|
assert copilot.command_filename("plan") == "speckit.plan.agent.md"
|
|
|
|
def test_setup_creates_agent_md_files(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.setup(tmp_path, m)
|
|
assert len(created) > 0
|
|
agent_files = [f for f in created if ".agent." in f.name]
|
|
assert len(agent_files) > 0
|
|
for f in agent_files:
|
|
assert f.parent == tmp_path / ".github" / "agents"
|
|
assert f.name.endswith(".agent.md")
|
|
|
|
def test_setup_creates_companion_prompts(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.setup(tmp_path, m)
|
|
prompt_files = [f for f in created if f.parent.name == "prompts"]
|
|
assert len(prompt_files) > 0
|
|
for f in prompt_files:
|
|
assert f.name.endswith(".prompt.md")
|
|
content = f.read_text(encoding="utf-8")
|
|
assert content.startswith("---\nagent: speckit.")
|
|
|
|
def test_agent_and_prompt_counts_match(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.setup(tmp_path, m)
|
|
agents = [f for f in created if ".agent.md" in f.name]
|
|
prompts = [f for f in created if ".prompt.md" in f.name]
|
|
assert len(agents) == len(prompts)
|
|
|
|
def test_setup_creates_vscode_settings_new(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
assert copilot._vscode_settings_path() is not None
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.setup(tmp_path, m)
|
|
settings = tmp_path / ".vscode" / "settings.json"
|
|
assert settings.exists()
|
|
assert settings in created
|
|
assert any("settings.json" in k for k in m.files)
|
|
|
|
def test_setup_merges_existing_vscode_settings(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
vscode_dir = tmp_path / ".vscode"
|
|
vscode_dir.mkdir(parents=True)
|
|
existing = {"editor.fontSize": 14, "custom.setting": True}
|
|
(vscode_dir / "settings.json").write_text(json.dumps(existing, indent=4), encoding="utf-8")
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.setup(tmp_path, m)
|
|
settings = tmp_path / ".vscode" / "settings.json"
|
|
data = json.loads(settings.read_text(encoding="utf-8"))
|
|
assert data["editor.fontSize"] == 14
|
|
assert data["custom.setting"] is True
|
|
assert settings not in created
|
|
assert not any("settings.json" in k for k in m.files)
|
|
|
|
def test_all_created_files_tracked_in_manifest(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.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.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.install(tmp_path, m)
|
|
assert len(created) > 0
|
|
m.save()
|
|
for f in created:
|
|
assert f.exists()
|
|
removed, skipped = copilot.uninstall(tmp_path, m)
|
|
assert len(removed) == len(created)
|
|
assert skipped == []
|
|
|
|
def test_modified_file_survives_uninstall(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
created = copilot.install(tmp_path, m)
|
|
m.save()
|
|
modified_file = created[0]
|
|
modified_file.write_text("user modified this", encoding="utf-8")
|
|
removed, skipped = copilot.uninstall(tmp_path, m)
|
|
assert modified_file.exists()
|
|
assert modified_file in skipped
|
|
|
|
def test_directory_structure(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
copilot.setup(tmp_path, m)
|
|
agents_dir = tmp_path / ".github" / "agents"
|
|
assert agents_dir.is_dir()
|
|
agent_files = sorted(agents_dir.glob("speckit.*.agent.md"))
|
|
assert len(agent_files) == 9
|
|
expected_commands = {
|
|
"analyze", "checklist", "clarify", "constitution",
|
|
"implement", "plan", "specify", "tasks", "taskstoissues",
|
|
}
|
|
actual_commands = {f.name.removeprefix("speckit.").removesuffix(".agent.md") for f in agent_files}
|
|
assert actual_commands == expected_commands
|
|
|
|
def test_templates_are_processed(self, tmp_path):
|
|
from specify_cli.integrations.copilot import CopilotIntegration
|
|
copilot = CopilotIntegration()
|
|
m = IntegrationManifest("copilot", tmp_path)
|
|
copilot.setup(tmp_path, m)
|
|
agents_dir = tmp_path / ".github" / "agents"
|
|
for agent_file in agents_dir.glob("speckit.*.agent.md"):
|
|
content = agent_file.read_text(encoding="utf-8")
|
|
assert "{SCRIPT}" not in content, f"{agent_file.name} has unprocessed {{SCRIPT}}"
|
|
assert "__AGENT__" not in content, f"{agent_file.name} has unprocessed __AGENT__"
|
|
assert "{ARGS}" not in content, f"{agent_file.name} has unprocessed {{ARGS}}"
|
|
assert "\nscripts:\n" not in content
|
|
assert "\nagent_scripts:\n" not in content
|
|
|
|
def test_complete_file_inventory_sh(self, tmp_path):
|
|
"""Every file produced by specify init --integration copilot --script sh."""
|
|
from typer.testing import CliRunner
|
|
from specify_cli import app
|
|
project = tmp_path / "inventory-sh"
|
|
project.mkdir()
|
|
old_cwd = os.getcwd()
|
|
try:
|
|
os.chdir(project)
|
|
result = CliRunner().invoke(app, [
|
|
"init", "--here", "--integration", "copilot", "--script", "sh", "--no-git",
|
|
], catch_exceptions=False)
|
|
finally:
|
|
os.chdir(old_cwd)
|
|
assert result.exit_code == 0
|
|
actual = sorted(p.relative_to(project).as_posix() for p in project.rglob("*") if p.is_file())
|
|
expected = sorted([
|
|
".github/agents/speckit.analyze.agent.md",
|
|
".github/agents/speckit.checklist.agent.md",
|
|
".github/agents/speckit.clarify.agent.md",
|
|
".github/agents/speckit.constitution.agent.md",
|
|
".github/agents/speckit.implement.agent.md",
|
|
".github/agents/speckit.plan.agent.md",
|
|
".github/agents/speckit.specify.agent.md",
|
|
".github/agents/speckit.tasks.agent.md",
|
|
".github/agents/speckit.taskstoissues.agent.md",
|
|
".github/prompts/speckit.analyze.prompt.md",
|
|
".github/prompts/speckit.checklist.prompt.md",
|
|
".github/prompts/speckit.clarify.prompt.md",
|
|
".github/prompts/speckit.constitution.prompt.md",
|
|
".github/prompts/speckit.implement.prompt.md",
|
|
".github/prompts/speckit.plan.prompt.md",
|
|
".github/prompts/speckit.specify.prompt.md",
|
|
".github/prompts/speckit.tasks.prompt.md",
|
|
".github/prompts/speckit.taskstoissues.prompt.md",
|
|
".vscode/settings.json",
|
|
".specify/integration.json",
|
|
".specify/init-options.json",
|
|
".specify/integrations/copilot.manifest.json",
|
|
".specify/integrations/speckit.manifest.json",
|
|
".specify/integrations/copilot/scripts/update-context.ps1",
|
|
".specify/integrations/copilot/scripts/update-context.sh",
|
|
".specify/scripts/bash/check-prerequisites.sh",
|
|
".specify/scripts/bash/common.sh",
|
|
".specify/scripts/bash/create-new-feature.sh",
|
|
".specify/scripts/bash/setup-plan.sh",
|
|
".specify/scripts/bash/update-agent-context.sh",
|
|
".specify/templates/agent-file-template.md",
|
|
".specify/templates/checklist-template.md",
|
|
".specify/templates/constitution-template.md",
|
|
".specify/templates/plan-template.md",
|
|
".specify/templates/spec-template.md",
|
|
".specify/templates/tasks-template.md",
|
|
".specify/memory/constitution.md",
|
|
])
|
|
assert actual == expected, (
|
|
f"Missing: {sorted(set(expected) - set(actual))}\n"
|
|
f"Extra: {sorted(set(actual) - set(expected))}"
|
|
)
|
|
|
|
def test_complete_file_inventory_ps(self, tmp_path):
|
|
"""Every file produced by specify init --integration copilot --script ps."""
|
|
from typer.testing import CliRunner
|
|
from specify_cli import app
|
|
project = tmp_path / "inventory-ps"
|
|
project.mkdir()
|
|
old_cwd = os.getcwd()
|
|
try:
|
|
os.chdir(project)
|
|
result = CliRunner().invoke(app, [
|
|
"init", "--here", "--integration", "copilot", "--script", "ps", "--no-git",
|
|
], catch_exceptions=False)
|
|
finally:
|
|
os.chdir(old_cwd)
|
|
assert result.exit_code == 0
|
|
actual = sorted(p.relative_to(project).as_posix() for p in project.rglob("*") if p.is_file())
|
|
expected = sorted([
|
|
".github/agents/speckit.analyze.agent.md",
|
|
".github/agents/speckit.checklist.agent.md",
|
|
".github/agents/speckit.clarify.agent.md",
|
|
".github/agents/speckit.constitution.agent.md",
|
|
".github/agents/speckit.implement.agent.md",
|
|
".github/agents/speckit.plan.agent.md",
|
|
".github/agents/speckit.specify.agent.md",
|
|
".github/agents/speckit.tasks.agent.md",
|
|
".github/agents/speckit.taskstoissues.agent.md",
|
|
".github/prompts/speckit.analyze.prompt.md",
|
|
".github/prompts/speckit.checklist.prompt.md",
|
|
".github/prompts/speckit.clarify.prompt.md",
|
|
".github/prompts/speckit.constitution.prompt.md",
|
|
".github/prompts/speckit.implement.prompt.md",
|
|
".github/prompts/speckit.plan.prompt.md",
|
|
".github/prompts/speckit.specify.prompt.md",
|
|
".github/prompts/speckit.tasks.prompt.md",
|
|
".github/prompts/speckit.taskstoissues.prompt.md",
|
|
".vscode/settings.json",
|
|
".specify/integration.json",
|
|
".specify/init-options.json",
|
|
".specify/integrations/copilot.manifest.json",
|
|
".specify/integrations/speckit.manifest.json",
|
|
".specify/integrations/copilot/scripts/update-context.ps1",
|
|
".specify/integrations/copilot/scripts/update-context.sh",
|
|
".specify/scripts/powershell/check-prerequisites.ps1",
|
|
".specify/scripts/powershell/common.ps1",
|
|
".specify/scripts/powershell/create-new-feature.ps1",
|
|
".specify/scripts/powershell/setup-plan.ps1",
|
|
".specify/scripts/powershell/update-agent-context.ps1",
|
|
".specify/templates/agent-file-template.md",
|
|
".specify/templates/checklist-template.md",
|
|
".specify/templates/constitution-template.md",
|
|
".specify/templates/plan-template.md",
|
|
".specify/templates/spec-template.md",
|
|
".specify/templates/tasks-template.md",
|
|
".specify/memory/constitution.md",
|
|
])
|
|
assert actual == expected, (
|
|
f"Missing: {sorted(set(expected) - set(actual))}\n"
|
|
f"Extra: {sorted(set(actual) - set(expected))}"
|
|
)
|