blis-cloud-cli 0.1.1__tar.gz

blis_cloud_cli-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mitchell Rysavy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

blis_cloud_cli-0.1.1/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.1
+Name: blis-cloud-cli
+Version: 0.1.1
+Summary: Command-line tool for the BLIS web-based lab information system.
+License: MIT
+Author: Mitchell Rysavy
+Author-email: mitchell.rysavy@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: Jinja2 (>=3.1.3,<3.2.0)
+Requires-Dist: PyYAML (>=6.0.1,<6.1.0)
+Requires-Dist: click (>=8.1.7,<8.2.0)
+Requires-Dist: colorama (>=0.4.4,<0.5.0)
+Requires-Dist: docker (>=6.1.3,<6.2.0)
+Requires-Dist: psutil (>=5.9.0,<5.10.0)
+Requires-Dist: requests (>=2.31.0,<2.32.0)
+Description-Content-Type: text/markdown
+
+# blis-cloud-cli
+
+A tool for managing cloud installations of [BLIS](http://blis.cc.gatech.edu/index.php).
+
+Documentation for the tool can be found on [the BLIS documentation website.](https://docs.c4gblis.org/)
+You can view the original proposal for this tool [here](docs/proposal.md).
+

blis_cloud_cli-0.1.1/README.md

@@ -0,0 +1,6 @@
+# blis-cloud-cli
+
+A tool for managing cloud installations of [BLIS](http://blis.cc.gatech.edu/index.php).
+
+Documentation for the tool can be found on [the BLIS documentation website.](https://docs.c4gblis.org/)
+You can view the original proposal for this tool [here](docs/proposal.md).

blis_cloud_cli-0.1.1/blis_cli/blis.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+
+import click
+import os
+import sys
+import psutil
+
+from blis_cli.util import config as blis_config
+from blis_cli.util import docker_util as blis_docker_util
+from blis_cli.util import environment as blis_env
+
+from blis_cli.util import bash
+from blis_cli.commands import docker as cmd_docker_grp
+from blis_cli.commands import install as cmd_install
+from blis_cli.commands import logs as cmd_logs_grp
+from blis_cli.commands import start as cmd_start
+from blis_cli.commands import status as cmd_status
+from blis_cli.commands import stop as cmd_stop
+from blis_cli.commands import update as cmd_update
+from blis_cli.commands import domain as cmd_domain_grp
+from blis_cli.commands import swap as cmd_swap_grp
+
+
+@click.command()
+def status():
+    exit(cmd_status.run())
+
+
+@click.command()
+def install():
+    exit(cmd_install.run())
+
+
+@click.command()
+def start():
+    exit(cmd_start.run())
+
+
+@click.command()
+def stop():
+    exit(cmd_stop.run())
+
+
+@click.command()
+def update():
+    exit(cmd_update.run())
+
+
+@click.group()
+def entry_point():
+    pass
+
+
+def main():
+    entry_point.add_command(install)
+    entry_point.add_command(start)
+    entry_point.add_command(status)
+    entry_point.add_command(stop)
+    entry_point.add_command(update)
+
+    entry_point.add_command(cmd_logs_grp.entrypoint, "logs")
+    entry_point.add_command(cmd_docker_grp.entrypoint, "docker")
+    entry_point.add_command(cmd_domain_grp.entrypoint, "domain")
+    entry_point.add_command(cmd_swap_grp.entrypoint, "swap")
+
+    entry_point()
+

blis_cloud_cli-0.1.1/blis_cli/commands/docker.py

@@ -0,0 +1,139 @@
+import click
+import docker as lib_docker
+import getpass
+import os
+import requests
+import shutil
+
+from blis_cli.util import bash
+from blis_cli.util import config
+from blis_cli.util import docker_util
+from blis_cli.util import environment as env
+from blis_cli.util import packages
+
+
+@click.group()
+def entrypoint():
+    pass
+
+
+@click.command
+def install():
+    # If Docker is installed, and we are in the docker group, we will not need root privileges.
+    if not (env.in_docker_grp() and docker_util.installed()):
+        if not (os.geteuid() == 0 or env.can_sudo()):
+            click.secho(
+                "Docker must be installed. You must run this script as root or have passwordless sudo privileges.",
+                fg="red",
+            )
+            exit(1)
+
+        install_docker()
+
+        # Returns a success code because we probably succeeded and installed Docker, but we need to log out and log back in.
+        exit(0)
+
+    # We might have Docker installed, but not be in the docker group.
+    if docker_util.installed() and not env.in_docker_grp():
+        click.secho(
+            "You have Docker installed, but you are not in the docker group.",
+            fg="yellow",
+        )
+        # Try to fix the problem...
+        if env.can_sudo():
+            bash.sudo(f"usermod -aG docker {getpass.getuser()}")
+            click.echo("Please log out and log back in, and run this command again.")
+            exit(0)
+        else:
+            click.secho(
+                "You must run this script as root or have passwordless sudo privileges.",
+                fg="red",
+            )
+        exit(1)
+
+    click.secho("Docker is installed!", fg="green")
+
+
+def install_docker():
+    click.echo("Setting up Docker... ")
+    packages.remove(["docker", "docker-engine", "docker.io", "containerd", "runc"])
+    packages.install(["ca-certificates", "curl", "gnupg", "lsb-release"])
+    bash.sudo("mkdir -p /etc/apt/keyrings")
+    bash.run(
+        "curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o - | sudo tee /etc/apt/keyrings/docker.gpg >/dev/null"
+    )
+    bash.run(
+        'echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null'
+    )
+    packages.apt_update()
+    packages.install(
+        [
+            "docker-ce",
+            "docker-ce-cli",
+            "containerd.io",
+            "docker-compose-plugin",
+            "docker-buildx-plugin",
+        ]
+    )
+    bash.sudo(f"usermod -aG docker {getpass.getuser()}")
+    bash.sudo("systemctl enable docker.service")
+    bash.sudo("systemctl start docker.service")
+    click.secho("Success!", fg="green")
+    click.echo("Please log out and log back in, and run this command again.")
+
+
+@click.command
+def purge():
+    if not env.can_sudo():
+        click.secho("You must have root privileges to run this.", fg="red")
+        exit(1)
+
+    packages.remove(["docker", "docker-engine", "docker.io", "containerd", "runc"])
+    packages.remove(
+        [
+            "docker-ce",
+            "docker-ce-cli",
+            "containerd.io",
+            "docker-compose-plugin",
+            "docker-buildx-plugin",
+        ]
+    )
+    packages.apt_update()
+
+
+@click.command
+def status():
+    docker_ok = True
+    click.echo("Docker is accessible? ", nl=False)
+    try:
+        client = lib_docker.from_env()
+        client.containers.list()
+        click.secho("Yes", fg="green")
+    except Exception as e:
+        docker_ok = False
+        click.secho("No", fg="red")
+
+    cmd = "blis docker install"
+    if not env.can_sudo():
+        cmd = "sudo " + cmd
+
+    if not docker_ok:
+        click.echo("Docker is not accessible. Please run:")
+        click.echo("  " + cmd)
+        return 0
+
+    click.echo("Docker Compose is installed? ", nl=False)
+    if docker_util.compose_v2_installed():
+        click.secho("v2", fg="green")
+    elif docker_util.compose_v1_installed():
+        click.secho("v1", fg="green")
+    else:
+        click.secho("No", fg="red")
+        click.echo("Docker Compose is not installed. Please run:")
+        click.echo("  " + cmd)
+        return 0
+
+
+entrypoint.add_command(install)
+entrypoint.add_command(purge)
+entrypoint.add_command(status)

blis_cloud_cli-0.1.1/blis_cli/commands/domain.py

@@ -0,0 +1,144 @@
+import click
+import psutil
+import socket
+
+from blis_cli.util import caddy
+from blis_cli.util import docker_util
+
+
+@click.group()
+def entrypoint():
+    pass
+
+
+@click.command()
+def status():
+    click.secho("Caddy is configured: ", nl=False)
+    if caddy.installed():
+        click.secho("Yes!", fg="green")
+    else:
+        click.secho("No", fg="red")
+        click.echo("\nThere are no domains configured. Please run:")
+        click.echo("  blis domain add [mydomain.example.com]")
+        exit(0)
+
+    domains = caddy.get_domains()
+    if len(domains) < 1:
+        click.echo("\nThere are no domains configured. Please run:")
+        click.echo("  blis domain add [mydomain.example.com]")
+        exit(0)
+
+    # These are only "possible" IPs because the computer
+    # might be behind a firewall/NAT and these will only contain
+    # the local IP addresses.
+    possible_ipv4_addrs = get_interfaces()
+
+    for domain in domains:
+        click.echo()
+        click.secho(domain, fg="green")
+        click.echo("IP Addresses: ", nl=False)
+        ip_addrs = get_ipv4_by_hostname(domain)
+        click.secho(", ".join(ip_addrs), fg="green")
+
+        for ip in ip_addrs:
+            if ip in possible_ipv4_addrs:
+                # This is the 'happiest' path since the computer/VM has an IP that is facing the Internet.
+                click.secho("Domain points to computer!")
+                break
+
+    exit(0)
+
+
+@click.command()
+@click.argument("name")
+def add(name: str):
+    current_domains = caddy.get_domains()
+    if name in current_domains:
+        click.echo(f"{name} is already configured as a domain.")
+        return 0
+
+    click.confirm(f"Do you want to add {name} as a domain?", abort=True)
+
+    restart_blis = False
+    if docker_util.blis_is_running():
+        if not docker_util.stop_blis_with_confirm():
+            return 1
+        restart_blis = True
+
+    if not caddy.installed():
+        click.echo("Installing Caddy... ", nl=False)
+        try:
+            caddy.install()
+            click.secho("Success!", fg="green")
+        except Exception as e:
+            click.secho(e, fg="red")
+            return 1
+
+    click.echo(f"Adding {name} to Caddyfile... ", nl=False)
+
+    current_domains.append(name)
+    caddy.set_domains(current_domains)
+
+    click.secho("Success!", fg="green")
+
+    if restart_blis:
+        docker_util.start_blis("app")
+        docker_util.restart_caddy()
+
+
+@click.command()
+def clear():
+    click.secho("This will remove all of the domains from the configuration.", fg="red")
+    click.confirm(f"Do you want to continue?", abort=True)
+
+    restart_blis = False
+    if docker_util.blis_is_running():
+        if not docker_util.stop_blis_with_confirm():
+            return 1
+        restart_blis = True
+
+    click.echo(f"Removing all domains from Caddyfile... ", nl=False)
+
+    caddy.set_domains([])
+
+    click.secho("Success!", fg="green")
+
+    if restart_blis:
+        docker_util.start_blis("app")
+        docker_util.restart_caddy()
+
+
+# Source:
+# https://stackoverflow.com/questions/2805231/how-can-i-do-dns-lookups-in-python-including-referring-to-etc-hosts/66000439#66000439
+# Licensed: CC BY-SA 4.0
+def get_ipv4_by_hostname(hostname):
+    # see `man getent` `/ hosts `
+    # see `man getaddrinfo`
+    try:
+        return list(
+            i[4][0]  # raw socket structure  # internet protocol info  # address
+            for i in socket.getaddrinfo(hostname, 0)  # port, required
+            if i[0] is socket.AddressFamily.AF_INET  # ipv4
+            # ignore duplicate addresses with other socket types
+            and i[1] is socket.SocketKind.SOCK_RAW
+        )
+    except Exception as e:
+        click.secho(str(e), fg="red", nl=False)
+        return []
+
+
+def get_interfaces():
+    addrs = psutil.net_if_addrs()
+    ip_addrs = []
+    for key in addrs:
+        addr = addrs[key]
+        for a in addr:
+            if a.family == socket.AddressFamily.AF_INET:
+                ip_addrs.append(a.address)
+
+    return ip_addrs
+
+
+entrypoint.add_command(add)
+entrypoint.add_command(clear)
+entrypoint.add_command(status)

blis_cloud_cli-0.1.1/blis_cli/commands/install.py

@@ -0,0 +1,92 @@
+import click
+import glob
+import os
+import docker as lib_docker
+import shutil
+
+from blis_cli.util import bash
+from blis_cli.util import caddy
+from blis_cli.util import config
+from blis_cli.util import docker_util as docker
+from blis_cli.util import environment as env
+from blis_cli.util import packages
+
+
+def run():
+    try:
+        version = lib_docker.from_env().version()
+        click.echo(f"Docker version: {click.style(version['Version'], fg='green')}")
+    except Exception as e:
+        click.secho("There was a problem accessing Docker.", fg="red")
+        click.echo("Please run `blis docker status` and follow the instructions.")
+        return 1
+
+    if os.path.exists(config.compose_file()):
+        if not click.confirm(
+            "BLIS has already been installed in ~/.blis. Do you want to overwrite the configuration?"
+        ):
+            return 0
+
+    config.make_basedir()
+    copy_docker_files()
+
+    if config.validate_compose():
+        click.echo("docker-compose.yml is valid.")
+    else:
+        click.secho("docker-compose.yml is not valid.", fg="red")
+        return 1
+
+    run_blis_and_setup_db()
+
+    click.secho("BLIS has been successfully installed!", fg="green")
+
+
+def copy_docker_files():
+    click.echo("Copying docker-compose.yml to ~/.blis/...")
+    shutil.copy(
+        f"{os.path.dirname(__file__)}/../extra/docker-compose.yml",
+        config.compose_file(),
+    )
+    click.echo("Creating ~/.blis/Caddyfile...")
+    caddy.set_domains([])
+
+
+def run_blis_and_setup_db():
+    click.echo("Starting BLIS database... ", nl=False)
+    out, err = bash.run(
+        f"{docker.compose()} -f {config.compose_file()} up -d --wait db"
+    )
+    if err:
+        click.secho("Failed", fg="red")
+        click.echo(err, err=True)
+        return False
+
+    click.secho("Success!", fg="green")
+
+    db_password = config.compose_key("services.db.environment.MYSQL_ROOT_PASSWORD")
+    seed_failed = False
+
+    for file in glob.glob(f"{os.path.dirname(__file__)}/../extra/*.sql"):
+        click.echo(f"Seeding {os.path.basename(file)}... ", nl=False)
+        out, err = bash.run(
+            f"{docker.compose()} -f {config.compose_file()} exec -T db mysql -hdb -uroot -p{db_password} < {file}"
+        )
+        if err:
+            click.secho("Failed", fg="red")
+            click.echo(err, err=True, nl=False)
+            seed_failed = True
+        else:
+            click.secho("Success!", fg="green")
+
+    if seed_failed:
+        click.secho("Seeding database failed.", fg="yellow")
+        click.echo("BLIS might still start. Please check the errors for details.")
+
+    click.echo("Starting BLIS... ", nl=False)
+    out, err = bash.run(f"{docker.compose()} -f {config.compose_file()} up -d app")
+    if err:
+        click.secho("Failed", fg="red")
+        click.echo(err, err=True)
+        return False
+
+    click.secho("Success!", fg="green")

blis_cloud_cli-0.1.1/blis_cli/commands/logs.py

@@ -0,0 +1,73 @@
+import click
+import docker
+import tarfile
+import tempfile
+
+from blis_cli.util import config
+from blis_cli.util import environment
+from blis_cli.util import docker_util
+
+
+@click.group
+def entrypoint():
+    pass
+
+
+def get_container_log_file(filename):
+    try:
+        c = docker_util.blis_container()
+
+        # This is technically not required. We could probably extract logs from
+        # a stopped BLIS since the /log folder is mounted as its own volume.
+        # However... I don't know how to reliably do that right now.
+        # And it would definitely need root.
+        if c == None:
+            click.secho("BLIS is not running.", fg="red")
+            click.echo("Please start BLIS to see logs.")
+            return 0
+
+        with tempfile.TemporaryFile() as f:
+            bits, stat = c.get_archive(filename)
+
+            for chunk in bits:
+                f.write(chunk)
+
+            f.seek(0)
+            tf = tarfile.open(fileobj=f)
+            m = tf.extractfile(tf.getnames()[0])
+            for chunk in m:
+                click.echo(chunk, nl=False)
+
+    except docker.errors.NotFound as e:
+        click.echo("The log file was not found.", err=True)
+        return 1
+    except Exception as e:
+        click.echo("There was a problem getting the logs for BLIS!", err=True)
+        click.echo(e)
+        return 1
+
+
+@click.command()
+def application():
+    exit(get_container_log_file("/var/www/blis/log/application.log"))
+
+
+@click.command()
+def database():
+    exit(get_container_log_file("/var/www/blis/log/database.log"))
+
+
+@click.command(name="apache2/access")
+def apache2_access():
+    exit(get_container_log_file("/var/log/apache2/access.log"))
+
+
+@click.command(name="apache2/error")
+def apache2_error():
+    exit(get_container_log_file("/var/log/apache2/error.log"))
+
+
+entrypoint.add_command(application)
+entrypoint.add_command(database)
+entrypoint.add_command(apache2_access)
+entrypoint.add_command(apache2_error)

blis_cloud_cli-0.1.1/blis_cli/commands/start.py

@@ -0,0 +1,13 @@
+import click
+import os
+
+from blis_cli.util import config
+from blis_cli.util import docker_util
+
+
+def run():
+    if not os.path.exists(config.compose_file()):
+        click.secho("Please run `blis install` and run this command again.", fg="red")
+        return 1
+
+    return docker_util.start_blis()

blis_cloud_cli-0.1.1/blis_cli/commands/status.py

@@ -0,0 +1,78 @@
+import click
+import psutil
+
+from blis_cli.util import caddy
+from blis_cli.util import config
+from blis_cli.util import environment as blis_env
+from blis_cli.util import docker_util as blis_docker_util
+
+
+def run():
+    try:
+        blis_installed = False
+        click.echo("BLIS is installed: ", nl=False)
+        if config.validate_compose():
+            blis_installed = True
+            click.secho("Yes!", fg="green")
+        else:
+            click.secho("No", fg="red")
+
+        click.echo("BLIS is running: ", nl=False)
+        if blis_docker_util.blis_is_running():
+            click.secho("Yes!", fg="green")
+        else:
+            click.secho("No", fg="red")
+
+        click.echo("Caddy is enabled: ", nl=False)
+        if caddy.installed():
+            click.secho("Yes!", fg="green")
+        else:
+            click.secho("No", fg="red")
+            if blis_installed:
+                click.secho("Custom domain support is disabled. Please run `blis domain add` to setup.", fg="red")
+
+        total_ram = psutil.virtual_memory().total / (1024.0**3)
+        swap_space = psutil.swap_memory().total / (1024.0**3)
+        click.echo("Total RAM: ", nl=False)
+        click.secho(f"{total_ram:.2f} GiB", fg="green", nl=False)
+        if swap_space > 0:
+            click.secho(f" (swap: {swap_space:.2f} GiB)", fg="green")
+        else:
+            click.echo()
+
+        if total_ram < 0.9:
+            click.secho(
+                "1GB of RAM is recommended to run BLIS. Things might not work as expected!",
+                fg="red",
+            )
+
+        click.echo("Supported Ubuntu distribution: ", nl=False)
+        if blis_env.supported_distro():
+            click.secho("Yes!", fg="green")
+        else:
+            click.secho("No", fg="red")
+            click.echo("BLIS is supported on these Ubuntu distributions: ", nl=False)
+            click.secho(", ".join(blis_env.SUPPORTED_DISTROS), fg="green")
+            click.echo("You have: ", nl=False)
+            click.secho(blis_env.distro(), fg="green")
+
+        click.echo("Passwordless sudo: ", nl=False)
+        if blis_env.can_sudo():
+            click.secho("Yes!", fg="green")
+        else:
+            click.secho("No", fg="red")
+
+        if (
+            blis_docker_util.blis_container() == None
+            and not blis_docker_util.installed()
+        ):
+            click.secho(
+                "Please run `blis docker status` to check the status of Docker on your machine.",
+                fg="yellow",
+            )
+
+        return 0
+    except Exception as e:
+        click.echo("There was a problem getting the status of BLIS!")
+        click.echo(e)
+        return 1

blis_cloud_cli-0.1.1/blis_cli/commands/stop.py

@@ -0,0 +1,18 @@
+import click
+
+from blis_cli.util import bash
+from blis_cli.util import config
+from blis_cli.util import docker_util as docker
+
+
+def run():
+    click.echo("Stopping BLIS... ", nl=False)
+    out, err = bash.run(f"{docker.compose()} -f {config.compose_file()} down")
+    if err:
+        click.secho("Failed", fg="red")
+        click.echo(err, err=True)
+        return False
+
+    click.secho("Success!", fg="green")
+
+    return 0