test: add integration test scaffold

Signed-off-by: WANG Xuerui <[email protected]>

Author: xen0n

tests/fixtures/__init__.py

@@ -1,13 +1,20 @@
-from contextlib import contextmanager
+from contextlib import contextmanager, redirect_stderr, redirect_stdout
 from importlib import resources
+from dataclasses import dataclass
+import io
+import os
 import pathlib
 import sys
-from typing import Generator
+from typing import Generator, cast
 
+from pygit2 import Repository
 import pytest
 
+from ruyi.cli.main import main as ruyi_main
+from ruyi.config import GlobalConfig
 from ruyi.log import RuyiConsoleLogger, RuyiLogger
-from ruyi.utils.global_mode import GlobalModeProvider
+from ruyi.ruyipkg.repo import MetadataRepo
+from ruyi.utils.global_mode import EnvGlobalModeProvider, GlobalModeProvider
 
 
 class RuyiFileFixtureFactory:
@@ -158,3 +165,140 @@ def mock_gm() -> MockGlobalModeProvider:
 def ruyi_logger(mock_gm: GlobalModeProvider) -> RuyiLogger:
     """Fixture for creating a RuyiLogger instance."""
     return RuyiConsoleLogger(mock_gm)
+
+
+@dataclass
+class CLIRunResult:
+    exit_code: int
+    stdout: str
+    stderr: str
+
+
+class MockRepository:
+    def __init__(self, root: pathlib.Path) -> None:
+        self.workdir = root
+        self.path = root
+
+
+class IntegrationTestHarness:
+    def __init__(
+        self,
+        env: dict[str, str],
+        repo_root: pathlib.Path,
+        repo_url: str,
+        repo_branch: str,
+    ) -> None:
+        self._env = env
+        self.repo_root = repo_root
+        self.repo_url = repo_url
+        self.repo_branch = repo_branch
+
+    def __call__(self, *args: str) -> CLIRunResult:
+        return self.run(*args)
+
+    def run(self, *args: str) -> CLIRunResult:
+        argv = ["ruyi", *args]
+        stdout_io = io.StringIO()
+        stderr_io = io.StringIO()
+        with redirect_stdout(stdout_io), redirect_stderr(stderr_io):
+            gm = EnvGlobalModeProvider(self._env, argv)
+            gm.record_self_exe(argv[0], __file__, argv[0])
+            logger = RuyiConsoleLogger(gm, stdout=stdout_io, stderr=stderr_io)
+            gc = GlobalConfig.load_from_config(gm, logger)
+            gc.override_repo_dir = str(self.repo_root)
+            gc.override_repo_url = self.repo_url
+            gc.override_repo_branch = self.repo_branch
+            exit_code = ruyi_main(gm, gc, argv)
+        return CLIRunResult(exit_code, stdout_io.getvalue(), stderr_io.getvalue())
+
+    def add_package(
+        self,
+        category: str,
+        name: str,
+        version: str,
+        manifest_toml: str,
+    ) -> pathlib.Path:
+        pkg_dir = self.repo_root / "manifests" / category / name
+        pkg_dir.mkdir(parents=True, exist_ok=True)
+        manifest_path = pkg_dir / f"{version}.toml"
+        manifest_path.write_text(manifest_toml, encoding="utf-8")
+        return manifest_path
+
+
+def _populate_default_packages_index(repo_root: pathlib.Path) -> None:
+    repo_root.mkdir(parents=True, exist_ok=True)
+
+    config_text = """\
+ruyi-repo = "v1"
+
+[[mirrors]]
+id = "ruyi-dist"
+urls = ["https://example.invalid/dist/"]
+"""
+
+    (repo_root / "config.toml").write_text(config_text + "\n", encoding="utf-8")
+
+    sha_stub = "0" * 64
+    manifest_text = f"""\
+format = "v1"
+kind = ["source"]
+
+[metadata]
+desc = "Sample integration package"
+vendor = {{ name = "Ruyi Integration Tests", eula = "" }}
+
+[[distfiles]]
+name = "sample-src.tar.zst"
+size = 0
+
+[distfiles.checksums]
+sha256 = "{sha_stub}"
+"""
+
+    manifest_dir = repo_root / "manifests" / "dev-tools" / "sample-cli"
+    manifest_dir.mkdir(parents=True, exist_ok=True)
+    (manifest_dir / "1.0.0.toml").write_text(manifest_text + "\n", encoding="utf-8")
+
+
+@pytest.fixture
+def ruyi_cli_runner(
+    tmp_path: pathlib.Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> IntegrationTestHarness:
+    base_dir = tmp_path / "integration-env"
+    home_dir = base_dir / "home"
+    cache_dir = base_dir / "cache"
+    config_dir = base_dir / "config"
+    data_dir = base_dir / "data"
+    state_dir = base_dir / "state"
+
+    for p in (home_dir, cache_dir, config_dir, data_dir, state_dir):
+        p.mkdir(parents=True, exist_ok=True)
+
+    monkeypatch.setenv("HOME", str(home_dir))
+    monkeypatch.setenv("XDG_CACHE_HOME", str(cache_dir))
+    monkeypatch.setenv("XDG_CONFIG_HOME", str(config_dir))
+    monkeypatch.setenv("XDG_DATA_HOME", str(data_dir))
+    monkeypatch.setenv("XDG_STATE_HOME", str(state_dir))
+    monkeypatch.setenv("RUYI_TELEMETRY_OPTOUT", "1")
+
+    repo_root = cache_dir / "ruyi" / "packages-index"
+    _populate_default_packages_index(repo_root)
+
+    def _ensure_git_repo_stub(self: MetadataRepo) -> Repository:
+        if self.repo is None:
+            repo_path = pathlib.Path(self.root)
+            repo_path.mkdir(parents=True, exist_ok=True)
+            self.repo = cast(Repository, MockRepository(repo_path))
+        return self.repo
+
+    monkeypatch.setattr(MetadataRepo, "ensure_git_repo", _ensure_git_repo_stub)
+
+    env = dict(os.environ)
+
+    return IntegrationTestHarness(
+        env=env,
+        repo_root=repo_root,
+        repo_url="https://example.invalid/packages-index.git",
+        repo_branch="main",
+    )

tests/integration/test_cli_basic.py

@@ -0,0 +1,41 @@
+from tests.fixtures import IntegrationTestHarness
+
+
+def test_cli_version(ruyi_cli_runner: IntegrationTestHarness) -> None:
+    for argv in [
+        ["--version"],
+        ["version"],
+    ]:
+        result = ruyi_cli_runner(*argv)
+        assert result.exit_code == 0
+        assert "Ruyi" in result.stdout
+        assert "fatal error" not in result.stderr.lower()
+
+
+def test_cli_list_with_mock_repo(ruyi_cli_runner: IntegrationTestHarness) -> None:
+    result = ruyi_cli_runner("list", "--name-contains", "sample-cli")
+
+    assert result.exit_code == 0
+    assert "dev-tools/sample-cli" in result.stdout
+
+
+def test_cli_list_with_custom_package(ruyi_cli_runner: IntegrationTestHarness) -> None:
+    sha_stub = "1" * 64
+    manifest = (
+        'format = "v1"\n'
+        'kind = ["source"]\n\n'
+        "[metadata]\n"
+        'desc = "Custom integration package"\n'
+        'vendor = { name = "Integration Tests", eula = "" }\n\n'
+        "[[distfiles]]\n"
+        'name = "custom-src.tar.zst"\n'
+        "size = 0\n\n"
+        "[distfiles.checksums]\n"
+        f'sha256 = "{sha_stub}"\n'
+    )
+    ruyi_cli_runner.add_package("examples", "custom-cli", "0.1.0", manifest)
+
+    result = ruyi_cli_runner("list", "--category-is", "examples")
+
+    assert result.exit_code == 0
+    assert "examples/custom-cli" in result.stdout