Skip to content

ubuntu_apt

Ubuntu apt installer backend.

This installer wraps apt-get to provide a simple, uniform interface for the setup application.

Notes
  • Commands are executed via awesome_os.commands.run.
  • Logging goes through awesome_os.logger.
  • install() currently runs apt-get update before installing each package. This is safe but can be slow; batching may be added later.

UbuntuAptManager

Ubuntu apt-get package manager backend.

This backend provides both package installation and system maintenance operations.

Source code in src/awesome_os/tasks/managers/ubuntu_apt.py 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
class UbuntuAptManager:
    """Ubuntu `apt-get` package manager backend.

    This backend provides both package installation and system maintenance
    operations.
    """

    name = "apt"

    def is_installed(self, package: str) -> bool:
        """Return whether the given package is already installed."""
        res = run(["dpkg", "-s", package], check=False)
        if res.returncode != 0:
            return False

        # `dpkg -s` can still exit 0 when a package is removed but config files remain
        # (e.g. `Status: deinstall ok config-files`). Only treat `install ok installed`
        # as installed.
        for line in res.stdout.splitlines():
            if not line.startswith("Status:"):
                continue
            status = line.removeprefix("Status:").strip().lower()
            return status == "install ok installed"

        # If we can't find the status line, be conservative and assume it's not installed.
        return False

    def install(self, package: str) -> InstallResult:
        """Install a package using `apt-get`."""
        if not sudo_non_interactive_ok():
            return InstallResult(
                ok=False,
                summary=f"Failed to install {package} (sudo password required)",
                details=sudo_required_details(),
            )
        logger.info(f"Installing {package} via {self.name}...")
        update_res = run(["sudo", "-n", "apt-get", "update"], check=False)
        install_res = run(["sudo", "-n", "apt-get", "install", "-y", package], check=False)
        if update_res.returncode == 0 and install_res.returncode == 0:
            return InstallResult(ok=True, summary=f"Installed {package}")

        details = (
            (update_res.stdout + "\n" + update_res.stderr).strip()
            + "\n"
            + (install_res.stdout + "\n" + install_res.stderr).strip()
        ).strip()
        return InstallResult(ok=False, summary=f"Failed to install {package}", details=details)

    def update(self) -> TaskResult:
        if not sudo_non_interactive_ok():
            return TaskResult(
                ok=False,
                summary="apt update: sudo password required",
                details=sudo_required_details(),
            )
        res = run(["sudo", "-n", "apt-get", "update"], check=False)
        if res.returncode == 0:
            return TaskResult(ok=True, summary="apt update: done")
        details = (res.stdout + "\n" + res.stderr).strip()
        return TaskResult(ok=False, summary="apt update: failed", details=details)

    def upgrade(self) -> TaskResult:
        if not sudo_non_interactive_ok():
            return TaskResult(
                ok=False,
                summary="apt upgrade: sudo password required",
                details=sudo_required_details(),
            )
        res = run(["sudo", "-n", "apt-get", "upgrade", "-y"], check=False)
        if res.returncode == 0:
            return TaskResult(ok=True, summary="apt upgrade: done")
        details = (res.stdout + "\n" + res.stderr).strip()
        return TaskResult(ok=False, summary="apt upgrade: failed", details=details)

    def cleanup(self) -> TaskResult:
        if not sudo_non_interactive_ok():
            return TaskResult(
                ok=False,
                summary="apt cleanup: sudo password required",
                details=sudo_required_details(),
            )
        res = run(["sudo", "-n", "apt-get", "autoremove", "-y"], check=False)
        if res.returncode == 0:
            return TaskResult(ok=True, summary="apt cleanup (autoremove): done")
        details = (res.stdout + "\n" + res.stderr).strip()
        return TaskResult(ok=False, summary="apt cleanup (autoremove): failed", details=details)

install(package)

Install a package using apt-get.

Source code in src/awesome_os/tasks/managers/ubuntu_apt.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def install(self, package: str) -> InstallResult:
    """Install a package using `apt-get`."""
    if not sudo_non_interactive_ok():
        return InstallResult(
            ok=False,
            summary=f"Failed to install {package} (sudo password required)",
            details=sudo_required_details(),
        )
    logger.info(f"Installing {package} via {self.name}...")
    update_res = run(["sudo", "-n", "apt-get", "update"], check=False)
    install_res = run(["sudo", "-n", "apt-get", "install", "-y", package], check=False)
    if update_res.returncode == 0 and install_res.returncode == 0:
        return InstallResult(ok=True, summary=f"Installed {package}")

    details = (
        (update_res.stdout + "\n" + update_res.stderr).strip()
        + "\n"
        + (install_res.stdout + "\n" + install_res.stderr).strip()
    ).strip()
    return InstallResult(ok=False, summary=f"Failed to install {package}", details=details)

is_installed(package)

Return whether the given package is already installed.

Source code in src/awesome_os/tasks/managers/ubuntu_apt.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def is_installed(self, package: str) -> bool:
    """Return whether the given package is already installed."""
    res = run(["dpkg", "-s", package], check=False)
    if res.returncode != 0:
        return False

    # `dpkg -s` can still exit 0 when a package is removed but config files remain
    # (e.g. `Status: deinstall ok config-files`). Only treat `install ok installed`
    # as installed.
    for line in res.stdout.splitlines():
        if not line.startswith("Status:"):
            continue
        status = line.removeprefix("Status:").strip().lower()
        return status == "install ok installed"

    # If we can't find the status line, be conservative and assume it's not installed.
    return False