refactor(main): set function to call for command

avoids matching on string names, simplifies adding new commands

Author: thekaveman

compiler_admin/commands/info.py

@@ -2,7 +2,7 @@
 from compiler_admin.services.google import CallGAMCommand, CallGYBCommand
 
 
-def info() -> int:
+def info(*args, **kwargs) -> int:
     """Print information about this package and the GAM environment.
 
     Returns:

compiler_admin/commands/init.py

@@ -22,7 +22,7 @@ def _clean_config_dir(config_dir: Path) -> None:
             rmtree(path)
 
 
-def init(args: Namespace) -> int:
+def init(args: Namespace, *extras) -> int:
     """Initialize a new GAM project.
 
     See https://github.com/taers232c/GAMADV-XTD3/wiki/How-to-Install-Advanced-GAM

compiler_admin/main.py

@@ -37,15 +37,18 @@ def main(argv=None):
 
     cmd_parsers = parser.add_subparsers(dest="command", help="The command to run")
 
-    cmd_parsers.add_parser("info", help="Print configuration and debugging information.")
+    info_cmd = add_sub_cmd(cmd_parsers, "info", help="Print configuration and debugging information.")
+    info_cmd.set_defaults(func=info)
 
     init_cmd = add_sub_cmd_username(
         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)
 
     user_cmd = add_sub_cmd(cmd_parsers, "user", help="Work with users in the Compiler org.")
+    user_cmd.set_defaults(func=user)
     user_subcmds = user_cmd.add_subparsers(dest="subcommand", help="The user command to run.")
 
     user_create = add_sub_cmd_username(user_subcmds, "create", help="Create a new user in the Compiler domain.")
@@ -78,12 +81,10 @@ def main(argv=None):
 
     args, extra = parser.parse_known_args(argv)
 
-    if args.command == "info":
-        return info()
-    if args.command == "init":
-        return init(args)
-    elif args.command == "user":
-        return user(args, *extra)
+    if args.func:
+        return args.func(args, *extra)
+    else:
+        raise ValueError("Unrecognized command")
 
 
 if __name__ == "__main__":

tests/test_main.py

@@ -28,23 +28,30 @@ def test_main_user_create(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="create", username="username", notify=None) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="create", username="username", notify=None) in call_args
+    )
 
 
 def test_main_user_create_notify(mock_commands_user):
     main(argv=["user", "create", "username", "--notify", "notification"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="create", username="username", notify="notification") in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="create", username="username", notify="notification")
+        in call_args
+    )
 
 
 def test_main_user_create_extras(mock_commands_user):
     main(argv=["user", "create", "username", "extra1", "extra2"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="create", username="username", notify=None) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="create", username="username", notify=None) in call_args
+    )
     assert "extra1" in call_args
     assert "extra2" in call_args
 
@@ -60,7 +67,12 @@ def test_main_user_convert(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="convert", username="username", account_type="contractor") in call_args
+    assert (
+        Namespace(
+            func=mock_commands_user, command="user", subcommand="convert", username="username", account_type="contractor"
+        )
+        in call_args
+    )
 
 
 def test_main_user_convert_no_username(mock_commands_user):
@@ -80,15 +92,19 @@ def test_main_user_delete(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="delete", username="username", force=False) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="delete", username="username", force=False) in call_args
+    )
 
 
 def test_main_user_delete_force(mock_commands_user):
     main(argv=["user", "delete", "username", "--force"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="delete", username="username", force=True) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="delete", username="username", force=True) in call_args
+    )
 
 
 def test_main_user_delete_no_username(mock_commands_user):
@@ -114,23 +130,23 @@ def test_main_init_default(mock_commands_init):
 
     mock_commands_init.assert_called_once()
     call_args = mock_commands_init.call_args.args
-    assert Namespace(command="init", username="username", gam=False, gyb=False) in call_args
+    assert Namespace(func=mock_commands_init, command="init", username="username", gam=False, gyb=False) in call_args
 
 
 def test_main_init_gam(mock_commands_init):
     main(argv=["init", "username", "--gam"])
 
     mock_commands_init.assert_called_once()
     call_args = mock_commands_init.call_args.args
-    assert Namespace(command="init", username="username", gam=True, gyb=False) in call_args
+    assert Namespace(func=mock_commands_init, command="init", username="username", gam=True, gyb=False) in call_args
 
 
 def test_main_init_gyb(mock_commands_init):
     main(argv=["init", "username", "--gyb"])
 
     mock_commands_init.assert_called_once()
     call_args = mock_commands_init.call_args.args
-    assert Namespace(command="init", username="username", gam=False, gyb=True) in call_args
+    assert Namespace(func=mock_commands_init, command="init", username="username", gam=False, gyb=True) in call_args
 
 
 def test_main_init_no_username(mock_commands_init):
@@ -144,23 +160,39 @@ def test_main_user_offboard(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="offboard", username="username", alias=None, force=False) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="offboard", username="username", alias=None, force=False)
+        in call_args
+    )
 
 
 def test_main_user_offboard_force(mock_commands_user):
     main(argv=["user", "offboard", "username", "--force"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="offboard", username="username", alias=None, force=True) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="offboard", username="username", alias=None, force=True)
+        in call_args
+    )
 
 
 def test_main_user_offboard_with_alias(mock_commands_user):
     main(argv=["user", "offboard", "username", "--alias", "anotheruser"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="offboard", username="username", alias="anotheruser", force=False) in call_args
+    assert (
+        Namespace(
+            func=mock_commands_user,
+            command="user",
+            subcommand="offboard",
+            username="username",
+            alias="anotheruser",
+            force=False,
+        )
+        in call_args
+    )
 
 
 def test_main_user_offboard_no_username(mock_commands_user):
@@ -174,15 +206,23 @@ def test_main_user_reset_password(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="reset-password", username="username", notify=None) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="reset-password", username="username", notify=None)
+        in call_args
+    )
 
 
 def test_main_user_reset_password_notify(mock_commands_user):
     main(argv=["user", "reset-password", "username", "--notify", "notification"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="reset-password", username="username", notify="notification") in call_args
+    assert (
+        Namespace(
+            func=mock_commands_user, command="user", subcommand="reset-password", username="username", notify="notification"
+        )
+        in call_args
+    )
 
 
 def test_main_user_reset_password_no_username(mock_commands_user):
@@ -196,7 +236,7 @@ def test_main_user_restore(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="restore", username="username") in call_args
+    assert Namespace(func=mock_commands_user, command="user", subcommand="restore", username="username") in call_args
 
 
 def test_main_user_restore_no_username(mock_commands_user):
@@ -210,15 +250,19 @@ def test_main_user_signout(mock_commands_user):
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="signout", username="username", force=False) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="signout", username="username", force=False) in call_args
+    )
 
 
 def test_main_user_signout_force(mock_commands_user):
     main(argv=["user", "signout", "username", "--force"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
-    assert Namespace(command="user", subcommand="signout", username="username", force=True) in call_args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="signout", username="username", force=True) in call_args
+    )
 
 
 def test_main_user_signout_no_username(mock_commands_user):