mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 20:36:23 +08:00
* docs: add Spec Kit spec for agent-context full opt-in Use Spec Kit's own specify workflow to author the spec that makes the agent-context extension a full opt-in, removing all agent-context configuration/support from the Python codebase and removing the deprecation message. Force-added despite specs/ being gitignored; the generated artifact will be purged prior to merge. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: add Spec Kit plan artifacts for agent-context full opt-in Phase 0/1 of the SDD plan workflow: plan.md, research.md, data-model.md, quickstart.md, and contracts/cli-behavior.md. Constitution Check is a documented no-op (repo has no ratified constitution). Force-added despite specs/ being gitignored; generated artifacts will be purged prior to merge. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: correct Constitution Check against ratified v1.0.0 Earlier draft wrongly treated the gate as a no-op; the fork's main is 16 commits behind upstream/main, which carries .specify/memory/constitution.md. Re-evaluate the feature against Principles I-V (all PASS) and note that Principle I mandates keeping context_file as a declared class attribute, validating the R1 metadata decision. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: refresh plan artifacts against synced upstream/main After syncing fork main to upstream and rebasing, re-scan the current agent-context surface. Upstream generalized the single context_file into a plural context_files concept with new resolver helpers (_resolve_context_files, _resolve_context_file_values, _format_context_file_values) and upsert/remove now loop over multiple files. Update research.md, data-model.md, contracts, quickstart grep guards, and the plan summary to cover the expanded removal scope. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: add Spec Kit tasks for agent-context full opt-in Phase 2 of SDD: dependency-ordered tasks.md (30 tasks) organized by the three user stories, with mandatory test tasks (Constitution Principle II) and a foundational phase decoupling __CONTEXT_FILE__ resolution from the extension config. Includes the extension self-seeding task (T015) and a static guard test (T002) enforcing zero agent-context references in the CLI. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat!: remove agent-context lifecycle from the Specify CLI Make the agent-context extension a full opt-in. The CLI no longer installs the extension during init, writes agent-context-config.yml, or creates/updates/removes the managed Spec Kit section in agent context files. Context-section upsert/remove, marker resolution, extension-enabled gating, the config helpers, and the obsolete inline deprecation warning are all removed. Integration context_file stays as inert metadata; __CONTEXT_FILE__ now resolves from registry metadata. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat(agent-context): self-seed context file from the active integration When agent-context-config.yml has no context_file/context_files, the bundled bash and PowerShell update scripts now resolve the context file from the active integration in .specify/init-options.json via the integration registry, so the extension no longer depends on the CLI writing its config. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test+docs: update suite and docs for agent-context opt-in Update integration/extension tests to expect no agent-context install, config, or context-section writes during init. Add a static guard test (test_agent_context_cli_free.py) asserting the CLI source is free of agent-context lifecycle symbols, plus backward-compatibility tests for legacy projects. Refresh AGENTS.md, the extension README, and add a CHANGELOG entry describing the opt-in behavior change. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(agent-context): warn on self-seed failure, correct docs, speed up guard test Address PR review feedback: - Self-seed scripts (bash + PowerShell) now emit an actionable warning when an active integration is configured but specify_cli cannot be imported by the chosen Python (e.g. pipx installs), or when the integration declares no context file, instead of silently falling through to 'nothing to do'. - Correct the extension README disable note: command rendering never reads the extension config; __CONTEXT_FILE__ is always substituted from integration metadata, so a stale context_files value cannot affect rendering. - Cache CLI source reads in the static guard test via a module-scoped fixture so the directory walk happens once instead of once per forbidden symbol. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat(agent-context): ship self-owned per-agent context-file defaults The extension now bundles agent-context-defaults.json (key→context_file map) and self-seeds from it, dropping any dependency on the Specify CLI registry. Both the bash and PowerShell update scripts read the bundled JSON map keyed by the active integration from init-options.json. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat!: remove all agent-context state from the Specify CLI Strip every context_file reference from the CLI: the field on all 35 integration classes, the IntegrationBase plumbing (process_template param/step, _context_file_display, docstrings), the __CONTEXT_FILE__ resolution in agents.py, the legacy context_file/context_markers popping in _helpers.py, and the context_file template in integration_scaffold.py. Also drop the Agent context update step and __CONTEXT_FILE__ placeholder from templates/commands/plan.md. The agent-context extension now solely owns all context-file knowledge, including the per-agent default mapping. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test: drop context_file coverage and guard against CLI reintroduction Remove CONTEXT_FILE attrs and context_file assertions across the base mixins, all 35 per-integration test files, shared integration tests, and conftest stubs. Rewrite the base-mixin context tests to assert no managed section is written and no __CONTEXT_FILE__ placeholder survives. Extend the CLI-free static guard to forbid context_file, __CONTEXT_FILE__, and _context_file_display in src/specify_cli, and have the extension tests copy the bundled defaults JSON so self-seed runs without the CLI. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: reflect full removal of agent-context state from the CLI Update AGENTS.md (integration examples, required-fields table, context behavior section, pitfalls), CHANGELOG, and the SDD spec artifacts (FR-007, SC-002, data-model) to state that the CLI carries no context_file and the extension fully owns the per-agent default mapping via agent-context-defaults.json. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: align SDD artifacts with full context_file removal Update research.md (R1, R2, R4, summary table), contracts/cli-behavior.md (C3, C5), tasks.md (Phase 2, T026, notes), plan.md (Principle I, source map), and checklists/requirements.md so the spec artifacts reflect the implemented decision: the CLI carries no context_file attribute or __CONTEXT_FILE__ resolution, and the per-agent defaults map lives in the extension. Resolves PR review #4548130110. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: scrub stale context-file mentions from CLI docstrings Update the multi_install_safe docstring (drop the removed "context file" invariant), the RovoDev setup docstring (no longer upserts a context section), the Copilot module docstring (drop the context-file line), and tighten the _update_init_options_for_integration note. Pure docstring changes — no behavioral impact. Resolves PR review #4548237085. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test+docs: harden agent-context test helper and fix stale docs - base.py: document multi_install_safe as an optional subclass attribute in the IntegrationBase docstring. - test_cli.py: clarify the init-options assertion is guarding against leftover legacy agent-context keys, not relocation. - test_extension_agent_context.py: _install_agent_context_config now asserts the bundled agent-context-defaults.json exists and always copies it, so self-seeding tests fail loudly instead of silently skipping when the map is missing. - test_integration_cursor_agent.py: drop Path/IntegrationManifest imports left unused after removing the context-section frontmatter tests. Resolves PR review #4548293116. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: remove gitignored SDD artifacts from specs/ The specs/001-agent-context-full-optin/ artifacts were force-added for dogfooding visibility, but specs/ is gitignored and these were always intended to be purged before merge. Remove them so merging does not add an intentionally-untracked directory to repo history. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: keep CHANGELOG.md identical to upstream CHANGELOG.md is auto-generated at release time, so the branch should not carry a manual entry. Restore it to match upstream/main exactly. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: preserve Cursor .mdc frontmatter in agent-context updater scripts The bundled agent-context updater scripts wrote the managed section as plain text. For Cursor-style `.mdc` targets this dropped the required `---\nalwaysApply: true\n---` frontmatter, reintroducing the rule-loading bug originally fixed in #1699. Port the `_ensure_mdc_frontmatter` logic into both the bash and PowerShell updaters: prepend frontmatter when missing, repair `alwaysApply` when set to the wrong value, and leave non-`.mdc` targets untouched. Add regression tests covering both shells. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test: scope CLI-free guard to agent-context-specific symbols Drop the bare "context_file" substring from FORBIDDEN_SYMBOLS so the guard no longer fails on unrelated future CLI fields named context_file. The list still covers agent-context-specific identifiers (__CONTEXT_FILE__, _context_file_display, _resolve_context_files, _resolve_context_file_values). Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: harden agent-context bash self-seed against malformed init JSON Two robustness fixes in the embedded Python self-seed logic: - Coerce the integration value from init-options.json to a string only when it is actually a string; otherwise treat it as unset so a corrupted dict/list value degrades to the existing nothing-to-do behavior instead of breaking the agents-map lookup. - Normalize agent-context-defaults.json: only use 'agents' when both the JSON root and the 'agents' value are dicts, so a wrong-shaped (but valid) JSON falls back to the warning path instead of raising on .get. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: correct PowerShell hyphenated key lookup and regex replace count - Self-seed now reads the defaults mapping via $defaults.agents.PSObject.Properties[$integrationKey].Value instead of member access ($defaults.agents.$integrationKey), which parsed hyphenated keys like 'cursor-agent'/'kiro-cli' as subtraction and failed to resolve. - Replace the static [regex]::Replace(..., 1) call, whose trailing 1 was interpreted as RegexOptions.IgnoreCase rather than a replacement count, with an instance Regex whose Replace(input, replacement, 1) limits to the first match as intended. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: make bash .mdc frontmatter guard case-insensitive The bash updater only injected Cursor .mdc frontmatter when ctx_path ended in lowercase '.mdc', so a mixed/upper-case extension (e.g. specify-rules.MDC) was skipped and Cursor would not auto-load the rule file. Compare against the casefolded path. The PowerShell variant already uses -match, which is case-insensitive by default, so no change is needed there. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: document separator-agnostic agent-context update invocation The README hard-coded the dot-notation slash command (/speckit.agent-context.update), which hyphen-separator agents like Forge and Cline do not recognize. Document the canonical command ID plus both slash invocations so users copy the form their agent accepts. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
149 lines
6.7 KiB
Python
149 lines
6.7 KiB
Python
"""Tests for KiroCliIntegration."""
|
|
|
|
import os
|
|
import re
|
|
|
|
from specify_cli.integrations import get_integration
|
|
from specify_cli.integrations.kiro_cli import _KIRO_ARG_FALLBACK
|
|
from specify_cli.integrations.manifest import IntegrationManifest
|
|
|
|
from .test_integration_base_markdown import MarkdownIntegrationTests
|
|
|
|
|
|
# Regex shapes that indicate a value is a placeholder token, not prose.
|
|
# Covers Bash ($VAR, ${VAR}, ${VAR:-default}), Mustache/Handlebars/Jinja
|
|
# ({{var}}, {{{var}}}), Liquid/Jinja control ({% ... %}), Python str.format /
|
|
# .NET ({var}, {0}), angle-bracket (<var>), and Windows-style (%VAR%).
|
|
# Anchored to the FULL STRING so legitimate prose mentioning a placeholder
|
|
# (e.g. "the {{magic}} of placeholders") is not flagged. The Liquid pattern
|
|
# is anchored to the START so multi-tag templates fire while mid-sentence
|
|
# {%-quotation does not.
|
|
_PLACEHOLDER_TOKEN_PATTERNS = (
|
|
re.compile(r"^\$\w+$"), # $ARGUMENTS, $args
|
|
re.compile(r"^\$\{\w+(?:[:\-+?][^}]*)?\}$"), # ${ARGS}, ${ARGS:-default}
|
|
re.compile(r"^\{\{\{?\s*\w+(\s*[|.][^}]*)?\s*\}?\}\}$"), # {{var}} {{{var}}} {{x|y}}
|
|
re.compile(r"^\{%"), # {% if x %}{{ x }}{% endif %}
|
|
re.compile(r"^<\w+>$"), # <args>
|
|
re.compile(r"^%\w+%$"), # %USERNAME%
|
|
re.compile(r"^\{(?:\d+|[a-zA-Z_]\w*)(?:[.\[][^}]*)?(?:![rsa])?(?::[^}]*)?\}$"), # {0}, {var}, {0:>5}
|
|
)
|
|
|
|
|
|
def _looks_like_placeholder_token(value: str) -> bool:
|
|
"""Return True if *value* matches a known placeholder-token shape."""
|
|
if not value:
|
|
return False
|
|
return any(p.search(value) for p in _PLACEHOLDER_TOKEN_PATTERNS)
|
|
|
|
|
|
class TestKiroCliIntegration(MarkdownIntegrationTests):
|
|
KEY = "kiro-cli"
|
|
FOLDER = ".kiro/"
|
|
COMMANDS_SUBDIR = "prompts"
|
|
REGISTRAR_DIR = ".kiro/prompts"
|
|
|
|
def test_registrar_config(self):
|
|
"""Override base assertion: kiro-cli uses a prose fallback for args
|
|
because Kiro CLI file-based prompts do not natively substitute
|
|
``$ARGUMENTS`` (see issue #1926 / kirodotdev/Kiro#4141). The
|
|
regression-guard load is carried by the two layer tests below
|
|
(exact-fallback + placeholder-shape rejection)."""
|
|
i = get_integration(self.KEY)
|
|
assert i.registrar_config["dir"] == self.REGISTRAR_DIR
|
|
assert i.registrar_config["format"] == "markdown"
|
|
assert i.registrar_config["extension"] == ".md"
|
|
|
|
def test_registrar_config_args_is_exact_prose_fallback(self):
|
|
"""Layer 1 — pin the exact fallback so wording drift requires a
|
|
deliberate paired commit (production constant + test update)."""
|
|
i = get_integration(self.KEY)
|
|
assert i.registrar_config["args"] == _KIRO_ARG_FALLBACK, (
|
|
f"args drifted from the pinned fallback constant. "
|
|
f"Got: {i.registrar_config['args']!r}; expected: {_KIRO_ARG_FALLBACK!r}. "
|
|
f"If the wording change is intentional, update _KIRO_ARG_FALLBACK and "
|
|
f"this test together."
|
|
)
|
|
|
|
def test_registrar_config_args_does_not_look_like_a_placeholder_token(self):
|
|
"""Layer 2 — independent regression guard: even if someone bypasses
|
|
layer-1 by changing both constant and test, the value still must not
|
|
look like ANY placeholder token shape ($X, ${X}, {{X}}, <X>, %X%, {0},
|
|
{% %}). Catches the class of regression Copilot called out: a swap
|
|
from $ARGUMENTS to $INPUT or {{userMessage}} would fail this test
|
|
even if it accidentally passed layer 1."""
|
|
i = get_integration(self.KEY)
|
|
args = i.registrar_config["args"]
|
|
assert not _looks_like_placeholder_token(args), (
|
|
f"registrar_config['args'] = {args!r} matches a known placeholder-"
|
|
f"token shape — Kiro CLI does not substitute placeholders so this "
|
|
f"would reach the model verbatim and break the prompt (issue #1926). "
|
|
f"Use a prose fallback instead."
|
|
)
|
|
|
|
def test_rendered_prompts_do_not_contain_raw_arguments(self, tmp_path):
|
|
"""Rendered Kiro prompt files must NOT contain the raw ``$ARGUMENTS``
|
|
token — Kiro CLI does not substitute it, so the literal would reach
|
|
the model and break the prompt (issue #1926)."""
|
|
integration = get_integration(self.KEY)
|
|
manifest = IntegrationManifest(self.KEY, tmp_path)
|
|
integration.setup(tmp_path, manifest, script_type="sh")
|
|
|
|
prompts_dir = tmp_path / self.REGISTRAR_DIR
|
|
rendered = list(prompts_dir.glob("*.md"))
|
|
assert rendered, "expected at least one rendered prompt file"
|
|
|
|
offenders = [
|
|
p.name for p in rendered if "$ARGUMENTS" in p.read_text(encoding="utf-8")
|
|
]
|
|
assert offenders == [], (
|
|
f"these rendered prompts still contain the raw $ARGUMENTS token: {offenders}"
|
|
)
|
|
|
|
def test_rendered_prompts_contain_kiro_arg_placeholder(self, tmp_path):
|
|
"""The chosen kiro-cli args fallback string must end up in at least
|
|
one rendered prompt (proves substitution actually fired, not just
|
|
that $ARGUMENTS was removed). Imports the fallback constant directly
|
|
instead of reading the field back so the test stays independent of
|
|
the integration's own config — even if the registrar_config['args']
|
|
regresses, this test still verifies the FALLBACK STRING is in the
|
|
rendered output."""
|
|
integration = get_integration(self.KEY)
|
|
manifest = IntegrationManifest(self.KEY, tmp_path)
|
|
integration.setup(tmp_path, manifest, script_type="sh")
|
|
|
|
expected = _KIRO_ARG_FALLBACK
|
|
prompts_dir = tmp_path / self.REGISTRAR_DIR
|
|
contents = "\n".join(
|
|
p.read_text(encoding="utf-8") for p in prompts_dir.glob("*.md")
|
|
)
|
|
assert expected in contents, (
|
|
f"none of the rendered prompts contain the configured args fallback "
|
|
f"({expected!r})"
|
|
)
|
|
|
|
|
|
class TestKiroIntegration:
|
|
"""--integration kiro-cli creates expected files."""
|
|
|
|
def test_integration_kiro_cli_creates_files(self, tmp_path):
|
|
"""--integration kiro-cli should create files in .kiro/prompts."""
|
|
from typer.testing import CliRunner
|
|
from specify_cli import app
|
|
|
|
target = tmp_path / "kiro-proj"
|
|
target.mkdir()
|
|
|
|
old_cwd = os.getcwd()
|
|
try:
|
|
os.chdir(target)
|
|
runner = CliRunner()
|
|
result = runner.invoke(app, [
|
|
"init", "--here", "--integration", "kiro-cli",
|
|
"--ignore-agent-tools", "--script", "sh",
|
|
], catch_exceptions=False)
|
|
finally:
|
|
os.chdir(old_cwd)
|
|
|
|
assert result.exit_code == 0
|
|
assert (target / ".kiro" / "prompts" / "speckit.plan.md").exists()
|