refactor(user): describe as @click.group of commands

Author: thekaveman

compiler_admin/commands/user/__init__.py

@@ -1,22 +1,28 @@
-from argparse import Namespace
+import click
 
-from compiler_admin.commands.user.alumni import alumni  # noqa: F401
-from compiler_admin.commands.user.create import create  # noqa: F401
-from compiler_admin.commands.user.convert import convert  # noqa: F401
-from compiler_admin.commands.user.delete import delete  # noqa: F401
-from compiler_admin.commands.user.offboard import offboard  # noqa: F401
-from compiler_admin.commands.user.reset import reset  # noqa: F401
-from compiler_admin.commands.user.restore import restore  # noqa: F401
-from compiler_admin.commands.user.signout import signout  # noqa: F401
+from compiler_admin.commands.user.alumni import alumni
+from compiler_admin.commands.user.convert import convert
+from compiler_admin.commands.user.create import create
+from compiler_admin.commands.user.delete import delete
+from compiler_admin.commands.user.offboard import offboard
+from compiler_admin.commands.user.reset import reset
+from compiler_admin.commands.user.restore import restore
+from compiler_admin.commands.user.signout import signout
 
 
-def user(args: Namespace, *extra):
-    # try to call the subcommand function directly from global (module) symbols
-    # if the subcommand function was imported above, it should exist in globals()
-    global_env = globals()
+@click.group
+def user():
+    """
+    Work with users in the Compiler org.
+    """
+    pass
 
-    if args.subcommand in global_env:
-        cmd_func = global_env[args.subcommand]
-        cmd_func(args, *extra)
-    else:
-        raise NotImplementedError(f"Unknown user subcommand: {args.subcommand}")
+
+user.add_command(alumni)
+user.add_command(convert)
+user.add_command(create)
+user.add_command(delete)
+user.add_command(offboard)
+user.add_command(reset)
+user.add_command(restore)
+user.add_command(signout)

compiler_admin/commands/user/alumni.py

@@ -1,116 +1,73 @@
-from argparse import Namespace
+import click
 
 from compiler_admin import RESULT_FAILURE, RESULT_SUCCESS
 from compiler_admin.commands.user.reset import reset
 from compiler_admin.services.google import (
     OU_ALUMNI,
-    USER_HELLO,
     CallGAMCommand,
     move_user_ou,
     user_account_name,
     user_exists,
 )
 
 
-def alumni(args: Namespace) -> int:
-    """Convert a user to a Compiler alumni.
-
-    Optionally notify an email address with the new randomly generated password.
-
-    Args:
-        username (str): the user account to convert.
-
-        notify (str): an email address to send the new password notification.
-    Returns:
-        A value indicating if the operation succeeded or failed.
+@click.command()
+@click.option("-f", "--force", is_flag=True, help="Don't ask for confirmation.")
+@click.option("-n", "--notify", help="An email address to send the new password notification.")
+@click.option(
+    "-e",
+    "--recovery-email",
+    help="An email address to use as the new recovery email. Without a value, clears the recovery email.",
+)
+@click.option(
+    "-p",
+    "--recovery-phone",
+    help="A phone number to use as the new recovery phone number. Without a value, clears the recovery phone number.",
+)
+@click.argument("username")
+@click.pass_context
+def alumni(
+    ctx: click.Context, username: str, force: bool = False, recovery_email: str = "", recovery_phone: str = "", **kwargs
+):
     """
-    if not hasattr(args, "username"):
-        raise ValueError("username is required")
-
-    account = user_account_name(args.username)
+    Convert a user to a Compiler alumni.
+    """
+    account = user_account_name(username)
 
     if not user_exists(account):
-        print(f"User does not exist: {account}")
-        return RESULT_FAILURE
+        click.echo(f"User does not exist: {account}")
+        raise SystemExit(RESULT_FAILURE)
 
-    if getattr(args, "force", False) is False:
-        cont = input(f"Convert account to alumni: {account}? (Y/n) ")
+    if not force:
+        cont = input(f"Convert account to alumni for {account}? (Y/n): ")
         if not cont.lower().startswith("y"):
-            print("Aborting conversion.")
-            return RESULT_SUCCESS
+            click.echo("Aborting conversion.")
+            raise SystemExit(RESULT_SUCCESS)
 
-    res = RESULT_SUCCESS
+    click.echo(f"User exists, converting to alumni: {account}")
 
-    print("Removing from groups")
-    res += CallGAMCommand(("user", account, "delete", "groups"))
+    click.echo("Removing from groups")
+    CallGAMCommand(("user", account, "delete", "groups"))
 
-    print(f"Moving to OU: {OU_ALUMNI}")
-    res += move_user_ou(account, OU_ALUMNI)
+    click.echo(f"Moving to OU: {OU_ALUMNI}")
+    move_user_ou(account, OU_ALUMNI)
 
     # reset password, sign out
-    res += reset(args)
+    ctx.forward(reset)
 
-    print("Clearing user profile info")
+    click.echo("Clearing user profile info")
     for prop in ["address", "location", "otheremail", "phone"]:
         command = ("update", "user", account, prop, "clear")
-        res += CallGAMCommand(command)
+        CallGAMCommand(command)
 
-    print("Resetting recovery email")
-    recovery = getattr(args, "recovery_email", "")
-    command = ("update", "user", account, "recoveryemail", recovery)
-    res += CallGAMCommand(command)
+    click.echo("Resetting recovery email")
+    command = ("update", "user", account, "recoveryemail", recovery_email)
+    CallGAMCommand(command)
 
-    print("Resetting recovery phone")
-    recovery = getattr(args, "recovery_phone", "")
-    command = ("update", "user", account, "recoveryphone", recovery)
-    res += CallGAMCommand(command)
+    click.echo("Resetting recovery phone")
+    command = ("update", "user", account, "recoveryphone", recovery_phone)
+    CallGAMCommand(command)
 
-    print("Turning off 2FA")
+    click.echo("Turning off 2FA")
     command = ("user", account, "turnoff2sv")
-    res += CallGAMCommand(command)
-
-    print("Resetting email signature")
-    # https://github.com/taers232c/GAMADV-XTD3/wiki/Users-Gmail-Send-As-Signature-Vacation#manage-signature
-    command = (
-        "user",
-        account,
-        "signature",
-        f"Compiler LLC<br />https://compiler.la<br />{USER_HELLO}",
-        "replyto",
-        USER_HELLO,
-        "default",
-        "treatasalias",
-        "false",
-        "name",
-        "Compiler LLC",
-        "primary",
-    )
-    res += CallGAMCommand(command)
-
-    print("Turning on email autoresponder")
-    # https://github.com/taers232c/GAMADV-XTD3/wiki/Users-Gmail-Send-As-Signature-Vacation#manage-vacation
-    message = (
-        "Thank you for contacting Compiler. This inbox is no longer actively monitored.<br /><br />"
-        + f"Please reach out to {USER_HELLO} if you need to get a hold of us."
-    )
-    command = (
-        "user",
-        account,
-        "vacation",
-        "true",
-        "subject",
-        "[This inbox is no longer active]",
-        "message",
-        message,
-        "contactsonly",
-        "false",
-        "domainonly",
-        "false",
-        "start",
-        "Started",
-        "end",
-        "2999-12-31",
-    )
-    res += CallGAMCommand(command)
-
-    return res
+    CallGAMCommand(command)

compiler_admin/commands/user/convert.py

@@ -1,6 +1,6 @@
-from argparse import Namespace
+import click
 
-from compiler_admin import RESULT_SUCCESS, RESULT_FAILURE
+from compiler_admin import RESULT_FAILURE
 from compiler_admin.commands.user.alumni import alumni
 from compiler_admin.services.google import (
     GROUP_PARTNERS,
@@ -22,62 +22,63 @@
 ACCOUNT_TYPE_OU = {"alumni": OU_ALUMNI, "contractor": OU_CONTRACTORS, "partner": OU_PARTNERS, "staff": OU_STAFF}
 
 
-def convert(args: Namespace) -> 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.
+@click.command()
+@click.option("-f", "--force", is_flag=True, help="Don't ask for confirmation.")
+@click.option(
+    "-n", "--notify", help="An email address to send the new password notification. Only valid for alumni conversion."
+)
+@click.option(
+    "-e",
+    "--recovery-email",
+    help="An email address to use as the new recovery email. Only valid for alumni conversion.",
+)
+@click.option(
+    "-p",
+    "--recovery-phone",
+    help="A phone number to use as the new recovery phone number. Only valid for alumni conversion.",
+)
+@click.argument("username")
+@click.argument("account_type", type=click.Choice(ACCOUNT_TYPE_OU.keys(), case_sensitive=False))
+@click.pass_context
+def convert(ctx: click.Context, username: str, account_type: str, **kwargs):
     """
-    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
+    Convert a user of one type to another.
+    """
+    account = user_account_name(username)
 
     if not user_exists(account):
-        print(f"User does not exist: {account}")
-        return RESULT_FAILURE
+        click.echo(f"User does not exist: {account}")
+        raise SystemExit(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
+    click.echo(f"User exists, converting to: {account_type} for {account}")
 
     if account_type == "alumni":
-        res = alumni(args)
+        # call the alumni command
+        ctx.forward(alumni)
 
     elif account_type == "contractor":
         if user_is_partner(account):
-            res += remove_user_from_group(account, GROUP_PARTNERS)
-            res += remove_user_from_group(account, GROUP_STAFF)
+            remove_user_from_group(account, GROUP_PARTNERS)
+            remove_user_from_group(account, GROUP_STAFF)
         elif user_is_staff(account):
-            res = remove_user_from_group(account, GROUP_STAFF)
+            remove_user_from_group(account, GROUP_STAFF)
 
     elif account_type == "staff":
         if user_is_partner(account):
-            res += remove_user_from_group(account, GROUP_PARTNERS)
+            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)
+            click.echo(f"User is already staff: {account}")
+            raise SystemExit(RESULT_FAILURE)
+        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
+            click.echo(f"User is already partner: {account}")
+            raise SystemExit(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])
+            add_user_to_group(account, GROUP_STAFF)
+        add_user_to_group(account, GROUP_PARTNERS)
 
-    print(f"Account conversion complete for: {account}")
+    move_user_ou(account, ACCOUNT_TYPE_OU[account_type])
 
-    return RESULT_SUCCESS if res == RESULT_SUCCESS else RESULT_FAILURE
+    click.echo(f"Account conversion complete for: {account}")

compiler_admin/commands/user/create.py

@@ -1,47 +1,46 @@
-from argparse import Namespace
-from typing import Sequence
-
-from compiler_admin 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(args: Namespace, *extra: Sequence[str]) -> int:
-    """Create a new user account in Compiler.
+import click
+
+from compiler_admin import RESULT_FAILURE
+from compiler_admin.services.google import (
+    GROUP_TEAM,
+    USER_HELLO,
+    add_user_to_group,
+    CallGAMCommand,
+    user_account_name,
+    user_exists,
+)
+
+
+@click.command(context_settings={"ignore_unknown_options": True})
+@click.option("-n", "--notify", help="An email address to send the new password notification.")
+@click.argument("username")
+@click.argument("gam_args", nargs=-1, type=click.UNPROCESSED)
+def create(username: str, notify: str = "", gam_args: list = []):
+    """Create a new user account.
 
     The user's password is randomly generated and requires reset on first login.
 
     Extra args are passed along to GAM as options.
-    See https://github.com/taers232c/GAMADV-XTD3/wiki/Users#create-a-user
-    for the complete list of options supported.
 
-    Args:
-        username (str): The account to create. Must not exist already.
-    Returns:
-        A value indicating if the operation succeeded or failed.
+    https://github.com/taers232c/GAMADV-XTD3/wiki/Users#create-a-user
     """
-    if not hasattr(args, "username"):
-        raise ValueError("username is required")
-
-    account = user_account_name(args.username)
+    account = user_account_name(username)
 
     if user_exists(account):
-        print(f"User already exists: {account}")
-        return RESULT_FAILURE
+        click.echo(f"User already exists: {account}")
+        raise SystemExit(RESULT_FAILURE)
 
-    print(f"User does not exist, continuing: {account}")
+    click.echo(f"User does not exist, continuing: {account}")
 
     command = ("create", "user", account, "password", "random", "changepassword")
 
-    notify = getattr(args, "notify", None)
     if notify:
-        command += ("notify", notify, "from", "hello@compiler.la")
-
-    command += (*extra,)
+        command += ("notify", notify, "from", USER_HELLO)
 
-    res = CallGAMCommand(command)
+    command += (*gam_args,)
 
-    res += add_user_to_group(account, GROUP_TEAM)
+    CallGAMCommand(command)
 
-    print(f"User created successfully: {account}")
+    add_user_to_group(account, GROUP_TEAM)
 
-    return RESULT_SUCCESS if res == RESULT_SUCCESS else RESULT_FAILURE
+    click.echo(f"User created successfully: {account}")