[update-checkout] add typing to git invocation exceptions

Author: charles-zablit

utils/update_checkout/update_checkout/git_command.py

@@ -1,7 +1,44 @@
+import os
 import shlex
 import subprocess
 import sys
-from typing import List, Any, Optional, Dict
+from typing import List, Any, Optional, Dict, Tuple
+
+
+class GitException(Exception):
+    """
+    Exception raised when a Git command execution fails.
+
+    Attributes
+    ----------
+    returncode : int
+        The return code from the failed Git command.
+    command : List[str]
+        The Git command that was executed.
+    repo_name : str
+        The name of the Git repository.
+    stderr : str
+        The output of the failed Git command.
+    """
+
+    def __init__(
+        self,
+        returncode: int,
+        command: List[str],
+        repo_name: str,
+        output: str,
+    ):
+        super().__init__()
+        self.returncode = returncode
+        self.command = command
+        self.repo_name = repo_name
+        self.stderr = output
+
+    def __str__(self):
+        return (
+            f"[{self.repo_name}] {Git._quote_command(self.command)} "
+            f"returned ({self.returncode}) with the following {self.stderr}."
+        )
 
 
 class Git:
@@ -15,9 +52,9 @@ def run(
         allow_non_zero_exit: bool = False,
         fatal: bool = False,
         **kwargs,
-    ):
+    ) -> Tuple[str, int, List[str]]:
         command = Git._build_command(args)
-
+        output = ""
         try:
             result = subprocess.run(
                 command,
@@ -38,20 +75,15 @@ def run(
             if fatal:
                 sys.exit(
                     f"command `{command}` terminated with a non-zero exit "
-                    f"status {str(e.returncode)}, aborting")
-            eout = Exception(
-                f"[{repo_path}] '{Git._quote_command(command)}' failed with '{output}'"
+                    f"status {str(e.returncode)}, aborting"
+                )
+            raise GitException(
+                e.returncode, command, os.path.dirname(repo_path), output
             )
-            eout.ret = e.returncode
-            eout.arguments = command
-            eout.repo_path = repo_path
-            eout.stderr = output
-            raise eout
         except OSError as e:
             if fatal:
                 sys.exit(
-                    f"could not execute '{Git._quote_command(command)}': "
-                    f"{e.strerror}"
+                    f"could not execute '{Git._quote_command(command)}': {e.strerror}"
                 )
         return (output.strip(), result.returncode, command)
 
@@ -73,7 +105,7 @@ def _echo_command(
         print(f"{prefix}+ {' '.join(command_str)}", file=sys.stderr)
         if output:
             for line in output.splitlines():
-                print(prefix+line)
+                print(prefix + line)
         sys.stdout.flush()
         sys.stderr.flush()
 
@@ -86,5 +118,5 @@ def _quote(arg: Any) -> str:
         return shlex.quote(str(arg))
 
     @staticmethod
-    def _quote_command(command: Any) -> str:
+    def _quote_command(command: List[Any]) -> str:
         return " ".join(Git._quote(arg) for arg in command)

utils/update_checkout/update_checkout/parallel_runner.py

@@ -6,6 +6,8 @@
 from concurrent.futures import ThreadPoolExecutor
 import shutil
 
+from swift.utils.update_checkout.update_checkout.git_command import GitException
+
 from .runner_arguments import RunnerArguments, AdditionalSwiftSourcesArguments
 
 
@@ -129,13 +131,8 @@ def _monitor(self):
         sys.stdout.flush()
 
     @staticmethod
-    def check_results(results, op) -> int:
-        """Function used to check the results of ParallelRunner.
-
-        NOTE: This function was originally located in the shell module of
-        swift_build_support and should eventually be replaced with a better
-        parallel implementation.
-        """
+    def check_results(results, operation: str) -> int:
+        """Check the results of ParallelRunner and print the failures."""
 
         fail_count = 0
         if results is None:
@@ -144,15 +141,13 @@ def check_results(results, op) -> int:
             if r is None:
                 continue
             if fail_count == 0:
-                print("======%s FAILURES======" % op)
+                print(f"======{operation} FAILURES======")
             fail_count += 1
             if isinstance(r, str):
                 print(r)
                 continue
-            if not hasattr(r, "repo_path"):
-                # TODO: create a proper Exception class with these attributes
+            if isinstance(r, GitException):
+                print(str(r))
                 continue
-            print("%s failed (ret=%d): %s" % (r.repo_path, r.ret, r))
-            if r.stderr:
-                print(r.stderr.decode())
+            print(r)
         return fail_count