refactor(init): optionally init GAM, GYB projects

Author: thekaveman

compiler_admin/commands/init.py

@@ -7,44 +7,62 @@
 from compiler_admin.services.google import USER_ARCHIVE, CallGAMCommand
 
 
-CONFIG_DIR = os.environ.get("GAMCFGDIR", "./.config")
-CONFIG_PATH = Path(CONFIG_DIR)
-CONFIG_PATH_NAME = str(CONFIG_PATH)
+GAM_CONFIG_DIR = os.environ.get("GAMCFGDIR", "./.config/gam")
+GAM_CONFIG_PATH = Path(GAM_CONFIG_DIR)
+GYB_CONFIG_PATH = GAM_CONFIG_PATH.parent / "gyb"
 
 
-def _clean_config_dir():
-    for path in CONFIG_PATH.glob("**/*"):
-        if path.is_file():
-            path.unlink()
-        elif path.is_dir():
-            rmtree(path)
+def _clean_config_dir(gam: bool, gyb: bool) -> None:
+    if gam:
+        for path in GAM_CONFIG_PATH.glob("**/*"):
+            if path.is_file():
+                path.unlink()
+            elif path.is_dir():
+                rmtree(path)
+    if gyb:
+        for path in GYB_CONFIG_PATH.glob("**/*"):
+            if path.is_file():
+                path.unlink()
+            elif path.is_dir():
+                rmtree(path)
 
 
-def init(admin_user: str) -> int:
+def init(admin_user: str, gam: bool = False, gyb: bool = False) -> int:
     """Initialize a new GAM project.
 
     See https://github.com/taers232c/GAMADV-XTD3/wiki/How-to-Install-Advanced-GAM
 
     Args:
         admin_user (str): The Compiler admin with which to initialize a new project.
+
+        init_gam (bool): If True, initialize a new GAM project.
+
+        init_gyb (bool): If True, initialize a new GYB project.
     Returns:
         A value indicating if the operation succeeded or failed.
     """
-    if CONFIG_PATH.exists():
-        _clean_config_dir()
-
-    res = CallGAMCommand(("config", "drive_dir", CONFIG_PATH_NAME, "verify"))
-    res += CallGAMCommand(("create", "project"))
-    res += CallGAMCommand(("oauth", "create"))
-    res += CallGAMCommand(("user", admin_user, "check", "serviceaccount"))
-
-    # download GYB installer to config directory
-    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)
-
-    # install, giving values to options that prompt by default
-    # https://github.com/GAM-team/got-your-back/blob/main/install-gyb.sh
-    res += subprocess.call((gyb, "-u", admin_user, "-r", USER_ARCHIVE))
+    _clean_config_dir(gam, gyb)
+
+    res = RESULT_SUCCESS
+
+    if gam:
+        GAM_CONFIG_PATH.mkdir(parents=True, exist_ok=True)
+        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"))
+
+    if gyb:
+        GYB_CONFIG_PATH.mkdir(parents=True, exist_ok=True)
+        # 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)
+
+        # 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

tests/commands/test_init.py

@@ -1,11 +1,17 @@
 import pytest
 
+import compiler_admin.commands.init
 from compiler_admin.commands.init import init, __name__ as MODULE
 
 
 @pytest.fixture
-def mock_CONFIG_PATH(mocker):
-    return mocker.patch(f"{MODULE}.CONFIG_PATH")
+def spy_GAM_CONFIG_PATH(mocker):
+    return mocker.spy(compiler_admin.commands.init, "GAM_CONFIG_PATH")
+
+
+@pytest.fixture
+def spy_GYB_CONFIG_PATH(mocker):
+    return mocker.spy(compiler_admin.commands.init, "GYB_CONFIG_PATH")
 
 
 @pytest.fixture
@@ -23,23 +29,24 @@ def mock_subprocess_call(mocker):
     return mocker.patch(f"{MODULE}.subprocess.call")
 
 
-def test_init_config_path_exists(mock_CONFIG_PATH, mock_clean_config_dir, mock_google_CallGAMCommand, mock_subprocess_call):
-    mock_CONFIG_PATH.exists.return_value = True
-
-    init("username")
+def test_init_cleans_config(mock_clean_config_dir):
+    init("username", gam=False, gyb=False)
 
     mock_clean_config_dir.assert_called_once()
-    assert mock_google_CallGAMCommand.call_count > 0
-    assert mock_subprocess_call.call_count > 0
-
+    assert mock_clean_config_dir.call_args.args == (False, False)
 
-def test_init_config_path_does_not_exist(
-    mock_CONFIG_PATH, mock_clean_config_dir, mock_google_CallGAMCommand, mock_subprocess_call
-):
-    mock_CONFIG_PATH.exists.return_value = False
 
-    init("username")
+@pytest.mark.usefixtures("mock_clean_config_dir")
+def test_init_gam(spy_GAM_CONFIG_PATH, mock_google_CallGAMCommand):
+    init("username", gam=True, gyb=False)
 
-    assert mock_clean_config_dir.call_count == 0
+    spy_GAM_CONFIG_PATH.mkdir.assert_called_once()
     assert mock_google_CallGAMCommand.call_count > 0
+
+
+@pytest.mark.usefixtures("mock_clean_config_dir")
+def test_init_gyb(spy_GYB_CONFIG_PATH, mock_subprocess_call):
+    init("username", gam=False, gyb=True)
+
+    spy_GYB_CONFIG_PATH.mkdir.assert_called_once()
     assert mock_subprocess_call.call_count > 0