test: cover install and verify scripts

Author: TimInTech

tests/test_install_script.py

@@ -0,0 +1,191 @@
+from __future__ import annotations
+
+import os
+import shutil
+import subprocess
+from pathlib import Path
+
+# NOTE: tests/conftest.py's autouse `_block_real_notifications` fixture patches
+# `subprocess.run` process-wide (it patches the shared `subprocess` module via
+# `app.notify.subprocess.run`). Resolving real tool paths must therefore use
+# `shutil.which`, not `subprocess.run(["which", ...])`.
+BASH = shutil.which("bash")
+
+
+def _write_stub(path: Path, body: str) -> None:
+    path.write_text(f"#!{BASH}\n{body}\n", encoding="utf-8")
+    path.chmod(0o755)
+
+
+def _prepare_install_script(tmp_path: Path, repo_root: Path) -> tuple[Path, Path]:
+    """Builds a fake repo + PATH so install.sh can run to completion without
+    touching real system packages, sudo, or systemd state.
+
+    Strategy: shadow only the specific external commands whose real-world
+    invocation would be destructive or non-deterministic (dpkg-query,
+    systemctl, pgrep, ydotool, sudo, pip) by prepending a stub bin directory
+    to the inherited PATH. Everything else (grep, sed, id, python3, ...)
+    keeps using the real inherited PATH, since those calls are read-only and
+    their real behavior is safe and deterministic across Ubuntu/Debian hosts.
+    """
+    repo_dir = tmp_path / "repo"
+    scripts_dir = repo_dir / "scripts"
+    scripts_dir.mkdir(parents=True, exist_ok=True)
+    script_path = scripts_dir / "install.sh"
+    script_path.write_text((repo_root / "scripts" / "install.sh").read_text(encoding="utf-8"), encoding="utf-8")
+    script_path.chmod(0o755)
+
+    systemd_dir = repo_dir / "systemd"
+    systemd_dir.mkdir(parents=True, exist_ok=True)
+    (systemd_dir / "blitztext-linux.service").write_text(
+        (repo_root / "systemd" / "blitztext-linux.service").read_text(encoding="utf-8"), encoding="utf-8"
+    )
+
+    venv_bin = repo_dir / ".venv" / "bin"
+    venv_bin.mkdir(parents=True, exist_ok=True)
+    _write_stub(venv_bin / "pip", "exit 0")
+
+    stub_bin = tmp_path / "bin"
+    stub_bin.mkdir(parents=True, exist_ok=True)
+
+    _write_stub(stub_bin / "dpkg-query", 'printf "install ok installed\\n"\nexit 0')
+    _write_stub(stub_bin / "ydotool", "exit 0")
+    _write_stub(stub_bin / "pgrep", "exit 1")
+    _write_stub(stub_bin / "sudo", 'exec "$@"')
+    _write_stub(
+        stub_bin / "systemctl",
+        r"""
+args="$*"
+case "$args" in
+  *"ydotool.service"*)
+    exit 1
+    ;;
+  *"is-active --quiet blitztext-linux"*)
+    [[ "${BT_TEST_APP_ACTIVE:-0}" == "1" ]] && exit 0 || exit 1
+    ;;
+  *"is-enabled --quiet blitztext-linux"*)
+    [[ "${BT_TEST_APP_ENABLED:-0}" == "1" ]] && exit 0 || exit 1
+    ;;
+  *"daemon-reload"*)
+    exit 0
+    ;;
+  *"user enable blitztext-linux"*)
+    exit 0
+    ;;
+  *)
+    exit 1
+    ;;
+esac
+""".strip("\n"),
+    )
+
+    return script_path, stub_bin
+
+
+def _run_script(
+    script_path: Path,
+    home_dir: Path,
+    runtime_dir: Path,
+    stub_bin: Path,
+    *,
+    extra_env: dict[str, str] | None = None,
+) -> subprocess.CompletedProcess[str]:
+    env = os.environ.copy()
+    env.update(
+        {
+            "HOME": str(home_dir),
+            "XDG_RUNTIME_DIR": str(runtime_dir),
+            "PATH": f"{stub_bin}{os.pathsep}{env['PATH']}",
+        }
+    )
+    if extra_env:
+        env.update(extra_env)
+    proc = subprocess.Popen(
+        [BASH, str(script_path)],
+        cwd=str(script_path.parent),
+        env=env,
+        text=True,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    stdout, stderr = proc.communicate()
+    return subprocess.CompletedProcess(proc.args, proc.returncode, stdout, stderr)
+
+
+def test_install_dies_on_invalid_blitztext_no_hotkey_value(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_install_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(
+        script_path, home_dir, runtime_dir, stub_bin, extra_env={"BLITZTEXT_NO_HOTKEY": "2"}
+    )
+
+    assert result.returncode == 1
+    assert "BLITZTEXT_NO_HOTKEY muss 0 oder 1 sein" in result.stderr
+
+
+def test_install_warns_before_daemon_reload_when_app_is_active(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_install_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(
+        script_path,
+        home_dir,
+        runtime_dir,
+        stub_bin,
+        extra_env={"BLITZTEXT_NO_HOTKEY": "1", "BT_TEST_APP_ACTIVE": "1"},
+    )
+
+    assert result.returncode == 0, result.stderr
+    assert "blitztext-linux läuft gerade" in result.stdout
+    assert "daemon-reload kann die App unerwartet beenden" in result.stdout
+    assert "systemctl --user stop blitztext-linux" in result.stdout
+
+
+def test_install_stays_quiet_before_daemon_reload_when_app_is_inactive(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_install_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(
+        script_path,
+        home_dir,
+        runtime_dir,
+        stub_bin,
+        extra_env={"BLITZTEXT_NO_HOTKEY": "1", "BT_TEST_APP_ACTIVE": "0"},
+    )
+
+    assert result.returncode == 0, result.stderr
+    assert "blitztext-linux läuft gerade" not in result.stdout
+    assert "daemon-reload kann die App unerwartet beenden" not in result.stdout
+
+
+def test_install_completes_and_enables_autostart_when_not_yet_enabled(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_install_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(
+        script_path,
+        home_dir,
+        runtime_dir,
+        stub_bin,
+        extra_env={"BLITZTEXT_NO_HOTKEY": "1", "BT_TEST_APP_ENABLED": "0"},
+    )
+
+    assert result.returncode == 0, result.stderr
+    assert "Installation abgeschlossen" in result.stdout
+    assert "blitztext-linux.service für Autostart aktiviert" in result.stdout
+    service_dst = home_dir / ".config" / "systemd" / "user" / "blitztext-linux.service"
+    assert service_dst.exists()
+    assert "%BLITZTEXT_DIR%" not in service_dst.read_text(encoding="utf-8")

tests/test_verify_script.py

@@ -0,0 +1,186 @@
+from __future__ import annotations
+
+import os
+import shutil
+import subprocess
+from pathlib import Path
+
+# NOTE: tests/conftest.py's autouse `_block_real_notifications` fixture patches
+# `subprocess.run` process-wide (it patches the shared `subprocess` module via
+# `app.notify.subprocess.run`). Resolving real tool paths must therefore use
+# `shutil.which`, not `subprocess.run(["which", ...])`.
+INFRA_TOOLS = ("grep", "whoami", "stat", "sort", "dirname", "sed")
+BASH = shutil.which("bash")
+
+
+def _symlink_real_tool(stub_bin: Path, name: str) -> None:
+    resolved = shutil.which(name)
+    if not resolved:
+        raise RuntimeError(f"required real tool not found on PATH: {name}")
+    (stub_bin / name).symlink_to(resolved)
+
+
+def _write_stub(stub_bin: Path, name: str, body: str) -> None:
+    path = stub_bin / name
+    path.write_text(f"#!{BASH}\n{body}\n", encoding="utf-8")
+    path.chmod(0o755)
+
+
+def _prepare_verify_script(
+    tmp_path: Path,
+    repo_root: Path,
+    *,
+    present_checked_tools: tuple[str, ...] = (),
+    fake_groups: str = "",
+) -> tuple[Path, Path]:
+    """Copies verify.sh into an isolated fake repo and builds a deterministic PATH.
+
+    Returns (script_path, stub_bin_dir). The isolated PATH shadows every
+    checked binary (parec/wl-copy/xclip/ydotool/ffmpeg/socat) so results do
+    not depend on what happens to be installed on the machine running the
+    tests.
+    """
+    scripts_dir = tmp_path / "repo" / "scripts"
+    scripts_dir.mkdir(parents=True, exist_ok=True)
+    script_path = scripts_dir / "verify.sh"
+    script_path.write_text((repo_root / "scripts" / "verify.sh").read_text(encoding="utf-8"), encoding="utf-8")
+    script_path.chmod(0o755)
+
+    stub_bin = tmp_path / "bin"
+    stub_bin.mkdir(parents=True, exist_ok=True)
+    for tool in INFRA_TOOLS:
+        _symlink_real_tool(stub_bin, tool)
+
+    for tool in present_checked_tools:
+        _write_stub(stub_bin, tool, "exit 0")
+
+    _write_stub(
+        stub_bin,
+        "groups",
+        f'printf "%s\\n" "{fake_groups}"',
+    )
+    _write_stub(stub_bin, "id", '[[ "$1" == "-Gn" ]] && printf "%s\\n" "" || echo 0')
+    _write_stub(stub_bin, "systemctl", "exit 1")
+    _write_stub(stub_bin, "pgrep", "exit 1")
+
+    return script_path, stub_bin
+
+
+def _run_script(script_path: Path, home_dir: Path, runtime_dir: Path, stub_bin: Path) -> subprocess.CompletedProcess[str]:
+    env = os.environ.copy()
+    env.update(
+        {
+            "HOME": str(home_dir),
+            "XDG_RUNTIME_DIR": str(runtime_dir),
+            "PATH": str(stub_bin),
+            "WAYLAND_DISPLAY": "",
+            "DISPLAY": "",
+        }
+    )
+    proc = subprocess.Popen(
+        [BASH, str(script_path)],
+        cwd=str(script_path.parent),
+        env=env,
+        text=True,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    stdout, stderr = proc.communicate()
+    return subprocess.CompletedProcess(proc.args, proc.returncode, stdout, stderr)
+
+
+def test_verify_fails_and_exits_1_when_required_tools_and_venv_are_missing(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_verify_script(tmp_path, repo_root, present_checked_tools=())
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(script_path, home_dir, runtime_dir, stub_bin)
+
+    assert result.returncode == 1
+    assert "[FAIL]" in result.stdout
+    assert ".venv/bin/python nicht gefunden" in result.stdout
+
+
+def test_verify_config_permissions_pass_when_file_is_0600(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_verify_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+    config_file = home_dir / ".config" / "blitztext-linux" / "config.json"
+    config_file.parent.mkdir(parents=True, exist_ok=True)
+    config_file.write_text("{}", encoding="utf-8")
+    config_file.chmod(0o600)
+
+    result = _run_script(script_path, home_dir, runtime_dir, stub_bin)
+
+    assert "config.json vorhanden und korrekt geschützt (0600)" in result.stdout
+
+
+def test_verify_config_permissions_warn_when_file_is_more_permissive(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_verify_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+    config_file = home_dir / ".config" / "blitztext-linux" / "config.json"
+    config_file.parent.mkdir(parents=True, exist_ok=True)
+    config_file.write_text("{}", encoding="utf-8")
+    config_file.chmod(0o644)
+
+    result = _run_script(script_path, home_dir, runtime_dir, stub_bin)
+
+    assert "Berechtigungen sind 644" in result.stdout
+    assert "chmod 600" in result.stdout
+
+
+def test_verify_config_missing_reports_info_not_fail(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_verify_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(script_path, home_dir, runtime_dir, stub_bin)
+
+    assert "config.json nicht gefunden" in result.stdout
+    assert "wird beim ersten Start automatisch erstellt" in result.stdout
+
+
+def test_verify_missing_xdg_runtime_dir_is_reported_as_fail(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    script_path, stub_bin = _prepare_verify_script(tmp_path, repo_root)
+    home_dir = tmp_path / "home"
+
+    env = os.environ.copy()
+    env.update({"HOME": str(home_dir), "PATH": str(stub_bin), "WAYLAND_DISPLAY": "", "DISPLAY": ""})
+    env.pop("XDG_RUNTIME_DIR", None)
+    proc = subprocess.Popen(
+        [BASH, str(script_path)],
+        cwd=str(script_path.parent),
+        env=env,
+        text=True,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    stdout, _ = proc.communicate()
+
+    assert "XDG_RUNTIME_DIR nicht gesetzt" in stdout
+    assert proc.returncode == 1
+
+
+def test_verify_all_checked_binaries_present_removes_their_fail_lines(tmp_path: Path):
+    repo_root = Path(__file__).resolve().parents[1]
+    checked_tools = ("parec", "wl-copy", "xclip", "ydotool", "ffmpeg", "socat")
+    script_path, stub_bin = _prepare_verify_script(tmp_path, repo_root, present_checked_tools=checked_tools)
+    home_dir = tmp_path / "home"
+    runtime_dir = tmp_path / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+
+    result = _run_script(script_path, home_dir, runtime_dir, stub_bin)
+
+    for tool in checked_tools:
+        assert f"{tool} nicht gefunden" not in result.stdout
+        assert f"{tool} gefunden" in result.stdout