Python based ubuntu bootstrap

bootstrap.py

#!/usr/bin/env python3

from pathlib import Path
import subprocess
import os
import sys

print(
    """
   _   _   _   _   _   _   _   _   _  
  / \ / \ / \ / \ / \ / \ / \ / \ / \ 
 ( B | O | O | T | S | T | R | A | P )
  \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ \_/ 

"""
)

# color for the print statement
CRED = "\033[91m"
CEND = "\033[0m"

# Common system tools which can be installed without any additional steps or third party packages.
tools = {
    "common_tools": [
        "htop",
        "cowsay",
        "screenfetch",
        "figlet",
        "gparted",
        "stacer",
        "copyq",
        "git",
        "dconf-editor",
        "jq",
        "curl",
        "wget",
        "tree",
        "xclip",
        "gpg",
        "software-properties-common",
        "apt-transport-https",
    ],
    "terminal": ["vim", "fish", "nano", "kitty"],
    "browser": ["brave-browser"],
    "editor": ["zim", "sublime-text", "code"],
    "media": ["vlc", "gimp", "peek", "ksnip", "flameshot"],
    "backup": ["timeshift", "rsync", "grsync"],
    "torrent": ["qbittorrent"],
    "vm": [
        "qemu-kvm",
        "libvirt-daemon-system",
        "libvirt-clients",
        "bridge-utils",
        "virt-manager",
        "libvirt-dev",
        "vagrant",
    ],
    "python": ["python3-virtualenv", "python3-pip", "bpython"],
    "container": ["podman"],
    "fonts": ["fonts-hack", "fonts-firacode", "fonts-ubuntu-console"],
    "firewall": ["ufw", "gufw"],
}


def vagrant_libvirt_dep() -> None:
    
    """
    Function will install libvirt plugin for vagrant to work with KVM
    Without this plugin vagrant-libvirt plugin cannot be installed.

    RETURN: NONE
    ARGS: NONE
    """

    vagrant_libvirt = subprocess.run("vagrant plugin install vagrant-libvirt",shell=True,capture_output=True,text=True)
    if vagrant_libvirt.returncode == 0:
        print("   |_ Installed/Available Vagrant-libvirt plugin")
    else:
        print("   |_ Failed Installing Vagrant-libvirt plugin")


def enable_firewall() -> None:
    
    """
    UFW firewall to be enabled to its default policy. The policy will be set to incoming = deny, outgoing = allow

    RETURN: NONE
    ARGS: NONE
    """

    enable_ufw = ["sudo ufw enable","sudo ufw default allow outgoing","sudo ufw default deny incoming"]
    for action in enable_ufw:
        run_action = subprocess.run(action, shell=True, capture_output=True, text=True)
        if run_action.returncode != 0:
            print(f"   |_ Failed UFW -> Got RC != 0 when running {action}")

    print_ufw_status = subprocess.run(
        "sudo ufw status", shell=True, capture_output=True, text=True
    )
    print("    |_ UFW enabled and default rule is set to { incoming = deny }, { outgoing = allow }\n       |_ UFW", print_ufw_status.stdout)


def check_if_root() -> None:
    
    """
    All the packages required to be submitted as root. Either run
    directly as root or with sudo
    ARGS: NONE
    RETURNS: NONE
    """
    
    if os.getuid() != 0:
        print("++ [FAILED] - Submit the script with root/sudo privilage")
        sys.exit(1)
    else:
        print("++ Root user check passed...")


def update_package_index() -> None:
    
    """
    Runs the apt update command and update the package index
    ARGS: NONE
    RETURNS : NONE
    """

    print(f"\n{CRED}++ Updating package index...{CEND}")
    update_index = subprocess.run(
        "apt update", shell=True, capture_output=True, text=True
    )
    if update_index.returncode != 0:
        print("++ Something wrong when running apt update command.\n")
        print("ERROR ==> \n")
        print(update_index.stdout, update_index.stderr)
        print("ERROR <==")
        sys.exit(1)
    else:
        print("   |__ Package Index Updated.")


def pre_step() -> None:
    """
    Not all the packages are available in default repositories. For some packages apt repository to be added
    before installing the package. This function will install apt repo for different tools.

    RETURN: NONE
    ARGS: NONE
    """
    print(f"\n{CRED}++ Add Additional repos...{CEND}")
    repos = {
        "subl_repo": """
    wget -qO - https://download.sublimetext.com/sublimehq-pub.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/sublimehq-archive.gpg > /dev/null && echo "deb https://download.sublimetext.com/ apt/stable/" | sudo tee /etc/apt/sources.list.d/sublime-text.list
    """,
        "vscode_repo": """
    wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > packages.microsoft.gpg &&
    sudo install -D -o root -g root -m 644 packages.microsoft.gpg /etc/apt/keyrings/packages.microsoft.gpg &&
    sudo sh -c 'echo "deb [arch=amd64,arm64,armhf signed-by=/etc/apt/keyrings/packages.microsoft.gpg] https://packages.microsoft.com/repos/code stable main" > /etc/apt/sources.list.d/vscode.list' &&
    rm -f packages.microsoft.gpg
    """,
        "vbox_repo": """
    wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add - &&
    wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add - &&
    sudo apt install software-properties-common && 
    echo "deb [arch=amd64] https://download.virtualbox.org/virtualbox/debian jammy contrib" | sudo tee /etc/apt/sources.list.d/virtualbox.list
    """,
        "brave_repo": """
    sudo curl -fsSLo /usr/share/keyrings/brave-browser-archive-keyring.gpg https://brave-browser-apt-release.s3.brave.com/brave-browser-archive-keyring.gpg &&
    echo "deb [signed-by=/usr/share/keyrings/brave-browser-archive-keyring.gpg] https://brave-browser-apt-release.s3.brave.com/ stable main"|sudo tee /etc/apt/sources.list.d/brave-browser-release.list
    """,
        "vagrant_repo": """
    wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg
    echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com jammy main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
    """,
    }

    for k in repos.keys():
        repo_add = subprocess.run(repos[k], shell=True, capture_output=True, text=True)
        if repo_add.returncode == 0:
            print(f"   |__ Added {k}")
        else:
            print(f"   |__ Failed {k}")


def install_package() -> None:
    """
    Runs the apt insall <package name>
    RETURNS: NONE
    """

    for k, v in tools.items():
        print(f"\n{CRED}++ {k} Installation...{CEND}")
        for pkg in tools[k]:
            command = f"apt install -y {pkg}"
            install_pkg = subprocess.run(command, shell=True, capture_output=True, text=True)
            if install_pkg.returncode == 0:
                print(f"   |__ Installed/Available {pkg}")
            else:
                print(f"   |__ Failed Installing {pkg}")


if __name__ == "__main__":
    check_if_root()
    pre_step()
    update_package_index()
    install_package()
    print(f"\n{CRED}++ Other dependent packages{CEND}")
    vagrant_libvirt_dep()
    print(f"\n{CRED}++ System Settings{CEND}")
    enable_firewall()

Output image of the script