Added Docker functionality and the Manager

Author: Dtar380

src/cli/builder.py

@@ -11,6 +11,7 @@
 from yaspin import yaspin  # type: ignore
 
 from ..core.copy_files import copy_files  # type: ignore
+from ..core.docker import ComposeManager
 from ..core.manage_json import read_json, write_json
 from ..core.manage_templates import template_to_file
 from ..utils.cli import clear, confirm
@@ -102,8 +103,9 @@ def callback(
             path: Path = self.cwd.joinpath("data.json")
 
             if not path.exists():
-                print("Missing JSON file for services. Use 'create' first.")
-                return
+                exit(
+                    "ERROR: Missing JSON file for services. Use 'create' first."
+                )
 
             data: dicts = read_json(path) or {}
             compose: dicts = data.get("compose", {}) or {}
@@ -113,8 +115,7 @@ def callback(
             envs: list[dicts] = data.get("envs", []) or []
 
             if not services:
-                print("No services found. Use 'create' first.")
-                return
+                exit("ERROR: No services found. Use 'create' first.")
 
             def find_index_by_name(name: str) -> int | None:
                 for i, s in enumerate(services):
@@ -127,16 +128,15 @@ def find_index_by_name(name: str) -> int | None:
                 if not target:
                     names = [s.get("name") for s in services if s.get("name")]
                     if not names:
-                        print("No services found.")
-                        return
+                        exit("ERROR: No services found.")
+
                     target = inquirer.select(  # type: ignore
                         message="Select a service to remove: ", choices=names
                     ).execute()
 
-                idx = find_index_by_name(target)
+                idx = find_index_by_name(target)  # type: ignore
                 if idx is None:
-                    print(f"Service '{target}' not found.")
-                    return
+                    exit(f"ERROR: Service '{target}' not found.")
 
                 if confirm(msg=f"Remove service '{target}'"):
                     services.pop(idx)
@@ -158,8 +158,8 @@ def find_index_by_name(name: str) -> int | None:
                     if not confirm(
                         msg=f"Service '{name}' already exists. Overwrite? "
                     ):
-                        print("Add cancelled.")
-                        return
+                        exit("ERROR: Add cancelled.")
+
                     services = [s for s in services if s.get("name") != name]
                     envs = [e for e in envs if e.get("CONTAINER_NAME") != name]
 
@@ -202,21 +202,20 @@ def build(self) -> Command:
         help = "Build the files for the containerization."
         options: list[Option] = []
 
-        def callback(
-            service: str | None = None, add: bool = False, remove: bool = False
-        ) -> None:
+        def callback() -> None:
             clear(0)
 
             path: Path = self.cwd.joinpath("data.json")
 
             if not path.exists():
-                print("Missing JSON file for services. Use 'create' first.")
-                return
+                exit(
+                    "ERROR: Missing JSON file for services. Use 'create' first."
+                )
 
             data: dicts = read_json(path) or {}
 
             if not data:
-                print("JSON file is empty. Use 'create' first.")
+                exit("ERROR: JSON file is empty. Use 'create' first.")
 
             clear(0)
             self.__save_files(data, build=True)

src/cli/manager.py

@@ -6,6 +6,7 @@
 from InquirerPy.validator import EmptyInputValidator  # type: ignore
 from click import Command, Option
 
+from ..core.docker import ComposeManager
 from ..utils.cli import clear, confirm  # type: ignore
 from .custom_group import CustomGroup
 
@@ -14,14 +15,15 @@ class Manager(CustomGroup):
 
     def __init__(self) -> None:
         super().__init__()
+        self.compose_manager = ComposeManager()
 
     def backup(self) -> Command:
 
         help = "Create a backup of the files inside the containers to their respective build directories."
         options = [Option()]
 
         def callback() -> None:
-            pass
+            self.compose_manager.back_up(self.cwd)
 
         return Command(
             name=inspect.currentframe().f_code.co_name,  # type: ignore
@@ -30,13 +32,27 @@ def callback() -> None:
             params=options,  # type: ignore
         )
 
-    def delete(self) -> Command:
+    def up(self) -> Command:
+        help = "Start up the container (first time start)."
+        options = [Option(["--detached"], is_flag=True, default=False)]
 
-        help = "Delete entirely the files related with the containerization of the server/network."
-        options = [Option()]
+        def callback(detached: bool = False) -> None:
+            self.compose_manager.up(detached)
 
-        def callback() -> None:
-            pass
+        return Command(
+            name=inspect.currentframe().f_code.co_name,  # type: ignore
+            help=help,
+            callback=callback,
+            params=options,  # type: ignore
+        )
+
+    def down(self) -> Command:
+
+        help = "Delete the container."
+        options = [Option(["--rm-volumes"], is_flag=True, default=True)]
+
+        def callback(rm_volumes: bool = True) -> None:
+            self.compose_manager.down(rm_volumes)
 
         return Command(
             name=inspect.currentframe().f_code.co_name,  # type: ignore
@@ -51,7 +67,7 @@ def start(self) -> Command:
         options = [Option()]
 
         def callback() -> None:
-            pass
+            self.compose_manager.start()
 
         return Command(
             name=inspect.currentframe().f_code.co_name,  # type: ignore
@@ -66,7 +82,7 @@ def stop(self) -> Command:
         options = [Option()]
 
         def callback() -> None:
-            pass
+            self.compose_manager.stop()
 
         return Command(
             name=inspect.currentframe().f_code.co_name,  # type: ignore

src/core/copy_files.py

@@ -6,7 +6,7 @@
 from importlib_resources import files  # type: ignore
 
 
-def copy_files(path: Path, services: list[str] | Iterable[str]) -> None:
+def copy_files(path: Path, services: list[str]) -> None:
     # Resolve resource traversables
     docker_pkg = files("minecraft-docker-cli.assets.docker")
     dockerfile_res = docker_pkg.joinpath("Dockerfile")

src/core/docker.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+from pathlib import Path
+from subprocess import CompletedProcess, run
+from time import strftime
+from typing import Any
+
+from yaspin import yaspin
+
+from .manage_json import read_json
+
+
+class ComposeManager:
+
+    def __init__(self) -> None:
+        self.composer_file = Path.cwd().joinpath("docker-compose.yml")
+        if not self.composer_file.exists():
+            exit(
+                "ERROR: docker-compose.yml was not located in current directory."
+            )
+
+    def __run(
+        self, *args: str, capture_output: bool = False
+    ) -> CompletedProcess[str]:
+        command = ["docker", "compose", "-f", str(self.composer_file), *args]
+        result = run(command, text=True, capture_output=capture_output)
+        if result.returncode != 0:
+            print("ERROR:\n", result.stderr)
+        else:
+            print("Command run:\n", result.stdout)
+        return result
+
+    @yaspin("Building Container...")
+    def build(
+        self, no_cache: bool = False, pull: bool = False
+    ) -> CompletedProcess[str]:
+        args = ["build"]
+        if no_cache:
+            args.append("--no-cache")
+        if pull:
+            args.append("--pull")
+        return self.__run(*args)
+
+    @yaspin("Stopping Services...")
+    def stop(self) -> CompletedProcess[str]:
+        return self.__run("stop")
+
+    @yaspin("Starting Services...")
+    def start(self) -> CompletedProcess[str]:
+        return self.__run("start")
+
+    @yaspin("Removing Container...")
+    def down(self, remove_volumes: bool = False) -> CompletedProcess[str]:
+        args = ["down"]
+        if remove_volumes:
+            args.append("-v")
+        return self.__run(*args)
+
+    @yaspin("Putting Up Container...")
+    def up(self, detached: bool = True) -> CompletedProcess[str]:
+        args = ["up"]
+        if detached:
+            args.append("-d")
+        return self.__run(*args)
+
+    @yaspin("Backing Up Container...")
+    def back_up(self, cwd: Path = Path.cwd()) -> None:
+        backup_path = cwd.joinpath(".backup")
+        compose_json = cwd.joinpath("data.json")
+
+        backup_path.mkdir(exist_ok=True)
+        data: dict[str, Any] = read_json(compose_json)
+        services = data.get("composer", {}).get("services", []) or []
+        names: list[str] = [svc.get("name") for svc in services if svc.get("name") is not None]  # type: ignore
+        for svc_name in names:
+            container_path = svc_name
+            tar_file = backup_path.joinpath(
+                f"{svc_name}_{strftime("%d-%m-%Y_%H:%M:%S")}.tar.gz"
+            )
+            container_name = self.__get_container_name(svc_name)
+            if container_name:
+                run(
+                    [
+                        "docker",
+                        "compose",
+                        "cp",
+                        f"{container_name}:{container_path}",
+                        tar_file,
+                    ],
+                    check=True,
+                )
+
+    def __get_container_name(self, service_name: str) -> str | None:
+        result = self.__run("ps", capture_output=True)
+        lines = result.stdout.splitlines()
+        for line in lines[2:]:  # skip header
+            if service_name in line:
+                return line.split()[0]
+        return None