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

Author: thekaveman

compiler_admin/main.py

@@ -1,231 +1,24 @@
-from argparse import ArgumentParser, _SubParsersAction
-from datetime import datetime, timedelta
-import os
-import sys
+import click
 
-from pytz import timezone
+from compiler_admin import __version__
 
-from compiler_admin import __version__ as version
 from compiler_admin.commands.info import info
 from compiler_admin.commands.init import init
 from compiler_admin.commands.time import time
-from compiler_admin.commands.time.convert import CONVERTERS
 from compiler_admin.commands.user import user
-from compiler_admin.commands.user.convert import ACCOUNT_TYPE_OU
 
 
-TZINFO = timezone(os.environ.get("TZ_NAME", "America/Los_Angeles"))
+@click.group
+@click.version_option(__version__, prog_name="compiler-admin")
+def main():
+    """Compiler's command line interface."""
+    pass
 
 
-def local_now():
-    return datetime.now(tz=TZINFO)
-
-
-def prior_month_end():
-    now = local_now()
-    first = now.replace(day=1)
-    return first - timedelta(days=1)
-
-
-def prior_month_start():
-    end = prior_month_end()
-    return end.replace(day=1)
-
-
-def add_sub_cmd_parser(parser: ArgumentParser, dest="subcommand", help=None):
-    """Helper adds a subparser for the given dest."""
-    return parser.add_subparsers(dest=dest, help=help)
-
-
-def add_sub_cmd(cmd: _SubParsersAction, subcmd, help) -> ArgumentParser:
-    """Helper creates a new subcommand parser."""
-    return cmd.add_parser(subcmd, help=help)
-
-
-def add_sub_cmd_with_username_arg(cmd: _SubParsersAction, subcmd, help) -> ArgumentParser:
-    """Helper creates a new subcommand parser with a required username arg."""
-    sub_cmd = add_sub_cmd(cmd, subcmd, help=help)
-    sub_cmd.add_argument("username", help="A Compiler user account name, sans domain.")
-    return sub_cmd
-
-
-def setup_info_command(cmd_parsers: _SubParsersAction):
-    info_cmd = add_sub_cmd(cmd_parsers, "info", help="Print configuration and debugging information.")
-    info_cmd.set_defaults(func=info)
-
-
-def setup_init_command(cmd_parsers: _SubParsersAction):
-    init_cmd = add_sub_cmd_with_username_arg(
-        cmd_parsers, "init", help="Initialize a new admin project. This command should be run once before any others."
-    )
-    init_cmd.add_argument("--gam", action="store_true", help="If provided, initialize a new GAM project.")
-    init_cmd.add_argument("--gyb", action="store_true", help="If provided, initialize a new GYB project.")
-    init_cmd.set_defaults(func=init)
-
-
-def setup_time_command(cmd_parsers: _SubParsersAction):
-    time_cmd = add_sub_cmd(cmd_parsers, "time", help="Work with Compiler time entries.")
-    time_cmd.set_defaults(func=time)
-    time_subcmds = add_sub_cmd_parser(time_cmd, help="The time command to run.")
-
-    time_convert = add_sub_cmd(time_subcmds, "convert", help="Convert a time report from one format into another.")
-    time_convert.add_argument(
-        "--input",
-        default=os.environ.get("TOGGL_DATA", sys.stdin),
-        help="The path to the source data for conversion. Defaults to $TOGGL_DATA or stdin.",
-    )
-    time_convert.add_argument(
-        "--output",
-        default=os.environ.get("HARVEST_DATA", sys.stdout),
-        help="The path to the file where converted data should be written. Defaults to $HARVEST_DATA or stdout.",
-    )
-    time_convert.add_argument(
-        "--from",
-        default="toggl",
-        choices=sorted(CONVERTERS.keys()),
-        dest="from_fmt",
-        help="The format of the source data. Defaults to 'toggl'.",
-    )
-    time_convert.add_argument(
-        "--to",
-        default="harvest",
-        choices=sorted([to_fmt for sub in CONVERTERS.values() for to_fmt in sub.keys()]),
-        dest="to_fmt",
-        help="The format of the converted data. Defaults to 'harvest'.",
-    )
-    time_convert.add_argument("--client", default=None, help="The name of the client to use in converted data.")
-
-    time_download = add_sub_cmd(time_subcmds, "download", help="Download a Toggl report in CSV format.")
-    time_download.add_argument(
-        "--start",
-        metavar="YYYY-MM-DD",
-        default=prior_month_start(),
-        type=lambda s: TZINFO.localize(datetime.strptime(s, "%Y-%m-%d")),
-        help="The start date of the reporting period. Defaults to the beginning of the prior month.",
-    )
-    time_download.add_argument(
-        "--end",
-        metavar="YYYY-MM-DD",
-        default=prior_month_end(),
-        type=lambda s: TZINFO.localize(datetime.strptime(s, "%Y-%m-%d")),
-        help="The end date of the reporting period. Defaults to the end of the prior month.",
-    )
-    time_download.add_argument(
-        "--output",
-        default=os.environ.get("TOGGL_DATA", sys.stdout),
-        help="The path to the file where downloaded data should be written. Defaults to $TOGGL_DATA or stdout.",
-    )
-    time_download.add_argument(
-        "--all",
-        default=True,
-        action="store_false",
-        dest="billable",
-        help="Download all time entries. The default is to download only billable time entries.",
-    )
-    time_download.add_argument(
-        "--client",
-        dest="client_ids",
-        metavar="CLIENT_ID",
-        action="append",
-        type=int,
-        help="An ID for a Toggl Client to filter for in reports. Can be supplied more than once.",
-    )
-    time_download.add_argument(
-        "--project",
-        dest="project_ids",
-        metavar="PROJECT_ID",
-        action="append",
-        type=int,
-        help="An ID for a Toggl Project to filter for in reports. Can be supplied more than once.",
-    )
-    time_download.add_argument(
-        "--task",
-        dest="task_ids",
-        metavar="TASK_ID",
-        action="append",
-        type=int,
-        help="An ID for a Toggl Project Task to filter for in reports. Can be supplied more than once.",
-    )
-    time_download.add_argument(
-        "--user",
-        dest="user_ids",
-        metavar="USER_ID",
-        action="append",
-        type=int,
-        help="An ID for a Toggl User to filter for in reports. Can be supplied more than once.",
-    )
-
-
-def setup_user_command(cmd_parsers: _SubParsersAction):
-    user_cmd = add_sub_cmd(cmd_parsers, "user", help="Work with users in the Compiler org.")
-    user_cmd.set_defaults(func=user)
-    user_subcmds = add_sub_cmd_parser(user_cmd, help="The user command to run.")
-
-    user_alumni = add_sub_cmd_with_username_arg(user_subcmds, "alumni", help="Convert a user account to a Compiler alumni.")
-    user_alumni.add_argument("--notify", help="An email address to send the alumni's new password.")
-    user_alumni.add_argument(
-        "--force", action="store_true", default=False, help="Don't ask for confirmation before conversion."
-    )
-
-    user_create = add_sub_cmd_with_username_arg(user_subcmds, "create", help="Create a new user in the Compiler domain.")
-    user_create.add_argument("--notify", help="An email address to send the newly created account info.")
-
-    user_convert = add_sub_cmd_with_username_arg(user_subcmds, "convert", help="Convert a user account to a new type.")
-    user_convert.add_argument("account_type", choices=ACCOUNT_TYPE_OU.keys(), help="Target account type for this conversion.")
-    user_convert.add_argument(
-        "--force", action="store_true", default=False, help="Don't ask for confirmation before conversion."
-    )
-    user_convert.add_argument("--notify", help="An email address to send the alumni's new password.")
-
-    user_delete = add_sub_cmd_with_username_arg(user_subcmds, "delete", help="Delete a user account.")
-    user_delete.add_argument("--force", action="store_true", default=False, help="Don't ask for confirmation before deletion.")
-
-    user_offboard = add_sub_cmd_with_username_arg(user_subcmds, "offboard", help="Offboard a user account.")
-    user_offboard.add_argument("--alias", help="Account to assign username as an alias.")
-    user_offboard.add_argument(
-        "--force", action="store_true", default=False, help="Don't ask for confirmation before offboarding."
-    )
-
-    user_reset = add_sub_cmd_with_username_arg(
-        user_subcmds, "reset", help="Reset a user's password to a randomly generated string."
-    )
-    user_reset.add_argument("--force", action="store_true", default=False, help="Don't ask for confirmation before reset.")
-    user_reset.add_argument("--notify", help="An email address to send the newly generated password.")
-
-    add_sub_cmd_with_username_arg(user_subcmds, "restore", help="Restore an email backup from a prior offboarding.")
-
-    user_signout = add_sub_cmd_with_username_arg(user_subcmds, "signout", help="Signs a user out from all active sessions.")
-    user_signout.add_argument("--force", action="store_true", default=False, help="Don't ask for confirmation before signout.")
-
-
-def main(argv=None):
-    argv = argv if argv is not None else sys.argv[1:]
-    parser = ArgumentParser(prog="compiler-admin")
-
-    # https://stackoverflow.com/a/8521644/812183
-    parser.add_argument(
-        "-v",
-        "--version",
-        action="version",
-        version=f"%(prog)s {version}",
-    )
-
-    cmd_parsers = add_sub_cmd_parser(parser, dest="command", help="The command to run")
-    setup_info_command(cmd_parsers)
-    setup_init_command(cmd_parsers)
-    setup_time_command(cmd_parsers)
-    setup_user_command(cmd_parsers)
-
-    if len(argv) == 0:
-        argv = ["info"]
-
-    args, extra = parser.parse_known_args(argv)
-
-    if args.func:
-        return args.func(args, *extra)
-    else:
-        raise ValueError("Unrecognized command")
-
+main.add_command(init)
+main.add_command(info)
+main.add_command(time)
+main.add_command(user)
 
 if __name__ == "__main__":
     raise SystemExit(main())

tests/conftest.py

@@ -58,72 +58,24 @@ def mock_commands_alumni(mock_command):
     return mock_command("alumni")
 
 
-@pytest.fixture
-def mock_commands_create(mock_command):
-    """Fixture returns a function that patches the create function in a given module."""
-    return mock_command("create")
-
-
-@pytest.fixture
-def mock_commands_convert(mock_command):
-    """Fixture returns a function that patches the convert command function in a given module."""
-    return mock_command("convert")
-
-
 @pytest.fixture
 def mock_commands_delete(mock_command):
     """Fixture returns a function that patches the delete command function in a given module."""
     return mock_command("delete")
 
 
-@pytest.fixture
-def mock_commands_info(mock_command):
-    """Fixture returns a function that patches the info command function in a given module."""
-    return mock_command("info")
-
-
-@pytest.fixture
-def mock_commands_init(mock_command):
-    """Fixture returns a function that patches the init command function in a given module."""
-    return mock_command("init")
-
-
-@pytest.fixture
-def mock_commands_offboard(mock_command):
-    """Fixture returns a function that patches the offboard command function in a given module."""
-    return mock_command("offboard")
-
-
 @pytest.fixture
 def mock_commands_reset(mock_command):
     """Fixture returns a function that patches the reset command function in a given module."""
     return mock_command("reset")
 
 
-@pytest.fixture
-def mock_commands_restore(mock_command):
-    """Fixture returns a function that patches the restore command function in a given module."""
-    return mock_command("restore")
-
-
 @pytest.fixture
 def mock_commands_signout(mock_command):
     """Fixture returns a function that patches the signout command function in a given module."""
     return mock_command("signout")
 
 
-@pytest.fixture
-def mock_commands_time(mock_command):
-    """Fixture returns a function that patches the time command function in a given module."""
-    return mock_command("time")
-
-
-@pytest.fixture
-def mock_commands_user(mock_command):
-    """Fixture returns a function that patches the user command function in a given module."""
-    return mock_command("user")
-
-
 @pytest.fixture
 def mock_google_CallGAMCommand(mock_module_name):
     """Fixture returns a function that patches the CallGAMCommand function from a given module."""