mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
Support controlled multi-install for safe AI agent integrations (#2389)
* support controlled multi-install integrations * fix: harden multi-install integration state * refactor: isolate integration runtime helpers * fix: address copilot review feedback * fix: address follow-up copilot feedback * fix: tighten integration switch semantics * fix: address final copilot review feedback * fix: harden integration manifest read errors * fix: refuse symlinked shared infra paths * test: filter expected self-test preset warning * test: address copilot review nits * refactor: centralize safe shared infra writes * fix: use no-follow writes for shared infra * fix: keep default integration atomic on template refresh * fix: harden shared infra error paths * fix: preflight shared infra and future state schemas * fix: support nested shared scripts during preflight * test: tolerate wrapped schema error output * fix: use safe default mode for shared text writes * fix: use posix paths in shared skip output * fix: share project guard for integration use * fix: centralize spec-kit project guards * fix: use posix project paths in cli output * fix: harden shared manifest and upgrade refresh
This commit is contained in:
@@ -43,6 +43,8 @@ specify integration list
|
||||
```
|
||||
|
||||
Shows all available integrations, which one is currently installed, and whether each requires a CLI tool or is IDE-based.
|
||||
When multiple integrations are installed, the list marks the default integration separately from the other installed integrations.
|
||||
The list also shows whether each built-in integration is declared multi-install safe.
|
||||
|
||||
## Install an Integration
|
||||
|
||||
@@ -53,9 +55,12 @@ specify integration install <key>
|
||||
| Option | Description |
|
||||
| ------------------------ | ------------------------------------------------------------------------ |
|
||||
| `--script sh\|ps` | Script type: `sh` (bash/zsh) or `ps` (PowerShell) |
|
||||
| `--force` | Opt in to installing alongside integrations that are not declared multi-install safe |
|
||||
| `--integration-options` | Integration-specific options (e.g. `--integration-options="--commands-dir .myagent/cmds"`) |
|
||||
|
||||
Installs the specified integration into the current project. Fails if another integration is already installed — use `switch` instead. If the installation fails partway through, it automatically rolls back to a clean state.
|
||||
Installs the specified integration into the current project. If another integration is already installed, the command only proceeds automatically when all involved integrations are declared multi-install safe. Otherwise, use `switch` to replace the default integration or pass `--force` to explicitly opt in to multi-install. If the installation fails partway through, it automatically rolls back to a clean state.
|
||||
|
||||
Installing an additional integration does not change the default integration. Use `specify integration use <key>` to change the default.
|
||||
|
||||
> **Note:** All integration management commands require a project already initialized with `specify init`. To start a new project with a specific agent, use `specify init <project> --integration <key>` instead.
|
||||
|
||||
@@ -84,10 +89,22 @@ specify integration switch <key>
|
||||
| Option | Description |
|
||||
| ------------------------ | ------------------------------------------------------------------------ |
|
||||
| `--script sh\|ps` | Script type: `sh` (bash/zsh) or `ps` (PowerShell) |
|
||||
| `--force` | Force removal of modified files during uninstall |
|
||||
| `--integration-options` | Options for the target integration |
|
||||
| `--force` | Force removal of modified files during uninstall; when the target is already installed, overwrite managed shared templates while changing the default |
|
||||
| `--integration-options` | Options for the target integration when it is not already installed |
|
||||
|
||||
Equivalent to running `uninstall` followed by `install` in a single step.
|
||||
If the target integration is not already installed, equivalent to running `uninstall` followed by `install` in a single step. In this mode, `--force` controls whether modified files from the removed integration are deleted. If the target integration is already installed, `switch` only changes the default integration, like `use`; in this mode, `--force` controls whether managed shared templates are overwritten while the default changes. `--integration-options` is rejected for already-installed targets because changing integration options requires reinstalling managed files; run `upgrade <key> --integration-options ...` first, then `use <key>`.
|
||||
|
||||
## Use an Installed Integration
|
||||
|
||||
```bash
|
||||
specify integration use <key>
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| --------- | --------------------------------------------------- |
|
||||
| `--force` | Overwrite managed shared templates while changing the default |
|
||||
|
||||
Sets the default integration without uninstalling any other installed integrations. This also refreshes managed shared templates so command references match the new default integration's invocation style. Modified or untracked shared templates are preserved unless `--force` is used.
|
||||
|
||||
## Upgrade an Integration
|
||||
|
||||
@@ -101,7 +118,7 @@ specify integration upgrade [<key>]
|
||||
| `--script sh\|ps` | Script type: `sh` (bash/zsh) or `ps` (PowerShell) |
|
||||
| `--integration-options` | Options for the integration |
|
||||
|
||||
Reinstalls the current integration with updated templates and commands (e.g., after upgrading Spec Kit). Defaults to the currently installed integration; if a key is provided, it must match the installed one — otherwise the command fails and suggests using `switch` instead. Detects locally modified files and blocks the upgrade unless `--force` is used. Stale files from the previous install that are no longer needed are removed automatically.
|
||||
Reinstalls an installed integration with updated templates and commands (e.g., after upgrading Spec Kit). Defaults to the default integration; if a key is provided, it must be one of the installed integrations. Detects locally modified files and blocks the upgrade unless `--force` is used. Stale files from the previous install that are no longer needed are removed automatically. Shared templates stay aligned with the default integration even when upgrading a non-default integration.
|
||||
|
||||
## Integration-Specific Options
|
||||
|
||||
@@ -120,9 +137,39 @@ specify integration install generic --integration-options="--commands-dir .myage
|
||||
|
||||
## FAQ
|
||||
|
||||
### Can I use multiple integrations at the same time?
|
||||
### Can I install multiple integrations in the same project?
|
||||
|
||||
No. Only one AI coding agent integration can be installed per project. Use `specify integration switch <key>` to change to a different AI coding agent.
|
||||
Yes, but it is intended for team portability rather than the default workflow. Multiple integrations are allowed automatically only when the installed integration and the new integration are declared multi-install safe by Spec Kit. For other combinations, pass `--force` to acknowledge that multiple agents may see unrelated agent-specific instructions or commands.
|
||||
|
||||
Spec Kit tracks one default integration in `.specify/integration.json` with `default_integration`, all installed integrations with `installed_integrations`, per-integration runtime settings with `integration_settings`, and a dedicated `integration_state_schema` for future state migrations. The legacy `integration` field remains as an alias for the default integration.
|
||||
|
||||
### Which integrations are multi-install safe?
|
||||
|
||||
An integration is multi-install safe when it uses isolated agent directories, a dedicated context file that does not collide with another safe integration, stable command invocation settings, and a separate install manifest. Shared Spec Kit templates remain aligned to the single default integration.
|
||||
|
||||
The currently declared multi-install safe integrations are:
|
||||
|
||||
| Key | Isolation |
|
||||
| --- | --------- |
|
||||
| `auggie` | `.augment/commands`, `.augment/rules/specify-rules.md` |
|
||||
| `claude` | `.claude/skills`, `CLAUDE.md` |
|
||||
| `codebuddy` | `.codebuddy/commands`, `CODEBUDDY.md` |
|
||||
| `codex` | `.agents/skills`, `AGENTS.md` |
|
||||
| `cursor-agent` | `.cursor/skills`, `.cursor/rules/specify-rules.mdc` |
|
||||
| `gemini` | `.gemini/commands`, `GEMINI.md` |
|
||||
| `iflow` | `.iflow/commands`, `IFLOW.md` |
|
||||
| `junie` | `.junie/commands`, `.junie/AGENTS.md` |
|
||||
| `kilocode` | `.kilocode/workflows`, `.kilocode/rules/specify-rules.md` |
|
||||
| `kimi` | `.kimi/skills`, `KIMI.md` |
|
||||
| `qodercli` | `.qoder/commands`, `QODER.md` |
|
||||
| `qwen` | `.qwen/commands`, `QWEN.md` |
|
||||
| `roo` | `.roo/commands`, `.roo/rules/specify-rules.md` |
|
||||
| `shai` | `.shai/commands`, `SHAI.md` |
|
||||
| `tabnine` | `.tabnine/agent/commands`, `TABNINE.md` |
|
||||
| `trae` | `.trae/skills`, `.trae/rules/project_rules.md` |
|
||||
| `windsurf` | `.windsurf/workflows`, `.windsurf/rules/specify-rules.md` |
|
||||
|
||||
Integrations that share a context file or command directory with another integration, require dynamic install paths such as `--commands-dir`, or merge shared tool settings are not declared safe by default. They can still be installed alongside another integration with `--force`.
|
||||
|
||||
### What happens to my changes when I uninstall or switch?
|
||||
|
||||
@@ -138,4 +185,4 @@ CLI-based integrations (like Claude Code, Gemini CLI) require the tool to be ins
|
||||
|
||||
### When should I use `upgrade` vs `switch`?
|
||||
|
||||
Use `upgrade` when you've upgraded Spec Kit and want to refresh the same integration's templates. Use `switch` when you want to change to a different AI coding agent.
|
||||
Use `upgrade` when you've upgraded Spec Kit and want to refresh an installed integration's managed files. Use `switch` when you want to replace the current default with another integration; if the target is already installed, `switch` behaves like `use`.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
90
src/specify_cli/integration_runtime.py
Normal file
90
src/specify_cli/integration_runtime.py
Normal file
@@ -0,0 +1,90 @@
|
||||
"""Runtime helpers for integration commands."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from typing import Any
|
||||
|
||||
from .integration_state import integration_setting, integration_settings
|
||||
|
||||
|
||||
ParseOptions = Callable[[Any, str], dict[str, Any] | None]
|
||||
|
||||
|
||||
def resolve_integration_options(
|
||||
integration: Any,
|
||||
state: dict[str, Any],
|
||||
key: str,
|
||||
raw_options: str | None,
|
||||
*,
|
||||
parse_options: ParseOptions,
|
||||
) -> tuple[str | None, dict[str, Any] | None]:
|
||||
"""Resolve raw and parsed options for an integration operation."""
|
||||
if raw_options is not None:
|
||||
return raw_options, parse_options(integration, raw_options)
|
||||
|
||||
setting = integration_setting(state, key)
|
||||
stored_raw = setting.get("raw_options")
|
||||
if not isinstance(stored_raw, str):
|
||||
stored_raw = None
|
||||
|
||||
stored_parsed = setting.get("parsed_options")
|
||||
if isinstance(stored_parsed, dict):
|
||||
return stored_raw, stored_parsed or None
|
||||
|
||||
if stored_raw:
|
||||
return stored_raw, parse_options(integration, stored_raw)
|
||||
|
||||
return None, None
|
||||
|
||||
|
||||
def with_integration_setting(
|
||||
state: dict[str, Any],
|
||||
key: str,
|
||||
integration: Any,
|
||||
*,
|
||||
script_type: str | None = None,
|
||||
raw_options: str | None = None,
|
||||
parsed_options: dict[str, Any] | None = None,
|
||||
) -> dict[str, dict[str, Any]]:
|
||||
"""Return integration settings with *key* updated."""
|
||||
settings = integration_settings(state)
|
||||
current = dict(settings.get(key, {}))
|
||||
|
||||
if script_type:
|
||||
current["script"] = script_type
|
||||
if raw_options is not None:
|
||||
current["raw_options"] = raw_options
|
||||
elif "raw_options" in current and not current.get("raw_options"):
|
||||
current.pop("raw_options", None)
|
||||
|
||||
if parsed_options is not None:
|
||||
current["parsed_options"] = parsed_options
|
||||
elif raw_options is not None:
|
||||
current.pop("parsed_options", None)
|
||||
|
||||
current["invoke_separator"] = integration.effective_invoke_separator(parsed_options)
|
||||
settings[key] = current
|
||||
return settings
|
||||
|
||||
|
||||
def invoke_separator_for_integration(
|
||||
integration: Any,
|
||||
state: dict[str, Any],
|
||||
key: str,
|
||||
parsed_options: dict[str, Any] | None = None,
|
||||
) -> str:
|
||||
"""Resolve the invocation separator for stored/default integration state."""
|
||||
if parsed_options is not None:
|
||||
return integration.effective_invoke_separator(parsed_options)
|
||||
|
||||
setting = integration_setting(state, key)
|
||||
stored_separator = setting.get("invoke_separator")
|
||||
if isinstance(stored_separator, str) and stored_separator:
|
||||
return stored_separator
|
||||
|
||||
stored_parsed = setting.get("parsed_options")
|
||||
if isinstance(stored_parsed, dict):
|
||||
return integration.effective_invoke_separator(stored_parsed)
|
||||
|
||||
return integration.effective_invoke_separator(None)
|
||||
161
src/specify_cli/integration_state.py
Normal file
161
src/specify_cli/integration_state.py
Normal file
@@ -0,0 +1,161 @@
|
||||
"""State helpers for installed AI agent integrations."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
|
||||
INTEGRATION_JSON = ".specify/integration.json"
|
||||
INTEGRATION_STATE_SCHEMA = 1
|
||||
|
||||
|
||||
def clean_integration_key(key: Any) -> str | None:
|
||||
"""Return a stripped integration key, or None for empty/non-string values."""
|
||||
if not isinstance(key, str) or not key.strip():
|
||||
return None
|
||||
return key.strip()
|
||||
|
||||
|
||||
def dedupe_integration_keys(keys: list[Any]) -> list[str]:
|
||||
"""Return a de-duplicated list of non-empty integration keys."""
|
||||
seen: set[str] = set()
|
||||
deduped: list[str] = []
|
||||
for key in keys:
|
||||
clean = clean_integration_key(key)
|
||||
if clean is None:
|
||||
continue
|
||||
if clean in seen:
|
||||
continue
|
||||
seen.add(clean)
|
||||
deduped.append(clean)
|
||||
return deduped
|
||||
|
||||
|
||||
def normalize_integration_settings(settings: Any) -> dict[str, dict[str, Any]]:
|
||||
"""Return JSON-safe per-integration runtime settings."""
|
||||
if not isinstance(settings, dict):
|
||||
return {}
|
||||
|
||||
normalized: dict[str, dict[str, Any]] = {}
|
||||
for key, value in settings.items():
|
||||
if not isinstance(key, str) or not key.strip() or not isinstance(value, dict):
|
||||
continue
|
||||
|
||||
clean: dict[str, Any] = {}
|
||||
script = value.get("script")
|
||||
if isinstance(script, str) and script.strip():
|
||||
clean["script"] = script.strip()
|
||||
|
||||
raw_options = value.get("raw_options")
|
||||
if isinstance(raw_options, str):
|
||||
clean["raw_options"] = raw_options
|
||||
|
||||
parsed_options = value.get("parsed_options")
|
||||
if isinstance(parsed_options, dict):
|
||||
clean["parsed_options"] = parsed_options
|
||||
|
||||
invoke_separator = value.get("invoke_separator")
|
||||
if isinstance(invoke_separator, str) and invoke_separator.strip():
|
||||
clean["invoke_separator"] = invoke_separator.strip()
|
||||
|
||||
if clean:
|
||||
normalized[key.strip()] = clean
|
||||
|
||||
return normalized
|
||||
|
||||
|
||||
def _normalized_integration_state_schema(value: Any) -> int:
|
||||
if isinstance(value, int) and not isinstance(value, bool) and value > INTEGRATION_STATE_SCHEMA:
|
||||
return value
|
||||
return INTEGRATION_STATE_SCHEMA
|
||||
|
||||
|
||||
def normalize_integration_state(data: dict[str, Any]) -> dict[str, Any]:
|
||||
"""Normalize legacy and multi-install integration metadata."""
|
||||
legacy_key = clean_integration_key(data.get("integration"))
|
||||
default_key = clean_integration_key(data.get("default_integration")) or legacy_key
|
||||
|
||||
installed = data.get("installed_integrations")
|
||||
installed_keys = dedupe_integration_keys(installed if isinstance(installed, list) else [])
|
||||
if not default_key and installed_keys:
|
||||
default_key = installed_keys[0]
|
||||
if default_key and default_key not in installed_keys:
|
||||
installed_keys.insert(0, default_key)
|
||||
|
||||
settings = normalize_integration_settings(data.get("integration_settings"))
|
||||
|
||||
normalized = dict(data)
|
||||
normalized["integration_state_schema"] = _normalized_integration_state_schema(
|
||||
data.get("integration_state_schema")
|
||||
)
|
||||
if default_key:
|
||||
normalized["integration"] = default_key
|
||||
normalized["default_integration"] = default_key
|
||||
else:
|
||||
normalized.pop("integration", None)
|
||||
normalized.pop("default_integration", None)
|
||||
normalized["installed_integrations"] = installed_keys
|
||||
normalized["integration_settings"] = {
|
||||
key: settings[key] for key in installed_keys if key in settings
|
||||
}
|
||||
return normalized
|
||||
|
||||
|
||||
def default_integration_key(state: dict[str, Any]) -> str | None:
|
||||
"""Return the default integration key from normalized state."""
|
||||
key = state.get("default_integration") or state.get("integration")
|
||||
return clean_integration_key(key)
|
||||
|
||||
|
||||
def installed_integration_keys(state: dict[str, Any]) -> list[str]:
|
||||
"""Return installed integration keys from normalized state."""
|
||||
return dedupe_integration_keys(state.get("installed_integrations", []))
|
||||
|
||||
|
||||
def integration_settings(state: dict[str, Any]) -> dict[str, dict[str, Any]]:
|
||||
"""Return normalized per-integration settings from state."""
|
||||
return normalize_integration_settings(state.get("integration_settings"))
|
||||
|
||||
|
||||
def integration_setting(state: dict[str, Any], key: str) -> dict[str, Any]:
|
||||
"""Return stored runtime settings for *key*."""
|
||||
return dict(integration_settings(state).get(key, {}))
|
||||
|
||||
|
||||
def write_integration_json(
|
||||
project_root: Path,
|
||||
*,
|
||||
version: str,
|
||||
integration_key: str | None,
|
||||
installed_integrations: list[str] | None = None,
|
||||
settings: dict[str, dict[str, Any]] | None = None,
|
||||
) -> None:
|
||||
"""Write ``.specify/integration.json`` with legacy-compatible state."""
|
||||
dest = project_root / INTEGRATION_JSON
|
||||
dest.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
integration_key = clean_integration_key(integration_key)
|
||||
installed = dedupe_integration_keys(installed_integrations or [])
|
||||
if integration_key and integration_key not in installed:
|
||||
installed.insert(0, integration_key)
|
||||
if not integration_key and installed:
|
||||
integration_key = installed[0]
|
||||
|
||||
normalized_settings = normalize_integration_settings(settings or {})
|
||||
normalized_settings = {
|
||||
key: normalized_settings[key] for key in installed if key in normalized_settings
|
||||
}
|
||||
|
||||
data: dict[str, Any] = {
|
||||
"version": version,
|
||||
"integration_state_schema": INTEGRATION_STATE_SCHEMA,
|
||||
"installed_integrations": installed,
|
||||
"integration_settings": normalized_settings,
|
||||
}
|
||||
if integration_key:
|
||||
data["integration"] = integration_key
|
||||
data["default_integration"] = integration_key
|
||||
|
||||
dest.write_text(json.dumps(data, indent=2) + "\n", encoding="utf-8")
|
||||
@@ -19,3 +19,4 @@ class AuggieIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = ".augment/rules/specify-rules.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -87,6 +87,14 @@ class IntegrationBase(ABC):
|
||||
invoke_separator: str = "."
|
||||
"""Separator used in slash-command invocations (``"."`` → ``/speckit.plan``)."""
|
||||
|
||||
multi_install_safe: bool = False
|
||||
"""Whether this integration is declared safe to install alongside others.
|
||||
|
||||
Safe integrations must use a static, unique agent root, command directory,
|
||||
and context file. Registry tests enforce those invariants for every
|
||||
integration that sets this flag.
|
||||
"""
|
||||
|
||||
# -- Markers for managed context section ------------------------------
|
||||
|
||||
CONTEXT_MARKER_START = "<!-- SPECKIT START -->"
|
||||
|
||||
@@ -53,6 +53,7 @@ class ClaudeIntegration(SkillsIntegration):
|
||||
"extension": "/SKILL.md",
|
||||
}
|
||||
context_file = "CLAUDE.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@staticmethod
|
||||
def inject_argument_hint(content: str, hint: str) -> str:
|
||||
|
||||
@@ -19,3 +19,4 @@ class CodebuddyIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = "CODEBUDDY.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -27,6 +27,7 @@ class CodexIntegration(SkillsIntegration):
|
||||
"extension": "/SKILL.md",
|
||||
}
|
||||
context_file = "AGENTS.md"
|
||||
multi_install_safe = True
|
||||
|
||||
def build_exec_args(
|
||||
self,
|
||||
|
||||
@@ -26,6 +26,7 @@ class CursorAgentIntegration(SkillsIntegration):
|
||||
}
|
||||
|
||||
context_file = ".cursor/rules/specify-rules.mdc"
|
||||
multi_install_safe = True
|
||||
|
||||
@classmethod
|
||||
def options(cls) -> list[IntegrationOption]:
|
||||
|
||||
@@ -19,3 +19,4 @@ class GeminiIntegration(TomlIntegration):
|
||||
"extension": ".toml",
|
||||
}
|
||||
context_file = "GEMINI.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class IflowIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = "IFLOW.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class JunieIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = ".junie/AGENTS.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class KilocodeIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = ".kilocode/rules/specify-rules.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -36,6 +36,7 @@ class KimiIntegration(SkillsIntegration):
|
||||
"extension": "/SKILL.md",
|
||||
}
|
||||
context_file = "KIMI.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@classmethod
|
||||
def options(cls) -> list[IntegrationOption]:
|
||||
|
||||
@@ -11,6 +11,7 @@ from __future__ import annotations
|
||||
import hashlib
|
||||
import json
|
||||
import os
|
||||
import tempfile
|
||||
from datetime import datetime, timezone
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
@@ -47,6 +48,59 @@ def _validate_rel_path(rel: Path, root: Path) -> Path:
|
||||
return resolved
|
||||
|
||||
|
||||
def _manifest_path_label(root: Path, path: Path) -> str:
|
||||
try:
|
||||
return path.relative_to(root).as_posix()
|
||||
except ValueError:
|
||||
return path.as_posix()
|
||||
|
||||
|
||||
def _ensure_safe_manifest_directory(root: Path, directory: Path) -> None:
|
||||
"""Create a manifest directory without following symlinked parents."""
|
||||
root_resolved = root.resolve()
|
||||
try:
|
||||
rel = directory.relative_to(root)
|
||||
except ValueError:
|
||||
label = _manifest_path_label(root, directory)
|
||||
raise ValueError(f"Integration manifest directory escapes project root: {label}") from None
|
||||
|
||||
current = root
|
||||
for part in rel.parts:
|
||||
current = current / part
|
||||
label = _manifest_path_label(root, current)
|
||||
if current.is_symlink():
|
||||
raise ValueError(f"Refusing to use symlinked integration manifest directory: {label}")
|
||||
if current.exists():
|
||||
if not current.is_dir():
|
||||
raise ValueError(f"Integration manifest directory path is not a directory: {label}")
|
||||
try:
|
||||
current.resolve().relative_to(root_resolved)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Integration manifest directory escapes project root: {label}") from None
|
||||
continue
|
||||
current.mkdir()
|
||||
try:
|
||||
current.resolve().relative_to(root_resolved)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Integration manifest directory escapes project root: {label}") from None
|
||||
|
||||
|
||||
def _ensure_safe_manifest_destination(root: Path, path: Path) -> None:
|
||||
"""Refuse manifest writes that would escape the project or follow symlinks."""
|
||||
root_resolved = root.resolve()
|
||||
_ensure_safe_manifest_directory(root, path.parent)
|
||||
label = _manifest_path_label(root, path)
|
||||
if path.is_symlink():
|
||||
raise ValueError(f"Refusing to overwrite symlinked integration manifest path: {label}")
|
||||
if path.exists():
|
||||
if not path.is_file():
|
||||
raise ValueError(f"Integration manifest path is not a file: {label}")
|
||||
try:
|
||||
path.resolve().relative_to(root_resolved)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Integration manifest path escapes project root: {label}") from None
|
||||
|
||||
|
||||
class IntegrationManifest:
|
||||
"""Tracks files installed by a single integration.
|
||||
|
||||
@@ -217,8 +271,19 @@ class IntegrationManifest:
|
||||
"files": self._files,
|
||||
}
|
||||
path = self.manifest_path
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
path.write_text(json.dumps(data, indent=2) + "\n", encoding="utf-8")
|
||||
content = json.dumps(data, indent=2) + "\n"
|
||||
_ensure_safe_manifest_destination(self.project_root, path)
|
||||
fd, temp_name = tempfile.mkstemp(prefix=f".{path.name}.", dir=path.parent)
|
||||
temp_path = Path(temp_name)
|
||||
try:
|
||||
with os.fdopen(fd, "w", encoding="utf-8") as fh:
|
||||
fh.write(content)
|
||||
temp_path.chmod(0o644)
|
||||
_ensure_safe_manifest_destination(self.project_root, path)
|
||||
os.replace(temp_path, path)
|
||||
finally:
|
||||
if temp_path.exists():
|
||||
temp_path.unlink()
|
||||
return path
|
||||
|
||||
@classmethod
|
||||
|
||||
@@ -19,3 +19,4 @@ class QodercliIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = "QODER.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class QwenIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = "QWEN.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class RooIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = ".roo/rules/specify-rules.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class ShaiIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = "SHAI.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -19,3 +19,4 @@ class TabnineIntegration(TomlIntegration):
|
||||
"extension": ".toml",
|
||||
}
|
||||
context_file = "TABNINE.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@@ -27,6 +27,7 @@ class TraeIntegration(SkillsIntegration):
|
||||
"extension": "/SKILL.md",
|
||||
}
|
||||
context_file = ".trae/rules/project_rules.md"
|
||||
multi_install_safe = True
|
||||
|
||||
@classmethod
|
||||
def options(cls) -> list[IntegrationOption]:
|
||||
|
||||
@@ -19,3 +19,4 @@ class WindsurfIntegration(MarkdownIntegration):
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = ".windsurf/rules/specify-rules.md"
|
||||
multi_install_safe = True
|
||||
|
||||
317
src/specify_cli/shared_infra.py
Normal file
317
src/specify_cli/shared_infra.py
Normal file
@@ -0,0 +1,317 @@
|
||||
"""Shared Spec Kit infrastructure installation helpers."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
from .integrations.base import IntegrationBase
|
||||
from .integrations.manifest import IntegrationManifest
|
||||
|
||||
|
||||
def load_speckit_manifest(
|
||||
project_path: Path,
|
||||
*,
|
||||
version: str,
|
||||
console: Any | None = None,
|
||||
) -> IntegrationManifest:
|
||||
"""Load the shared infrastructure manifest, preserving existing entries."""
|
||||
manifest_path = project_path / ".specify" / "integrations" / "speckit.manifest.json"
|
||||
if manifest_path.exists():
|
||||
try:
|
||||
manifest = IntegrationManifest.load("speckit", project_path)
|
||||
manifest.version = version
|
||||
return manifest
|
||||
except (ValueError, FileNotFoundError, OSError, UnicodeDecodeError) as exc:
|
||||
if console is not None:
|
||||
console.print(
|
||||
f"[yellow]Warning:[/yellow] Could not read shared infrastructure "
|
||||
f"manifest at {manifest_path}: {exc}"
|
||||
)
|
||||
console.print(
|
||||
"A new shared manifest will be created; previously tracked "
|
||||
"shared files may be treated as untracked."
|
||||
)
|
||||
return IntegrationManifest("speckit", project_path, version=version)
|
||||
|
||||
|
||||
def shared_templates_source(
|
||||
*,
|
||||
core_pack: Path | None,
|
||||
repo_root: Path,
|
||||
) -> Path:
|
||||
"""Return the bundled/source shared templates directory."""
|
||||
if core_pack and (core_pack / "templates").is_dir():
|
||||
return core_pack / "templates"
|
||||
return repo_root / "templates"
|
||||
|
||||
|
||||
def shared_scripts_source(
|
||||
*,
|
||||
core_pack: Path | None,
|
||||
repo_root: Path,
|
||||
) -> Path:
|
||||
"""Return the bundled/source shared scripts directory."""
|
||||
if core_pack and (core_pack / "scripts").is_dir():
|
||||
return core_pack / "scripts"
|
||||
return repo_root / "scripts"
|
||||
|
||||
|
||||
def _shared_destination_label(project_path: Path, dest: Path) -> str:
|
||||
try:
|
||||
return dest.relative_to(project_path).as_posix()
|
||||
except ValueError:
|
||||
return str(dest)
|
||||
|
||||
|
||||
def _shared_relative_path(project_path: Path, dest: Path) -> Path:
|
||||
try:
|
||||
rel = dest.relative_to(project_path)
|
||||
except ValueError:
|
||||
label = _shared_destination_label(project_path, dest)
|
||||
raise ValueError(f"Shared infrastructure path escapes project root: {label}") from None
|
||||
|
||||
if rel.is_absolute() or ".." in rel.parts:
|
||||
label = _shared_destination_label(project_path, dest)
|
||||
raise ValueError(f"Shared infrastructure path escapes project root: {label}")
|
||||
return rel
|
||||
|
||||
|
||||
def _ensure_safe_shared_directory(project_path: Path, directory: Path, *, create: bool = True) -> None:
|
||||
"""Create a shared infra directory without following symlinked parents."""
|
||||
root = project_path.resolve()
|
||||
rel = _shared_relative_path(project_path, directory)
|
||||
current = project_path
|
||||
|
||||
for part in rel.parts:
|
||||
current = current / part
|
||||
label = _shared_destination_label(project_path, current)
|
||||
if current.is_symlink():
|
||||
raise ValueError(f"Refusing to use symlinked shared infrastructure directory: {label}")
|
||||
if current.exists():
|
||||
if not current.is_dir():
|
||||
raise ValueError(f"Shared infrastructure directory path is not a directory: {label}")
|
||||
try:
|
||||
current.resolve().relative_to(root)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Shared infrastructure directory escapes project root: {label}") from None
|
||||
continue
|
||||
if not create:
|
||||
raise ValueError(f"Shared infrastructure directory does not exist: {label}")
|
||||
current.mkdir()
|
||||
if current.is_symlink():
|
||||
raise ValueError(f"Refusing to use symlinked shared infrastructure directory: {label}")
|
||||
try:
|
||||
current.resolve().relative_to(root)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Shared infrastructure directory escapes project root: {label}") from None
|
||||
|
||||
|
||||
def _validate_safe_shared_directory(project_path: Path, directory: Path) -> None:
|
||||
"""Validate existing directory parents while allowing missing directories."""
|
||||
root = project_path.resolve()
|
||||
rel = _shared_relative_path(project_path, directory)
|
||||
current = project_path
|
||||
|
||||
for part in rel.parts:
|
||||
current = current / part
|
||||
label = _shared_destination_label(project_path, current)
|
||||
if current.is_symlink():
|
||||
raise ValueError(f"Refusing to use symlinked shared infrastructure directory: {label}")
|
||||
if not current.exists():
|
||||
continue
|
||||
if not current.is_dir():
|
||||
raise ValueError(f"Shared infrastructure directory path is not a directory: {label}")
|
||||
try:
|
||||
current.resolve().relative_to(root)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Shared infrastructure directory escapes project root: {label}") from None
|
||||
|
||||
|
||||
def _ensure_safe_shared_destination(
|
||||
project_path: Path,
|
||||
dest: Path,
|
||||
*,
|
||||
parent_must_exist: bool = True,
|
||||
) -> None:
|
||||
"""Refuse shared infra writes that would escape or follow symlinks."""
|
||||
root = project_path.resolve()
|
||||
_shared_relative_path(project_path, dest)
|
||||
if parent_must_exist:
|
||||
_ensure_safe_shared_directory(project_path, dest.parent, create=False)
|
||||
else:
|
||||
_validate_safe_shared_directory(project_path, dest.parent)
|
||||
label = _shared_destination_label(project_path, dest)
|
||||
if dest.is_symlink():
|
||||
raise ValueError(f"Refusing to overwrite symlinked shared infrastructure path: {label}")
|
||||
|
||||
if dest.exists():
|
||||
try:
|
||||
dest.resolve().relative_to(root)
|
||||
except (OSError, ValueError):
|
||||
raise ValueError(f"Shared infrastructure destination escapes project root: {label}") from None
|
||||
|
||||
|
||||
def _write_shared_text(project_path: Path, dest: Path, content: str) -> None:
|
||||
_write_shared_bytes(project_path, dest, content.encode("utf-8"))
|
||||
|
||||
|
||||
def _write_shared_bytes(
|
||||
project_path: Path,
|
||||
dest: Path,
|
||||
content: bytes,
|
||||
*,
|
||||
mode: int = 0o644,
|
||||
) -> None:
|
||||
_ensure_safe_shared_destination(project_path, dest)
|
||||
fd, temp_name = tempfile.mkstemp(prefix=f".{dest.name}.", dir=dest.parent)
|
||||
temp_path = Path(temp_name)
|
||||
try:
|
||||
with os.fdopen(fd, "wb") as fh:
|
||||
fh.write(content)
|
||||
temp_path.chmod(mode)
|
||||
_ensure_safe_shared_destination(project_path, dest)
|
||||
os.replace(temp_path, dest)
|
||||
finally:
|
||||
if temp_path.exists():
|
||||
temp_path.unlink()
|
||||
|
||||
|
||||
def refresh_shared_templates(
|
||||
project_path: Path,
|
||||
*,
|
||||
version: str,
|
||||
core_pack: Path | None,
|
||||
repo_root: Path,
|
||||
console: Any,
|
||||
invoke_separator: str,
|
||||
force: bool = False,
|
||||
) -> None:
|
||||
"""Refresh default-sensitive shared templates without touching scripts."""
|
||||
templates_src = shared_templates_source(core_pack=core_pack, repo_root=repo_root)
|
||||
if not templates_src.is_dir():
|
||||
return
|
||||
|
||||
manifest = load_speckit_manifest(project_path, version=version, console=console)
|
||||
tracked_files = manifest.files
|
||||
modified = set(manifest.check_modified())
|
||||
skipped_files: list[str] = []
|
||||
planned_updates: list[tuple[Path, str, str]] = []
|
||||
|
||||
dest_templates = project_path / ".specify" / "templates"
|
||||
_ensure_safe_shared_directory(project_path, dest_templates)
|
||||
for src in templates_src.iterdir():
|
||||
if not src.is_file() or src.name == "vscode-settings.json" or src.name.startswith("."):
|
||||
continue
|
||||
|
||||
dst = dest_templates / src.name
|
||||
_ensure_safe_shared_destination(project_path, dst)
|
||||
rel = dst.relative_to(project_path).as_posix()
|
||||
if dst.exists() and not force:
|
||||
if rel not in tracked_files or rel in modified:
|
||||
skipped_files.append(rel)
|
||||
continue
|
||||
|
||||
content = src.read_text(encoding="utf-8")
|
||||
content = IntegrationBase.resolve_command_refs(content, invoke_separator)
|
||||
planned_updates.append((dst, rel, content))
|
||||
|
||||
for dst, rel, content in planned_updates:
|
||||
_write_shared_text(project_path, dst, content)
|
||||
manifest.record_existing(rel)
|
||||
|
||||
manifest.save()
|
||||
|
||||
if skipped_files:
|
||||
console.print(
|
||||
f"[yellow]⚠[/yellow] {len(skipped_files)} modified or untracked shared template file(s) were not updated:"
|
||||
)
|
||||
for rel in skipped_files:
|
||||
console.print(f" {rel}")
|
||||
|
||||
|
||||
def install_shared_infra(
|
||||
project_path: Path,
|
||||
script_type: str,
|
||||
*,
|
||||
version: str,
|
||||
core_pack: Path | None,
|
||||
repo_root: Path,
|
||||
console: Any,
|
||||
force: bool = False,
|
||||
invoke_separator: str = ".",
|
||||
) -> bool:
|
||||
"""Install shared scripts and templates into *project_path*."""
|
||||
manifest = load_speckit_manifest(project_path, version=version, console=console)
|
||||
skipped_files: list[str] = []
|
||||
planned_copies: list[tuple[Path, str, bytes, int]] = []
|
||||
planned_templates: list[tuple[Path, str, str]] = []
|
||||
|
||||
scripts_src = shared_scripts_source(core_pack=core_pack, repo_root=repo_root)
|
||||
if scripts_src.is_dir():
|
||||
dest_scripts = project_path / ".specify" / "scripts"
|
||||
_ensure_safe_shared_directory(project_path, dest_scripts)
|
||||
variant_dir = "bash" if script_type == "sh" else "powershell"
|
||||
variant_src = scripts_src / variant_dir
|
||||
if variant_src.is_dir():
|
||||
dest_variant = dest_scripts / variant_dir
|
||||
_ensure_safe_shared_directory(project_path, dest_variant)
|
||||
for src_path in variant_src.rglob("*"):
|
||||
if not src_path.is_file():
|
||||
continue
|
||||
|
||||
rel_path = src_path.relative_to(variant_src)
|
||||
dst_path = dest_variant / rel_path
|
||||
_ensure_safe_shared_destination(project_path, dst_path, parent_must_exist=False)
|
||||
if dst_path.exists() and not force:
|
||||
skipped_files.append(dst_path.relative_to(project_path).as_posix())
|
||||
continue
|
||||
|
||||
_ensure_safe_shared_directory(project_path, dst_path.parent)
|
||||
rel = dst_path.relative_to(project_path).as_posix()
|
||||
planned_copies.append((dst_path, rel, src_path.read_bytes(), src_path.stat().st_mode & 0o777))
|
||||
|
||||
templates_src = shared_templates_source(core_pack=core_pack, repo_root=repo_root)
|
||||
if templates_src.is_dir():
|
||||
dest_templates = project_path / ".specify" / "templates"
|
||||
_ensure_safe_shared_directory(project_path, dest_templates)
|
||||
for src in templates_src.iterdir():
|
||||
if not src.is_file() or src.name == "vscode-settings.json" or src.name.startswith("."):
|
||||
continue
|
||||
|
||||
dst = dest_templates / src.name
|
||||
_ensure_safe_shared_destination(project_path, dst)
|
||||
if dst.exists() and not force:
|
||||
skipped_files.append(dst.relative_to(project_path).as_posix())
|
||||
continue
|
||||
|
||||
content = src.read_text(encoding="utf-8")
|
||||
content = IntegrationBase.resolve_command_refs(content, invoke_separator)
|
||||
rel = dst.relative_to(project_path).as_posix()
|
||||
planned_templates.append((dst, rel, content))
|
||||
|
||||
for dst_path, rel, content, mode in planned_copies:
|
||||
_ensure_safe_shared_directory(project_path, dst_path.parent)
|
||||
_write_shared_bytes(project_path, dst_path, content, mode=mode)
|
||||
manifest.record_existing(rel)
|
||||
|
||||
for dst, rel, content in planned_templates:
|
||||
_write_shared_text(project_path, dst, content)
|
||||
manifest.record_existing(rel)
|
||||
|
||||
if skipped_files:
|
||||
console.print(
|
||||
f"[yellow]⚠[/yellow] {len(skipped_files)} shared infrastructure file(s) already exist and were not updated:"
|
||||
)
|
||||
for path in skipped_files:
|
||||
console.print(f" {path}")
|
||||
console.print(
|
||||
"To refresh shared infrastructure, run "
|
||||
"[cyan]specify init --here --force[/cyan] or "
|
||||
"[cyan]specify integration upgrade --force[/cyan]."
|
||||
)
|
||||
|
||||
manifest.save()
|
||||
return True
|
||||
@@ -1,13 +1,21 @@
|
||||
"""Tests for --integration flag on specify init (CLI-level)."""
|
||||
|
||||
import io
|
||||
import json
|
||||
import os
|
||||
|
||||
import pytest
|
||||
import yaml
|
||||
from rich.console import Console
|
||||
|
||||
from tests.conftest import strip_ansi
|
||||
|
||||
|
||||
class _NoopConsole:
|
||||
def print(self, *args, **kwargs):
|
||||
pass
|
||||
|
||||
|
||||
def _normalize_cli_output(output: str) -> str:
|
||||
output = strip_ansi(output)
|
||||
output = " ".join(output.split())
|
||||
@@ -254,6 +262,310 @@ class TestInitIntegrationFlag:
|
||||
normalized = " ".join(captured.out.split())
|
||||
assert "specify integration upgrade --force" in normalized
|
||||
|
||||
def test_shared_infra_warns_when_manifest_cannot_be_loaded(self, tmp_path, capsys):
|
||||
"""Invalid shared manifests warn before falling back to a new manifest."""
|
||||
from specify_cli import _install_shared_infra
|
||||
|
||||
project = tmp_path / "bad-shared-manifest-test"
|
||||
project.mkdir()
|
||||
integrations_dir = project / ".specify" / "integrations"
|
||||
integrations_dir.mkdir(parents=True)
|
||||
manifest_path = integrations_dir / "speckit.manifest.json"
|
||||
manifest_path.write_text("{not json", encoding="utf-8")
|
||||
|
||||
_install_shared_infra(project, "sh")
|
||||
|
||||
captured = capsys.readouterr()
|
||||
assert "Could not read shared infrastructure manifest" in captured.out
|
||||
assert "A new shared manifest will be created" in captured.out
|
||||
|
||||
def test_shared_infra_warns_when_manifest_cannot_be_decoded(self, tmp_path, capsys):
|
||||
"""Non-UTF-8 shared manifests warn before falling back to a new manifest."""
|
||||
from specify_cli import _install_shared_infra
|
||||
|
||||
project = tmp_path / "bad-shared-manifest-encoding-test"
|
||||
project.mkdir()
|
||||
integrations_dir = project / ".specify" / "integrations"
|
||||
integrations_dir.mkdir(parents=True)
|
||||
manifest_path = integrations_dir / "speckit.manifest.json"
|
||||
manifest_path.write_bytes(b"\xff\xfe\x00")
|
||||
|
||||
_install_shared_infra(project, "sh")
|
||||
|
||||
captured = capsys.readouterr()
|
||||
assert "Could not read shared infrastructure manifest" in captured.out
|
||||
assert "A new shared manifest will be created" in captured.out
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_infra_refuses_symlinked_script_destination(self, tmp_path):
|
||||
"""Shared script refreshes must not follow destination symlinks."""
|
||||
from specify_cli import _install_shared_infra
|
||||
|
||||
project = tmp_path / "symlink-script-test"
|
||||
project.mkdir()
|
||||
(project / ".specify").mkdir()
|
||||
|
||||
outside = tmp_path / "outside-script.sh"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
scripts_dir = project / ".specify" / "scripts" / "bash"
|
||||
scripts_dir.mkdir(parents=True)
|
||||
os.symlink(outside, scripts_dir / "common.sh")
|
||||
|
||||
with pytest.raises(ValueError, match="Refusing to overwrite symlinked"):
|
||||
_install_shared_infra(project, "sh", force=True)
|
||||
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_infra_refuses_symlinked_template_destination(self, tmp_path):
|
||||
"""Shared template installs must not follow destination symlinks."""
|
||||
from specify_cli import _install_shared_infra
|
||||
|
||||
project = tmp_path / "symlink-template-test"
|
||||
project.mkdir()
|
||||
(project / ".specify").mkdir()
|
||||
|
||||
outside = tmp_path / "outside-template.md"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
templates_dir = project / ".specify" / "templates"
|
||||
templates_dir.mkdir(parents=True)
|
||||
os.symlink(outside, templates_dir / "plan-template.md")
|
||||
|
||||
with pytest.raises(ValueError, match="Refusing to overwrite symlinked"):
|
||||
_install_shared_infra(project, "sh", force=True)
|
||||
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_template_refresh_refuses_symlinked_destination(self, tmp_path):
|
||||
"""Template-only refreshes must not follow destination symlinks."""
|
||||
from specify_cli import _refresh_shared_templates
|
||||
|
||||
project = tmp_path / "symlink-refresh-test"
|
||||
project.mkdir()
|
||||
(project / ".specify").mkdir()
|
||||
|
||||
outside = tmp_path / "outside-refresh.md"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
templates_dir = project / ".specify" / "templates"
|
||||
templates_dir.mkdir(parents=True)
|
||||
os.symlink(outside, templates_dir / "plan-template.md")
|
||||
|
||||
with pytest.raises(ValueError, match="Refusing to overwrite symlinked"):
|
||||
_refresh_shared_templates(project, invoke_separator=".", force=True)
|
||||
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_infra_refuses_symlinked_specify_directory_before_mkdir(self, tmp_path):
|
||||
"""Shared infra directory creation must not follow a symlinked .specify."""
|
||||
from specify_cli import _install_shared_infra
|
||||
|
||||
project = tmp_path / "symlink-dir-test"
|
||||
project.mkdir()
|
||||
outside = tmp_path / "outside-specify"
|
||||
outside.mkdir()
|
||||
os.symlink(outside, project / ".specify")
|
||||
|
||||
with pytest.raises(ValueError, match="symlinked shared infrastructure directory"):
|
||||
_install_shared_infra(project, "sh", force=True)
|
||||
|
||||
assert not (outside / "scripts").exists()
|
||||
assert not (outside / "templates").exists()
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_infra_refuses_symlinked_shared_manifest(self, tmp_path):
|
||||
"""Shared infra manifest saves must not follow destination symlinks."""
|
||||
from specify_cli.shared_infra import install_shared_infra
|
||||
|
||||
project = tmp_path / "symlink-shared-manifest-test"
|
||||
project.mkdir()
|
||||
integrations_dir = project / ".specify" / "integrations"
|
||||
integrations_dir.mkdir(parents=True)
|
||||
|
||||
outside = tmp_path / "outside-manifest.json"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
os.symlink(outside, integrations_dir / "speckit.manifest.json")
|
||||
|
||||
core_pack = tmp_path / "core-pack"
|
||||
templates_src = core_pack / "templates"
|
||||
templates_src.mkdir(parents=True)
|
||||
(templates_src / "plan-template.md").write_text("# plan\n", encoding="utf-8")
|
||||
|
||||
with pytest.raises(ValueError, match="symlinked integration manifest"):
|
||||
install_shared_infra(
|
||||
project,
|
||||
"sh",
|
||||
version="test",
|
||||
core_pack=core_pack,
|
||||
repo_root=tmp_path / "unused",
|
||||
console=_NoopConsole(),
|
||||
force=True,
|
||||
)
|
||||
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_template_refresh_preflights_before_writing(self, tmp_path):
|
||||
"""Template refresh validates all destinations before writing any file."""
|
||||
from specify_cli.shared_infra import refresh_shared_templates
|
||||
|
||||
project = tmp_path / "preflight-refresh-test"
|
||||
project.mkdir()
|
||||
templates_dir = project / ".specify" / "templates"
|
||||
templates_dir.mkdir(parents=True)
|
||||
|
||||
core_pack = tmp_path / "core-pack"
|
||||
templates_src = core_pack / "templates"
|
||||
templates_src.mkdir(parents=True)
|
||||
(templates_src / "a-template.md").write_text("# new a\n", encoding="utf-8")
|
||||
(templates_src / "z-template.md").write_text("# new z\n", encoding="utf-8")
|
||||
|
||||
existing = templates_dir / "a-template.md"
|
||||
existing.write_text("# old a\n", encoding="utf-8")
|
||||
outside = tmp_path / "outside-z.md"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
os.symlink(outside, templates_dir / "z-template.md")
|
||||
|
||||
with pytest.raises(ValueError, match="Refusing to overwrite symlinked"):
|
||||
refresh_shared_templates(
|
||||
project,
|
||||
version="test",
|
||||
core_pack=core_pack,
|
||||
repo_root=tmp_path / "unused",
|
||||
console=_NoopConsole(),
|
||||
invoke_separator=".",
|
||||
force=True,
|
||||
)
|
||||
|
||||
assert existing.read_text(encoding="utf-8") == "# old a\n"
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_shared_infra_install_preflights_before_writing(self, tmp_path):
|
||||
"""Full shared infra installs validate destinations before writing any file."""
|
||||
from specify_cli.shared_infra import install_shared_infra
|
||||
|
||||
project = tmp_path / "preflight-install-test"
|
||||
project.mkdir()
|
||||
scripts_dir = project / ".specify" / "scripts" / "bash"
|
||||
scripts_dir.mkdir(parents=True)
|
||||
|
||||
core_pack = tmp_path / "core-pack"
|
||||
scripts_src = core_pack / "scripts" / "bash"
|
||||
scripts_src.mkdir(parents=True)
|
||||
(scripts_src / "a.sh").write_text("# new a\n", encoding="utf-8")
|
||||
(scripts_src / "z.sh").write_text("# new z\n", encoding="utf-8")
|
||||
|
||||
existing = scripts_dir / "a.sh"
|
||||
existing.write_text("# old a\n", encoding="utf-8")
|
||||
outside = tmp_path / "outside-z.sh"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
os.symlink(outside, scripts_dir / "z.sh")
|
||||
|
||||
with pytest.raises(ValueError, match="Refusing to overwrite symlinked"):
|
||||
install_shared_infra(
|
||||
project,
|
||||
"sh",
|
||||
version="test",
|
||||
core_pack=core_pack,
|
||||
repo_root=tmp_path / "unused",
|
||||
console=_NoopConsole(),
|
||||
force=True,
|
||||
)
|
||||
|
||||
assert existing.read_text(encoding="utf-8") == "# old a\n"
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
def test_shared_infra_install_supports_nested_script_sources(self, tmp_path):
|
||||
"""Nested script source files create safe destination parents at write time."""
|
||||
from specify_cli.shared_infra import install_shared_infra
|
||||
|
||||
project = tmp_path / "nested-script-install-test"
|
||||
project.mkdir()
|
||||
|
||||
core_pack = tmp_path / "core-pack"
|
||||
nested_src = core_pack / "scripts" / "bash" / "nested"
|
||||
nested_src.mkdir(parents=True)
|
||||
(nested_src / "deep.sh").write_text("# nested\n", encoding="utf-8")
|
||||
|
||||
install_shared_infra(
|
||||
project,
|
||||
"sh",
|
||||
version="test",
|
||||
core_pack=core_pack,
|
||||
repo_root=tmp_path / "unused",
|
||||
console=_NoopConsole(),
|
||||
force=True,
|
||||
)
|
||||
|
||||
nested_dest = project / ".specify" / "scripts" / "bash" / "nested" / "deep.sh"
|
||||
assert nested_dest.read_text(encoding="utf-8") == "# nested\n"
|
||||
|
||||
def test_shared_infra_skip_warning_uses_posix_paths(self, tmp_path):
|
||||
"""Skipped shared infra paths are reported consistently across platforms."""
|
||||
from specify_cli.shared_infra import install_shared_infra
|
||||
|
||||
project = tmp_path / "posix-skip-warning-test"
|
||||
project.mkdir()
|
||||
nested_dest = project / ".specify" / "scripts" / "bash" / "nested"
|
||||
nested_dest.mkdir(parents=True)
|
||||
(nested_dest / "deep.sh").write_text("# existing script\n", encoding="utf-8")
|
||||
|
||||
templates_dest = project / ".specify" / "templates"
|
||||
templates_dest.mkdir(parents=True)
|
||||
(templates_dest / "plan-template.md").write_text("# existing template\n", encoding="utf-8")
|
||||
|
||||
core_pack = tmp_path / "core-pack"
|
||||
nested_src = core_pack / "scripts" / "bash" / "nested"
|
||||
nested_src.mkdir(parents=True)
|
||||
(nested_src / "deep.sh").write_text("# bundled script\n", encoding="utf-8")
|
||||
|
||||
templates_src = core_pack / "templates"
|
||||
templates_src.mkdir(parents=True)
|
||||
(templates_src / "plan-template.md").write_text("# bundled template\n", encoding="utf-8")
|
||||
|
||||
buffer = io.StringIO()
|
||||
install_shared_infra(
|
||||
project,
|
||||
"sh",
|
||||
version="test",
|
||||
core_pack=core_pack,
|
||||
repo_root=tmp_path / "unused",
|
||||
console=Console(file=buffer, force_terminal=False, width=120),
|
||||
force=False,
|
||||
)
|
||||
|
||||
output = buffer.getvalue()
|
||||
assert ".specify/scripts/bash/nested/deep.sh" in output
|
||||
assert ".specify/templates/plan-template.md" in output
|
||||
|
||||
@pytest.mark.skipif(os.name == "nt", reason="POSIX mode bits are not stable on Windows")
|
||||
def test_shared_template_writes_are_not_world_writable(self, tmp_path):
|
||||
"""Shared template writes use a safe default mode instead of chmod 666."""
|
||||
from specify_cli.shared_infra import install_shared_infra
|
||||
|
||||
project = tmp_path / "template-mode-test"
|
||||
project.mkdir()
|
||||
|
||||
core_pack = tmp_path / "core-pack"
|
||||
templates_src = core_pack / "templates"
|
||||
templates_src.mkdir(parents=True)
|
||||
(templates_src / "plan-template.md").write_text("# plan\n", encoding="utf-8")
|
||||
|
||||
install_shared_infra(
|
||||
project,
|
||||
"sh",
|
||||
version="test",
|
||||
core_pack=core_pack,
|
||||
repo_root=tmp_path / "unused",
|
||||
console=_NoopConsole(),
|
||||
force=True,
|
||||
)
|
||||
|
||||
written = project / ".specify" / "templates" / "plan-template.md"
|
||||
assert written.stat().st_mode & 0o777 == 0o644
|
||||
|
||||
def test_shared_infra_no_warning_when_forced(self, tmp_path, capsys):
|
||||
"""No skip warning when force=True (all files overwritten)."""
|
||||
from specify_cli import _install_shared_infra
|
||||
@@ -712,6 +1024,7 @@ class TestIntegrationCatalogDiscoveryCLI:
|
||||
commands = [
|
||||
["integration", "list"],
|
||||
["integration", "install", "codex"],
|
||||
["integration", "use", "codex"],
|
||||
["integration", "uninstall"],
|
||||
["integration", "switch", "codex"],
|
||||
["integration", "upgrade"],
|
||||
@@ -730,10 +1043,92 @@ class TestIntegrationCatalogDiscoveryCLI:
|
||||
project.mkdir()
|
||||
(project / ".specify").write_text("not a directory")
|
||||
|
||||
result = self._invoke(["integration", "list"], project)
|
||||
commands = [
|
||||
["integration", "list"],
|
||||
["integration", "use", "codex"],
|
||||
]
|
||||
|
||||
assert result.exit_code == 1, result.output
|
||||
assert "Not a spec-kit project" in result.output
|
||||
for command in commands:
|
||||
result = self._invoke(command, project)
|
||||
assert result.exit_code == 1, result.output
|
||||
assert "Not a spec-kit project" in result.output
|
||||
|
||||
def test_project_scoped_commands_require_specify_directory(self, tmp_path):
|
||||
project = tmp_path / "bad-feature-commands"
|
||||
project.mkdir()
|
||||
(project / ".specify").write_text("not a directory")
|
||||
|
||||
commands = [
|
||||
["preset", "list"],
|
||||
["preset", "add", "demo"],
|
||||
["preset", "remove", "demo"],
|
||||
["preset", "search"],
|
||||
["preset", "resolve", "spec-template"],
|
||||
["preset", "info", "demo"],
|
||||
["preset", "set-priority", "demo", "5"],
|
||||
["preset", "enable", "demo"],
|
||||
["preset", "disable", "demo"],
|
||||
["preset", "catalog", "list"],
|
||||
["preset", "catalog", "add", "https://example.com/catalog.yml", "--name", "demo"],
|
||||
["preset", "catalog", "remove", "demo"],
|
||||
["extension", "list"],
|
||||
["extension", "add", "demo"],
|
||||
["extension", "remove", "demo"],
|
||||
["extension", "search"],
|
||||
["extension", "info", "demo"],
|
||||
["extension", "update", "demo"],
|
||||
["extension", "enable", "demo"],
|
||||
["extension", "disable", "demo"],
|
||||
["extension", "set-priority", "demo", "5"],
|
||||
["extension", "catalog", "list"],
|
||||
["extension", "catalog", "add", "https://example.com/catalog.yml", "--name", "demo"],
|
||||
["extension", "catalog", "remove", "demo"],
|
||||
["workflow", "run", "demo"],
|
||||
["workflow", "resume", "demo"],
|
||||
["workflow", "status"],
|
||||
["workflow", "list"],
|
||||
["workflow", "add", "demo"],
|
||||
["workflow", "remove", "demo"],
|
||||
["workflow", "search"],
|
||||
["workflow", "info", "demo"],
|
||||
["workflow", "catalog", "add", "https://example.com/catalog.yml"],
|
||||
["workflow", "catalog", "remove", "0"],
|
||||
]
|
||||
|
||||
for command in commands:
|
||||
result = self._invoke(command, project)
|
||||
failure_context = (
|
||||
f"command={command!r}, exit_code={result.exit_code}, output={result.output!r}"
|
||||
)
|
||||
assert result.exit_code == 1, failure_context
|
||||
assert "Not a spec-kit project" in result.output, failure_context
|
||||
|
||||
def test_catalog_config_output_uses_posix_paths(self, tmp_path):
|
||||
project = self._make_project(tmp_path)
|
||||
|
||||
preset_add = self._invoke([
|
||||
"preset", "catalog", "add",
|
||||
"https://example.com/preset-catalog.yml",
|
||||
"--name", "demo-presets",
|
||||
], project)
|
||||
assert preset_add.exit_code == 0, preset_add.output
|
||||
assert "Config saved to .specify/preset-catalogs.yml" in preset_add.output
|
||||
|
||||
preset_list = self._invoke(["preset", "catalog", "list"], project)
|
||||
assert preset_list.exit_code == 0, preset_list.output
|
||||
assert "Config: .specify/preset-catalogs.yml" in preset_list.output
|
||||
|
||||
extension_add = self._invoke([
|
||||
"extension", "catalog", "add",
|
||||
"https://example.com/extension-catalog.yml",
|
||||
"--name", "demo-extensions",
|
||||
], project)
|
||||
assert extension_add.exit_code == 0, extension_add.output
|
||||
assert "Config saved to .specify/extension-catalogs.yml" in extension_add.output
|
||||
|
||||
extension_list = self._invoke(["extension", "catalog", "list"], project)
|
||||
assert extension_list.exit_code == 0, extension_list.output
|
||||
assert "Config: .specify/extension-catalogs.yml" in extension_list.output
|
||||
|
||||
# -- search ------------------------------------------------------------
|
||||
|
||||
|
||||
@@ -670,7 +670,7 @@ class TestIntegrationUpgrade:
|
||||
finally:
|
||||
os.chdir(old)
|
||||
assert result.exit_code != 0
|
||||
assert "not the currently installed integration" in result.output
|
||||
assert "not installed" in result.output
|
||||
|
||||
def test_upgrade_no_manifest(self, tmp_path):
|
||||
"""Upgrade with missing manifest suggests fresh install."""
|
||||
|
||||
86
tests/integrations/test_integration_state.py
Normal file
86
tests/integrations/test_integration_state.py
Normal file
@@ -0,0 +1,86 @@
|
||||
"""Tests for integration state normalization helpers."""
|
||||
|
||||
import json
|
||||
|
||||
from specify_cli.integration_state import (
|
||||
INTEGRATION_JSON,
|
||||
default_integration_key,
|
||||
integration_setting,
|
||||
normalize_integration_state,
|
||||
write_integration_json,
|
||||
)
|
||||
|
||||
|
||||
def test_normalize_integration_state_strips_default_key_without_duplicates():
|
||||
state = normalize_integration_state(
|
||||
{
|
||||
"default_integration": " claude ",
|
||||
"integration": " claude ",
|
||||
"installed_integrations": ["claude"],
|
||||
}
|
||||
)
|
||||
|
||||
assert state["integration"] == "claude"
|
||||
assert state["default_integration"] == "claude"
|
||||
assert state["installed_integrations"] == ["claude"]
|
||||
|
||||
|
||||
def test_normalize_integration_state_strips_legacy_key_fallback():
|
||||
state = normalize_integration_state(
|
||||
{
|
||||
"integration": " codex ",
|
||||
"installed_integrations": [],
|
||||
}
|
||||
)
|
||||
|
||||
assert state["integration"] == "codex"
|
||||
assert state["default_integration"] == "codex"
|
||||
assert state["installed_integrations"] == ["codex"]
|
||||
|
||||
|
||||
def test_normalize_integration_state_preserves_newer_schema():
|
||||
state = normalize_integration_state(
|
||||
{
|
||||
"integration_state_schema": 99,
|
||||
"integration": "claude",
|
||||
"installed_integrations": ["claude"],
|
||||
"future_field": {"keep": True},
|
||||
}
|
||||
)
|
||||
|
||||
assert state["integration_state_schema"] == 99
|
||||
assert state["future_field"] == {"keep": True}
|
||||
|
||||
|
||||
def test_default_integration_key_strips_raw_state_values():
|
||||
assert default_integration_key({"default_integration": " claude "}) == "claude"
|
||||
assert default_integration_key({"integration": " codex "}) == "codex"
|
||||
|
||||
|
||||
def test_integration_settings_strip_invoke_separator():
|
||||
setting = integration_setting(
|
||||
{
|
||||
"integration_settings": {
|
||||
"claude": {
|
||||
"invoke_separator": " - ",
|
||||
}
|
||||
}
|
||||
},
|
||||
"claude",
|
||||
)
|
||||
|
||||
assert setting["invoke_separator"] == "-"
|
||||
|
||||
|
||||
def test_write_integration_json_strips_integration_key(tmp_path):
|
||||
write_integration_json(
|
||||
tmp_path,
|
||||
version="1.2.3",
|
||||
integration_key=" claude ",
|
||||
installed_integrations=["claude"],
|
||||
)
|
||||
|
||||
state = json.loads((tmp_path / INTEGRATION_JSON).read_text(encoding="utf-8"))
|
||||
assert state["integration"] == "claude"
|
||||
assert state["default_integration"] == "claude"
|
||||
assert state["installed_integrations"] == ["claude"]
|
||||
@@ -3,6 +3,7 @@
|
||||
import json
|
||||
import os
|
||||
|
||||
import pytest
|
||||
from typer.testing import CliRunner
|
||||
|
||||
from specify_cli import app
|
||||
@@ -41,6 +42,17 @@ def _run_in_project(project, args):
|
||||
os.chdir(old_cwd)
|
||||
|
||||
|
||||
def _write_invalid_manifest(project, key):
|
||||
manifest = project / ".specify" / "integrations" / f"{key}.manifest.json"
|
||||
manifest.write_bytes(b"\xff\xfe\x00")
|
||||
return manifest
|
||||
|
||||
|
||||
def _integration_list_row_cells(output: str, key: str) -> list[str]:
|
||||
row = next(line for line in output.splitlines() if line.startswith(f"│ {key}"))
|
||||
return [cell.strip() for cell in row.split("│")[1:-1]]
|
||||
|
||||
|
||||
# ── list ─────────────────────────────────────────────────────────────
|
||||
|
||||
|
||||
@@ -80,6 +92,39 @@ class TestIntegrationList:
|
||||
assert "claude" in result.output
|
||||
assert "gemini" in result.output
|
||||
|
||||
def test_list_shows_multi_install_safe_status(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, ["integration", "list"])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0
|
||||
assert "Multi-install" in result.output
|
||||
assert "Safe" in result.output
|
||||
assert _integration_list_row_cells(result.output, "claude")[-1] == "yes"
|
||||
assert _integration_list_row_cells(result.output, "copilot")[-1] == "no"
|
||||
|
||||
def test_list_rejects_newer_integration_state_schema(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
int_json = project / ".specify" / "integration.json"
|
||||
data = json.loads(int_json.read_text(encoding="utf-8"))
|
||||
data["integration_state_schema"] = 99
|
||||
int_json.write_text(json.dumps(data), encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, ["integration", "list"])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
|
||||
assert result.exit_code != 0
|
||||
normalized = " ".join(result.output.split())
|
||||
assert "schema 99" in normalized
|
||||
assert "only supports schema 1" in normalized
|
||||
|
||||
|
||||
# ── install ──────────────────────────────────────────────────────────
|
||||
|
||||
@@ -116,7 +161,9 @@ class TestIntegrationInstall:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0
|
||||
assert "already installed" in result.output
|
||||
assert "uninstall" in result.output
|
||||
normalized = " ".join(result.output.split())
|
||||
assert "specify integration upgrade copilot" in normalized
|
||||
assert "specify integration uninstall copilot" in normalized
|
||||
|
||||
def test_install_different_when_one_exists(self, tmp_path):
|
||||
project = _init_project(tmp_path, "copilot")
|
||||
@@ -127,8 +174,112 @@ class TestIntegrationInstall:
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "already installed" in result.output
|
||||
assert "uninstall" in result.output
|
||||
assert "Installed integrations: copilot" in result.output
|
||||
assert "Default integration: copilot" in result.output
|
||||
assert "--force" in result.output
|
||||
|
||||
def test_install_multi_safe_integration(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
assert "installed successfully" in result.output
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "claude"
|
||||
assert data["default_integration"] == "claude"
|
||||
assert data["integration_state_schema"] == 1
|
||||
assert data["installed_integrations"] == ["claude", "codex"]
|
||||
assert data["integration_settings"]["claude"]["invoke_separator"] == "-"
|
||||
assert data["integration_settings"]["codex"]["invoke_separator"] == "-"
|
||||
|
||||
assert (project / ".claude" / "skills" / "speckit-plan" / "SKILL.md").exists()
|
||||
assert (project / ".agents" / "skills" / "speckit-plan" / "SKILL.md").exists()
|
||||
|
||||
def test_install_additional_preserves_shared_manifest(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
shared_manifest = project / ".specify" / "integrations" / "speckit.manifest.json"
|
||||
before = set(json.loads(shared_manifest.read_text(encoding="utf-8"))["files"])
|
||||
assert before
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
|
||||
after = set(json.loads(shared_manifest.read_text(encoding="utf-8"))["files"])
|
||||
assert before <= after
|
||||
|
||||
def test_install_multi_safe_migrates_legacy_state(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
int_json = project / ".specify" / "integration.json"
|
||||
int_json.write_text(json.dumps({
|
||||
"integration": "claude",
|
||||
"version": "0.0.0",
|
||||
}), encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
|
||||
data = json.loads(int_json.read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "claude"
|
||||
assert data["default_integration"] == "claude"
|
||||
assert data["installed_integrations"] == ["claude", "codex"]
|
||||
|
||||
def test_install_multi_unsafe_requires_force(self, tmp_path):
|
||||
project = _init_project(tmp_path, "copilot")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "install", "claude",
|
||||
"--script", "sh",
|
||||
])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "Installed integrations: copilot" in result.output
|
||||
assert "multi-install safe" in result.output
|
||||
assert "--force" in result.output
|
||||
|
||||
def test_install_multi_unsafe_allowed_with_force(self, tmp_path):
|
||||
project = _init_project(tmp_path, "copilot")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "install", "claude",
|
||||
"--script", "sh",
|
||||
"--force",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "copilot"
|
||||
assert data["installed_integrations"] == ["copilot", "claude"]
|
||||
|
||||
def test_install_into_bare_project(self, tmp_path):
|
||||
"""Install into a project with .specify/ but no integration."""
|
||||
@@ -246,6 +397,7 @@ class TestIntegrationUninstall:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0
|
||||
assert "preserved" in result.output
|
||||
assert ".claude/skills/speckit-plan/SKILL.md" in result.output
|
||||
|
||||
# Modified file kept
|
||||
assert plan_file.exists()
|
||||
@@ -260,7 +412,68 @@ class TestIntegrationUninstall:
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "not the currently installed" in result.output
|
||||
assert "not installed" in result.output
|
||||
|
||||
def test_uninstall_invalid_manifest_reports_cli_error(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
_write_invalid_manifest(project, "claude")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, ["integration", "uninstall", "claude"])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "manifest" in result.output
|
||||
assert "unreadable" in result.output
|
||||
|
||||
def test_uninstall_non_default_preserves_default(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
result = runner.invoke(app, [
|
||||
"integration", "uninstall", "codex",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
assert not (project / ".agents" / "skills" / "speckit-plan" / "SKILL.md").exists()
|
||||
assert (project / ".claude" / "skills" / "speckit-plan" / "SKILL.md").exists()
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "claude"
|
||||
assert data["installed_integrations"] == ["claude"]
|
||||
|
||||
def test_uninstall_default_refreshes_templates_for_fallback(self, tmp_path):
|
||||
project = _init_project(tmp_path, "gemini")
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
assert "/speckit.plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "claude",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
result = runner.invoke(app, ["integration", "uninstall", "gemini"], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "claude"
|
||||
assert "/speckit-plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
def test_uninstall_preserves_shared_infra(self, tmp_path):
|
||||
"""Shared scripts and templates are not removed by integration uninstall."""
|
||||
@@ -281,6 +494,135 @@ class TestIntegrationUninstall:
|
||||
assert (project / ".specify" / "templates").is_dir()
|
||||
|
||||
|
||||
class TestIntegrationUse:
|
||||
def test_use_installed_integration_sets_default(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
result = runner.invoke(app, ["integration", "use", "codex"], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "codex"
|
||||
assert data["default_integration"] == "codex"
|
||||
assert data["installed_integrations"] == ["claude", "codex"]
|
||||
|
||||
opts = json.loads((project / ".specify" / "init-options.json").read_text(encoding="utf-8"))
|
||||
assert opts["integration"] == "codex"
|
||||
assert opts["ai"] == "codex"
|
||||
|
||||
def test_use_requires_installed_integration(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, ["integration", "use", "codex"])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "not installed" in result.output
|
||||
|
||||
def test_use_refreshes_shared_templates_between_command_styles(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
assert "/speckit-plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "gemini",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
use_gemini = runner.invoke(app, ["integration", "use", "gemini"], catch_exceptions=False)
|
||||
assert use_gemini.exit_code == 0, use_gemini.output
|
||||
assert "/speckit.plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
use_claude = runner.invoke(app, ["integration", "use", "claude"], catch_exceptions=False)
|
||||
assert use_claude.exit_code == 0, use_claude.output
|
||||
assert "/speckit-plan" in template.read_text(encoding="utf-8")
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
|
||||
def test_use_preserves_modified_templates_unless_forced(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
template.write_text("custom template with /speckit-plan\n", encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "gemini",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
use_gemini = runner.invoke(app, ["integration", "use", "gemini"], catch_exceptions=False)
|
||||
assert use_gemini.exit_code == 0, use_gemini.output
|
||||
assert template.read_text(encoding="utf-8") == "custom template with /speckit-plan\n"
|
||||
|
||||
force_use = runner.invoke(app, [
|
||||
"integration", "use", "gemini",
|
||||
"--force",
|
||||
], catch_exceptions=False)
|
||||
assert force_use.exit_code == 0, force_use.output
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
|
||||
updated = template.read_text(encoding="utf-8")
|
||||
assert "/speckit.plan" in updated
|
||||
assert "custom template" not in updated
|
||||
|
||||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="symlinks are unavailable")
|
||||
def test_use_does_not_persist_default_when_template_refresh_fails(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
int_json = project / ".specify" / "integration.json"
|
||||
init_options = project / ".specify" / "init-options.json"
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
before_state = json.loads(int_json.read_text(encoding="utf-8"))
|
||||
before_options = json.loads(init_options.read_text(encoding="utf-8"))
|
||||
|
||||
outside = tmp_path / "outside-template.md"
|
||||
outside.write_text("# outside\n", encoding="utf-8")
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
template.unlink()
|
||||
os.symlink(outside, template)
|
||||
|
||||
result = runner.invoke(app, [
|
||||
"integration", "use", "codex",
|
||||
"--force",
|
||||
])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
|
||||
assert result.exit_code != 0
|
||||
assert "Failed to refresh shared templates" in result.output
|
||||
assert json.loads(int_json.read_text(encoding="utf-8")) == before_state
|
||||
assert json.loads(init_options.read_text(encoding="utf-8")) == before_options
|
||||
assert outside.read_text(encoding="utf-8") == "# outside\n"
|
||||
|
||||
|
||||
# ── switch ───────────────────────────────────────────────────────────
|
||||
|
||||
|
||||
@@ -306,6 +648,22 @@ class TestIntegrationSwitch:
|
||||
assert result.exit_code != 0
|
||||
assert "Unknown integration" in result.output
|
||||
|
||||
def test_switch_invalid_current_manifest_reports_cli_error(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
_write_invalid_manifest(project, "claude")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "switch", "codex",
|
||||
"--script", "sh",
|
||||
])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "Could not read integration manifest" in result.output
|
||||
|
||||
def test_switch_same_noop(self, tmp_path):
|
||||
project = _init_project(tmp_path, "copilot")
|
||||
old_cwd = os.getcwd()
|
||||
@@ -315,7 +673,48 @@ class TestIntegrationSwitch:
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0
|
||||
assert "already installed" in result.output
|
||||
assert "already the default integration" in result.output
|
||||
|
||||
def test_switch_same_force_refreshes_shared_templates(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
template.write_text("# custom shared template\n", encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, [
|
||||
"integration", "switch", "claude",
|
||||
"--force",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
assert "managed shared templates refreshed" in result.output
|
||||
assert "/speckit-plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
def test_switch_installed_target_rejects_integration_options(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
result = runner.invoke(app, [
|
||||
"integration", "switch", "codex",
|
||||
"--integration-options", "--bogus",
|
||||
])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "--integration-options cannot be used" in result.output
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["default_integration"] == "claude"
|
||||
|
||||
def test_switch_between_integrations(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
@@ -522,6 +921,107 @@ class TestIntegrationSwitch:
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "claude"
|
||||
|
||||
def test_failed_switch_keeps_fallback_metadata_consistent(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "codex",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
result = runner.invoke(app, [
|
||||
"integration", "switch", "generic",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "codex"
|
||||
assert data["installed_integrations"] == ["codex"]
|
||||
|
||||
opts = json.loads((project / ".specify" / "init-options.json").read_text(encoding="utf-8"))
|
||||
assert opts["integration"] == "codex"
|
||||
assert opts["ai"] == "codex"
|
||||
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
assert "/speckit-plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
|
||||
class TestIntegrationUpgrade:
|
||||
def test_upgrade_invalid_manifest_reports_cli_error(self, tmp_path):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
_write_invalid_manifest(project, "claude")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
result = runner.invoke(app, ["integration", "upgrade", "claude"])
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code != 0
|
||||
assert "manifest" in result.output
|
||||
assert "unreadable" in result.output
|
||||
|
||||
def test_upgrade_does_not_persist_state_when_template_refresh_fails(self, tmp_path, monkeypatch):
|
||||
project = _init_project(tmp_path, "claude")
|
||||
int_json = project / ".specify" / "integration.json"
|
||||
init_options = project / ".specify" / "init-options.json"
|
||||
manifest_path = project / ".specify" / "integrations" / "claude.manifest.json"
|
||||
|
||||
before_state = json.loads(int_json.read_text(encoding="utf-8"))
|
||||
before_options = json.loads(init_options.read_text(encoding="utf-8"))
|
||||
before_manifest = manifest_path.read_text(encoding="utf-8")
|
||||
|
||||
import specify_cli
|
||||
|
||||
def fail_refresh(*args, **kwargs):
|
||||
raise ValueError("refuse refresh")
|
||||
|
||||
monkeypatch.setattr(specify_cli, "_refresh_shared_templates", fail_refresh)
|
||||
|
||||
result = _run_in_project(project, [
|
||||
"integration", "upgrade", "claude",
|
||||
"--force",
|
||||
])
|
||||
|
||||
assert result.exit_code != 0
|
||||
assert "Failed to refresh shared templates" in result.output
|
||||
assert json.loads(int_json.read_text(encoding="utf-8")) == before_state
|
||||
assert json.loads(init_options.read_text(encoding="utf-8")) == before_options
|
||||
assert manifest_path.read_text(encoding="utf-8") == before_manifest
|
||||
|
||||
def test_upgrade_non_default_keeps_default_template_invocations(self, tmp_path):
|
||||
project = _init_project(tmp_path, "gemini")
|
||||
template = project / ".specify" / "templates" / "plan-template.md"
|
||||
assert "/speckit.plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
install = runner.invoke(app, [
|
||||
"integration", "install", "claude",
|
||||
"--script", "sh",
|
||||
], catch_exceptions=False)
|
||||
assert install.exit_code == 0, install.output
|
||||
|
||||
result = runner.invoke(app, [
|
||||
"integration", "upgrade", "claude",
|
||||
"--script", "sh",
|
||||
"--force",
|
||||
], catch_exceptions=False)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
assert result.exit_code == 0, result.output
|
||||
|
||||
data = json.loads((project / ".specify" / "integration.json").read_text(encoding="utf-8"))
|
||||
assert data["integration"] == "gemini"
|
||||
assert "/speckit.plan" in template.read_text(encoding="utf-8")
|
||||
|
||||
|
||||
# ── Full lifecycle ───────────────────────────────────────────────────
|
||||
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
"""Tests for INTEGRATION_REGISTRY — mechanics, completeness, and registrar alignment."""
|
||||
|
||||
import pytest
|
||||
import json
|
||||
import os
|
||||
from pathlib import PurePosixPath
|
||||
|
||||
import pytest
|
||||
from typer.testing import CliRunner
|
||||
|
||||
from specify_cli import app
|
||||
from specify_cli.integrations import (
|
||||
INTEGRATION_REGISTRY,
|
||||
_register,
|
||||
@@ -25,6 +31,72 @@ ALL_INTEGRATION_KEYS = [
|
||||
]
|
||||
|
||||
|
||||
def _multi_install_safe_keys() -> list[str]:
|
||||
return sorted(
|
||||
key
|
||||
for key, integration in INTEGRATION_REGISTRY.items()
|
||||
if integration.multi_install_safe
|
||||
)
|
||||
|
||||
|
||||
def _multi_install_safe_pairs() -> list[tuple[str, str]]:
|
||||
safe_keys = _multi_install_safe_keys()
|
||||
return [
|
||||
(safe_keys[left], safe_keys[right])
|
||||
for left in range(len(safe_keys))
|
||||
for right in range(left + 1, len(safe_keys))
|
||||
]
|
||||
|
||||
|
||||
def _posix_path(value: str | None) -> str | None:
|
||||
if not value:
|
||||
return None
|
||||
return PurePosixPath(value).as_posix()
|
||||
|
||||
|
||||
def _integration_root_dir(key: str) -> str | None:
|
||||
integration = INTEGRATION_REGISTRY[key]
|
||||
cfg = integration.config if isinstance(integration.config, dict) else {}
|
||||
return _posix_path(cfg.get("folder"))
|
||||
|
||||
|
||||
def _integration_commands_dir(key: str) -> str | None:
|
||||
integration = INTEGRATION_REGISTRY[key]
|
||||
cfg = integration.config if isinstance(integration.config, dict) else {}
|
||||
folder = cfg.get("folder")
|
||||
if not folder:
|
||||
return None
|
||||
subdir = cfg.get("commands_subdir", "commands")
|
||||
return (PurePosixPath(folder) / subdir).as_posix()
|
||||
|
||||
|
||||
def _paths_overlap(first: str | None, second: str | None) -> bool:
|
||||
if not first or not second:
|
||||
return False
|
||||
left = PurePosixPath(first)
|
||||
right = PurePosixPath(second)
|
||||
try:
|
||||
left.relative_to(right)
|
||||
return True
|
||||
except ValueError:
|
||||
pass
|
||||
try:
|
||||
right.relative_to(left)
|
||||
return True
|
||||
except ValueError:
|
||||
return False
|
||||
|
||||
|
||||
def _path_is_inside(path: str | None, directory: str | None) -> bool:
|
||||
if not path or not directory:
|
||||
return False
|
||||
try:
|
||||
PurePosixPath(path).relative_to(PurePosixPath(directory))
|
||||
return True
|
||||
except ValueError:
|
||||
return False
|
||||
|
||||
|
||||
class TestRegistry:
|
||||
def test_registry_is_dict(self):
|
||||
assert isinstance(INTEGRATION_REGISTRY, dict)
|
||||
@@ -85,3 +157,134 @@ class TestRegistrarKeyAlignment:
|
||||
"""The old 'cursor' shorthand must not appear in AGENT_CONFIGS."""
|
||||
from specify_cli.agents import CommandRegistrar
|
||||
assert "cursor" not in CommandRegistrar.AGENT_CONFIGS
|
||||
|
||||
|
||||
class TestMultiInstallSafeContracts:
|
||||
"""Declared safe integrations must stay isolated from each other."""
|
||||
|
||||
@pytest.mark.parametrize("key", _multi_install_safe_keys())
|
||||
def test_safe_integrations_have_static_isolated_paths(self, key):
|
||||
integration = INTEGRATION_REGISTRY[key]
|
||||
|
||||
assert _integration_root_dir(key), (
|
||||
f"{key} is declared multi-install safe but has no static root directory"
|
||||
)
|
||||
assert _integration_commands_dir(key), (
|
||||
f"{key} is declared multi-install safe but has no static commands directory"
|
||||
)
|
||||
assert integration.context_file, (
|
||||
f"{key} is declared multi-install safe but has no context file"
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(("first", "second"), _multi_install_safe_pairs())
|
||||
def test_safe_integrations_have_distinct_agent_roots(self, first, second):
|
||||
assert not _paths_overlap(_integration_root_dir(first), _integration_root_dir(second)), (
|
||||
f"{first} and {second} are declared multi-install safe but have "
|
||||
f"overlapping agent roots {_integration_root_dir(first)!r} and "
|
||||
f"{_integration_root_dir(second)!r}"
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(("first", "second"), _multi_install_safe_pairs())
|
||||
def test_safe_integrations_have_distinct_command_dirs(self, first, second):
|
||||
assert not _paths_overlap(_integration_commands_dir(first), _integration_commands_dir(second)), (
|
||||
f"{first} and {second} are declared multi-install safe but have "
|
||||
f"overlapping command directories {_integration_commands_dir(first)!r} and "
|
||||
f"{_integration_commands_dir(second)!r}"
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(("first", "second"), _multi_install_safe_pairs())
|
||||
def test_safe_integrations_have_distinct_context_files(self, first, second):
|
||||
first_context = _posix_path(INTEGRATION_REGISTRY[first].context_file)
|
||||
second_context = _posix_path(INTEGRATION_REGISTRY[second].context_file)
|
||||
|
||||
assert first_context != second_context, (
|
||||
f"{first} and {second} are declared multi-install safe but share "
|
||||
f"context file {first_context!r}"
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(("first", "second"), _multi_install_safe_pairs())
|
||||
def test_safe_context_files_do_not_overlap_other_agent_roots(self, first, second):
|
||||
first_context = _posix_path(INTEGRATION_REGISTRY[first].context_file)
|
||||
second_context = _posix_path(INTEGRATION_REGISTRY[second].context_file)
|
||||
|
||||
assert not _path_is_inside(first_context, _integration_root_dir(second)), (
|
||||
f"{first} context file {first_context!r} lives under {second} "
|
||||
f"agent root {_integration_root_dir(second)!r}"
|
||||
)
|
||||
assert not _path_is_inside(second_context, _integration_root_dir(first)), (
|
||||
f"{second} context file {second_context!r} lives under {first} "
|
||||
f"agent root {_integration_root_dir(first)!r}"
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(("first", "second"), _multi_install_safe_pairs())
|
||||
def test_safe_context_files_do_not_overlap_other_command_dirs(self, first, second):
|
||||
first_context = _posix_path(INTEGRATION_REGISTRY[first].context_file)
|
||||
second_context = _posix_path(INTEGRATION_REGISTRY[second].context_file)
|
||||
|
||||
assert not _path_is_inside(first_context, _integration_commands_dir(second)), (
|
||||
f"{first} context file {first_context!r} lives under {second} "
|
||||
f"commands directory {_integration_commands_dir(second)!r}"
|
||||
)
|
||||
assert not _path_is_inside(second_context, _integration_commands_dir(first)), (
|
||||
f"{second} context file {second_context!r} lives under {first} "
|
||||
f"commands directory {_integration_commands_dir(first)!r}"
|
||||
)
|
||||
|
||||
@pytest.mark.parametrize(("first", "second"), _multi_install_safe_pairs())
|
||||
def test_safe_integrations_have_disjoint_manifests(
|
||||
self,
|
||||
tmp_path,
|
||||
first,
|
||||
second,
|
||||
):
|
||||
for initial, additional in ((first, second), (second, first)):
|
||||
project_root = tmp_path / f"project-{initial}-{additional}"
|
||||
project_root.mkdir()
|
||||
runner = CliRunner()
|
||||
|
||||
original_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project_root)
|
||||
init_result = runner.invoke(
|
||||
app,
|
||||
[
|
||||
"init",
|
||||
"--here",
|
||||
"--integration",
|
||||
initial,
|
||||
"--script",
|
||||
"sh",
|
||||
"--no-git",
|
||||
"--ignore-agent-tools",
|
||||
],
|
||||
catch_exceptions=False,
|
||||
)
|
||||
assert init_result.exit_code == 0, init_result.output
|
||||
|
||||
install_result = runner.invoke(
|
||||
app,
|
||||
["integration", "install", additional, "--script", "sh"],
|
||||
catch_exceptions=False,
|
||||
)
|
||||
assert install_result.exit_code == 0, install_result.output
|
||||
finally:
|
||||
os.chdir(original_cwd)
|
||||
|
||||
initial_manifest = json.loads(
|
||||
(
|
||||
project_root / ".specify" / "integrations" / f"{initial}.manifest.json"
|
||||
).read_text(encoding="utf-8")
|
||||
)
|
||||
additional_manifest = json.loads(
|
||||
(
|
||||
project_root / ".specify" / "integrations" / f"{additional}.manifest.json"
|
||||
).read_text(encoding="utf-8")
|
||||
)
|
||||
|
||||
initial_files = set(initial_manifest.get("files", {}))
|
||||
additional_files = set(additional_manifest.get("files", {}))
|
||||
|
||||
assert initial_files.isdisjoint(additional_files), (
|
||||
f"{initial} and {additional} are declared multi-install safe but both manage "
|
||||
f"these files: {sorted(initial_files & additional_files)}"
|
||||
)
|
||||
|
||||
@@ -14,6 +14,7 @@ import pytest
|
||||
import json
|
||||
import tempfile
|
||||
import shutil
|
||||
import warnings
|
||||
import zipfile
|
||||
from pathlib import Path
|
||||
from datetime import datetime, timezone
|
||||
@@ -1921,6 +1922,10 @@ class TestPresetCatalogMultiCatalog:
|
||||
|
||||
|
||||
SELF_TEST_PRESET_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
SELF_TEST_WRAP_WARNING = (
|
||||
r"Cannot compose command 'speckit\.wrap-test': no base layer\. "
|
||||
r"Stale command files may remain\."
|
||||
)
|
||||
|
||||
CORE_TEMPLATE_NAMES = [
|
||||
"spec-template",
|
||||
@@ -1931,6 +1936,18 @@ CORE_TEMPLATE_NAMES = [
|
||||
]
|
||||
|
||||
|
||||
def install_self_test_preset(manager: PresetManager, speckit_version: str = "0.1.5") -> PresetManifest:
|
||||
"""Install self-test while filtering its intentionally missing wrap base."""
|
||||
with warnings.catch_warnings():
|
||||
warnings.filterwarnings(
|
||||
"ignore",
|
||||
message=SELF_TEST_WRAP_WARNING,
|
||||
category=UserWarning,
|
||||
module=r"specify_cli\.presets",
|
||||
)
|
||||
return manager.install_from_directory(SELF_TEST_PRESET_DIR, speckit_version)
|
||||
|
||||
|
||||
class TestSelfTestPreset:
|
||||
"""Tests using the self-test preset that ships with the repo."""
|
||||
|
||||
@@ -1971,7 +1988,7 @@ class TestSelfTestPreset:
|
||||
def test_install_self_test_preset(self, project_dir):
|
||||
"""Test installing the self-test preset from its directory."""
|
||||
manager = PresetManager(project_dir)
|
||||
manifest = manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
manifest = install_self_test_preset(manager)
|
||||
assert manifest.id == "self-test"
|
||||
assert manager.registry.is_installed("self-test")
|
||||
|
||||
@@ -1984,7 +2001,7 @@ class TestSelfTestPreset:
|
||||
|
||||
# Install self-test preset
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
# Every core template should now resolve from the preset
|
||||
resolver = PresetResolver(project_dir)
|
||||
@@ -2003,7 +2020,7 @@ class TestSelfTestPreset:
|
||||
(templates_dir / f"{name}.md").write_text(f"# Core {name}\n")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
for name in CORE_TEMPLATE_NAMES:
|
||||
@@ -2020,7 +2037,7 @@ class TestSelfTestPreset:
|
||||
(templates_dir / f"{name}.md").write_text(f"# Core {name}\n")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
manager.remove("self-test")
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
@@ -2056,7 +2073,7 @@ class TestSelfTestPreset:
|
||||
claude_dir.mkdir(parents=True)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
# Check the skill was registered
|
||||
cmd_file = claude_dir / "speckit-specify" / "SKILL.md"
|
||||
@@ -2072,7 +2089,7 @@ class TestSelfTestPreset:
|
||||
gemini_dir.mkdir(parents=True)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
# Check the command was registered in TOML format
|
||||
cmd_file = gemini_dir / "speckit.specify.toml"
|
||||
@@ -2087,7 +2104,7 @@ class TestSelfTestPreset:
|
||||
claude_dir.mkdir(parents=True)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
cmd_file = claude_dir / "speckit-specify" / "SKILL.md"
|
||||
assert cmd_file.exists()
|
||||
@@ -2098,7 +2115,7 @@ class TestSelfTestPreset:
|
||||
def test_self_test_no_commands_without_agent_dirs(self, project_dir):
|
||||
"""Test that no commands are registered when no agent dirs exist."""
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
metadata = manager.registry.get("self-test")
|
||||
assert metadata["registered_commands"] == {}
|
||||
@@ -2247,8 +2264,7 @@ class TestPresetSkills:
|
||||
|
||||
# Install self-test preset (has a command override for speckit.specify)
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
skill_file = skills_dir / "speckit-specify" / "SKILL.md"
|
||||
assert skill_file.exists()
|
||||
@@ -2267,8 +2283,7 @@ class TestPresetSkills:
|
||||
self._create_skill(skills_dir, "speckit-specify", body="untouched")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
skill_file = skills_dir / "speckit-specify" / "SKILL.md"
|
||||
content = skill_file.read_text()
|
||||
@@ -2300,8 +2315,7 @@ class TestPresetSkills:
|
||||
self._create_skill(skills_dir, "speckit-specify", body="untouched")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
skill_file = skills_dir / "speckit-specify" / "SKILL.md"
|
||||
file_content = skill_file.read_text()
|
||||
@@ -2321,8 +2335,7 @@ class TestPresetSkills:
|
||||
(core_cmds / "specify.md").write_text("---\ndescription: Core specify command\n---\n\nCore specify body\n")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
# Verify preset content is in the skill
|
||||
skill_file = skills_dir / "speckit-specify" / "SKILL.md"
|
||||
@@ -2358,8 +2371,7 @@ class TestPresetSkills:
|
||||
)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
manager.remove("self-test")
|
||||
|
||||
content = (skills_dir / "speckit-specify" / "SKILL.md").read_text()
|
||||
@@ -2375,8 +2387,7 @@ class TestPresetSkills:
|
||||
(skills_dir / "speckit-specify").write_text("not-a-directory")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
assert (skills_dir / "speckit-specify").is_file()
|
||||
metadata = manager.registry.get("self-test")
|
||||
@@ -2388,8 +2399,7 @@ class TestPresetSkills:
|
||||
# Don't create skills dir — simulate --ai-skills never created them
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
SELF_TEST_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(SELF_TEST_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
metadata = manager.registry.get("self-test")
|
||||
assert metadata.get("registered_skills", []) == []
|
||||
@@ -2590,8 +2600,7 @@ class TestPresetSkills:
|
||||
(project_dir / ".kimi" / "commands").mkdir(parents=True, exist_ok=True)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
self_test_dir = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(self_test_dir, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
skill_file = skills_dir / "speckit.specify" / "SKILL.md"
|
||||
assert skill_file.exists()
|
||||
@@ -2611,8 +2620,7 @@ class TestPresetSkills:
|
||||
(project_dir / ".kimi" / "commands").mkdir(parents=True, exist_ok=True)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
self_test_dir = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(self_test_dir, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
skill_file = skills_dir / "speckit-specify" / "SKILL.md"
|
||||
assert skill_file.exists()
|
||||
@@ -2791,8 +2799,7 @@ class TestPresetSkills:
|
||||
self._create_skill(skills_dir, "speckit-specify", body="untouched")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
self_test_dir = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
manager.install_from_directory(self_test_dir, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
skill_content = (skills_dir / "speckit-specify" / "SKILL.md").read_text()
|
||||
assert "untouched" in skill_content
|
||||
@@ -3451,7 +3458,7 @@ class TestWrapStrategy:
|
||||
)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
written = (skill_subdir / "SKILL.md").read_text()
|
||||
assert "{CORE_TEMPLATE}" not in written
|
||||
@@ -3503,7 +3510,7 @@ class TestWrapStrategy:
|
||||
)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(SELF_TEST_PRESET_DIR, "0.1.5")
|
||||
install_self_test_preset(manager)
|
||||
|
||||
written = (skill_subdir / "SKILL.md").read_text()
|
||||
# {SCRIPT} should have been resolved (not left as a literal placeholder)
|
||||
|
||||
Reference in New Issue
Block a user