Merge pull request #13 from getsentry/iw/docker-compos-error-handling

fix(cli): Adding basic error handling to docker-compose commands

Author: IanWoodard

src/commands/logs.py

@@ -8,6 +8,7 @@
 
 from constants import DEVSERVICES_DIR_NAME
 from constants import DOCKER_COMPOSE_FILE_NAME
+from exceptions import DockerComposeError
 from utils.docker_compose import run_docker_compose_command
 from utils.services import find_matching_service
 
@@ -38,8 +39,12 @@ def logs(args: Namespace) -> None:
     service_config_file_path = os.path.join(
         service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
     )
-    logs = run_docker_compose_command(
-        f"-f {service_config_file_path} logs {mode_dependencies}"
-    )
+    try:
+        logs = run_docker_compose_command(
+            f"-f {service_config_file_path} logs {mode_dependencies}"
+        )
+    except DockerComposeError as dce:
+        print(f"Failed to get logs for {service.name}: {dce.stderr}")
+        exit(1)
     sys.stdout.write(logs.stdout)
     sys.stdout.flush()

src/commands/start.py

@@ -7,6 +7,7 @@
 
 from constants import DEVSERVICES_DIR_NAME
 from constants import DOCKER_COMPOSE_FILE_NAME
+from exceptions import DockerComposeError
 from utils.docker_compose import run_docker_compose_command
 from utils.services import find_matching_service
 
@@ -34,6 +35,10 @@ def start(args: Namespace) -> None:
     service_config_file_path = os.path.join(
         service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
     )
-    run_docker_compose_command(
-        f"-f {service_config_file_path} up -d {mode_dependencies}"
-    )
+    try:
+        run_docker_compose_command(
+            f"-f {service_config_file_path} up -d {mode_dependencies}"
+        )
+    except DockerComposeError as dce:
+        print(f"Failed to start {service.name}: {dce.stderr}")
+        exit(1)

src/commands/status.py

@@ -9,6 +9,7 @@
 
 from constants import DEVSERVICES_DIR_NAME
 from constants import DOCKER_COMPOSE_FILE_NAME
+from exceptions import DockerComposeError
 from utils.docker_compose import run_docker_compose_command
 from utils.services import find_matching_service
 
@@ -74,9 +75,13 @@ def status(args: Namespace) -> None:
         service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
     )
     mode_dependencies = " ".join(modes[mode_to_view])
-    status_json = run_docker_compose_command(
-        f"-f {service_config_file_path} ps {mode_dependencies} --format json"
-    ).stdout
+    try:
+        status_json = run_docker_compose_command(
+            f"-f {service_config_file_path} ps {mode_dependencies} --format json"
+        ).stdout
+    except DockerComposeError as dce:
+        print(f"Failed to get status for {service.name}: {dce.stderr}")
+        exit(1)
     # If the service is not running, the status_json will be empty
     if not status_json:
         print(f"{service.name} is not running")

src/commands/stop.py

@@ -7,6 +7,7 @@
 
 from constants import DEVSERVICES_DIR_NAME
 from constants import DOCKER_COMPOSE_FILE_NAME
+from exceptions import DockerComposeError
 from utils.docker_compose import run_docker_compose_command
 from utils.services import find_matching_service
 
@@ -34,6 +35,10 @@ def stop(args: Namespace) -> None:
     service_config_file_path = os.path.join(
         service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
     )
-    run_docker_compose_command(
-        f"-f {service_config_file_path} down {mode_dependencies}"
-    )
+    try:
+        run_docker_compose_command(
+            f"-f {service_config_file_path} down {mode_dependencies}"
+        )
+    except DockerComposeError as dce:
+        print(f"Failed to stop {service.name}: {dce.stderr}")
+        exit(1)

src/exceptions.py

@@ -29,3 +29,13 @@ class ConfigParseError(ConfigError):
     """Raised when a configuration file cannot be parsed."""
 
     pass
+
+
+class DockerComposeError(Exception):
+    """Base class for Docker Compose related errors."""
+
+    def __init__(self, command: str, returncode: int, stdout: str, stderr: str):
+        self.command = command
+        self.returncode = returncode
+        self.stdout = stdout
+        self.stderr = stderr

src/utils/docker_compose.py

@@ -2,7 +2,17 @@
 
 import subprocess
 
+from exceptions import DockerComposeError
+
 
 def run_docker_compose_command(command: str) -> subprocess.CompletedProcess[str]:
     cmd = ["docker", "compose"] + command.split()
-    return subprocess.run(cmd, check=True, capture_output=True, text=True)
+    try:
+        return subprocess.run(cmd, check=True, capture_output=True, text=True)
+    except subprocess.CalledProcessError as e:
+        raise DockerComposeError(
+            command=command,
+            returncode=e.returncode,
+            stdout=e.stdout,
+            stderr=e.stderr,
+        )