refactor(commands): pass args namespace directly

makes later usage of additional args easier without having to change function signatures

Author: thekaveman

compiler_admin/commands/convert.py

@@ -1,3 +1,5 @@
+from argparse import Namespace
+
 from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
 from compiler_admin.services.google import (
     GROUP_PARTNERS,
@@ -18,7 +20,7 @@
 ACCOUNT_TYPE_OU = {"contractor": OU_CONTRACTORS, "partner": OU_PARTNERS, "staff": OU_STAFF}
 
 
-def convert(username: str, account_type: str) -> int:
+def convert(args: Namespace) -> int:
     f"""Convert a user of one type to another.
     Args:
         username (str): The account to convert. Must exist already.
@@ -27,7 +29,13 @@ def convert(username: str, account_type: str) -> int:
     Returns:
         A value indicating if the operation succeeded or failed.
     """
-    account = user_account_name(username)
+    if not hasattr(args, "username"):
+        raise ValueError("username is required")
+    if not hasattr(args, "account_type"):
+        raise ValueError("account_type is required")
+
+    account = user_account_name(args.username)
+    account_type = args.account_type
 
     if not user_exists(account):
         print(f"User does not exist: {account}")

compiler_admin/commands/create.py

@@ -1,10 +1,11 @@
+from argparse import Namespace
 from typing import Sequence
 
 from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
 from compiler_admin.services.google import GROUP_TEAM, add_user_to_group, CallGAMCommand, user_account_name, user_exists
 
 
-def create(username: str, *args: Sequence[str]) -> int:
+def create(args: Namespace, *extra: Sequence[str]) -> int:
     """Create a new user account in Compiler.
 
     The user's password is randomly generated and requires reset on first login.
@@ -18,15 +19,18 @@ def create(username: str, *args: Sequence[str]) -> int:
     Returns:
         A value indicating if the operation succeeded or failed.
     """
-    account = user_account_name(username)
+    if not hasattr(args, "username"):
+        raise ValueError("username is required")
+
+    account = user_account_name(args.username)
 
     if user_exists(account):
         print(f"User already exists: {account}")
         return RESULT_FAILURE
 
     print(f"User does not exist, continuing: {account}")
 
-    res = CallGAMCommand(("create", "user", account, "password", "random", "changepassword", *args))
+    res = CallGAMCommand(("create", "user", account, "password", "random", "changepassword", *extra))
 
     res += add_user_to_group(account, GROUP_TEAM)
 

compiler_admin/commands/delete.py

@@ -1,16 +1,21 @@
+from argparse import Namespace
+
 from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
 from compiler_admin.services.google import CallGAMCommand, user_account_name, user_exists
 
 
-def delete(username: str) -> int:
+def delete(args: Namespace) -> int:
     """Delete the user account.
 
     Args:
         username (str): The account to delete. Must exist and not be an alias.
     Returns:
         A value indicating if the operation succeeded or failed.
     """
-    account = user_account_name(username)
+    if not hasattr(args, "username"):
+        raise ValueError("username is required")
+
+    account = user_account_name(args.username)
 
     if not user_exists(account):
         print(f"User does not exist: {account}")

compiler_admin/commands/init.py

@@ -1,3 +1,4 @@
+from argparse import Namespace
 import os
 from pathlib import Path
 from shutil import rmtree
@@ -21,7 +22,7 @@ def _clean_config_dir(config_dir: Path) -> None:
             rmtree(path)
 
 
-def init(admin_user: str, gam: bool = False, gyb: bool = False) -> int:
+def init(args: Namespace) -> int:
     """Initialize a new GAM project.
 
     See https://github.com/taers232c/GAMADV-XTD3/wiki/How-to-Install-Advanced-GAM
@@ -36,17 +37,21 @@ def init(admin_user: str, gam: bool = False, gyb: bool = False) -> int:
     Returns:
         A value indicating if the operation succeeded or failed.
     """
+    if not hasattr(args, "admin_user"):
+        raise ValueError("admin_user is required")
+
+    admin_user = args.admin_user
     res = RESULT_SUCCESS
 
-    if gam:
+    if getattr(args, "gam", False):
         _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"))
 
-    if gyb:
+    if getattr(args, "gyb", False):
         _clean_config_dir(GYB_CONFIG_PATH)
         # download GYB installer to config directory
         gyb = GYB_CONFIG_PATH / "gyb-install.sh"

compiler_admin/commands/offboard.py

@@ -1,3 +1,4 @@
+from argparse import Namespace
 from tempfile import NamedTemporaryFile
 
 from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
@@ -12,7 +13,7 @@
 )
 
 
-def offboard(username: str, alias: str = None) -> int:
+def offboard(args: Namespace) -> int:
     """Fully offboard a user from Compiler.
 
     Args:
@@ -22,12 +23,17 @@ def offboard(username: str, alias: str = None) -> int:
     Returns:
         A value indicating if the operation succeeded or failed.
     """
+    if not hasattr(args, "username"):
+        raise ValueError("username is required")
+
+    username = args.username
     account = user_account_name(username)
 
     if not user_exists(account):
         print(f"User does not exist: {account}")
         return RESULT_FAILURE
 
+    alias = getattr(args, "alias", None)
     alias_account = user_account_name(alias)
     if alias_account is not None and not user_exists(alias_account):
         print(f"Alias target user does not exist: {alias_account}")

compiler_admin/commands/restore.py

@@ -1,18 +1,22 @@
+from argparse import Namespace
 import pathlib
 
 from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
 from compiler_admin.services.google import USER_ARCHIVE, CallGYBCommand, user_account_name
 
 
-def restore(username: str) -> int:
+def restore(args: Namespace) -> int:
     """Restore an email backup from a prior offboarding.
 
     Args:
         username (str): the user account with a local email backup to restore.
     Returns:
         A value indicating if the operation succeeded or failed.
     """
-    account = user_account_name(username)
+    if not hasattr(args, "username"):
+        raise ValueError("username is required")
+
+    account = user_account_name(args.username)
     backup_dir = f"GYB-GMail-Backup-{account}"
 
     if not pathlib.Path(backup_dir).exists():

compiler_admin/commands/signout.py

@@ -1,16 +1,21 @@
+from argparse import Namespace
+
 from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
 from compiler_admin.services.google import CallGAMCommand, user_account_name, user_exists
 
 
-def signout(username: str) -> int:
+def signout(args: Namespace) -> int:
     """Signs the user out from all active sessions.
 
     Args:
         username (str): The account to sign out. Must exist already.
     Returns:
         A value indicating if the operation succeeded or failed.
     """
-    account = user_account_name(username)
+    if not hasattr(args, "username"):
+        raise ValueError("username is required")
+
+    account = user_account_name(args.username)
 
     if not user_exists(account):
         print(f"User does not exist: {account}")

compiler_admin/main.py

@@ -66,19 +66,19 @@ def _subcmd(name, help, add_username_arg=True) -> argparse.ArgumentParser:
     if args.command == "info":
         return info()
     elif args.command == "create":
-        return create(args.username, *extra)
+        return create(args, *extra)
     elif args.command == "convert":
-        return convert(args.username, args.account_type)
+        return convert(args)
     elif args.command == "delete":
-        return delete(args.username)
+        return delete(args)
     elif args.command == "init":
-        return init(args.username, gam=args.gam, gyb=args.gyb)
+        return init(args)
     elif args.command == "offboard":
-        return offboard(args.username, args.alias)
+        return offboard(args)
     elif args.command == "restore":
-        return restore(args.username)
+        return restore(args)
     elif args.command == "signout":
-        return signout(args.username)
+        return signout(args)
 
 
 if __name__ == "__main__":

tests/commands/test_convert.py

@@ -1,3 +1,4 @@
+from argparse import Namespace
 import pytest
 
 from compiler_admin.commands import RESULT_FAILURE, RESULT_SUCCESS
@@ -64,18 +65,34 @@ def mock_google_user_is_staff_false(mock_google_user_is_staff):
     return mock_google_user_is_staff
 
 
+def test_convert_user_username_required():
+    args = Namespace()
+
+    with pytest.raises(ValueError, match="username is required"):
+        convert(args)
+
+
+def test_convert_user_account_type_required():
+    args = Namespace(username="username")
+
+    with pytest.raises(ValueError, match="account_type is required"):
+        convert(args)
+
+
 def test_convert_user_does_not_exists(mock_google_user_exists, mock_google_move_user_ou):
     mock_google_user_exists.return_value = False
 
-    res = convert("username", "account_type")
+    args = Namespace(username="username", account_type="account_type")
+    res = convert(args)
 
     assert res == RESULT_FAILURE
     assert mock_google_move_user_ou.call_count == 0
 
 
 @pytest.mark.usefixtures("mock_google_user_exists_true")
 def test_convert_user_exists_bad_account_type(mock_google_move_user_ou):
-    res = convert("username", "account_type")
+    args = Namespace(username="username", account_type="account_type")
+    res = convert(args)
 
     assert res == RESULT_FAILURE
     assert mock_google_move_user_ou.call_count == 0
@@ -85,15 +102,17 @@ def test_convert_user_exists_bad_account_type(mock_google_move_user_ou):
     "mock_google_user_exists_true", "mock_google_user_is_partner_false", "mock_google_user_is_staff_false"
 )
 def test_convert_contractor(mock_google_move_user_ou):
-    res = convert("username", "contractor")
+    args = Namespace(username="username", account_type="contractor")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     mock_google_move_user_ou.assert_called_once()
 
 
 @pytest.mark.usefixtures("mock_google_user_exists_true", "mock_google_user_is_partner_true", "mock_google_user_is_staff_false")
 def test_convert_contractor_user_is_partner(mock_google_remove_user_from_group, mock_google_move_user_ou):
-    res = convert("username", "contractor")
+    args = Namespace(username="username", account_type="contractor")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     assert mock_google_remove_user_from_group.call_count == 2
@@ -102,7 +121,8 @@ def test_convert_contractor_user_is_partner(mock_google_remove_user_from_group,
 
 @pytest.mark.usefixtures("mock_google_user_exists_true", "mock_google_user_is_partner_false", "mock_google_user_is_staff_true")
 def test_convert_contractor_user_is_staff(mock_google_remove_user_from_group, mock_google_move_user_ou):
-    res = convert("username", "contractor")
+    args = Namespace(username="username", account_type="contractor")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     mock_google_remove_user_from_group.assert_called_once()
@@ -113,7 +133,8 @@ def test_convert_contractor_user_is_staff(mock_google_remove_user_from_group, mo
     "mock_google_user_exists_true", "mock_google_user_is_partner_false", "mock_google_user_is_staff_false"
 )
 def test_convert_staff(mock_google_add_user_to_group, mock_google_move_user_ou):
-    res = convert("username", "staff")
+    args = Namespace(username="username", account_type="staff")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     mock_google_add_user_to_group.assert_called_once()
@@ -124,7 +145,8 @@ def test_convert_staff(mock_google_add_user_to_group, mock_google_move_user_ou):
 def test_convert_staff_user_is_partner(
     mock_google_add_user_to_group, mock_google_remove_user_from_group, mock_google_move_user_ou
 ):
-    res = convert("username", "staff")
+    args = Namespace(username="username", account_type="staff")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     mock_google_remove_user_from_group.assert_called_once()
@@ -134,7 +156,8 @@ def test_convert_staff_user_is_partner(
 
 @pytest.mark.usefixtures("mock_google_user_exists_true", "mock_google_user_is_partner_false", "mock_google_user_is_staff_true")
 def test_convert_staff_user_is_staff(mock_google_add_user_to_group, mock_google_move_user_ou):
-    res = convert("username", "staff")
+    args = Namespace(username="username", account_type="staff")
+    res = convert(args)
 
     assert res == RESULT_FAILURE
     assert mock_google_add_user_to_group.call_count == 0
@@ -145,7 +168,8 @@ def test_convert_staff_user_is_staff(mock_google_add_user_to_group, mock_google_
     "mock_google_user_exists_true", "mock_google_user_is_partner_false", "mock_google_user_is_staff_false"
 )
 def test_convert_partner(mock_google_add_user_to_group, mock_google_move_user_ou):
-    res = convert("username", "partner")
+    args = Namespace(username="username", account_type="partner")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     mock_google_add_user_to_group.call_count == 2
@@ -154,7 +178,8 @@ def test_convert_partner(mock_google_add_user_to_group, mock_google_move_user_ou
 
 @pytest.mark.usefixtures("mock_google_user_exists_true", "mock_google_user_is_partner_true", "mock_google_user_is_staff_false")
 def test_convert_partner_user_is_partner(mock_google_add_user_to_group, mock_google_move_user_ou):
-    res = convert("username", "partner")
+    args = Namespace(username="username", account_type="partner")
+    res = convert(args)
 
     assert res == RESULT_FAILURE
     assert mock_google_add_user_to_group.call_count == 0
@@ -163,7 +188,8 @@ def test_convert_partner_user_is_partner(mock_google_add_user_to_group, mock_goo
 
 @pytest.mark.usefixtures("mock_google_user_exists_true", "mock_google_user_is_partner_false", "mock_google_user_is_staff_true")
 def test_convert_partner_user_is_staff(mock_google_add_user_to_group, mock_google_move_user_ou):
-    res = convert("username", "partner")
+    args = Namespace(username="username", account_type="partner")
+    res = convert(args)
 
     assert res == RESULT_SUCCESS
     mock_google_add_user_to_group.assert_called_once()