refactor(init): describe as @click.command

Author: thekaveman

compiler_admin/commands/init.py

@@ -1,10 +1,10 @@
-from argparse import Namespace
 import os
 from pathlib import Path
 from shutil import rmtree
 import subprocess
 
-from compiler_admin import RESULT_FAILURE, RESULT_SUCCESS
+import click
+
 from compiler_admin.services.google import USER_ARCHIVE, CallGAMCommand
 
 
@@ -22,48 +22,37 @@ def _clean_config_dir(config_dir: Path) -> None:
             rmtree(path)
 
 
-def init(args: Namespace, *extras) -> int:
-    """Initialize a new GAM project.
-
-    See https://github.com/taers232c/GAMADV-XTD3/wiki/How-to-Install-Advanced-GAM
-
-    Args:
-        username (str): The Compiler admin with which to initialize a new project.
-
-        gam (bool): If True, initialize a new GAM project.
+@click.command()
+@click.option("--gam", "init_gam", is_flag=True)
+@click.option("--gyb", "init_gyb", is_flag=True)
+@click.argument("username")
+def init(username: str, init_gam: bool = False, init_gyb: bool = False):
+    """Initialize a new GAM and/or GYB project.
 
-        gyb (bool): If True, initialize a new GYB project.
+    See:
 
-    Returns:
-        A value indicating if the operation succeeded or failed.
+    - https://github.com/taers232c/GAMADV-XTD3/wiki/How-to-Install-Advanced-GAM
+    - https://github.com/GAM-team/got-your-back/wiki
     """
-    if not hasattr(args, "username"):
-        raise ValueError("username is required")
-
-    admin_user = args.username
-    res = RESULT_SUCCESS
-
-    if getattr(args, "gam", False):
+    if init_gam:
         _clean_config_dir(GAM_CONFIG_PATH)
         # GAM is already installed via pyproject.toml
-        res += CallGAMCommand(("config", "drive_dir", str(GAM_CONFIG_PATH), "verify"))
-        res += CallGAMCommand(("create", "project"))
-        res += CallGAMCommand(("oauth", "create"))
-        res += CallGAMCommand(("user", admin_user, "check", "serviceaccount"))
+        CallGAMCommand(("config", "drive_dir", str(GAM_CONFIG_PATH), "verify"))
+        CallGAMCommand(("create", "project"))
+        CallGAMCommand(("oauth", "create"))
+        CallGAMCommand(("user", username, "check", "serviceaccount"))
 
-    if getattr(args, "gyb", False):
+    if init_gyb:
         _clean_config_dir(GYB_CONFIG_PATH)
         # download GYB installer to config directory
         gyb = GYB_CONFIG_PATH / "gyb-install.sh"
         with gyb.open("w+") as dest:
-            res += subprocess.call(("curl", "-s", "-S", "-L", "https://gyb-shortn.jaylee.us/gyb-install"), stdout=dest)
+            subprocess.call(("curl", "-s", "-S", "-L", "https://gyb-shortn.jaylee.us/gyb-install"), stdout=dest)
 
-        res += subprocess.call(("chmod", "+x", str(gyb.absolute())))
+        subprocess.call(("chmod", "+x", str(gyb.absolute())))
 
         # install, giving values to some options
         # https://github.com/GAM-team/got-your-back/blob/main/install-gyb.sh
         #
         # use GYB_CONFIG_PATH.parent for the install directory option, otherwise we get a .config/gyb/gyb directory structure
-        res += subprocess.call((gyb, "-u", admin_user, "-r", USER_ARCHIVE, "-d", str(GYB_CONFIG_PATH.parent)))
-
-    return RESULT_SUCCESS if res == RESULT_SUCCESS else RESULT_FAILURE
+        subprocess.call((gyb, "-u", username, "-r", USER_ARCHIVE, "-d", str(GYB_CONFIG_PATH.parent)))

tests/commands/test_init.py

@@ -1,6 +1,6 @@
-from argparse import Namespace
 import pytest
 
+from compiler_admin import RESULT_SUCCESS
 from compiler_admin.commands.init import _clean_config_dir, init, __name__ as MODULE
 
 
@@ -52,35 +52,28 @@ def test_clean_config_dir(mocker, mock_GAM_CONFIG_PATH, mock_rmtree):
     assert mock_dir in mock_rmtree.call_args.args
 
 
-def test_init_admin_user_required():
-    args = Namespace()
-
-    with pytest.raises(ValueError, match="username is required"):
-        init(args)
-
-
-def test_init_default(mock_clean_config_dir, mock_google_CallGAMCommand, mock_subprocess_call):
-    args = Namespace(username="username")
-    init(args)
+def test_init_default(cli_runner, mock_clean_config_dir, mock_google_CallGAMCommand, mock_subprocess_call):
+    result = cli_runner.invoke(init, ["username"])
 
+    assert result.exit_code == RESULT_SUCCESS
     assert mock_clean_config_dir.call_count == 0
     assert mock_google_CallGAMCommand.call_count == 0
     assert mock_subprocess_call.call_count == 0
 
 
-def test_init_gam(mock_GAM_CONFIG_PATH, mock_clean_config_dir, mock_google_CallGAMCommand):
-    args = Namespace(username="username", gam=True, gyb=False)
-    init(args)
+def test_init_gam(cli_runner, mock_GAM_CONFIG_PATH, mock_clean_config_dir, mock_google_CallGAMCommand):
+    result = cli_runner.invoke(init, ["--gam", "username"])
 
+    assert result.exit_code == RESULT_SUCCESS
     mock_clean_config_dir.assert_called_once()
     assert mock_GAM_CONFIG_PATH in mock_clean_config_dir.call_args.args
     assert mock_google_CallGAMCommand.call_count > 0
 
 
-def test_init_gyb(mock_GYB_CONFIG_PATH, mock_clean_config_dir, mock_subprocess_call):
-    args = Namespace(username="username", gam=False, gyb=True)
-    init(args)
+def test_init_gyb(cli_runner, mock_GYB_CONFIG_PATH, mock_clean_config_dir, mock_subprocess_call):
+    result = cli_runner.invoke(init, ["--gyb", "username"])
 
+    assert result.exit_code == RESULT_SUCCESS
     mock_clean_config_dir.assert_called_once()
     assert mock_GYB_CONFIG_PATH in mock_clean_config_dir.call_args.args
     assert mock_subprocess_call.call_count > 0