92c2392fd6
* fix: show docker as N/A inside the container * test: cover in-container docker detection * fix: make the N/A dependency chip legible * refactor: make remote docker applicability explicit and tested
185 lines
6.6 KiB
Python
185 lines
6.6 KiB
Python
"""Tests for shell_routes.py helpers."""
|
|
|
|
import builtins
|
|
import importlib.util
|
|
import json
|
|
import sys
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
from routes.shell_routes import (
|
|
_find_line_break,
|
|
_running_in_container,
|
|
_docker_row_status,
|
|
DOCKER_IN_CONTAINER_HINT,
|
|
)
|
|
|
|
|
|
def test_shell_routes_import_without_posix_pty_modules(monkeypatch):
|
|
"""Native Windows has no fcntl/termios; importing routes must still work."""
|
|
real_import = builtins.__import__
|
|
|
|
def fake_import(name, globals=None, locals=None, fromlist=(), level=0):
|
|
if name in {"fcntl", "pty"}:
|
|
raise ImportError(f"No module named {name!r}")
|
|
return real_import(name, globals, locals, fromlist, level)
|
|
|
|
monkeypatch.setattr(builtins, "__import__", fake_import)
|
|
cached_modules = {name: sys.modules.pop(name, None) for name in ("fcntl", "pty")}
|
|
|
|
module_path = Path(__file__).resolve().parents[1] / "routes" / "shell_routes.py"
|
|
spec = importlib.util.spec_from_file_location("_shell_routes_without_pty", module_path)
|
|
module = importlib.util.module_from_spec(spec)
|
|
sys.modules[spec.name] = module
|
|
try:
|
|
spec.loader.exec_module(module)
|
|
finally:
|
|
sys.modules.pop(spec.name, None)
|
|
for name, cached_module in cached_modules.items():
|
|
if cached_module is not None:
|
|
sys.modules[name] = cached_module
|
|
|
|
assert module.PTY_SUPPORTED is False
|
|
assert module._find_line_break(b"ok\n") == (2, 1)
|
|
|
|
|
|
async def test_generate_pty_reports_explicit_unsupported_error(monkeypatch):
|
|
"""Clients can distinguish unsupported PTY mode from process failures."""
|
|
import routes.shell_routes as shell_routes
|
|
|
|
monkeypatch.setattr(shell_routes, "PTY_SUPPORTED", False)
|
|
monkeypatch.setattr(shell_routes, "_PTY_IMPORT_ERROR", ImportError("No module named 'termios'"))
|
|
|
|
request = SimpleNamespace(is_disconnected=lambda: False)
|
|
events = [
|
|
json.loads(chunk.removeprefix("data: ").strip())
|
|
async for chunk in shell_routes._generate_pty("echo hi", 5, request)
|
|
]
|
|
|
|
assert events == [
|
|
{
|
|
"stream": "stderr",
|
|
"data": "PTY streaming is not supported on this platform: No module named 'termios'",
|
|
"error": shell_routes.PTY_UNSUPPORTED_ERROR,
|
|
},
|
|
{"exit_code": -1, "error": shell_routes.PTY_UNSUPPORTED_ERROR},
|
|
]
|
|
|
|
|
|
class TestFindLineBreak:
|
|
"""Test line-break detection in byte buffers."""
|
|
|
|
def test_newline(self):
|
|
assert _find_line_break(b"hello\nworld") == (5, 1)
|
|
|
|
def test_crlf(self):
|
|
assert _find_line_break(b"hello\r\nworld") == (5, 2)
|
|
|
|
def test_cr_only(self):
|
|
assert _find_line_break(b"hello\rworld") == (5, 1)
|
|
|
|
def test_no_breaks(self):
|
|
assert _find_line_break(b"no breaks") == (-1, 0)
|
|
|
|
def test_empty(self):
|
|
assert _find_line_break(b"") == (-1, 0)
|
|
|
|
def test_leading_newline(self):
|
|
assert _find_line_break(b"\n") == (0, 1)
|
|
|
|
def test_leading_cr(self):
|
|
assert _find_line_break(b"\r") == (0, 1)
|
|
|
|
def test_leading_crlf(self):
|
|
assert _find_line_break(b"\r\n") == (0, 2)
|
|
|
|
def test_multiple_newlines(self):
|
|
"""Should find the first one."""
|
|
assert _find_line_break(b"a\nb\nc") == (1, 1)
|
|
|
|
def test_cr_before_newline_not_adjacent(self):
|
|
"""\\r at pos 2, \\n at pos 5 — not CRLF, should return \\r pos."""
|
|
assert _find_line_break(b"ab\rcd\n") == (2, 1)
|
|
|
|
def test_newline_before_cr(self):
|
|
"""\\n comes before \\r — should return \\n."""
|
|
assert _find_line_break(b"ab\ncd\r") == (2, 1)
|
|
|
|
|
|
class TestRunningInContainer:
|
|
"""Detect whether the Odysseus process itself runs inside a container."""
|
|
|
|
def test_dockerenv_marker_present(self, tmp_path):
|
|
marker = tmp_path / ".dockerenv"
|
|
marker.write_text("")
|
|
assert _running_in_container(
|
|
dockerenv_path=str(marker), cgroup_path=str(tmp_path / "missing"),
|
|
) is True
|
|
|
|
def test_cgroup_names_a_container_runtime(self, tmp_path):
|
|
cgroup = tmp_path / "cgroup"
|
|
cgroup.write_text("12:devices:/docker/abcdef0123456789\n")
|
|
assert _running_in_container(
|
|
dockerenv_path=str(tmp_path / "no-marker"), cgroup_path=str(cgroup),
|
|
) is True
|
|
|
|
def test_bare_host_has_neither_signal(self, tmp_path):
|
|
cgroup = tmp_path / "cgroup"
|
|
cgroup.write_text("0::/user.slice/session-1.scope\n")
|
|
assert _running_in_container(
|
|
dockerenv_path=str(tmp_path / "no-marker"), cgroup_path=str(cgroup),
|
|
) is False
|
|
|
|
def test_missing_cgroup_file_is_not_a_container(self, tmp_path):
|
|
assert _running_in_container(
|
|
dockerenv_path=str(tmp_path / "no-marker"),
|
|
cgroup_path=str(tmp_path / "also-missing"),
|
|
) is False
|
|
|
|
|
|
class TestDockerRowStatus:
|
|
"""Applicability plus install hint for the docker dependency row."""
|
|
|
|
DEFAULT = "Install Docker on the selected server."
|
|
|
|
def test_in_container_and_absent_is_not_applicable_with_safe_default_hint(self):
|
|
status = _docker_row_status(
|
|
on_remote=False, in_container=True, installed=False, default_hint=self.DEFAULT,
|
|
)
|
|
assert status.applicable is False
|
|
assert status.install_hint == DOCKER_IN_CONTAINER_HINT
|
|
|
|
def test_in_container_but_present_is_applicable_with_default_hint(self):
|
|
status = _docker_row_status(
|
|
on_remote=False, in_container=True, installed=True, default_hint=self.DEFAULT,
|
|
)
|
|
assert status.applicable is True
|
|
assert status.install_hint == self.DEFAULT
|
|
|
|
def test_on_host_and_absent_stays_applicable_with_default_hint(self):
|
|
status = _docker_row_status(
|
|
on_remote=False, in_container=False, installed=False, default_hint=self.DEFAULT,
|
|
)
|
|
assert status.applicable is True
|
|
assert status.install_hint == self.DEFAULT
|
|
|
|
def test_remote_server_is_always_applicable_even_when_absent(self):
|
|
status = _docker_row_status(
|
|
on_remote=True, in_container=False, installed=False, default_hint=self.DEFAULT,
|
|
)
|
|
assert status.applicable is True
|
|
assert status.install_hint == self.DEFAULT
|
|
|
|
def test_remote_server_ignores_local_container_status(self):
|
|
status = _docker_row_status(
|
|
on_remote=True, in_container=True, installed=False, default_hint=self.DEFAULT,
|
|
)
|
|
assert status.applicable is True
|
|
assert status.install_hint == self.DEFAULT
|
|
|
|
def test_container_hint_steers_to_remote_and_warns_on_socket(self):
|
|
lowered = DOCKER_IN_CONTAINER_HINT.lower()
|
|
assert "remote" in lowered
|
|
assert "socket" in lowered
|
|
assert "host-root" in lowered or "host root" in lowered
|