Fix --dev extension agent symlinks (#2554)

* Fix dev extension agent symlinks

* Address dev symlink review feedback

* fix: handle dev symlink relpath failures

* fix: fall back when dev cache writes fail

* test: cover dev symlink fallback without privileges
This commit is contained in:
NgoQuocViet2001
2026-05-28 21:29:17 +07:00
committed by GitHub
parent 5a678c552e
commit 9307093d8a
5 changed files with 543 additions and 16 deletions

View File

@@ -11,6 +11,7 @@ Tests cover:
"""
import json
import os
import pytest
import tempfile
import shutil
@@ -116,6 +117,18 @@ def _create_extension_dir(temp_dir: Path, ext_id: str = "test-ext") -> Path:
return ext_dir
def _can_create_symlink(temp_dir: Path) -> bool:
"""Return True when the current platform/user can create file symlinks."""
target = temp_dir / "symlink-target.txt"
link = temp_dir / "symlink-link.txt"
target.write_text("ok", encoding="utf-8")
try:
os.symlink(target, link)
except OSError:
return False
return link.is_symlink()
# ===== Fixtures =====
@pytest.fixture
@@ -324,6 +337,149 @@ class TestExtensionSkillRegistration:
# The pre-existing one should NOT be in registered_skills (it was skipped)
assert "speckit-test-ext-hello" not in metadata["registered_skills"]
def test_dev_skill_symlink_refreshes_existing_cache(
self, skills_project, extension_dir, temp_dir
):
"""Dev-mode skill symlinks should refresh rendered cache content."""
if not _can_create_symlink(temp_dir):
pytest.skip("Current platform/user cannot create symlinks")
project_dir, skills_dir = skills_project
manager = ExtensionManager(project_dir)
manifest = ExtensionManifest(extension_dir / "extension.yml")
manager._register_extension_skills(
manifest,
extension_dir,
link_outputs=True,
)
skill_file = skills_dir / "speckit-test-ext-hello" / "SKILL.md"
assert skill_file.is_symlink()
assert "Run this to say hello." in skill_file.read_text(encoding="utf-8")
(extension_dir / "commands" / "hello.md").write_text(
"---\n"
"description: \"Updated test hello command\"\n"
"---\n"
"\n"
"# Hello Command\n"
"\n"
"Run this updated hello.\n"
)
written = manager._register_extension_skills(
manifest,
extension_dir,
link_outputs=True,
)
assert "speckit-test-ext-hello" in written
assert "Run this updated hello." in skill_file.read_text(encoding="utf-8")
def test_dev_skill_registration_falls_back_to_copy_when_symlink_fails(
self, skills_project, extension_dir, monkeypatch
):
"""Dev-mode skill registration works when Windows cannot create symlinks."""
project_dir, skills_dir = skills_project
manager = ExtensionManager(project_dir)
manifest = ExtensionManifest(extension_dir / "extension.yml")
def raise_windows_symlink_error(target, link):
raise OSError("A required privilege is not held by the client")
monkeypatch.setattr(
"specify_cli.extensions.os.symlink", raise_windows_symlink_error
)
written = manager._register_extension_skills(
manifest,
extension_dir,
link_outputs=True,
)
skill_file = skills_dir / "speckit-test-ext-hello" / "SKILL.md"
assert "speckit-test-ext-hello" in written
assert skill_file.exists()
assert not skill_file.is_symlink()
assert "Run this to say hello." in skill_file.read_text(encoding="utf-8")
assert (
extension_dir
/ ".specify-dev"
/ "extension-skills"
/ "speckit-test-ext-hello"
/ "SKILL.md"
).exists()
def test_dev_skill_registration_falls_back_to_copy_when_relpath_fails(
self, skills_project, extension_dir, monkeypatch
):
"""Dev-mode skill registration stays functional across Windows drive roots."""
project_dir, skills_dir = skills_project
manager = ExtensionManager(project_dir)
manifest = ExtensionManifest(extension_dir / "extension.yml")
def raise_relpath_error(path, start=None):
raise ValueError("path is on mount 'D:', start on mount 'C:'")
monkeypatch.setattr(
"specify_cli.extensions.os.path.relpath", raise_relpath_error
)
written = manager._register_extension_skills(
manifest,
extension_dir,
link_outputs=True,
)
skill_file = skills_dir / "speckit-test-ext-hello" / "SKILL.md"
assert "speckit-test-ext-hello" in written
assert skill_file.exists()
assert not skill_file.is_symlink()
assert "Run this to say hello." in skill_file.read_text(encoding="utf-8")
assert (
extension_dir
/ ".specify-dev"
/ "extension-skills"
/ "speckit-test-ext-hello"
/ "SKILL.md"
).exists()
def test_dev_skill_registration_falls_back_to_copy_when_cache_write_fails(
self, skills_project, extension_dir, monkeypatch
):
"""Dev-mode skill registration stays functional when the dev cache is unwritable."""
project_dir, skills_dir = skills_project
manager = ExtensionManager(project_dir)
manifest = ExtensionManifest(extension_dir / "extension.yml")
original_write_text = Path.write_text
def raise_cache_write_error(path, *args, **kwargs):
if ".specify-dev" in path.parts:
raise OSError("cache is not writable")
return original_write_text(path, *args, **kwargs)
monkeypatch.setattr(Path, "write_text", raise_cache_write_error)
written = manager._register_extension_skills(
manifest,
extension_dir,
link_outputs=True,
)
skill_file = skills_dir / "speckit-test-ext-hello" / "SKILL.md"
assert "speckit-test-ext-hello" in written
assert skill_file.exists()
assert not skill_file.is_symlink()
assert "Run this to say hello." in skill_file.read_text(encoding="utf-8")
assert not (
extension_dir
/ ".specify-dev"
/ "extension-skills"
/ "speckit-test-ext-hello"
/ "SKILL.md"
).exists()
def test_registered_skills_in_registry(self, skills_project, extension_dir):
"""Registry should contain registered_skills list."""
project_dir, skills_dir = skills_project

View File

@@ -11,6 +11,7 @@ Tests cover:
import pytest
import json
import os
import platform
import tempfile
import shutil
@@ -36,6 +37,18 @@ from specify_cli.extensions import (
)
def can_create_symlink(tmp_path: Path) -> bool:
"""Return True when the current platform/user can create file symlinks."""
target = tmp_path / "symlink-target.txt"
link = tmp_path / "symlink-link.txt"
target.write_text("ok", encoding="utf-8")
try:
os.symlink(target, link)
except OSError:
return False
return link.is_symlink()
# ===== Fixtures =====
@pytest.fixture
@@ -1722,6 +1735,168 @@ Run {SCRIPT}
assert "description: Test hello command" in content
assert "test-ext" in content
def test_dev_register_commands_symlinks_rendered_copilot_agent(
self, extension_dir, project_dir, temp_dir
):
"""Dev-mode registration should symlink agent files to rendered outputs."""
if not can_create_symlink(temp_dir):
pytest.skip("Current platform/user cannot create symlinks")
agents_dir = project_dir / ".github" / "agents"
agents_dir.mkdir(parents=True)
manifest = ExtensionManifest(extension_dir / "extension.yml")
registrar = CommandRegistrar()
registered = registrar.register_commands_for_agent(
"copilot",
manifest,
extension_dir,
project_dir,
link_outputs=True,
)
assert registered == ["speckit.test-ext.hello"]
cmd_file = agents_dir / "speckit.test-ext.hello.agent.md"
assert cmd_file.is_symlink()
target = cmd_file.resolve()
assert ".specify-dev" in target.parts
assert target.is_file()
assert "Extension: test-ext" in cmd_file.read_text(encoding="utf-8")
def test_dev_register_commands_falls_back_to_copy_when_symlink_fails(
self, extension_dir, project_dir, monkeypatch
):
"""Dev-mode registration stays functional when symlinks are unavailable."""
agents_dir = project_dir / ".github" / "agents"
agents_dir.mkdir(parents=True)
def raise_symlink_error(target, link):
raise OSError("symlink unavailable")
monkeypatch.setattr("specify_cli.agents.os.symlink", raise_symlink_error)
manifest = ExtensionManifest(extension_dir / "extension.yml")
registrar = CommandRegistrar()
registrar.register_commands_for_agent(
"copilot",
manifest,
extension_dir,
project_dir,
link_outputs=True,
)
cmd_file = agents_dir / "speckit.test-ext.hello.agent.md"
assert cmd_file.exists()
assert not cmd_file.is_symlink()
assert "Extension: test-ext" in cmd_file.read_text(encoding="utf-8")
assert (
extension_dir
/ ".specify-dev"
/ "agent-commands"
/ "copilot"
/ "speckit.test-ext.hello.agent.md"
).exists()
def test_dev_register_commands_falls_back_to_copy_when_relpath_fails(
self, extension_dir, project_dir, monkeypatch
):
"""Dev-mode registration stays functional across Windows drive roots."""
agents_dir = project_dir / ".github" / "agents"
agents_dir.mkdir(parents=True)
def raise_relpath_error(path, start=None):
raise ValueError("path is on mount 'D:', start on mount 'C:'")
monkeypatch.setattr("specify_cli.agents.os.path.relpath", raise_relpath_error)
manifest = ExtensionManifest(extension_dir / "extension.yml")
registrar = CommandRegistrar()
registrar.register_commands_for_agent(
"copilot",
manifest,
extension_dir,
project_dir,
link_outputs=True,
)
cmd_file = agents_dir / "speckit.test-ext.hello.agent.md"
assert cmd_file.exists()
assert not cmd_file.is_symlink()
assert "Extension: test-ext" in cmd_file.read_text(encoding="utf-8")
assert (
extension_dir
/ ".specify-dev"
/ "agent-commands"
/ "copilot"
/ "speckit.test-ext.hello.agent.md"
).exists()
def test_dev_register_commands_falls_back_to_copy_when_cache_write_fails(
self, extension_dir, project_dir, monkeypatch
):
"""Dev-mode registration stays functional when the dev cache is unwritable."""
agents_dir = project_dir / ".github" / "agents"
agents_dir.mkdir(parents=True)
original_write_text = Path.write_text
def raise_cache_write_error(path, *args, **kwargs):
if ".specify-dev" in path.parts:
raise OSError("cache is not writable")
return original_write_text(path, *args, **kwargs)
monkeypatch.setattr(Path, "write_text", raise_cache_write_error)
manifest = ExtensionManifest(extension_dir / "extension.yml")
registrar = CommandRegistrar()
registrar.register_commands_for_agent(
"copilot",
manifest,
extension_dir,
project_dir,
link_outputs=True,
)
cmd_file = agents_dir / "speckit.test-ext.hello.agent.md"
assert cmd_file.exists()
assert not cmd_file.is_symlink()
assert "Extension: test-ext" in cmd_file.read_text(encoding="utf-8")
assert not (
extension_dir
/ ".specify-dev"
/ "agent-commands"
/ "copilot"
/ "speckit.test-ext.hello.agent.md"
).exists()
def test_dev_register_commands_rejects_cache_path_traversal(self, temp_dir):
"""Dev-mode cache writes must stay inside the agent cache root."""
from specify_cli.agents import CommandRegistrar as AgentCommandRegistrar
source_dir = temp_dir / "extension"
source_dir.mkdir()
commands_dir = temp_dir / "commands"
commands_dir.mkdir()
with pytest.raises(ValueError, match="escapes directory"):
AgentCommandRegistrar._write_registered_output(
commands_dir / "safe.md",
"content",
source_dir,
"copilot",
"../escaped",
".md",
True,
)
assert not (
source_dir
/ ".specify-dev"
/ "agent-commands"
/ "escaped.md"
).exists()
def test_copilot_companion_prompt_created(self, extension_dir, project_dir):
"""Test that companion .prompt.md files are created in .github/prompts/."""
agents_dir = project_dir / ".github" / "agents"
@@ -3458,6 +3633,86 @@ class TestExtensionIgnore:
class TestExtensionAddCLI:
"""CLI integration tests for extension add command."""
def test_add_dev_links_copilot_agent_when_supported(
self, extension_dir, project_dir, temp_dir
):
"""extension add --dev should link generated agent files when possible."""
from typer.testing import CliRunner
from unittest.mock import patch
from specify_cli import app
(project_dir / ".github" / "agents").mkdir(parents=True)
runner = CliRunner()
with patch.object(Path, "cwd", return_value=project_dir):
result = runner.invoke(
app,
["extension", "add", str(extension_dir), "--dev"],
catch_exceptions=True,
)
assert result.exit_code == 0, result.output
agent_file = (
project_dir
/ ".github"
/ "agents"
/ "speckit.test-ext.hello.agent.md"
)
assert agent_file.exists()
if can_create_symlink(temp_dir):
assert agent_file.is_symlink()
assert ".specify-dev" in agent_file.resolve().parts
else:
assert not agent_file.is_symlink()
def test_add_dev_falls_back_to_copy_when_windows_symlinks_unavailable(
self, extension_dir, project_dir, monkeypatch
):
"""extension add --dev should work when Windows cannot create symlinks."""
from typer.testing import CliRunner
from unittest.mock import patch
from specify_cli import app
(project_dir / ".github" / "agents").mkdir(parents=True)
def raise_windows_symlink_error(target, link):
raise OSError("A required privilege is not held by the client")
monkeypatch.setattr(
"specify_cli.agents.os.symlink", raise_windows_symlink_error
)
runner = CliRunner()
with patch.object(Path, "cwd", return_value=project_dir):
result = runner.invoke(
app,
["extension", "add", str(extension_dir), "--dev"],
catch_exceptions=True,
)
assert result.exit_code == 0, result.output
agent_file = (
project_dir
/ ".github"
/ "agents"
/ "speckit.test-ext.hello.agent.md"
)
assert agent_file.exists()
assert not agent_file.is_symlink()
assert "Extension: test-ext" in agent_file.read_text(encoding="utf-8")
assert (
project_dir
/ ".specify"
/ "extensions"
/ "test-ext"
/ ".specify-dev"
/ "agent-commands"
/ "copilot"
/ "speckit.test-ext.hello.agent.md"
).exists()
def test_add_by_display_name_uses_resolved_id_for_download(self, tmp_path):
"""extension add by display name should use resolved ID for download_extension()."""
from typer.testing import CliRunner