feat: convert user subcommand

Author: thekaveman

bin/convert.sh

@@ -0,0 +1,70 @@
+from compiler_admin.commands import RESULT_SUCCESS, RESULT_FAILURE
+from compiler_admin.services.google import (
+    GROUP_PARTNERS,
+    GROUP_STAFF,
+    OU_CONTRACTORS,
+    OU_PARTNERS,
+    OU_STAFF,
+    add_user_to_group,
+    move_user_ou,
+    remove_user_from_group,
+    user_account_name,
+    user_exists,
+    user_is_partner,
+    user_is_staff,
+)
+
+
+ACCOUNT_TYPE_OU = {"contractor": OU_CONTRACTORS, "partner": OU_PARTNERS, "staff": OU_STAFF}
+
+
+def convert(username: str, account_type: str) -> int:
+    f"""Convert a user of one type to another.
+    Args:
+        username (str): The account to convert. Must exist already.
+
+        account_type (str): One of {", ".join(ACCOUNT_TYPE_OU.keys())}
+    Returns:
+        A value indicating if the operation succeeded or failed.
+    """
+    account = user_account_name(username)
+
+    if not user_exists(account):
+        print(f"User does not exist: {account}")
+        return RESULT_FAILURE
+
+    if account_type not in ACCOUNT_TYPE_OU:
+        print(f"Unknown account type for conversion: {account_type}")
+        return RESULT_FAILURE
+
+    print(f"User exists, converting to: {account_type} for {account}")
+    res = RESULT_SUCCESS
+
+    if account_type == "contractor":
+        if user_is_partner(account):
+            res += remove_user_from_group(account, GROUP_PARTNERS)
+            res += remove_user_from_group(account, GROUP_STAFF)
+        elif user_is_staff(account):
+            res = remove_user_from_group(account, GROUP_STAFF)
+
+    elif account_type == "staff":
+        if user_is_partner(account):
+            res += remove_user_from_group(account, GROUP_PARTNERS)
+        elif user_is_staff(account):
+            print(f"User is already staff: {account}")
+            return RESULT_FAILURE
+        res += add_user_to_group(account, GROUP_STAFF)
+
+    elif account_type == "partner":
+        if user_is_partner(account):
+            print(f"User is already partner: {account}")
+            return RESULT_FAILURE
+        if not user_is_staff(account):
+            res += add_user_to_group(account, GROUP_STAFF)
+        res += add_user_to_group(account, GROUP_PARTNERS)
+
+    res += move_user_ou(account, ACCOUNT_TYPE_OU[account_type])
+
+    print(f"Account conversion complete for: {account}")
+
+    return RESULT_SUCCESS if res == RESULT_SUCCESS else RESULT_FAILURE

compiler_admin/commands/convert.py

@@ -3,6 +3,7 @@
 
 from compiler_admin import __version__ as version
 from compiler_admin.commands.create import create
+from compiler_admin.commands.convert import ACCOUNT_TYPE_OU, convert
 from compiler_admin.commands.delete import delete
 from compiler_admin.commands.info import info
 from compiler_admin.commands.init import init
@@ -41,6 +42,11 @@ def _subcmd(name, help, add_username_arg=True) -> argparse.ArgumentParser:
 
     _subcmd("create", help="Create a new user in the Compiler domain.")
 
+    convert_parser = _subcmd("convert", help="Convert a user account to a new type.")
+    convert_parser.add_argument(
+        "account_type", choices=ACCOUNT_TYPE_OU.keys(), help="Target account type for this conversion."
+    )
+
     _subcmd("delete", help="Delete a user account.")
 
     offboard_parser = _subcmd("offboard", help="Offboard a user account.")
@@ -59,6 +65,8 @@ def _subcmd(name, help, add_username_arg=True) -> argparse.ArgumentParser:
         return info()
     elif args.command == "create":
         return create(args.username, *extra)
+    elif args.command == "convert":
+        return convert(args.username, args.account_type)
     elif args.command == "delete":
         return delete(args.username)
     elif args.command == "init":

compiler_admin/main.py

@@ -0,0 +1,170 @@
+import pytest
+
+from compiler_admin.commands import RESULT_FAILURE, RESULT_SUCCESS
+from compiler_admin.commands.convert import convert, __name__ as MODULE
+
+
+@pytest.fixture
+def mock_google_user_exists(mock_google_user_exists):
+    return mock_google_user_exists(MODULE)
+
+
+@pytest.fixture
+def mock_google_user_exists_true(mock_google_user_exists):
+    mock_google_user_exists.return_value = True
+    return mock_google_user_exists
+
+
+@pytest.fixture
+def mock_google_add_user_to_group(mock_google_add_user_to_group):
+    return mock_google_add_user_to_group(MODULE)
+
+
+@pytest.fixture
+def mock_google_move_user_ou(mock_google_move_user_ou):
+    return mock_google_move_user_ou(MODULE)
+
+
+@pytest.fixture
+def mock_google_remove_user_from_group(mock_google_remove_user_from_group):
+    return mock_google_remove_user_from_group(MODULE)
+
+
+@pytest.fixture
+def mock_google_user_is_partner(mock_google_user_is_partner):
+    return mock_google_user_is_partner(MODULE)
+
+
+@pytest.fixture
+def mock_google_user_is_partner_true(mock_google_user_is_partner):
+    mock_google_user_is_partner.return_value = True
+    return mock_google_user_is_partner
+
+
+@pytest.fixture
+def mock_google_user_is_partner_false(mock_google_user_is_partner):
+    mock_google_user_is_partner.return_value = False
+    return mock_google_user_is_partner
+
+
+@pytest.fixture
+def mock_google_user_is_staff(mock_google_user_is_staff):
+    return mock_google_user_is_staff(MODULE)
+
+
+@pytest.fixture
+def mock_google_user_is_staff_true(mock_google_user_is_staff):
+    mock_google_user_is_staff.return_value = True
+    return mock_google_user_is_staff
+
+
+@pytest.fixture
+def mock_google_user_is_staff_false(mock_google_user_is_staff):
+    mock_google_user_is_staff.return_value = False
+    return mock_google_user_is_staff
+
+
+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")
+
+    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")
+
+    assert res == RESULT_FAILURE
+    assert mock_google_move_user_ou.call_count == 0
+
+
+@pytest.mark.usefixtures(
+    "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")
+
+    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")
+
+    assert res == RESULT_SUCCESS
+    assert mock_google_remove_user_from_group.call_count == 2
+    mock_google_move_user_ou.assert_called_once()
+
+
+@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")
+
+    assert res == RESULT_SUCCESS
+    mock_google_remove_user_from_group.assert_called_once()
+    mock_google_move_user_ou.assert_called_once()
+
+
+@pytest.mark.usefixtures(
+    "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")
+
+    assert res == RESULT_SUCCESS
+    mock_google_add_user_to_group.assert_called_once()
+    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_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")
+
+    assert res == RESULT_SUCCESS
+    mock_google_remove_user_from_group.assert_called_once()
+    mock_google_add_user_to_group.assert_called_once()
+    mock_google_move_user_ou.assert_called_once()
+
+
+@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")
+
+    assert res == RESULT_FAILURE
+    assert mock_google_add_user_to_group.call_count == 0
+    assert mock_google_move_user_ou.call_count == 0
+
+
+@pytest.mark.usefixtures(
+    "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")
+
+    assert res == RESULT_SUCCESS
+    mock_google_add_user_to_group.call_count == 2
+    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_partner_user_is_partner(mock_google_add_user_to_group, mock_google_move_user_ou):
+    res = convert("username", "partner")
+
+    assert res == RESULT_FAILURE
+    assert mock_google_add_user_to_group.call_count == 0
+    assert mock_google_move_user_ou.call_count == 0
+
+
+@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")
+
+    assert res == RESULT_SUCCESS
+    mock_google_add_user_to_group.assert_called_once()
+    mock_google_move_user_ou.assert_called_once()

tests/commands/test_convert.py

@@ -11,6 +11,16 @@ def _mock_commands_create(module, **kwargs):
     return _mock_commands_create
 
 
+@pytest.fixture
+def mock_commands_convert(mocker):
+    """Fixture returns a function that patches commands.convert in a given module."""
+
+    def _mock_commands_convert(module, **kwargs):
+        return mocker.patch(f"{module}.convert", **kwargs)
+
+    return _mock_commands_convert
+
+
 @pytest.fixture
 def mock_commands_delete(mocker):
     """Fixture returns a function that patches commands.delete in a given module."""