feat: Add draft implementation of E2E tests

Author: jovnc

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test-e2e:
+    name: E2E Tests (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.13"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build binary
+        run: |
+          pyinstaller --onefile main.py --name gitmastery
+
+      - name: Set binary path (Unix)
+        if: runner.os != 'Windows'
+        run: echo "GITMASTERY_BINARY=./dist/gitmastery" >> $GITHUB_ENV
+
+      - name: Set binary path (Windows)
+        if: runner.os == 'Windows'
+        run: echo "GITMASTERY_BINARY=./dist/gitmastery.exe" >> $env:GITHUB_ENV
+
+      - name: Run E2E tests
+        run: |
+          python -m pytest tests/e2e/ -v

scripts/build_test_e2e.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+# Build and run E2E tests for gitmastery
+
+set -e
+FILENAME="gitmastery"
+
+echo "Building gitmastery binary..."
+pyinstaller --onefile main.py --name $FILENAME
+
+echo "Running E2E tests..."
+pytest tests/e2e -v
+
+echo "All E2E tests passed!"

tests/e2e/__init__.py

@@ -0,0 +1,8 @@
+import pytest
+
+from .runner import BinaryRunner
+
+
+@pytest.fixture(scope="session")
+def runner() -> BinaryRunner:
+    return BinaryRunner.from_env()

tests/e2e/conftest.py

@@ -0,0 +1,41 @@
+from dataclasses import dataclass
+from typing import List, Self
+import re
+
+
+@dataclass(frozen=True)
+class RunResult:
+    """Immutable result from a binary execution."""
+
+    stdout: str
+    stderr: str
+    returncode: int
+    command: List[str]
+
+    def assert_success(self) -> Self:
+        """Assert the command exited with code 0."""
+        ERROR_MSG = (
+            f"Expected exit code 0, got {self.returncode}\n"
+            f"Command: {' '.join(self.command)}\n"
+            f"stdout:\n{self.stdout}\n"
+            f"stderr:\n{self.stderr}"
+        )
+        assert self.returncode == 0, ERROR_MSG
+        return self
+
+    def assert_stdout_contains(self, text: str) -> Self:
+        """Assert stdout contains the given text."""
+        ERROR_MSG = (
+            f"Expected stdout to contain {text!r}\nActual stdout:\n{self.stdout}"
+        )
+        assert text in self.stdout, ERROR_MSG
+        return self
+
+    def assert_stdout_matches(self, pattern: str, flags: int = 0) -> Self:
+        """Assert stdout matches a regex pattern."""
+        ERROR_MSG = (
+            f"Expected stdout to match pattern {pattern!r}\n"
+            f"Actual stdout:\n{self.stdout}"
+        )
+        assert re.search(pattern, self.stdout, flags), ERROR_MSG
+        return self

tests/e2e/result.py

@@ -0,0 +1,71 @@
+import os
+import platform
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Dict, Optional, Sequence, Self
+from .result import RunResult
+
+
+@dataclass
+class BinaryRunner:
+    """Cross-platform runner for the gitmastery binary."""
+
+    binary_path: str
+    project_root: Path
+
+    @classmethod
+    def from_env(
+        cls,
+        env_var: str = "GITMASTERY_BINARY",
+        project_root: Optional[Path] = None,
+    ) -> Self:
+        """Build a runner from an environment variable."""
+        if project_root is None:
+            project_root = Path(__file__).resolve().parents[2]
+
+        raw = os.environ.get(env_var, "").strip()
+        if raw:
+            binary_path = raw
+        else:
+            system = platform.system().lower()
+            if system == "windows":
+                binary_path = str(project_root / "dist" / "gitmastery.exe")
+            else:
+                binary_path = str(project_root / "dist" / "gitmastery")
+
+        return cls(binary_path=binary_path, project_root=project_root)
+
+    def run(
+        self,
+        args: Sequence[str] = (),
+        *,
+        cwd: Optional[Path] = None,
+        env: Optional[Dict[str, str]] = None,
+        timeout: int = 30,
+        stdin_text: Optional[str] = None,
+    ) -> RunResult:
+        """Execute the binary with args and return a RunResult."""
+        cmd = [self.binary_path] + list(args)
+        run_env = os.environ.copy()
+        if env:
+            run_env.update(env)
+
+        run_env.setdefault("NO_COLOR", "1")
+        run_env.setdefault("PYTHONIOENCODING", "utf-8")
+
+        proc = subprocess.run(
+            cmd,
+            cwd=str(cwd) if cwd else str(self.project_root),
+            env=run_env,
+            capture_output=True,
+            text=True,
+            timeout=timeout if timeout > 0 else None,
+            input=stdin_text,
+        )
+        return RunResult(
+            stdout=proc.stdout,
+            stderr=proc.stderr,
+            returncode=proc.returncode,
+            command=cmd,
+        )

tests/e2e/runner.py

@@ -0,0 +1,9 @@
+from .runner import BinaryRunner
+
+
+def test_version(runner: BinaryRunner) -> None:
+    """Test the version command output."""
+    res = runner.run(["version"])
+    res.assert_success()
+    res.assert_stdout_contains("Git-Mastery app is")
+    res.assert_stdout_matches(r"v\d+\.\d+\.\d+")