Skip to content

💫 Toolkit to help you get started with SDD or any other process!

4.1 KB
Raw Blame
"""Shared helpers for extension command tests."""
from __future__ import annotations

import json
import os
from pathlib import Path

import pytest

from specify_cli.integration_state import write_integration_json
from specify_cli.integrations import get_integration
from specify_cli.integrations.manifest import IntegrationManifest


MINIMAL_ZIP_BYTES = b"PK\x05\x06" + b"\x00" * 18

# The ``extension_dir`` fixture provides ``speckit.test-ext.hello``. Each case
# pairs an agent's init options with the name that agent registers on disk
# (what the user types) and the other spelling, which must not be listed.
_HYPHENATED = "speckit-test-ext-hello"
_DOTTED = "speckit.test-ext.hello"
LISTED_COMMAND_NAME_CASES = [
    # .claude/skills/speckit-test-ext-hello/SKILL.md
    pytest.param({"ai": "claude", "ai_skills": True}, _HYPHENATED, _DOTTED, id="claude"),
    # .agents/skills/speckit-test-ext-hello/SKILL.md
    pytest.param({"ai": "codex", "ai_skills": True}, _HYPHENATED, _DOTTED, id="codex"),
    # .junie/commands/speckit-test-ext-hello.md
    pytest.param({"ai": "junie"}, _HYPHENATED, _DOTTED, id="junie"),
    # .github/skills/speckit-test-ext-hello/SKILL.md
    pytest.param({"ai": "copilot", "ai_skills": True}, _HYPHENATED, _DOTTED, id="copilot-skills"),
    pytest.param({"ai": "cline"}, _HYPHENATED, _DOTTED, id="cline"),
    pytest.param({"ai": "forge"}, _HYPHENATED, _DOTTED, id="forge"),
    # .github/agents/speckit.test-ext.hello.agent.md
    pytest.param({"ai": "copilot"}, _DOTTED, _HYPHENATED, id="copilot-commands"),
    # .gemini/commands/speckit.test-ext.hello.toml
    pytest.param({"ai": "gemini"}, _DOTTED, _HYPHENATED, id="gemini"),
    # <commands-dir>/speckit-test-ext-hello/SKILL.md
    pytest.param({"ai": "generic", "ai_skills": True}, _HYPHENATED, _DOTTED, id="generic-skills"),
    # <commands-dir>/speckit.test-ext.hello.md
    pytest.param({"ai": "generic"}, _DOTTED, _HYPHENATED, id="generic-commands"),
]


def write_listing_project_options(project_dir, init_options):
    """Record *init_options* as the project's init options for a listing case.

    Generic resolves its output directory from ``integration.json`` and
    registers extension commands next to its core commands, so its cases also
    set up the integration the way ``specify init`` does.
    """
    (project_dir / ".specify" / "init-options.json").write_text(
        json.dumps({**init_options, "script": "sh"}), encoding="utf-8"
    )
    if init_options["ai"] == "generic":
        parsed_options = {
            "commands_dir": ".myagent/commands",
            "skills": bool(init_options.get("ai_skills")),
        }
        manifest = IntegrationManifest("generic", project_dir)
        get_integration("generic").setup(
            project_dir, manifest, parsed_options=parsed_options
        )
        manifest.save()
        write_integration_json(
            project_dir, version="1.0.0", integration_key="generic",
            settings={"generic": {"parsed_options": parsed_options}},
        )


def open_test_download_zip(project_root, download_dir, zip_filename):
    """Create a transient download file using platform-appropriate semantics."""
    target = download_dir / zip_filename
    o_temporary = getattr(os, "O_TEMPORARY", 0)
    if o_temporary:
        return os.open(
            target,
            os.O_RDWR | os.O_CREAT | os.O_EXCL | o_temporary,
            0o600,
        )
    fd = os.open(target, os.O_RDWR | os.O_CREAT | os.O_EXCL, 0o600)
    try:
        os.unlink(target)
    except OSError:
        os.close(fd)
        raise
    return fd


def validate_safe_cache_dir(project_root):
    """Create the expected extension download cache for command tests."""
    download_dir = project_root / ".specify" / "extensions" / ".cache" / "downloads"
    download_dir.mkdir(parents=True, exist_ok=True)
    return download_dir


def can_create_symlink(tmp_path: Path) -> bool:
    """Return whether the current platform can create file symlinks."""
    target = tmp_path / "symlink-target.txt"
    link = tmp_path / "symlink-link.txt"
    target.write_text("ok", encoding="utf-8")
    try:
        os.symlink(target, link)
    except OSError:
        return False
    return link.is_symlink()