Improve error reporting

Author: misaka

python/mavis/server/aws.py

@@ -1,7 +1,8 @@
-import os
 import json
 import subprocess
 
+from .helpers import run_command
+
 REGION = "eu-west-2"
 PRODUCTION_ENVS = {"production", "production-data-replication"}
 
@@ -138,11 +139,11 @@ def resolve_task(env, task_id=None, task_ip=None, service=None):
     )
 
 
-def run_command(
-    env, task_id, command, container=None, interactive=True, replace_process=False
+def run_remote_command(
+    env, task_id, remote_command, container=None, replace_process=False
 ):
     """Execute a command in an ECS task, returning the exit code."""
-    cmd = [
+    command = [
         "aws",
         "ecs",
         "execute-command",
@@ -153,15 +154,12 @@ def run_command(
         "--task",
         task_id,
         "--command",
-        command,
+        remote_command,
+        "--interactive",
     ]
     if container:
-        cmd += ["--container", container]
-    if interactive:
-        cmd.append("--interactive")
-    if replace_process:
-        os.execvp(cmd[0], cmd)
-    return subprocess.run(cmd).returncode
+        command += ["--container", container]
+    return run_command(command, replace_process=replace_process)
 
 
 # --- private helpers ---

python/mavis/server/get_file.py

@@ -1,10 +1,9 @@
 import os
 import secrets
-import subprocess
 import sys
 
 from . import aws
-from .helpers import confirm_production
+from .helpers import confirm_production, run_command
 
 
 def register(subparsers):
@@ -59,24 +58,23 @@ def run(args):
     local_dest = _local_destination(args.remote_path, args.local_path)
 
     try:
-        exit_code = aws.run_command(
+        upload_result = aws.run_remote_command(
             env,
             task_id,
             f"aws s3 cp {args.remote_path} {s3_uri} --region {aws.REGION}",
             container=container,
         )
-        if exit_code != 0:
+        if not upload_result:
             sys.exit("Error: Failed to copy file from container to S3")
 
-        download = subprocess.run(
+        download_result = run_command(
             ["aws", "s3", "cp", s3_uri, local_dest, "--region", aws.REGION]
         )
-        if download.returncode != 0:
-            sys.exit("Error: Failed to download file from S3")
+        if not download_result:
+            sys.exit("Error: Download from S3 failed with code")
     finally:
-        subprocess.run(
+        run_command(
             ["aws", "s3", "rm", s3_uri, "--region", aws.REGION],
-            capture_output=True,
         )
 
     print(f"File successfully downloaded to {local_dest}")

python/mavis/server/helpers.py

@@ -1,3 +1,8 @@
+import os
+import sys
+import subprocess
+
+
 def confirm_production(env):
     """Prompt for confirmation before operating on production."""
     if env != "production":
@@ -6,3 +11,16 @@ def confirm_production(env):
     answer = input("Type 'production' to continue: ").strip()
     if answer != "production":
         raise RuntimeError("Production confirmation failed")
+
+
+def run_command(cmd, replace_process=False):
+    """Run command and print an error if it fails."""
+    if replace_process:
+        os.execvp(cmd[0], cmd)
+    return_code = subprocess.run(cmd).returncode
+    if return_code != 0:
+        print(
+            f"Command failed with exit code '{return_code}':\n  {' '.join(cmd)}",
+            file=sys.stderr,
+        )
+    return return_code == 0

python/mavis/server/put_file.py

@@ -1,10 +1,9 @@
 import os
 import secrets
-import subprocess
 import sys
 
 from . import aws
-from .helpers import confirm_production
+from .helpers import confirm_production, run_command
 
 
 def register(subparsers):
@@ -61,25 +60,24 @@ def run(args):
     key = f"temp-{secrets.token_hex(8)}"
     s3_uri = f"s3://{bucket}/{key}"
 
-    upload = subprocess.run(
+    upload_result = run_command(
         ["aws", "s3", "cp", args.local_file, s3_uri, "--region", aws.REGION]
     )
-    if upload.returncode != 0:
-        sys.exit("Error: Failed to upload file to S3")
+    if not upload_result != 0:
+        sys.exit("Error: Upload to S3 failed with code")
 
     try:
-        exit_code = aws.run_command(
+        download_result = aws.run_remote_command(
             env,
             task_id,
             f"aws s3 cp {s3_uri} {remote_path} --region {aws.REGION}",
             container=container,
         )
     finally:
-        subprocess.run(
+        run_command(
             ["aws", "s3", "rm", s3_uri, "--region", aws.REGION],
-            capture_output=True,
         )
 
-    if exit_code != 0:
+    if not download_result:
         sys.exit("Error: Failed to copy file into container")
     print("File successfully uploaded to container")

python/mavis/server/shell.py

@@ -1,7 +1,7 @@
 import sys
 
 from . import aws
-from .helpers import confirm_production
+from .helpers import confirm_production, run_command
 
 
 def register(subparsers):
@@ -50,12 +50,10 @@ def run(args):
         f"Opening shell in task {task_id}"
         + (f" (service {args.service})" if args.service else "")
     )
-    exit_code = aws.run_command(
+    aws.run_remote_command(
         env,
         task_id,
         "/rails/bin/docker-entrypoint /bin/bash",
         container=container,
         replace_process=True,
     )
-
-    sys.exit(exit_code)