diff --git a/src/specify_cli/__init__.py b/src/specify_cli/__init__.py index f5e117beef..fc92ba3aea 100644 --- a/src/specify_cli/__init__.py +++ b/src/specify_cli/__init__.py @@ -1894,11 +1894,17 @@ def get_speckit_version() -> str: integration_app.add_typer(integration_catalog_app, name="catalog") -INTEGRATION_JSON = ".specify/integration.json" +from ._paths import INTEGRATION_JSON # noqa: E402 (re-export for backward compat) def _read_integration_json(project_root: Path) -> dict[str, Any]: - """Load ``.specify/integration.json``. Returns ``{}`` when missing.""" + """Load ``.specify/integration.json``. Returns ``{}`` when missing. + + Shares its low-level parsing surface with + :func:`specify_cli._paths.try_read_integration_json` (used by the + workflow engine) but keeps loud, per-cause diagnostics so CLI users + get actionable messages instead of a silent fallback. + """ path = project_root / INTEGRATION_JSON if not path.exists(): return {} @@ -1909,6 +1915,11 @@ def _read_integration_json(project_root: Path) -> dict[str, Any]: console.print(f"Please fix or delete {INTEGRATION_JSON} and retry.") console.print(f"[dim]Details:[/dim] {exc}") raise typer.Exit(1) + except UnicodeDecodeError as exc: + console.print(f"[red]Error:[/red] {path} is not valid UTF-8.") + console.print(f"Please fix or delete {INTEGRATION_JSON} and retry.") + console.print(f"[dim]Details:[/dim] {exc}") + raise typer.Exit(1) except OSError as exc: console.print(f"[red]Error:[/red] Could not read {path}.") console.print(f"Please fix file permissions or delete {INTEGRATION_JSON} and retry.") diff --git a/src/specify_cli/_paths.py b/src/specify_cli/_paths.py new file mode 100644 index 0000000000..37df996dd2 --- /dev/null +++ b/src/specify_cli/_paths.py @@ -0,0 +1,42 @@ +"""Shared filesystem paths and low-level state helpers used across the +spec-kit package. + +This module exists so the CLI entrypoint and the workflows engine can share +canonical paths and parsing logic without duplicating string literals (which +drift) and without importing each other (which would create a circular +import on the CLI module). +""" + +from __future__ import annotations + +import json +from pathlib import Path +from typing import Any + + +# Project-relative path to the file that records which AI integration the +# project was initialized with. Read by the CLI to dispatch commands and by +# the workflow engine to resolve the ``"auto"`` integration default. +INTEGRATION_JSON = ".specify/integration.json" + + +def try_read_integration_json(project_root: Path) -> dict[str, Any] | None: + """Best-effort read of ``.specify/integration.json``. + + Returns the parsed mapping on success, or ``None`` when the file is + missing, unreadable, malformed JSON, non-UTF8, or not a JSON object. + Callers that want loud, user-facing error messages (e.g. the CLI's + :func:`specify_cli._read_integration_json`, which exits the process with + a diagnostic) should layer their own diagnostics on top instead of using + this helper directly. + """ + path = project_root / INTEGRATION_JSON + if not path.is_file(): + return None + try: + data = json.loads(path.read_text(encoding="utf-8")) + except (json.JSONDecodeError, OSError, UnicodeDecodeError): + return None + if not isinstance(data, dict): + return None + return data diff --git a/src/specify_cli/workflows/engine.py b/src/specify_cli/workflows/engine.py index d6a73bbeb0..4fb14f9d73 100644 --- a/src/specify_cli/workflows/engine.py +++ b/src/specify_cli/workflows/engine.py @@ -19,6 +19,7 @@ import yaml +from .._paths import try_read_integration_json from .base import RunStatus, StepContext, StepResult, StepStatus @@ -143,6 +144,35 @@ def validate_workflow(definition: WorkflowDefinition) -> list[str]: f"Must be 'string', 'number', or 'boolean'." ) + # Validate the default eagerly so authoring mistakes (e.g. a + # default not in the declared enum, or a non-numeric default for + # a number input) surface at install/validation time instead of + # at workflow-execution time. ``"auto"`` for the integration + # input is a runtime-resolved sentinel, so only the + # enum-membership check is exempted for that exact case — the + # declared type is still enforced (e.g. ``type: number`` paired + # with ``default: "auto"`` is still rejected). + if "default" in input_def: + default_value = input_def["default"] + is_auto_integration = ( + input_name == "integration" and default_value == "auto" + ) + validation_input_def: dict[str, Any] = input_def + if is_auto_integration and "enum" in input_def: + validation_input_def = { + key: value + for key, value in input_def.items() + if key != "enum" + } + try: + WorkflowEngine._coerce_input( + input_name, default_value, validation_input_def + ) + except ValueError as exc: + errors.append( + f"Input {input_name!r} has invalid default: {exc}" + ) + # -- Steps ------------------------------------------------------------ if not isinstance(definition.steps, list): errors.append("'steps' must be a list.") @@ -715,12 +745,61 @@ def _resolve_inputs( name, provided[name], input_def ) elif "default" in input_def: - resolved[name] = input_def["default"] + default_value = self._resolve_default(name, input_def["default"]) + # If the integration default could not be resolved against + # project state and falls back to the literal ``"auto"`` + # sentinel, exempt it from enum-membership coercion so a + # workflow that lists specific integrations in ``enum`` does + # not crash at runtime — declared type is still enforced. + coerce_input_def = input_def + if ( + name == "integration" + and default_value == "auto" + and "enum" in input_def + ): + coerce_input_def = { + key: value + for key, value in input_def.items() + if key != "enum" + } + resolved[name] = self._coerce_input( + name, default_value, coerce_input_def + ) elif input_def.get("required", False): msg = f"Required input {name!r} not provided." raise ValueError(msg) return resolved + def _resolve_default(self, name: str, default: Any) -> Any: + """Resolve special default sentinels against project state. + + For the ``integration`` input, ``"auto"`` resolves to the integration + recorded in ``.specify/integration.json`` so workflows dispatch to the + AI the project was actually initialized with, instead of a hardcoded + value baked into the workflow YAML. + """ + if name == "integration" and default == "auto": + resolved = self._load_project_integration() + if resolved is not None: + return resolved + return default + + def _load_project_integration(self) -> str | None: + """Read the active integration key from ``.specify/integration.json``. + + Returns None when the file is missing or malformed; callers are + expected to fall back to a literal default. The low-level read is + delegated to :func:`specify_cli._paths.try_read_integration_json` + so the parsing rules stay aligned with the CLI's loader. + """ + data = try_read_integration_json(self.project_root) + if data is None: + return None + value = data.get("integration") + if isinstance(value, str) and value: + return value + return None + @staticmethod def _coerce_input( name: str, value: Any, input_def: dict[str, Any] diff --git a/tests/test_workflows.py b/tests/test_workflows.py index 4c042fc7d5..804ec709be 100644 --- a/tests/test_workflows.py +++ b/tests/test_workflows.py @@ -1495,6 +1495,241 @@ def test_execute_missing_required_input(self, project_dir): with pytest.raises(ValueError, match="Required input"): engine.execute(definition, {}) + def test_integration_auto_default_uses_project_integration(self, project_dir): + """`integration: auto` should resolve to .specify/integration.json's integration.""" + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + specify_dir = project_dir / ".specify" + specify_dir.mkdir(parents=True, exist_ok=True) + (specify_dir / "integration.json").write_text( + json.dumps({"integration": "opencode", "version": "0.7.4"}), + encoding="utf-8", + ) + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "auto-default" + name: "Auto Default" + version: "1.0.0" +inputs: + integration: + type: string + default: "auto" +""") + engine = WorkflowEngine(project_dir) + resolved = engine._resolve_inputs(definition, {}) + assert resolved["integration"] == "opencode" + + def test_integration_auto_default_falls_back_when_no_integration_json(self, project_dir): + """`integration: auto` should keep the literal "auto" when project state is missing. + + The engine itself must not invent an integration when + ``.specify/integration.json`` is absent; any later validation or + command resolution will handle an unresolved ``"auto"`` value. + """ + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "auto-fallback" + name: "Auto Fallback" + version: "1.0.0" +inputs: + integration: + type: string + default: "auto" +""") + engine = WorkflowEngine(project_dir) + resolved = engine._resolve_inputs(definition, {}) + assert resolved["integration"] == "auto" + + def test_integration_explicit_input_overrides_auto(self, project_dir): + """An explicit --input integration=X must win over `auto` even when integration.json exists.""" + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + specify_dir = project_dir / ".specify" + specify_dir.mkdir(parents=True, exist_ok=True) + (specify_dir / "integration.json").write_text( + json.dumps({"integration": "opencode"}), + encoding="utf-8", + ) + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "explicit-wins" + name: "Explicit Wins" + version: "1.0.0" +inputs: + integration: + type: string + default: "auto" +""") + engine = WorkflowEngine(project_dir) + resolved = engine._resolve_inputs(definition, {"integration": "claude"}) + assert resolved["integration"] == "claude" + + def test_integration_auto_ignores_malformed_integration_json(self, project_dir): + """A malformed integration.json must not crash — fall back to the literal default.""" + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + specify_dir = project_dir / ".specify" + specify_dir.mkdir(parents=True, exist_ok=True) + (specify_dir / "integration.json").write_text("{not json", encoding="utf-8") + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "auto-malformed" + name: "Auto Malformed" + version: "1.0.0" +inputs: + integration: + type: string + default: "auto" +""") + engine = WorkflowEngine(project_dir) + resolved = engine._resolve_inputs(definition, {}) + assert resolved["integration"] == "auto" + + def test_integration_auto_ignores_non_utf8_integration_json(self, project_dir): + """A non-UTF8 integration.json must not crash — fall back to the literal default.""" + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + specify_dir = project_dir / ".specify" + specify_dir.mkdir(parents=True, exist_ok=True) + # 0xFF is invalid as the leading byte of a UTF-8 sequence, so + # ``Path.read_text(encoding="utf-8")`` raises UnicodeDecodeError. + (specify_dir / "integration.json").write_bytes(b"\xff\xfe\x00\x00") + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "auto-non-utf8" + name: "Auto Non UTF-8" + version: "1.0.0" +inputs: + integration: + type: string + default: "auto" +""") + engine = WorkflowEngine(project_dir) + resolved = engine._resolve_inputs(definition, {}) + assert resolved["integration"] == "auto" + + def test_default_value_is_validated_against_enum(self, project_dir): + """Defaults must run through the same coercion/enum check as provided inputs.""" + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "default-enum" + name: "Default Enum" + version: "1.0.0" +inputs: + scope: + type: string + default: "not-in-enum" + enum: ["full", "backend-only", "frontend-only"] +""") + engine = WorkflowEngine(project_dir) + with pytest.raises(ValueError, match="not in allowed values"): + engine._resolve_inputs(definition, {}) + + def test_default_value_is_coerced_to_declared_type(self, project_dir): + """A numeric default declared as a string should still be coerced like a provided input.""" + from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "default-coerce" + name: "Default Coerce" + version: "1.0.0" +inputs: + retries: + type: number + default: "3" +""") + engine = WorkflowEngine(project_dir) + resolved = engine._resolve_inputs(definition, {}) + assert resolved["retries"] == 3 + assert isinstance(resolved["retries"], int) + + def test_validate_workflow_rejects_invalid_default(self): + """Authoring-time validation should reject defaults that violate enum.""" + from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "bad-default" + name: "Bad Default" + version: "1.0.0" +inputs: + scope: + type: string + default: "not-in-enum" + enum: ["full", "backend-only", "frontend-only"] +steps: + - id: noop + type: gate + message: "noop" + options: [approve] +""") + errors = validate_workflow(definition) + assert any("invalid default" in e for e in errors), errors + + def test_validate_workflow_exempts_integration_auto_sentinel(self): + """``integration: auto`` is a runtime-resolved sentinel and must not fail validation.""" + from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "auto-ok" + name: "Auto OK" + version: "1.0.0" +inputs: + integration: + type: string + default: "auto" + enum: ["copilot", "claude", "gemini"] +steps: + - id: noop + type: gate + message: "noop" + options: [approve] +""") + errors = validate_workflow(definition) + assert not any("invalid default" in e for e in errors), errors + + def test_validate_workflow_still_checks_type_for_auto_sentinel(self): + """The ``auto`` exemption only skips enum-membership; declared type is still enforced.""" + from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow + + definition = WorkflowDefinition.from_string(""" +schema_version: "1.0" +workflow: + id: "auto-bad-type" + name: "Auto Bad Type" + version: "1.0.0" +inputs: + integration: + type: number + default: "auto" +steps: + - id: noop + type: gate + message: "noop" + options: [approve] +""") + errors = validate_workflow(definition) + assert any("invalid default" in e for e in errors), errors + # ===== State Persistence Tests ===== diff --git a/workflows/speckit/workflow.yml b/workflows/speckit/workflow.yml index bf18451029..f6b2a774bb 100644 --- a/workflows/speckit/workflow.yml +++ b/workflows/speckit/workflow.yml @@ -7,9 +7,22 @@ workflow: description: "Runs specify → plan → tasks → implement with review gates" requires: - speckit_version: ">=0.7.2" + # 0.8.3 is the first release with engine-side resolution of the + # ``integration: "auto"`` default. Older versions would treat "auto" + # as a literal integration key and fail at dispatch. + speckit_version: ">=0.8.3" integrations: - any: ["copilot", "claude", "gemini"] + # The four commands below (specify, plan, tasks, implement) are core + # spec-kit commands provided by every integration. The list here is an + # explicit non-exhaustive compatibility hint following the documented + # ``any: [...]`` schema; the workflow is intended to run against any + # integration the project was initialized with, including ones not + # listed below. + any: + - "claude" + - "copilot" + - "gemini" + - "opencode" inputs: spec: @@ -18,8 +31,8 @@ inputs: prompt: "Describe what you want to build" integration: type: string - default: "copilot" - prompt: "Integration to use (e.g. claude, copilot, gemini)" + default: "auto" + prompt: "Integration to use (e.g. claude, copilot, gemini; 'auto' uses the project's initialized integration)" scope: type: string default: "full"