[tooling] Add parity to app utilities

Author: woojiahao

exercise_utils/cli.py

@@ -1,8 +1,67 @@
 """General utility functions for running CLI commands."""
 
+import os
 import subprocess
+from dataclasses import dataclass
+from subprocess import CompletedProcess
 from sys import exit
-from typing import List, Optional
+from typing import Dict, List, Optional
+
+
+@dataclass
+class CommandResult:
+    result: CompletedProcess[str]
+
+    def is_success(self) -> bool:
+        return self.result.returncode == 0
+
+    @property
+    def stdout(self) -> str:
+        return self.result.stdout.strip()
+
+    @property
+    def returncode(self) -> int:
+        return self.result.returncode
+
+
+def run(
+    command: List[str],
+    verbose: bool,
+    env: Dict[str, str] = {},
+    exit_on_error: bool = False,
+) -> CommandResult:
+    """Runs the given command, logging the output if verbose is True."""
+    try:
+        result = subprocess.run(
+            command,
+            capture_output=True,
+            text=True,
+            env=dict(os.environ, **env),
+            encoding="utf-8",
+        )
+    except FileNotFoundError:
+        if exit_on_error:
+            exit(1)
+        error_msg = f"Command not found: {command[0]}"
+        result = CompletedProcess(command, returncode=127, stdout="", stderr=error_msg)
+    except PermissionError:
+        if exit_on_error:
+            exit(1)
+        error_msg = f"Permission denied: {command[0]}"
+        result = CompletedProcess(command, returncode=126, stdout="", stderr=error_msg)
+    except OSError as e:
+        if exit_on_error:
+            exit(1)
+        error_msg = f"OS error when running command {command}: {e}"
+        result = CompletedProcess(command, returncode=1, stdout="", stderr=error_msg)
+
+    if verbose:
+        if result.returncode == 0:
+            print("\t" + result.stdout)
+        else:
+            print("\t" + result.stderr)
+
+    return CommandResult(result=result)
 
 
 def run_command(command: List[str], verbose: bool) -> Optional[str]:

exercise_utils/git.py

@@ -78,3 +78,8 @@ def track_remote_branch(remote: str, branch: str, verbose: bool) -> None:
 def remove_remote(remote: str, verbose: bool) -> None:
     """Removes a given remote."""
     run_command(["git", "remote", "rm", remote], verbose)
+
+
+def add_remote(remote: str, remote_url: str, verbose: bool) -> None:
+    """Adds a remote with the given name and URL."""
+    run_command(["git", "remote", "add", remote, remote_url], verbose)

exercise_utils/github_cli.py

@@ -0,0 +1,63 @@
+"""Wrapper for Github CLI commands."""
+# TODO: The following should be built using the builder pattern
+
+from typing import Optional
+
+from exercise_utils.cli import run
+
+
+def fork_repo(repository_name: str, fork_name: str, verbose: bool) -> None:
+    """Creates a fork of a repository."""
+    run(
+        [
+            "gh",
+            "repo",
+            "fork",
+            repository_name,
+            "--default-branch-only",
+            "--fork-name",
+            fork_name,
+        ],
+        verbose,
+    )
+
+
+def clone_repo(repository_name: str, verbose: bool, name: Optional[str] = None) -> None:
+    """Creates a clone of a repository."""
+    if name is not None:
+        run(["gh", "repo", "clone", repository_name, name], verbose)
+    else:
+        run(["gh", "repo", "clone", repository_name], verbose)
+
+
+def delete_repo(repository_name: str, verbose: bool) -> None:
+    """Deletes a repository."""
+    run(["gh", "repo", "delete", repository_name, "--yes"], verbose)
+
+
+def create_repo(repository_name: str, verbose: bool) -> None:
+    """Creates a Github repository on the current user's account."""
+    run(["gh", "repo", "create", repository_name, "--public"], verbose)
+
+
+def get_github_username(verbose: bool) -> str:
+    """Returns the currently authenticated Github user's username."""
+    result = run(["gh", "api", "user", "-q", ".login"], verbose)
+
+    if result.is_success():
+        username = result.stdout.splitlines()[0]
+        return username
+    return ""
+
+
+def has_repo(repo_name: str, is_fork: bool, verbose: bool) -> bool:
+    """Returns if the given repository exists under the current user's repositories."""
+    command = ["gh", "repo", "view", repo_name]
+    if is_fork:
+        command.extend(["--json", "isFork", "--jq", ".isFork"])
+    result = run(
+        command,
+        verbose,
+        env={"GH_PAGER": "cat"},
+    )
+    return result.is_success() and result.stdout == "true"