mirror of
https://github.com/github/spec-kit.git
synced 2026-07-08 23:59:55 +08:00
5a901a698b
* fix(scripts): fall through to grep/sed when python3 is a broken stub in feature.json parser read_feature_json_feature_directory picked its json parser by availability (if jq / elif python3 / else grep-sed). on windows `python3` usually resolves to the microsoft store app execution alias stub: it satisfies `command -v` but fails at runtime (exit 49). the elif selected it, the runtime failure was swallowed to _fd='', and the grep/sed last resort was never reached - so a valid .specify/feature.json read as empty and every setup-plan / setup-tasks / check-prerequisites call errored with "Feature directory not found" right after a successful `specify init --script sh`. change selection from availability to parse success: try jq, then python3 only if still empty, then grep/sed only if still empty. a parser that exists but produces nothing now falls through instead of terminating the chain. the write path (_persist_feature_json) already uses jq-or-printf with no python3, so it was unaffected; only the read path needed this. add a regression test that puts a python3 stub (exit 49, like the store alias) first on PATH and asserts setup-plan.sh still resolves the feature via the grep/sed fallback. fixes #3304 * test: shadow jq so the broken-python3 fallback test actually exercises it the test claimed it dropped jq so the parser chain would reach python3 and then grep/sed, but it only prepended the python3 stub dir to PATH. on a runner with jq installed, read_feature_json_feature_directory parses via jq and never reaches the fallback the test is meant to cover. add a failing jq stub alongside the python3 stub so the chain is forced through jq -> python3 -> grep/sed regardless of what the runner has installed.
263 lines
9.0 KiB
Python
263 lines
9.0 KiB
Python
"""Tests for setup-plan bypassing branch-pattern checks when feature.json is valid."""
|
|
|
|
import json
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from tests.conftest import requires_bash
|
|
|
|
PROJECT_ROOT = Path(__file__).resolve().parent.parent
|
|
COMMON_SH = PROJECT_ROOT / "scripts" / "bash" / "common.sh"
|
|
SETUP_PLAN_SH = PROJECT_ROOT / "scripts" / "bash" / "setup-plan.sh"
|
|
COMMON_PS = PROJECT_ROOT / "scripts" / "powershell" / "common.ps1"
|
|
SETUP_PLAN_PS = PROJECT_ROOT / "scripts" / "powershell" / "setup-plan.ps1"
|
|
PLAN_TEMPLATE = PROJECT_ROOT / "templates" / "plan-template.md"
|
|
|
|
HAS_PWSH = shutil.which("pwsh") is not None
|
|
_WINDOWS_POWERSHELL = (shutil.which("powershell.exe") or shutil.which("powershell")) if os.name == "nt" else None
|
|
|
|
|
|
def _install_bash_scripts(repo: Path) -> None:
|
|
d = repo / ".specify" / "scripts" / "bash"
|
|
d.mkdir(parents=True, exist_ok=True)
|
|
shutil.copy(COMMON_SH, d / "common.sh")
|
|
shutil.copy(SETUP_PLAN_SH, d / "setup-plan.sh")
|
|
|
|
|
|
def _install_ps_scripts(repo: Path) -> None:
|
|
d = repo / ".specify" / "scripts" / "powershell"
|
|
d.mkdir(parents=True, exist_ok=True)
|
|
shutil.copy(COMMON_PS, d / "common.ps1")
|
|
shutil.copy(SETUP_PLAN_PS, d / "setup-plan.ps1")
|
|
|
|
|
|
def _minimal_templates(repo: Path) -> None:
|
|
tdir = repo / ".specify" / "templates"
|
|
tdir.mkdir(parents=True, exist_ok=True)
|
|
shutil.copy(PLAN_TEMPLATE, tdir / "plan-template.md")
|
|
|
|
|
|
def _write_feature_json(repo: Path, feature_directory: str) -> None:
|
|
(repo / ".specify" / "feature.json").write_text(
|
|
json.dumps({"feature_directory": feature_directory}),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
|
|
def _clean_env() -> dict[str, str]:
|
|
"""Return a copy of the current environment with any SPECIFY_* vars removed.
|
|
|
|
setup-plan.{sh,ps1} honors SPECIFY_FEATURE, SPECIFY_FEATURE_DIRECTORY, etc.,
|
|
which would otherwise leak from a developer shell or CI runner and make these
|
|
tests flaky. Stripping them forces every case to rely purely on git branch +
|
|
.specify/feature.json state set up by the fixture.
|
|
"""
|
|
env = os.environ.copy()
|
|
for key in list(env):
|
|
if key.startswith("SPECIFY_"):
|
|
env.pop(key)
|
|
return env
|
|
|
|
|
|
def _git_init(repo: Path) -> None:
|
|
subprocess.run(["git", "init", "-q"], cwd=repo, check=True)
|
|
subprocess.run(
|
|
["git", "config", "user.email", "test@example.com"], cwd=repo, check=True
|
|
)
|
|
subprocess.run(["git", "config", "user.name", "Test User"], cwd=repo, check=True)
|
|
subprocess.run(
|
|
["git", "commit", "--allow-empty", "-m", "init", "-q"], cwd=repo, check=True
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def plan_repo(tmp_path: Path) -> Path:
|
|
repo = tmp_path / "proj"
|
|
repo.mkdir()
|
|
_git_init(repo)
|
|
(repo / ".specify").mkdir()
|
|
_minimal_templates(repo)
|
|
_install_bash_scripts(repo)
|
|
_install_ps_scripts(repo)
|
|
return repo
|
|
|
|
|
|
@requires_bash
|
|
def test_setup_plan_passes_custom_branch_when_feature_json_valid(plan_repo: Path) -> None:
|
|
subprocess.run(
|
|
["git", "checkout", "-q", "-b", "feature/my-feature-branch"],
|
|
cwd=plan_repo,
|
|
check=True,
|
|
)
|
|
feat = plan_repo / "specs" / "001-tiny-notes-app"
|
|
feat.mkdir(parents=True)
|
|
(feat / "spec.md").write_text("# spec\n", encoding="utf-8")
|
|
_write_feature_json(plan_repo, "specs/001-tiny-notes-app")
|
|
script = plan_repo / ".specify" / "scripts" / "bash" / "setup-plan.sh"
|
|
result = subprocess.run(
|
|
["bash", str(script)],
|
|
cwd=plan_repo,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
env=_clean_env(),
|
|
)
|
|
assert result.returncode == 0, result.stderr + result.stdout
|
|
assert (feat / "plan.md").is_file()
|
|
|
|
|
|
@requires_bash
|
|
def test_setup_plan_errors_without_feature_context(plan_repo: Path) -> None:
|
|
"""Without feature.json or SPECIFY_FEATURE_DIRECTORY, setup-plan must error."""
|
|
script = plan_repo / ".specify" / "scripts" / "bash" / "setup-plan.sh"
|
|
result = subprocess.run(
|
|
["bash", str(script)],
|
|
cwd=plan_repo,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
env=_clean_env(),
|
|
)
|
|
assert result.returncode != 0
|
|
assert "Feature directory not found" in result.stderr
|
|
|
|
|
|
@requires_bash
|
|
def test_setup_plan_survives_broken_python3_stub(plan_repo: Path) -> None:
|
|
"""A `python3` on PATH that exists but fails at runtime must not defeat
|
|
feature.json parsing.
|
|
|
|
On Windows `python3` typically resolves to the Microsoft Store App Execution
|
|
Alias stub: it satisfies `command -v python3` yet exits non-zero at runtime.
|
|
The parser must fall through to the grep/sed fallback on that failure instead
|
|
of selecting python3 by mere availability and swallowing its error (#3304).
|
|
"""
|
|
subprocess.run(
|
|
["git", "checkout", "-q", "-b", "feature/my-feature-branch"],
|
|
cwd=plan_repo,
|
|
check=True,
|
|
)
|
|
feat = plan_repo / "specs" / "001-tiny-notes-app"
|
|
feat.mkdir(parents=True)
|
|
(feat / "spec.md").write_text("# spec\n", encoding="utf-8")
|
|
_write_feature_json(plan_repo, "specs/001-tiny-notes-app")
|
|
|
|
# A stub python3 that mimics the Windows Store alias: on PATH, exits 49.
|
|
stub_dir = plan_repo / "_stubbin"
|
|
stub_dir.mkdir()
|
|
stub = stub_dir / "python3"
|
|
stub.write_text(
|
|
"#!/bin/sh\n"
|
|
'echo "Python was not found; run without arguments to install from the '
|
|
'Microsoft Store" >&2\n'
|
|
"exit 49\n",
|
|
encoding="utf-8",
|
|
)
|
|
stub.chmod(0o755)
|
|
|
|
# A stub jq that shadows any real jq on PATH and also fails, so the parser
|
|
# cannot short-circuit on jq and must reach the broken python3 stub and then
|
|
# fall through to grep/sed. Without this, a runner that has jq installed
|
|
# would parse feature.json via jq and never exercise the fallback this test
|
|
# is meant to cover.
|
|
jq_stub = stub_dir / "jq"
|
|
jq_stub.write_text(
|
|
"#!/bin/sh\n"
|
|
'echo "jq: simulated failure" >&2\n'
|
|
"exit 1\n",
|
|
encoding="utf-8",
|
|
)
|
|
jq_stub.chmod(0o755)
|
|
|
|
env = _clean_env()
|
|
# Prepend the stub dir so the failing jq and python3 stubs take precedence
|
|
# over any real ones; PATH still needs the real bash utilities for grep/sed.
|
|
env["PATH"] = f"{stub_dir}{os.pathsep}{env.get('PATH', '')}"
|
|
|
|
script = plan_repo / ".specify" / "scripts" / "bash" / "setup-plan.sh"
|
|
result = subprocess.run(
|
|
["bash", str(script)],
|
|
cwd=plan_repo,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
env=env,
|
|
)
|
|
assert result.returncode == 0, result.stderr + result.stdout
|
|
assert (feat / "plan.md").is_file()
|
|
|
|
|
|
@requires_bash
|
|
def test_setup_plan_numbered_branch_works_with_feature_json(
|
|
plan_repo: Path,
|
|
) -> None:
|
|
"""A numbered branch still works when feature.json explicitly pins the spec dir."""
|
|
subprocess.run(
|
|
["git", "checkout", "-q", "-b", "001-tiny-notes-app"],
|
|
cwd=plan_repo,
|
|
check=True,
|
|
)
|
|
feat = plan_repo / "specs" / "001-tiny-notes-app"
|
|
feat.mkdir(parents=True)
|
|
(feat / "spec.md").write_text("# spec\n", encoding="utf-8")
|
|
_write_feature_json(plan_repo, "specs/001-tiny-notes-app")
|
|
script = plan_repo / ".specify" / "scripts" / "bash" / "setup-plan.sh"
|
|
result = subprocess.run(
|
|
["bash", str(script)],
|
|
cwd=plan_repo,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
env=_clean_env(),
|
|
)
|
|
assert result.returncode == 0, result.stderr + result.stdout
|
|
assert (feat / "plan.md").is_file()
|
|
|
|
|
|
@pytest.mark.skipif(not (HAS_PWSH or _WINDOWS_POWERSHELL), reason="no PowerShell available")
|
|
def test_setup_plan_ps_passes_custom_branch_when_feature_json_valid(plan_repo: Path) -> None:
|
|
subprocess.run(
|
|
["git", "checkout", "-q", "-b", "feature/my-feature-branch"],
|
|
cwd=plan_repo,
|
|
check=True,
|
|
)
|
|
feat = plan_repo / "specs" / "001-tiny-notes-app"
|
|
feat.mkdir(parents=True)
|
|
(feat / "spec.md").write_text("# spec\n", encoding="utf-8")
|
|
_write_feature_json(plan_repo, "specs/001-tiny-notes-app")
|
|
script = plan_repo / ".specify" / "scripts" / "powershell" / "setup-plan.ps1"
|
|
exe = "pwsh" if HAS_PWSH else _WINDOWS_POWERSHELL
|
|
result = subprocess.run(
|
|
[exe, "-NoProfile", "-File", str(script)],
|
|
cwd=plan_repo,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
env=_clean_env(),
|
|
)
|
|
assert result.returncode == 0, result.stderr + result.stdout
|
|
assert (feat / "plan.md").is_file()
|
|
|
|
|
|
@pytest.mark.skipif(not (HAS_PWSH or _WINDOWS_POWERSHELL), reason="no PowerShell available")
|
|
def test_setup_plan_ps_errors_without_feature_context(
|
|
plan_repo: Path,
|
|
) -> None:
|
|
script = plan_repo / ".specify" / "scripts" / "powershell" / "setup-plan.ps1"
|
|
exe = "pwsh" if HAS_PWSH else _WINDOWS_POWERSHELL
|
|
result = subprocess.run(
|
|
[exe, "-NoProfile", "-File", str(script)],
|
|
cwd=plan_repo,
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
env=_clean_env(),
|
|
)
|
|
combined = result.stderr + result.stdout
|
|
assert result.returncode != 0
|
|
assert "Feature directory not found" in combined
|