bambuddy/backend/tests/unit/test_spoolbuddy_ssh.py
maziggy f5ecc61cda fix(spoolbuddy): lower /update permission to INVENTORY_UPDATE so kiosk's own Settings -> Update button works
The kiosk's Settings -> Update Daemon button returned "API keys cannot
  be used for administrative operations" because POST /spoolbuddy/devices/
  {id}/update was gated on Permission.SETTINGS_UPDATE, and SETTINGS_UPDATE
  is in the _APIKEY_DENIED_PERMISSIONS deny-list introduced by PR #1241.
  Every kiosk-side request tripped the deny-list before the API key's
  scope set (Read / Print Queue / Control / Legacy) was even consulted.

  Same root cause as the four QuickMenu System buttons fixed in 0.2.4b3
  (Restart Daemon / Restart Browser / Reboot / Shutdown). Missed /update
  in that audit on the reasoning "replaces the daemon binary, different
  threat surface" — but that's wrong: restart_daemon already replaces
  the running daemon process, so daemon-replacement is not a step up in
  blast radius. The SSH update is also strictly scoped to the one device
  the operator physically controls (git fetch + pip install + systemctl
  restart on that host) — same threat profile as the system commands
  already running on INVENTORY_UPDATE.

  Lower /spoolbuddy/devices/{id}/update from SETTINGS_UPDATE to
  INVENTORY_UPDATE so it aligns with the rest of the kiosk-scoped routes
  (calibration/tare, display, cancel-write, system/command,
  system/command-result, update-status). The main Bambuddy in-app updater
  at POST /api/v1/updates/apply keeps SETTINGS_UPDATE — that one runs on
  the Bambuddy host and is correctly fenced behind the deny-list.
2026-05-08 14:28:41 +02:00

719 lines
28 KiB
Python

"""Unit tests for SpoolBuddy SSH update service."""
import asyncio
import os
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from backend.app.services.spoolbuddy_ssh import (
_get_ssh_key_dir,
_run_ssh_command,
detect_current_branch,
get_or_create_keypair,
get_public_key,
perform_ssh_update,
)
# -- _get_ssh_key_dir ---------------------------------------------------------
def test_get_ssh_key_dir_creates_directory(tmp_path):
with patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings:
mock_settings.base_dir = tmp_path
key_dir = _get_ssh_key_dir()
assert key_dir == tmp_path / "spoolbuddy" / "ssh"
assert key_dir.exists()
def test_get_ssh_key_dir_returns_existing(tmp_path):
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
with patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings:
mock_settings.base_dir = tmp_path
assert _get_ssh_key_dir() == ssh_dir
# -- get_or_create_keypair -----------------------------------------------------
@pytest.mark.asyncio
async def test_get_or_create_keypair_returns_existing(tmp_path):
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
priv = ssh_dir / "id_ed25519"
pub = ssh_dir / "id_ed25519.pub"
priv.write_text("PRIVATE")
pub.write_text("PUBLIC")
with patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings:
mock_settings.base_dir = tmp_path
result = await get_or_create_keypair()
assert result == (priv, pub)
@pytest.mark.asyncio
async def test_get_or_create_keypair_generates_new(tmp_path):
"""Key generation runs in-process via `cryptography` — no ssh-keygen subprocess.
This matters in Docker: when the container runs under an arbitrary PUID
that isn't in /etc/passwd, `ssh-keygen` aborts with "no user exists for uid
<N>". Generating the keypair in-process avoids the getpwuid() lookup.
"""
from cryptography.hazmat.primitives import serialization
from cryptography.hazmat.primitives.asymmetric import ed25519
with patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings:
mock_settings.base_dir = tmp_path
priv, pub = await get_or_create_keypair()
assert priv.exists()
assert pub.exists()
# Private key permissions — no world/group access
assert (priv.stat().st_mode & 0o077) == 0
# Public key is a valid OpenSSH ed25519 key with our comment
pub_text = pub.read_text()
assert pub_text.startswith("ssh-ed25519 ")
assert pub_text.rstrip().endswith("bambuddy-spoolbuddy")
# Private key is a valid OpenSSH-format ed25519 key we can load back
loaded = serialization.load_ssh_private_key(priv.read_bytes(), password=None)
assert isinstance(loaded, ed25519.Ed25519PrivateKey)
@pytest.mark.asyncio
async def test_get_or_create_keypair_does_not_shell_out(tmp_path):
"""Regression guard: must not invoke any subprocess (fixes Docker PUID bug)."""
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("asyncio.create_subprocess_exec") as mock_exec,
):
mock_settings.base_dir = tmp_path
await get_or_create_keypair()
mock_exec.assert_not_called()
# -- get_public_key ------------------------------------------------------------
@pytest.mark.asyncio
async def test_get_public_key(tmp_path):
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("ssh-ed25519 AAAA bambuddy-spoolbuddy\n")
with patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings:
mock_settings.base_dir = tmp_path
key = await get_public_key()
assert key == "ssh-ed25519 AAAA bambuddy-spoolbuddy"
# -- detect_current_branch ----------------------------------------------------
def test_detect_branch_from_git_head(tmp_path):
"""Read branch directly from .git/HEAD in the application root — no subprocess."""
git_dir = tmp_path / ".git"
git_dir.mkdir()
(git_dir / "HEAD").write_text("ref: refs/heads/dev\n")
with (
patch("backend.app.services.spoolbuddy_ssh._APP_DIR", tmp_path),
patch("asyncio.create_subprocess_exec") as mock_exec,
patch("subprocess.run") as mock_run,
):
assert detect_current_branch() == "dev"
# Regression guard: must not shell out (fails with getpwuid under
# arbitrary Docker PUIDs if ever reintroduced).
mock_exec.assert_not_called()
mock_run.assert_not_called()
def test_detect_branch_uses_app_dir_not_data_dir(tmp_path):
"""Branch detection must look in the application root, not the data dir.
Regression guard for the Docker bug where `.git` was being looked up in
`settings.base_dir` (which is `DATA_DIR=/app/data` in Docker), so it was
never found and the fallback always returned "main" — even when the user
was on a feature branch bind-mounted at `/app`.
"""
app_dir = tmp_path / "app"
data_dir = tmp_path / "app" / "data"
app_dir.mkdir()
data_dir.mkdir()
# Real .git lives at the application root (bind-mount style).
(app_dir / ".git").mkdir()
(app_dir / ".git" / "HEAD").write_text("ref: refs/heads/dev\n")
# Decoy .git in the data dir — if the code ever regresses to reading
# from settings.base_dir, this would be returned instead.
(data_dir / ".git").mkdir()
(data_dir / ".git" / "HEAD").write_text("ref: refs/heads/wrong-branch\n")
with (
patch("backend.app.services.spoolbuddy_ssh._APP_DIR", app_dir),
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
):
mock_settings.base_dir = data_dir
assert detect_current_branch() == "dev"
def test_detect_branch_worktree_gitdir_file(tmp_path):
"""Git worktrees store a `gitdir:` pointer instead of a dir — follow it."""
real_git_dir = tmp_path / "real-git"
real_git_dir.mkdir()
(real_git_dir / "HEAD").write_text("ref: refs/heads/feature-x\n")
(tmp_path / ".git").write_text(f"gitdir: {real_git_dir}\n")
with patch("backend.app.services.spoolbuddy_ssh._APP_DIR", tmp_path):
assert detect_current_branch() == "feature-x"
def test_detect_branch_detached_head_falls_back(tmp_path):
"""Detached HEAD (raw commit hash) should fall through to the env var."""
git_dir = tmp_path / ".git"
git_dir.mkdir()
(git_dir / "HEAD").write_text("deadbeef1234\n")
with (
patch("backend.app.services.spoolbuddy_ssh._APP_DIR", tmp_path),
patch.dict(os.environ, {"GIT_BRANCH": "release"}),
):
assert detect_current_branch() == "release"
def test_detect_branch_env_fallback(tmp_path):
with (
patch("backend.app.services.spoolbuddy_ssh._APP_DIR", tmp_path),
patch.dict(os.environ, {"GIT_BRANCH": "staging"}),
):
assert detect_current_branch() == "staging"
def test_detect_branch_default_main(tmp_path):
with (
patch("backend.app.services.spoolbuddy_ssh._APP_DIR", tmp_path),
patch.dict(os.environ, {}, clear=True),
):
# Remove GIT_BRANCH if present
os.environ.pop("GIT_BRANCH", None)
assert detect_current_branch() == "main"
# -- _run_ssh_command ----------------------------------------------------------
#
# _run_ssh_command uses asyncssh (pure Python) rather than the OpenSSH `ssh`
# binary. Both `ssh` and `ssh-keygen` call getpwuid(getuid()) during startup
# and abort with "No user exists for uid <N>" when the container runs under
# an arbitrary PUID that is not listed in /etc/passwd — asyncssh avoids the
# subprocess entirely.
@pytest.mark.asyncio
async def test_run_ssh_command_success(tmp_path):
key_file = tmp_path / "key"
key_file.write_text("KEY")
mock_result = MagicMock()
mock_result.stdout = "hello\n"
mock_result.stderr = ""
mock_result.exit_status = 0
mock_server_key = MagicMock()
mock_server_key.export_public_key.return_value = b"ssh-ed25519 AAAA test"
mock_conn = AsyncMock()
mock_conn.run = AsyncMock(return_value=mock_result)
mock_conn.get_server_host_key = MagicMock(return_value=mock_server_key)
mock_conn.__aenter__ = AsyncMock(return_value=mock_conn)
mock_conn.__aexit__ = AsyncMock(return_value=False)
with patch("backend.app.services.spoolbuddy_ssh.asyncssh.connect", return_value=mock_conn) as mock_connect:
rc, stdout, stderr, observed_key = await _run_ssh_command("10.0.0.1", "echo hello", key_file)
assert rc == 0
assert stdout == "hello\n"
assert stderr == ""
# TOFU mode (no known_hosts): returns observed key
assert observed_key == "ssh-ed25519 AAAA test"
kwargs = mock_connect.call_args.kwargs
assert kwargs["host"] == "10.0.0.1"
assert kwargs["username"] == "spoolbuddy"
assert kwargs["client_keys"] == [str(key_file)]
# TOFU default: known_hosts=None on first connect
assert kwargs["known_hosts"] is None
# ~/.ssh/config loading is disabled — HOME may not resolve under arbitrary Docker PUIDs
assert kwargs["config"] == []
mock_conn.run.assert_awaited_once()
run_args = mock_conn.run.call_args
assert run_args.args[0] == "echo hello"
# check=False — we handle non-zero exit codes ourselves
assert run_args.kwargs.get("check") is False
@pytest.mark.asyncio
async def test_run_ssh_command_with_known_hosts_skips_capture(tmp_path):
"""When known_hosts is provided, observed_host_key must be None."""
import asyncssh
key_file = tmp_path / "key"
key_file.write_text("KEY")
mock_result = MagicMock()
mock_result.stdout = ""
mock_result.stderr = ""
mock_result.exit_status = 0
mock_conn = AsyncMock()
mock_conn.run = AsyncMock(return_value=mock_result)
mock_conn.get_server_host_key = MagicMock()
mock_conn.__aenter__ = AsyncMock(return_value=mock_conn)
mock_conn.__aexit__ = AsyncMock(return_value=False)
fake_kh = MagicMock(spec=asyncssh.SSHKnownHosts)
with patch("backend.app.services.spoolbuddy_ssh.asyncssh.connect", return_value=mock_conn):
rc, _, _, observed_key = await _run_ssh_command("10.0.0.1", "echo hi", key_file, known_hosts=fake_kh)
assert rc == 0
assert observed_key is None
mock_conn.get_server_host_key.assert_not_called()
@pytest.mark.asyncio
async def test_run_ssh_command_host_key_mismatch(tmp_path):
"""HostKeyNotVerifiable must surface as rc=255 with a safe message (H1)."""
import asyncssh
key_file = tmp_path / "key"
key_file.write_text("KEY")
with patch(
"backend.app.services.spoolbuddy_ssh.asyncssh.connect",
side_effect=asyncssh.HostKeyNotVerifiable(asyncssh.DISC_HOST_KEY_NOT_VERIFIABLE, "key mismatch"),
):
rc, _, stderr, observed_key = await _run_ssh_command("10.0.0.1", "echo hello", key_file)
assert rc == 255
assert "mismatch" in stderr.lower()
assert observed_key is None
@pytest.mark.asyncio
async def test_run_ssh_command_no_subprocess(tmp_path):
"""Regression guard: _run_ssh_command must not spawn any subprocess."""
key_file = tmp_path / "key"
key_file.write_text("KEY")
mock_result = MagicMock()
mock_result.stdout = ""
mock_result.stderr = ""
mock_result.exit_status = 0
mock_conn = AsyncMock()
mock_conn.run = AsyncMock(return_value=mock_result)
mock_conn.get_server_host_key = MagicMock(return_value=None)
mock_conn.__aenter__ = AsyncMock(return_value=mock_conn)
mock_conn.__aexit__ = AsyncMock(return_value=False)
with (
patch("backend.app.services.spoolbuddy_ssh.asyncssh.connect", return_value=mock_conn),
patch("asyncio.create_subprocess_exec") as mock_exec,
):
await _run_ssh_command("10.0.0.1", "echo hi", key_file)
mock_exec.assert_not_called()
@pytest.mark.asyncio
async def test_run_ssh_command_connection_failure(tmp_path):
"""Connection errors should surface as rc=255 with the asyncssh message."""
import asyncssh
key_file = tmp_path / "key"
key_file.write_text("KEY")
with patch(
"backend.app.services.spoolbuddy_ssh.asyncssh.connect",
side_effect=asyncssh.Error(code=0, reason="Connection refused"),
):
rc, stdout, stderr, _ = await _run_ssh_command("10.0.0.1", "echo hello", key_file)
assert rc == 255
assert stdout == ""
assert "Connection refused" in stderr
@pytest.mark.asyncio
async def test_run_ssh_command_os_error(tmp_path):
"""OS-level connection errors (DNS, route) also map to rc=255."""
key_file = tmp_path / "key"
key_file.write_text("KEY")
with patch(
"backend.app.services.spoolbuddy_ssh.asyncssh.connect",
side_effect=OSError("Network is unreachable"),
):
rc, _, stderr, _ = await _run_ssh_command("10.0.0.1", "echo hello", key_file)
assert rc == 255
assert "Network is unreachable" in stderr
@pytest.mark.asyncio
async def test_run_ssh_command_timeout(tmp_path):
"""asyncio.timeout should convert long-running commands into rc=-1."""
key_file = tmp_path / "key"
key_file.write_text("KEY")
mock_conn = AsyncMock()
async def hang_enter():
await asyncio.sleep(10)
mock_conn.__aenter__ = AsyncMock(side_effect=hang_enter)
mock_conn.__aexit__ = AsyncMock(return_value=False)
with patch("backend.app.services.spoolbuddy_ssh.asyncssh.connect", return_value=mock_conn):
rc, _, stderr, _ = await _run_ssh_command("10.0.0.1", "sleep 999", key_file, timeout=0.05)
assert rc == -1
assert "timed out" in stderr
# -- perform_ssh_update --------------------------------------------------------
def _make_update_mocks(tmp_path):
"""Create common mocks for perform_ssh_update tests."""
mock_db_device = MagicMock()
mock_db_device.update_status = None
mock_db_device.update_message = None
mock_db_device.pending_command = None
mock_db_device.ssh_host_key = None # TOFU: no stored key
mock_result = MagicMock()
mock_result.scalar_one_or_none.return_value = mock_db_device
mock_session = AsyncMock()
mock_session.execute = AsyncMock(return_value=mock_result)
mock_session.commit = AsyncMock()
mock_ctx = AsyncMock()
mock_ctx.__aenter__ = AsyncMock(return_value=mock_session)
mock_ctx.__aexit__ = AsyncMock(return_value=False)
mock_ws = MagicMock()
mock_ws.broadcast = AsyncMock()
return mock_db_device, mock_ctx, mock_ws
@pytest.mark.asyncio
async def test_perform_ssh_update_success(tmp_path):
"""Full update flow: all SSH commands succeed."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
ssh_calls = []
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
ssh_calls.append(cmd)
return 0, "ok", "", "ssh-ed25519 AAAA fakehostkey"
_, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="dev"),
patch("backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts", return_value=MagicMock()),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
# Should have run: echo ok, git fetch, git checkout+reset, pip install,
# systemctl restart, find (SW cleanup), systemctl restart getty
assert len(ssh_calls) == 7
assert "echo ok" in ssh_calls[0]
assert "fetch" in ssh_calls[1]
assert "checkout" in ssh_calls[2]
assert "pip" in ssh_calls[3]
assert "spoolbuddy.service" in ssh_calls[4]
assert "Service Worker" in ssh_calls[5]
assert "getty" in ssh_calls[6]
assert mock_ws.broadcast.call_count >= 4
@pytest.mark.asyncio
async def test_perform_ssh_update_branch_is_shell_quoted(tmp_path):
"""Branch name with shell-special chars must be quoted in all git commands (L1 fix)."""
import shlex
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
# A branch name containing a semicolon — shell-injection without quoting
dangerous_branch = "dev; echo pwned"
safe_branch = shlex.quote(dangerous_branch) # expected: "'dev; echo pwned'"
ssh_calls = []
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
ssh_calls.append(cmd)
return 0, "ok", "", None
_, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value=dangerous_branch),
patch("backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts", return_value=MagicMock()),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
# All git commands must use the shell-quoted form, never the raw dangerous string
git_cmds = [c for c in ssh_calls if "fetch" in c or "checkout" in c or "reset" in c]
for cmd in git_cmds:
assert safe_branch in cmd, f"Branch not shell-quoted in: {cmd}"
assert dangerous_branch not in cmd.replace(safe_branch, ""), f"Raw dangerous branch in: {cmd}"
@pytest.mark.asyncio
async def test_perform_ssh_update_tofu_stores_host_key(tmp_path):
"""On first connect (no stored key), the observed host key must be persisted (H1)."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
FAKE_HOST_KEY = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5 fakehostkey"
call_count = 0
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
nonlocal call_count
call_count += 1
# Only first call returns the observed host key (TOFU)
observed = FAKE_HOST_KEY if call_count == 1 else None
return 0, "ok", "", observed
mock_device, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
mock_device.ssh_host_key = None # no stored key
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="main"),
patch("backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts", return_value=MagicMock()),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
# Device's ssh_host_key should have been set to the observed key
assert mock_device.ssh_host_key == FAKE_HOST_KEY
@pytest.mark.asyncio
async def test_perform_ssh_update_ssh_failure(tmp_path):
"""SSH connectivity check fails — should set error status."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
if "echo ok" in cmd:
return 255, "", "Connection refused", None
return 0, "", "", None
mock_device, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="main"),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
# Should broadcast error status
error_broadcasts = [c for c in mock_ws.broadcast.call_args_list if c[0][0].get("update_status") == "error"]
assert len(error_broadcasts) >= 1
assert "SSH connection failed" in error_broadcasts[0][0][0]["update_message"]
@pytest.mark.asyncio
async def test_perform_ssh_update_git_fetch_failure(tmp_path):
"""Git fetch fails — should set error and stop."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
ssh_calls = []
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
ssh_calls.append(cmd)
if "fetch" in cmd:
return 1, "", "fatal: could not read from remote", None
return 0, "ok", "", None
_, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="main"),
patch("backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts", return_value=MagicMock()),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
# Should stop after git fetch — no checkout, pip, restart
assert len(ssh_calls) == 2 # echo ok + git fetch
assert not any("checkout" in c for c in ssh_calls)
@pytest.mark.asyncio
async def test_perform_ssh_update_uses_stored_host_key(tmp_path):
"""When device already has ssh_host_key set, all SSH calls must receive non-None known_hosts (Gap 1)."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
STORED_KEY = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5 storedkey"
SENTINEL_KNOWN_HOSTS = MagicMock(name="known_hosts_sentinel")
received_known_hosts = []
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
received_known_hosts.append(known_hosts)
return 0, "ok", "", None # no new observed key (already stored)
mock_device, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
mock_device.ssh_host_key = STORED_KEY
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="main"),
patch(
"backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts",
return_value=SENTINEL_KNOWN_HOSTS,
),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
# Every SSH call must have received the sentinel known_hosts object (not None)
assert len(received_known_hosts) >= 2, "Expected at least 2 SSH calls"
for kh in received_known_hosts:
assert kh is SENTINEL_KNOWN_HOSTS, f"Expected sentinel known_hosts but got: {kh}"
@pytest.mark.asyncio
async def test_perform_ssh_update_corrupt_stored_key_falls_back_to_tofu(tmp_path):
"""When stored ssh_host_key can't be parsed, update continues with known_hosts=None (Gap 2)."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
ssh_calls = []
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
ssh_calls.append(cmd)
return 0, "ok", "", None
mock_device, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
mock_device.ssh_host_key = "THIS-IS-NOT-A-VALID-KEY"
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="main"),
patch(
"backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts",
side_effect=ValueError("Malformed key"),
),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
# Must not raise — corrupt key degrades gracefully
await perform_ssh_update("sb-test", "10.0.0.1")
# Update must have completed all steps despite the corrupt key
assert any("echo ok" in c for c in ssh_calls)
assert any("fetch" in c for c in ssh_calls)
assert any("checkout" in c for c in ssh_calls)
# Broadcast must show success, not error
error_broadcasts = [c for c in mock_ws.broadcast.call_args_list if c[0][0].get("update_status") == "error"]
assert not error_broadcasts, f"Got unexpected error broadcast: {error_broadcasts}"
@pytest.mark.asyncio
async def test_perform_ssh_update_passes_str_not_bytes_to_import_known_hosts(tmp_path):
"""asyncssh.import_known_hosts() is a str-only API — passing bytes crashes
inside its line parser (`line.startswith('#')` against a bytes line raises
TypeError). Pin both call sites — the stored-key parse and the just-stored
TOFU re-parse — to ensure we never re-introduce the .encode() bug."""
ssh_dir = tmp_path / "spoolbuddy" / "ssh"
ssh_dir.mkdir(parents=True)
(ssh_dir / "id_ed25519").write_text("PRIVATE")
(ssh_dir / "id_ed25519.pub").write_text("PUBLIC")
captured_args: list[object] = []
def capture_import(arg):
captured_args.append(arg)
return MagicMock(name="known_hosts")
async def mock_ssh(ip, cmd, key, *, known_hosts=None, timeout=60):
# Surface a freshly observed key on the first call so the TOFU branch
# also re-imports — exercises the second call site too.
observed = "ssh-rsa AAAAOBSERVED first-tofu" if not captured_args else None
return 0, "ok", "", observed
mock_device, mock_ctx, mock_ws = _make_update_mocks(tmp_path)
mock_device.ssh_host_key = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5 storedkey"
with (
patch("backend.app.services.spoolbuddy_ssh.settings") as mock_settings,
patch("backend.app.services.spoolbuddy_ssh._run_ssh_command", side_effect=mock_ssh),
patch("backend.app.services.spoolbuddy_ssh.detect_current_branch", return_value="main"),
patch(
"backend.app.services.spoolbuddy_ssh.asyncssh.import_known_hosts",
side_effect=capture_import,
),
patch("backend.app.core.database.async_session", return_value=mock_ctx),
patch("backend.app.api.routes.spoolbuddy.ws_manager", mock_ws),
):
mock_settings.base_dir = tmp_path
await perform_ssh_update("sb-test", "10.0.0.1")
assert captured_args, "import_known_hosts was never called"
for arg in captured_args:
assert isinstance(arg, str), f"asyncssh.import_known_hosts must receive str, got {type(arg).__name__}: {arg!r}"