Add an uninstall command (#19)

This command removes the install and data directories, deletes the "brainframe" group, and removes all BrainFrame Docker images from the machine. It's effectively meant as the opposite of the "install" command. However, the command does not remove Docker or Docker Compose even if the CLI was originally used to install them. It also does not uninstall the BrainFrame CLI itself.

Author: velovix

.circleci/config.yml

@@ -118,7 +118,10 @@ jobs:
       - run: sudo brainframe compose up -d
       - assert-core-container-running
       - assert-core-responds-to-http
-      - run: sudo brainframe compose down
+      - run: sudo brainframe uninstall --noninteractive
+      - assert-uninstalled-data-preserved:
+          install_path: /usr/share/brainframe
+          data_path: /var/lib/brainframe
 
   upload-to-pypi:
     docker:
@@ -143,7 +146,10 @@ jobs:
       - run: sudo $(which poetry) run brainframe compose up -d
       - assert-core-container-running
       - assert-core-responds-to-http
-      - run: sudo $(which poetry) run brainframe compose down
+      - run: sudo $(which poetry) run brainframe uninstall --noninteractive
+      - assert-uninstalled-data-preserved:
+          install_path: /usr/local/share/brainframe
+          data_path: /var/local/brainframe
 
   build-binary:
     docker:
@@ -188,7 +194,10 @@ jobs:
       - run: sudo brainframe compose up -d
       - assert-core-container-running
       - assert-core-responds-to-http
-      - run: sudo brainframe compose down
+      - run: sudo brainframe uninstall --noninteractive
+      - assert-uninstalled-data-preserved:
+          install_path: /usr/local/share/brainframe
+          data_path: /var/local/brainframe
 
 commands:
   install-poetry:
@@ -218,3 +227,17 @@ commands:
             done;
             echo "BrainFrame core service is up."
           no_output_timeout: 1m
+  assert-uninstalled-data-preserved:
+    parameters:
+      install_path:
+        type: string
+      data_path:
+        type: string
+    steps:
+      - run:
+          name: Check BrainFrame is uninstalled, but data is preserved
+          command: |
+            stat << parameters.data_path >>
+            ! stat << parameters.install_path >>
+            # Check that the images have been removed
+            ! docker image ls | grep aotuai/brainframe_core

brainframe/cli/commands/__init__.py

@@ -3,5 +3,6 @@
 from .info import info
 from .install import install
 from .self_update import self_update
+from .uninstall import uninstall
 from .update import update
 from .utils import by_name

brainframe/cli/commands/backup.py

@@ -12,23 +12,19 @@
     print_utils,
 )
 
-from .utils import command, subcommand_parse_args
+from .utils import command, requires_root, subcommand_parse_args
 
 BACKUP_DIR_FORMAT = "%Y-%m-%d_%H-%M-%S"
 
 
 @command("backup")
+@requires_root  # Some BrainFrame services write files as root
 def backup():
     install_path = config.install_path.value
     data_path = config.data_path.value
 
     args = _parse_args(data_path)
 
-    # This command has to be run as root for now because some BrainFrame
-    # services write files as the root user.
-    if not os_utils.is_root():
-        print_utils.fail_translate("general.user-not-root")
-
     docker_compose.assert_installed(install_path)
 
     dependencies.rsync.ensure(args.noninteractive, args.install_rsync)

brainframe/cli/commands/install.py

@@ -12,16 +12,14 @@
     print_utils,
 )
 
-from .utils import command, subcommand_parse_args
+from .utils import command, requires_root, subcommand_parse_args
 
 
 @command("install")
+@requires_root
 def install():
     args = _parse_args()
 
-    if not os_utils.is_root():
-        print_utils.fail_translate("general.user-not-root")
-
     # Print some introductory text
     if not args.noninteractive:
         print_utils.art()

brainframe/cli/commands/uninstall.py

@@ -0,0 +1,70 @@
+import shutil
+from argparse import ArgumentParser
+
+import i18n
+from brainframe.cli import config, docker_compose, os_utils, print_utils
+
+from .utils import command, requires_root, subcommand_parse_args
+
+
+@command("uninstall")
+@requires_root
+def uninstall():
+    install_path = config.install_path.value
+    data_path = config.data_path.value
+
+    args = _parse_args()
+
+    docker_compose.assert_installed(install_path)
+
+    if args.noninteractive:
+        delete_data = args.delete_data
+    else:
+        delete_data = print_utils.ask_yes_no("uninstall.ask-delete-data")
+
+    if not args.noninteractive:
+        directories_to_delete = [str(install_path)]
+        if delete_data:
+            print_utils.warning_translate("uninstall.warning-with-delete-data")
+            directories_to_delete.append(str(data_path))
+        else:
+            print_utils.warning_translate("uninstall.warning")
+
+        print_utils.warning_translate(
+            "uninstall.directories-deleted", directories=directories_to_delete,
+        )
+        confirmed = print_utils.ask_yes_no("uninstall.ask-confirm")
+        if not confirmed:
+            print_utils.fail_translate("uninstall.abort")
+
+    print_utils.translate("uninstall.deleting-images")
+    docker_compose.run(install_path, ["down", "--rmi", "all"])
+    print_utils.translate("uninstall.deleting-install-path")
+    shutil.rmtree(install_path)
+    if delete_data:
+        print_utils.translate("uninstall.deleting-data-path")
+        shutil.rmtree(data_path)
+
+    print()
+    print_utils.translate("uninstall.complete", color=print_utils.Color.GREEN)
+
+
+def _parse_args():
+    parser = ArgumentParser(
+        description=i18n.t("uninstall.description"),
+        usage=i18n.t("uninstall.usage"),
+    )
+
+    parser.add_argument(
+        "--noninteractive",
+        action="store_true",
+        help=i18n.t("general.noninteractive-help"),
+    )
+
+    parser.add_argument(
+        "--delete-data",
+        action="store_true",
+        help=i18n.t("uninstall.delete-data-help"),
+    )
+
+    return subcommand_parse_args(parser)

brainframe/cli/commands/utils.py

@@ -1,5 +1,9 @@
+import functools
 import sys
 from argparse import ArgumentParser
+from typing import Any, Callable
+
+from brainframe.cli import os_utils, print_utils
 
 by_name = {}
 """A dict that maps command names to their corresponding function"""
@@ -23,3 +27,16 @@ def subcommand_parse_args(parser: ArgumentParser):
         args.noninteractive = True
 
     return args
+
+
+def requires_root(function: Callable) -> Callable:
+    """A decorator that checks if the user is root before running a function"""
+
+    @functools.wraps(function)
+    def wrapper(*args, **kwargs) -> Any:
+        if not os_utils.is_root():
+            print_utils.fail_translate("general.user-not-root")
+
+        return function(*args, **kwargs)
+
+    return wrapper

brainframe/cli/os_utils.py

@@ -28,9 +28,9 @@ def create_group(group_name: str, group_id: int):
     # Create the group
     result = run(["groupadd", group_name, "--gid", str(group_id)])
     if result.returncode != 0:
-        message = i18n.t("install.create-group-failure")
-        message = message.format(error=str(result.stderr))
-        print_utils.fail(message)
+        print_utils.fail_translate(
+            "install.create-group-failure", error=str(result.stderr)
+        )
 
 
 def added_to_group(group_name):

brainframe/cli/translations/install.en.yml

@@ -72,3 +72,4 @@ en:
   group? Doing so will allow the BrainFrame CLI to interact with Docker without
   root permissions."
   install-version: "BrainFrame:%{version} will be installed."
+  create-group-failure: "Failed to create the \"brainframe\" group: %{error}"

brainframe/cli/translations/portal.en.yml

@@ -10,6 +10,7 @@ en:
       update       Updates the BrainFrame server to a new version
       info         Provides information about the BrainFrame server
       compose      Runs all following commands and flags through docker-compose
+      uninstall    Uninstalls the BrainFrame server
 
     Examples:
       brainframe install            Installs BrainFrame interactively

brainframe/cli/translations/uninstall.en.yml

@@ -0,0 +1,23 @@
+en:
+  description: "Uninstalls the BrainFrame server. This command does not
+  uninstall the BrainFrame CLI itself."
+  usage: "brainframe uninstall [<args>]"
+  delete-data-help: "If provided, data created by the BrainFrame server will be
+  deleted as well"
+
+  ask-delete-data: "Would you like to delete all data created by the BrainFrame
+  server as well?"
+  warning: "WARNING: This command will uninstall the BrainFrame server
+  and delete the server's Docker images!"
+  warning-with-delete-data: "WARNING: This command will uninstall the
+  BrainFrame server, permanently delete all data the server has produced
+  including backups, and delete the server's Docker images! This data cannot
+  be recovered."
+  directories-deleted: "The following directories will be deleted:
+  %{directories}"
+  ask-confirm: "Would you like to continue?"
+  abort: "Uninstallation has been cancelled. No data has been lost."
+  deleting-images: "Bringing down the BrainFrame server and deleting images..."
+  deleting-install-path: "Deleting the install path..."
+  deleting-data-path: "Deleting the data path..."
+  complete: "The BrainFrame server has been uninstalled."