blis-cloud-cli 0.1.1__py3-none-any.whl

blis_cli/extra/templates/Caddyfile.j2

@@ -0,0 +1,22 @@
+# Do not edit this file by hand!
+# This file is created and modified by the `blis` tool.
+
+http:// {
+    reverse_proxy http://app:80 {
+		header_up X-Forwarded-Proto http
+		header_up X-Forwarded-Scheme http
+    }
+}
+
+{% for domain in domains %}
+https://{{ domain }} {
+	reverse_proxy http://app:80 {
+		header_up X-Forwarded-Proto https
+		header_up X-Forwarded-Scheme https
+		header_up Origin https://{{ domain }}
+	}
+}
+{% endfor %}
+
+# Refer to the Caddy docs for more information:
+# https://caddyserver.com/docs/caddyfile

blis_cli/util/__init__.py

@@ -0,0 +1 @@
+# util module

blis_cli/util/bash.py

@@ -0,0 +1,25 @@
+import click
+import os
+import sys
+import subprocess
+
+
+def run(command: str, root=False):
+    cmd = ["bash", "-c", command]
+    if root:
+        cmd = ["sudo"] + cmd
+
+    if "BLIS_DEBUG" in os.environ and os.environ["BLIS_DEBUG"] == "true":
+        click.echo("+ " + " ".join(cmd))
+
+    proc = subprocess.run(cmd, capture_output=True)
+
+    if proc.returncode == 0:
+        return str(proc.stdout, "utf-8"), None
+    else:
+        return str(proc.stdout, "utf-8"), str(proc.stderr, "utf-8")
+
+
+def sudo(command: str):
+    use_sudo = os.geteuid() != 0
+    return run(command, root=use_sudo)

blis_cli/util/caddy.py

@@ -0,0 +1,63 @@
+import click
+from jinja2 import Environment, FileSystemLoader, select_autoescape
+import os
+import shutil
+import subprocess
+import re
+
+from blis_cli.util import config
+from blis_cli.util import docker_util
+
+
+jinja2 = Environment(
+    loader=FileSystemLoader(f"{os.path.dirname(__file__)}/../extra/templates/"),
+    autoescape=select_autoescape(),
+)
+
+CADDY_STANZA_START = re.compile("^https://(.+) {\s?$")
+
+
+def caddyfile():
+    return os.path.join(config.basedir(), "Caddyfile")
+
+
+def installed():
+    caddyfile_exists = os.path.exists(caddyfile())
+    caddy_stanza_present = config.compose_key("services.caddy")
+    return caddyfile_exists and (caddy_stanza_present is not None)
+
+
+def install():
+    config.add_volume("caddy_data")
+    config.add_volume("caddy_config")
+    config.add_section_from_template("services.caddy")
+    config.remove_key("services.app.ports")
+    config.set_key("services.app.depends_on", ["db", "caddy"])
+
+
+def set_domains(domains: list):
+    try:
+        template = jinja2.get_template("Caddyfile.j2")
+        rendered = template.render(domains=domains)
+
+        with open(os.path.join(config.basedir(), "Caddyfile"), "w") as f:
+            f.write(rendered)
+            return None
+    except Exception as e:
+        return e
+
+
+def get_domains():
+    domains = []
+    try:
+        with open(os.path.join(config.basedir(), "Caddyfile"), "r") as f:
+            for line in f:
+                res = CADDY_STANZA_START.match(line)
+                if res:
+                    domains.append(res.groups()[0])
+    except FileNotFoundError as e:
+        return []
+    except Exception as e:
+        click.secho("Error reading Caddyfile: " + e, fg="red")
+        return []
+    return domains

blis_cli/util/config.py

@@ -0,0 +1,159 @@
+import click
+import os
+import yaml
+from yaml import SafeDumper
+
+SafeDumper.add_representer(
+    type(None),
+    lambda dumper, value: dumper.represent_scalar("tag:yaml.org,2002:null", ""),
+)
+
+
+compose_file_disclaimer = """
+#####
+# This file is an example docker-compose file for deploying BLIS to a cloud provider
+# This file is used as a template, but will be rewritten by the BLIS tool as necessary.
+
+"""
+
+
+def basedir():
+    return os.path.expanduser("~/.blis")
+
+
+def make_basedir():
+    if not os.path.exists(basedir()):
+        os.makedirs(basedir())
+
+
+def compose_file():
+    return os.path.join(basedir(), "docker-compose.yml")
+
+
+def validate_compose():
+    if not os.path.exists(compose_file()):
+        return False
+
+    dcmp = _open_compose()
+    if dcmp is None:
+        return False
+
+    if "name" not in dcmp:
+        click.echo("Missing 'name' in docker-compose.yml", err=True)
+        return False
+
+    return True
+
+
+def _open_compose():
+    try:
+        with open(compose_file(), "r") as f:
+            return yaml.safe_load(f)
+    except FileNotFoundError:
+        return None
+    except yaml.YAMLError as e:
+        click.echo(e, err=True)
+        return None
+
+
+def _save_compose(contents):
+    try:
+        with open(compose_file(), "w") as f:
+            f.write(compose_file_disclaimer)
+            yaml.safe_dump(contents, f)
+    except Exception as e:
+        click.secho(e, err=True)
+        return False
+    return True
+
+
+def _load_template_yml():
+    try:
+        with open(f"{os.path.dirname(__file__)}/../extra/docker-compose.yml", "r") as f:
+            return yaml.safe_load(f)
+    except Exception as e:
+        click.secho(e, err=True)
+        return None
+
+
+def compose_key(key: str, contents=None):
+    if contents is None:
+        contents = _open_compose()
+        if contents is None:
+            return None
+
+    keys = key.split(".")
+    val = contents
+    for k in keys:
+        if k not in val:
+            return None
+        val = val[k]
+
+    return val
+
+
+def add_volume(volname, opts=None):
+    if compose_key(f"volumes.{volname}"):
+        return False, "already exists"
+
+    contents = _open_compose()
+    contents["volumes"][volname] = opts
+    _save_compose(contents)
+
+
+def add_section_from_template(keyname: str):
+    template_section = compose_key(keyname, _load_template_yml())
+    contents = _open_compose()
+
+    keys = keyname.split(".")
+    last = keys.pop()
+
+    val = contents
+    for k in keys:
+        if k not in val:
+            return False
+        val = val[k]
+
+    val[last] = template_section
+
+    _save_compose(contents)
+
+    return True
+
+
+def remove_key(keyname):
+    contents = _open_compose()
+
+    keys = keyname.split(".")
+    last = keys.pop()
+
+    val = contents
+    for k in keys:
+        if k not in val:
+            return False
+        val = val[k]
+
+    val.pop(last, None)
+
+    _save_compose(contents)
+
+    return True
+
+
+def set_key(keyname, value):
+    contents = _open_compose()
+
+    keys = keyname.split(".")
+    last = keys.pop()
+
+    val = contents
+    for k in keys:
+        if k not in val:
+            return False
+        val = val[k]
+
+    val[last] = value
+
+    _save_compose(contents)
+
+    return True

blis_cli/util/docker_util.py

@@ -0,0 +1,118 @@
+import click
+import docker
+import shutil
+import subprocess
+
+from blis_cli.util import bash
+from blis_cli.util import caddy
+from blis_cli.util import config
+
+
+def installed():
+    return shutil.which("docker") is not None
+
+
+def compose_v1_installed():
+    if not installed():
+        return False
+    return shutil.which("docker-compose") is not None
+
+
+def compose_v2_installed():
+    if not installed():
+        return False
+    res = subprocess.run(["docker", "compose"], capture_output=True)
+    return res.returncode == 0
+
+
+def compose():
+    if compose_v2_installed():
+        return "docker compose"
+    elif compose_v1_installed():
+        return "docker-compose"
+    else:
+        return None
+
+
+# Finds the _first_ container running the BLIS image.
+def blis_container(client=None):
+    try:
+        client = client or docker.from_env()
+        img_tag = config.compose_key("services.app.image")
+        for container in client.containers.list():
+            if img_tag in container.image.tags:
+                return container
+    except Exception as e:
+        return None
+    return None
+
+
+def blis_is_running():
+    return blis_container() is not None
+
+
+def stop_blis_with_confirm():
+    click.secho(
+        "BLIS must be stopped in order to continue.",
+        fg="yellow",
+    )
+    if not click.confirm("Continue stopping BLIS?"):
+        return False
+    click.echo("Stopping BLIS... ", nl=False)
+    blis_container().stop()
+    click.secho("Success!", fg="green")
+    return True
+
+
+# Starts BLIS containers
+# Starting only "app" will ensure that all of the containers will come up at once.
+# 'containers' can be specified to start containers in a certain order (if possible)
+def start_blis(*containers):
+    if not containers or len(containers) == 0:
+        containers = ["db", "app"]
+
+    for container in containers:
+        click.echo(f"Starting BLIS {container}... ", nl=False)
+        out, err = bash.run(
+            f"{compose()} -f {config.compose_file()} up -d --wait {container}"
+        )
+        if err:
+            click.secho("Failed", fg="red")
+            click.echo(err, err=True)
+            return 1
+        else:
+            click.secho("Success!", fg="green")
+
+    return 0
+
+
+def restart_caddy():
+    if not caddy.installed():
+        return
+
+    click.echo(f"Restarting Caddy... ", nl=False)
+
+    caddy_container = None
+
+    try:
+        client = docker.from_env()
+        img_tag = config.compose_key("services.caddy.image")
+        for container in client.containers.list():
+            if img_tag in container.image.tags:
+                caddy_container = container
+                break
+    except Exception as e:
+        click.secho("Failed", fg="red")
+        click.echo(e, err=True)
+        return 1
+
+    if caddy_container is not None:
+        out, err = bash.run(
+            f"{compose()} -f {config.compose_file()} restart caddy"
+        )
+        if err:
+            click.secho("Failed", fg="red")
+            click.echo(err, err=True)
+            return 1
+        else:
+            click.secho("Success!", fg="green")

blis_cli/util/environment.py

@@ -0,0 +1,35 @@
+import os
+import subprocess
+import pwd
+import grp
+
+
+def can_sudo():
+    result = subprocess.run(["sudo", "-n", "echo", "hello"], capture_output=True)
+    return result.returncode == 0 and result.stdout == b"hello\n"
+
+
+def distro():
+    result = subprocess.run(
+        ["grep", "DISTRIB_CODENAME", "/etc/lsb-release"], capture_output=True
+    )
+    if result.returncode == 0:
+        return result.stdout.decode("utf-8").strip().split("=")[1]
+
+
+def user():
+    return pwd.getpwuid(os.getuid())[0]
+
+
+def in_docker_grp():
+    try:
+        return user() in grp.getgrnam("docker")[3]
+    except KeyError:
+        return False
+
+
+SUPPORTED_DISTROS = set(["focal", "jammy"])
+
+
+def supported_distro():
+    return distro() in SUPPORTED_DISTROS

blis_cli/util/packages.py

@@ -0,0 +1,26 @@
+import click
+
+from blis_cli.util import bash
+
+
+def apt_update():
+    return bash.sudo("DEBIAN_FRONTEND=noninteractive apt-get update")
+
+
+def install(packages: list):
+    click.echo(f"Installing packages: {', '.join(packages)}")
+    return bash.sudo(
+        f"DEBIAN_FRONTEND=noninteractive apt-get install -y {' '.join(packages)}"
+    )
+
+
+def remove(packages: list):
+    click.echo(f"Removing packages: {', '.join(packages)}")
+    return bash.sudo(
+        f"DEBIAN_FRONTEND=noninteractive apt-get remove -y {' '.join(packages)}"
+    )
+
+
+def is_installed(package: str):
+    _, err = bash.run(f"dpkg -s {package}")
+    return err == None

blis_cloud_cli-0.1.1.dist-info/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,29 @@
+blis_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blis_cli/blis.py,sha256=WybYFyhMg_eYWSAw-bczZ_0ddFu1CTZD2jStzY41HT8,1530
+blis_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blis_cli/commands/docker.py,sha256=w5wM6iY7RCKTdzKRzcic7_PBT30PYdMbEPN2O8SWhio,4320
+blis_cli/commands/domain.py,sha256=fr9QxI_cUeOR09qSjToAt1WdnYHjKn5p709_qB5WvNY,4071
+blis_cli/commands/install.py,sha256=caj8L96VRwTLkRVb5EsXud6eWXVp7f0Eaa15_HLVF2k,2871
+blis_cli/commands/logs.py,sha256=ZGJNiPf82wm4hKnCt5CG30R7pr5Yy_jw4dsrEVeadA8,1942
+blis_cli/commands/start.py,sha256=6W-3xos-VFuafRKbJXg-oISDay93Qgj6bNfblqr-PcU,299
+blis_cli/commands/status.py,sha256=bOermMJRJaXyhSCrGwChWsqUI_2k4JvlZj0vNCISeRs,2655
+blis_cli/commands/stop.py,sha256=7eKBG2apw4bP1NHL6TBqkiwIx3jilF-PjuRkq7TsbAg,426
+blis_cli/commands/swap.py,sha256=2QtxQPDYKJmLlPJbBMmxRQ1_Ua5wyTuOIx65_j7s_5M,1250
+blis_cli/commands/update.py,sha256=OvgSzLEEMSUXzdQn0iuW8fMNvuWyfxeMrmhPDbqoDfo,961
+blis_cli/extra/docker-compose.yml,sha256=YU-hBL5HBOOy8M4MdD22p1ZWL9wReawl2YkOsXHKlLE,1269
+blis_cli/extra/dump-blis_12-202202091919.sql,sha256=Es151WVZK8Jh3In0cXx_4Y3JWD6lPcL34EtAAMOJvTE,77357
+blis_cli/extra/dump-blis_127-202202091919.sql,sha256=rv05pRDOkS4kA_k3ya-dW9yjy4MvjJ25d28jY316QeE,2828964
+blis_cli/extra/dump-blis_revamp-20220704.sql,sha256=Ca8aFLqfRfkUIHJfU16BHv5MPCrpFws2cP35-lkyPeM,45125
+blis_cli/extra/templates/Caddyfile.j2,sha256=_dP4GVlCzoPabSOw9P9Gs_EE1bSIsmDIRx8c1UigYC0,517
+blis_cli/util/__init__.py,sha256=gB924oIvkpDlCtZlR-ZKAbqWN8OXxjegQXH2L_big4Q,14
+blis_cli/util/bash.py,sha256=miqq5I5xzLCW7OWjR0Gzrw_IJr8EPmjpvDPAPcRooDw,587
+blis_cli/util/caddy.py,sha256=GTYInwwtyEjq3JJQDyiLWZHeJFQ8xdSp-Tk8djlO31I,1712
+blis_cli/util/config.py,sha256=miDndLRZTBgFCOO6t6p5FK2VT_uuRmOWC23uPevPDUU,3188
+blis_cli/util/docker_util.py,sha256=y-YUG0BmeQkjIKSr87pWW7idQXSNHmuJUUsloCUkzM8,3071
+blis_cli/util/environment.py,sha256=_m2YdpzWOd3IzH8hQGd_DvUrz0NDDQ4EESWnR63DPWg,735
+blis_cli/util/packages.py,sha256=WJhwaqzzHt4Wi34gkyQd7d1Xx0noqZIayL7h1xnBGD0,638
+blis_cloud_cli-0.1.1.dist-info/LICENSE,sha256=Fg3Y31_4Bsd-dXMUibTrCrtmfYitWVqeuJhEd13t50s,1072
+blis_cloud_cli-0.1.1.dist-info/METADATA,sha256=Lmm_fxSJFezTEGDl8nuFlqn1R7zUPah1TvcfJzTnHyM,1196
+blis_cloud_cli-0.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+blis_cloud_cli-0.1.1.dist-info/entry_points.txt,sha256=lleshol3IILCEcRfKrYsk7nnyRN14zHKHyn9VMAPAKA,43
+blis_cloud_cli-0.1.1.dist-info/RECORD,,

blis_cloud_cli-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

blis_cloud_cli-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+blis=blis_cli.blis:main
+