DocsGPT/docsgpt/deploy/docker.py

"""The docker CLI calls behind ``docsgpt up``."""

from __future__ import annotations

import http.client
import re
import shutil
import socket
import subprocess
import sys
import time
import urllib.request
from collections.abc import Callable, Sequence
from pathlib import Path
from typing import Optional

MIN_COMPOSE = (2, 24, 0)
DAEMON_START_SECONDS = 120


class DeployError(Exception):
    """A problem the user can act on; the command prints it without a traceback."""


def run(args: Sequence[str], *, cwd: Optional[Path] = None, capture: bool = False, check: bool = True,
        stdout=None, stdin=None):
    """Run a command, streaming its output unless ``capture`` or a file is given for ``stdout``.

    ``stdout`` and ``stdin`` take open files, so a dump goes straight to disk and
    back in again without passing through this process.
    """
    streams = {"capture_output": True} if capture else {"stdout": stdout, "stdin": stdin}
    try:
        result = subprocess.run(list(args), cwd=cwd, text=True, check=False, **streams)
    except FileNotFoundError as exc:
        raise DeployError(f"{args[0]} is not installed or not on PATH") from exc
    if check and result.returncode != 0:
        detail = (result.stderr or "").strip() if capture else ""
        message = f"`{' '.join(args)}` failed with exit code {result.returncode}"
        raise DeployError(f"{message}: {detail}" if detail else message)
    return result


def _parse_version(text: str) -> Optional[tuple[int, ...]]:
    match = re.search(r"(\d+)\.(\d+)\.(\d+)", text or "")
    return tuple(int(part) for part in match.groups()) if match else None


class Docker:
    """Docker and Docker Compose, through their command-line tools."""

    def __init__(
        self,
        runner: Callable[..., subprocess.CompletedProcess] = run,
        which: Callable[[str], Optional[str]] = shutil.which,
        sleep: Callable[[float], None] = time.sleep,
        platform: str = sys.platform,
    ) -> None:
        self._run = runner
        self._which = which
        self._sleep = sleep
        self._platform = platform

    def preflight(self, interactive: bool = False) -> None:
        """Make sure Docker is installed and running and Compose is new enough, starting Docker Desktop on macOS."""
        if not self._which("docker"):
            raise DeployError("Docker is not installed. Get it from https://docs.docker.com/get-docker/ and run this again.")
        info = self._run(["docker", "info"], capture=True, check=False)
        if info.returncode != 0:
            if "permission denied" in (info.stderr or "").lower():
                raise DeployError(
                    "Your user cannot use Docker (permission denied on its socket). Add it to the docker group "
                    "with `sudo usermod -aG docker $USER`, log out and back in, and run this again."
                )
            self._start_daemon()
        result = self._run(["docker", "compose", "version", "--short"], capture=True, check=False)
        version = _parse_version(result.stdout) if result.returncode == 0 else None
        if version is None:
            raise DeployError(
                "Docker Compose v2 is not available (`docker compose version` failed). "
                "Install the Compose plugin: https://docs.docker.com/compose/install/"
            )
        if version < MIN_COMPOSE:
            found = ".".join(str(part) for part in version)
            raise DeployError(f"Docker Compose {found} is too old; DocsGPT needs 2.24 or newer.")

    def daemon_running(self) -> bool:
        return self._run(["docker", "info"], capture=True, check=False).returncode == 0

    def _start_daemon(self) -> None:
        if self._platform == "darwin":
            print("Docker is not running; starting Docker Desktop ...", file=sys.stderr)
            self._run(["open", "-a", "Docker"], check=False)
            for _ in range(DAEMON_START_SECONDS // 2):
                self._sleep(2)
                if self.daemon_running():
                    return
            raise DeployError("Docker Desktop did not start within two minutes. Start it and run this again.")
        if self._platform.startswith("linux"):
            raise DeployError("Docker is not running. Start it with `sudo systemctl start docker` and run this again.")
        raise DeployError("Docker is not running. Start Docker Desktop and run this again.")

    def compose(self, directory: Path, *args: str, capture: bool = False, check: bool = True,
                stdout=None, stdin=None):
        """``docker compose <args>`` in ``directory``, which holds the Compose file and its ``.env``."""
        return self._run(["docker", "compose", *args], cwd=directory, capture=capture, check=check,
                         stdout=stdout, stdin=stdin)

    def export_volume(self, volume: str, dest: Path, image: str) -> None:
        """Write ``volume`` to ``dest`` as a tar, through an image the install already has."""
        dest.parent.mkdir(parents=True, exist_ok=True)
        with dest.open("wb") as handle:
            self._run(
                ["docker", "run", "--rm", "-v", f"{volume}:/data:ro", image, "tar", "cf", "-", "-C", "/data", "."],
                stdout=handle,
            )

    def import_volume(self, volume: str, source: Path, image: str) -> None:
        """Replace ``volume``'s contents with the tar at ``source``; the volume is created when missing."""
        with source.open("rb") as handle:
            self._run(
                ["docker", "run", "--rm", "-i", "-v", f"{volume}:/data", image,
                 "sh", "-c", "find /data -mindepth 1 -delete && tar xf - -C /data"],
                stdin=handle,
            )

    def volume_exists(self, name: str) -> bool:
        return self._run(["docker", "volume", "inspect", name], capture=True, check=False).returncode == 0

    def project_dirs(self, project: str) -> set[Path]:
        """The folders containers of Compose project ``project`` were started from."""
        result = self._run(
            [
                "docker", "ps", "-a",
                "--filter", f"label=com.docker.compose.project={project}",
                "--format", '{{.Label "com.docker.compose.project.working_dir"}}',
            ],
            capture=True,
            check=False,
        )
        if result.returncode != 0:
            return set()
        return {Path(line.strip()) for line in result.stdout.splitlines() if line.strip()}


def wait_healthy(
    url: str,
    timeout: float,
    *,
    opener: Callable = urllib.request.urlopen,
    sleep: Callable[[float], None] = time.sleep,
    clock: Callable[[], float] = time.monotonic,
) -> bool:
    """Poll ``url`` until it answers 2xx (True) or ``timeout`` seconds pass (False); tries at least once.

    No request starts once the deadline is reached, and neither the pauses nor the
    requests after the first run past it.
    """
    deadline = clock() + timeout
    request_timeout = min(5.0, timeout) if timeout > 0 else 5.0
    while True:
        try:
            with opener(url, timeout=request_timeout) as response:
                if 200 <= response.status < 300:
                    return True
        except (OSError, http.client.HTTPException):
            # Not answering yet: refused, reset, timed out or a broken response. Keep polling.
            pass
        remaining = deadline - clock()
        if remaining <= 0:
            return False
        sleep(min(2.0, remaining))
        remaining = deadline - clock()
        if remaining <= 0:
            return False
        request_timeout = min(5.0, remaining)


def lan_ip() -> str:
    """This machine's address on its network, or ``localhost``. No packet is sent."""
    with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as probe:
        try:
            probe.connect(("192.0.2.1", 80))
            return probe.getsockname()[0]
        except OSError:
            return "localhost"