Skip to content

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

14.6 KB
Raw Blame
"""Tests for AgyIntegration (Antigravity)."""

import hashlib
from pathlib import Path

import pytest

from specify_cli.integrations import get_integration

from .test_integration_base_skills import SkillsIntegrationTests


class TestAgyIntegration(SkillsIntegrationTests):
    KEY = "agy"
    FOLDER = ".agents/"
    COMMANDS_SUBDIR = "skills"
    REGISTRAR_DIR = ".agents/skills"

    def test_options_include_skills_flag(self):
        """Override inherited test: AgyIntegration should not expose a --skills flag because .agents/ is its only layout."""
        i = get_integration(self.KEY)
        skills_opts = [o for o in i.options() if o.name == "--skills"]
        assert len(skills_opts) == 0

    def test_requires_cli_is_true(self):
        """agy is a CLI tool; requires_cli must be True."""
        i = get_integration(self.KEY)
        assert i.config["requires_cli"] is True

    def test_install_url_is_set(self):
        """install_url must point to the official installation page."""
        i = get_integration(self.KEY)
        assert i.config["install_url"] == "https://antigravity.google/"


class TestAgyInitFlow:
    """--integration agy creates expected files."""

    def test_integration_agy_creates_skills(self, tmp_path):
        """--integration agy should create skills directory."""
        from typer.testing import CliRunner

        from specify_cli import app

        runner = CliRunner()
        target = tmp_path / "test-proj"
        result = runner.invoke(
            app,
            [
                "init",
                str(target),
                "--integration",
                "agy",
                "--script",
                "sh",
                "--ignore-agent-tools",
            ],
        )

        assert result.exit_code == 0, f"init --integration agy failed: {result.output}"
        assert (target / ".agents" / "skills" / "speckit-plan" / "SKILL.md").exists()

    def test_agy_setup_warning(self, tmp_path):
        """Agy integration should print a warning about CLI v1.0.0+ / IDE v2.0.0+ requirement during setup."""
        from typer.testing import CliRunner

        from specify_cli import app

        # Click >= 8.2 separates stdout and stderr natively
        runner = CliRunner()
        target = tmp_path / "test-proj2"
        result = runner.invoke(
            app,
            [
                "init",
                str(target),
                "--integration",
                "agy",
                "--script",
                "sh",
                "--ignore-agent-tools",
            ],
        )

        assert result.exit_code == 0
        assert (
            "Warning: The .agents/ layout requires Antigravity CLI v1.0.0 or newer "
            "(or Antigravity IDE v2.0.0 or newer)." in result.stderr
        )


class TestAgyBuildExecArgs:
    """agy non-interactive execution argument building."""

    @pytest.fixture(autouse=True)
    def _isolate_env(self, monkeypatch):
        """Isolate tests from ambient environment variables."""
        for var in (
            "SPECKIT_AGY_ALLOW_ALL_TOOLS",
            "SPECKIT_INTEGRATION_AGY_ALLOW_ALL_TOOLS",
            "SPECKIT_INTEGRATION_AGY_EXTRA_ARGS",
            "SPECKIT_INTEGRATION_AGY_EXECUTABLE",
        ):
            monkeypatch.delenv(var, raising=False)

    def test_build_exec_args_default(self):
        """build_exec_args returns ['agy', '--output-format', 'json', '--print', prompt] by default."""
        i = get_integration("agy")
        result = i.build_exec_args("describe my feature")
        assert result == [
            "agy",
            "--output-format",
            "json",
            "--print",
            "describe my feature",
        ]

    def test_build_exec_args_supports_model(self):
        """agy supports --model; model param must be included before --print."""
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", model="gemini-pro", output_json=False)
        assert result == [
            "agy",
            "--model",
            "gemini-pro",
            "--print",
            "my prompt",
        ]

    def test_build_exec_args_no_model_flag_when_model_is_none(self):
        """When model is None, no --model flag should appear in the args."""
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", model=None)
        assert "--model" not in result

    def test_build_exec_args_supports_model_and_json(self):
        """agy supports both --model and --output-format json simultaneously."""
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", model="gemini-pro", output_json=True)
        assert result == [
            "agy",
            "--model",
            "gemini-pro",
            "--output-format",
            "json",
            "--print",
            "my prompt",
        ]

    def test_build_exec_args_honors_output_json_false(self):
        """agy supports output_json=False; --output-format json must be omitted."""
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", output_json=False)
        assert result == [
            "agy",
            "--print",
            "my prompt",
        ]

    @pytest.mark.parametrize(
        ("env_var", "value"),
        [
            ("SPECKIT_AGY_ALLOW_ALL_TOOLS", "1"),
            ("SPECKIT_AGY_ALLOW_ALL_TOOLS", "true"),
            ("SPECKIT_AGY_ALLOW_ALL_TOOLS", "yes"),
            ("SPECKIT_AGY_ALLOW_ALL_TOOLS", "on"),
            ("SPECKIT_INTEGRATION_AGY_ALLOW_ALL_TOOLS", "1"),
            ("SPECKIT_INTEGRATION_AGY_ALLOW_ALL_TOOLS", "true"),
        ],
    )
    def test_build_exec_args_enables_skip_permissions_via_env(
        self, monkeypatch, env_var, value
    ):
        """Setting permissions env var to truthy values enables --dangerously-skip-permissions."""
        monkeypatch.setenv(env_var, value)
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", output_json=False)
        assert result == [
            "agy",
            "--dangerously-skip-permissions",
            "--print",
            "my prompt",
        ]

    @pytest.mark.parametrize(
        "value",
        ["0", "false", "no", "off", "", "random"],
    )
    def test_build_exec_args_disables_skip_permissions_with_falsy_values(
        self, monkeypatch, value
    ):
        """Falsy or invalid env values must not enable --dangerously-skip-permissions."""
        monkeypatch.setenv("SPECKIT_AGY_ALLOW_ALL_TOOLS", value)
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", output_json=False)
        assert "--dangerously-skip-permissions" not in result
        assert result == ["agy", "--print", "my prompt"]

    @pytest.mark.parametrize("empty_val", ["", "  "])
    def test_build_exec_args_env_empty_fallthrough(self, monkeypatch, empty_val):
        """Empty string or whitespace in integration-specific var must fall through to generic var."""
        monkeypatch.setenv("SPECKIT_INTEGRATION_AGY_ALLOW_ALL_TOOLS", empty_val)
        monkeypatch.setenv("SPECKIT_AGY_ALLOW_ALL_TOOLS", "1")
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", output_json=False)
        assert result == [
            "agy",
            "--dangerously-skip-permissions",
            "--print",
            "my prompt",
        ]

    def test_build_exec_args_env_precedence(self, monkeypatch):
        """Integration-specific variable takes precedence over generic variable."""
        monkeypatch.setenv("SPECKIT_INTEGRATION_AGY_ALLOW_ALL_TOOLS", "0")
        monkeypatch.setenv("SPECKIT_AGY_ALLOW_ALL_TOOLS", "1")
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", output_json=False)
        assert "--dangerously-skip-permissions" not in result

    def test_build_exec_args_honors_extra_args(self, monkeypatch):
        """SPECKIT_INTEGRATION_AGY_EXTRA_ARGS must be positioned before --print."""
        monkeypatch.setenv("SPECKIT_INTEGRATION_AGY_EXTRA_ARGS", "--verbose")
        i = get_integration("agy")
        assert i.build_exec_args("my prompt", output_json=False) == [
            "agy",
            "--verbose",
            "--print",
            "my prompt",
        ]

    def test_build_exec_args_add_dir_for_workspace(self, tmp_path):
        """--add-dir <project_root> must be injected before --print when project_root is given.

        Without --add-dir, agy cannot locate .agents/skills/ and reports
        'no active workspace', ignoring installed Spec Kit skills entirely.

        See issue #4480 (PR #4481).
        """
        i = get_integration("agy")
        result = i.build_exec_args(
            "my prompt", project_root=tmp_path, output_json=False
        )
        assert "--add-dir" in result
        add_dir_idx = result.index("--add-dir")
        print_idx = result.index("--print")
        assert add_dir_idx < print_idx, "--add-dir must come before --print"
        assert result[add_dir_idx + 1] == str(tmp_path.resolve())

    def test_build_exec_args_relative_project_root(self):
        """Relative project_root must be resolved to an absolute path.

        Passing a relative path to --add-dir breaks agy when the subprocess
        also changes cwd to that same relative path.
        """
        i = get_integration("agy")
        rel_path = Path("my_relative_dir")
        result = i.build_exec_args(
            "my prompt", project_root=rel_path, output_json=False
        )
        assert "--add-dir" in result
        add_dir_idx = result.index("--add-dir")
        assert result[add_dir_idx + 1] == str(rel_path.resolve())

    @pytest.mark.parametrize("empty_root", [None, "", "   "])
    def test_build_exec_args_no_add_dir_when_project_root_is_empty(self, empty_root):
        """When project_root is None or empty/whitespace, --add-dir must not appear."""
        i = get_integration("agy")
        result = i.build_exec_args("my prompt", project_root=empty_root)
        assert "--add-dir" not in result

    def test_build_exec_args_combined_flag_order(self, monkeypatch, tmp_path):
        """When permissions, model, output_json, project_root, and EXTRA_ARGS
        are all set, all must appear before --print in expected order.
        """
        monkeypatch.setenv("SPECKIT_AGY_ALLOW_ALL_TOOLS", "1")
        monkeypatch.setenv("SPECKIT_INTEGRATION_AGY_EXTRA_ARGS", "--custom-flag")
        i = get_integration("agy")
        result = i.build_exec_args(
            "hello", model="claude-3", project_root=tmp_path, output_json=True
        )
        assert result == [
            "agy",
            "--dangerously-skip-permissions",
            "--model",
            "claude-3",
            "--output-format",
            "json",
            "--add-dir",
            str(tmp_path.resolve()),
            "--custom-flag",
            "--print",
            "hello",
        ]

    def test_build_exec_args_honors_executable_override(self, monkeypatch):
        monkeypatch.setenv("SPECKIT_INTEGRATION_AGY_EXECUTABLE", "/custom/agy")
        i = get_integration("agy")
        assert i.build_exec_args("my prompt")[0] == "/custom/agy"

    def test_dispatch_command_forwards_project_root_as_add_dir(self, tmp_path):
        """dispatch_command must pass project_root to build_exec_args so --add-dir is included."""
        from unittest.mock import MagicMock, patch

        i = get_integration("agy")
        mock_result = MagicMock()
        mock_result.returncode = 0
        mock_result.stdout = ""
        mock_result.stderr = ""

        with (
            patch("specify_cli.integrations.base.shutil.which", return_value="agy"),
            patch("subprocess.run", return_value=mock_result) as mock_run,
        ):
            result = i.dispatch_command(
                "speckit.plan", stream=False, project_root=tmp_path
            )

        assert result["exit_code"] == 0
        argv = mock_run.call_args[0][0]
        assert "--add-dir" in argv
        assert argv[argv.index("--add-dir") + 1] == str(tmp_path.resolve())
        assert "--output-format" in argv
        assert argv[argv.index("--output-format") + 1] == "json"


class TestAgyHookCommandNote:
    """Verify dot-to-hyphen normalization note is injected into hook sections.

    Note: AgyIntegration inherits _inject_hook_command_note and
    post_process_skill_content directly from SkillsIntegration.
    """

    def test_hook_note_injected_in_skills_with_hooks(self, tmp_path):
        """Skills with hook sections should contain the normalization note and valid manifest hashes."""
        from specify_cli.integrations.manifest import IntegrationManifest

        i = get_integration("agy")
        m = IntegrationManifest("agy", tmp_path)
        created = i.setup(tmp_path, m, script_type="sh")
        specify_skill = tmp_path / ".agents/skills/speckit-specify/SKILL.md"
        assert specify_skill.exists()
        content = specify_skill.read_text(encoding="utf-8")
        assert "replace dots" in content, (
            "speckit-specify should have dot-to-hyphen hook note"
        )
        rel_key = ".agents/skills/speckit-specify/SKILL.md"
        assert rel_key in m.files
        assert (
            m.files[rel_key] == hashlib.sha256(specify_skill.read_bytes()).hexdigest()
        )
        assert m.check_modified() == []
        assert len(created) > 0

    def test_hook_note_not_in_skills_without_hooks(self):
        """Skills without hook sections should not get the note."""
        from specify_cli.integrations.agy import AgyIntegration

        content = "---\nname: test\ndescription: test\n---\n\nNo hooks here.\n"
        result = AgyIntegration._inject_hook_command_note(content)
        assert "replace dots" not in result

    def test_hook_note_idempotent(self):
        """Injecting the note twice must not duplicate it."""
        from specify_cli.integrations.agy import AgyIntegration

        content = (
            "---\nname: test\n---\n\n"
            "- For each executable hook, output the following based on its flag:\n"
        )
        once = AgyIntegration._inject_hook_command_note(content)
        twice = AgyIntegration._inject_hook_command_note(once)
        assert once == twice, "Hook note injection should be idempotent"

    def test_hook_note_preserves_indentation(self):
        """The injected note must match the indentation of the target line."""
        from specify_cli.integrations.agy import AgyIntegration

        content = (
            "---\nname: test\n---\n\n"
            "   - For each executable hook, output the following\n"
        )
        result = AgyIntegration._inject_hook_command_note(content)
        lines = result.splitlines()
        note_line = next((ln for ln in lines if "replace dots" in ln), None)
        assert note_line is not None, "Hook note line should be present"
        assert note_line.startswith("   "), "Note should preserve indentation"