Feat: option to notify on account creation (#16)

Author: thekaveman

README.md

@@ -64,13 +64,14 @@ Additionally, GYB is used for Gmail backup/restore. See the [GYB Wiki](https://g
 
 ```bash
 $ compiler-admin create -h
-usage: compiler-admin create [-h] username [OPTIONS]
+usage: compiler-admin create [-h] [--notify NOTIFY] username
 
 positional arguments:
-  username    The user's account name, sans domain.
+  username         A Compiler user account name, sans domain.
 
 options:
-  -h, --help  show this help message and exit
+  -h, --help       show this help message and exit
+  --notify NOTIFY  An email address to send the newly created account info.
 ```
 
 Additional options are passed through to GAM, see more about [GAM user create](https://github.com/taers232c/GAMADV-XTD3/wiki/Users#create-a-user)

compiler_admin/commands/create.py

@@ -30,7 +30,15 @@ def create(args: Namespace, *extra: Sequence[str]) -> int:
 
     print(f"User does not exist, continuing: {account}")
 
-    res = CallGAMCommand(("create", "user", account, "password", "random", "changepassword", *extra))
+    command = ("create", "user", account, "password", "random", "changepassword")
+
+    notify = getattr(args, "notify", None)
+    if notify:
+        command += ("notify", notify, "from", "[email protected]")
+
+    command += (*extra,)
+
+    res = CallGAMCommand(command)
 
     res += add_user_to_group(account, GROUP_TEAM)
 

compiler_admin/main.py

@@ -43,7 +43,8 @@ def _subcmd(name, help, add_username_arg=True) -> argparse.ArgumentParser:
     init_parser.add_argument("--gam", action="store_true", help="If provided, initialize a new GAM project.")
     init_parser.add_argument("--gyb", action="store_true", help="If provided, initialize a new GYB project.")
 
-    _subcmd("create", help="Create a new user in the Compiler domain.")
+    create_parser = _subcmd("create", help="Create a new user in the Compiler domain.")
+    create_parser.add_argument("--notify", help="An email address to send the newly created account info.")
 
     convert_parser = _subcmd("convert", help="Convert a user account to a new type.")
     convert_parser.add_argument(

tests/commands/test_create.py

@@ -3,6 +3,7 @@
 
 from compiler_admin.commands import RESULT_FAILURE, RESULT_SUCCESS
 from compiler_admin.commands.create import create, __name__ as MODULE
+from compiler_admin.services.google import USER_HELLO
 
 
 @pytest.fixture
@@ -50,3 +51,37 @@ def test_create_user_does_not_exists(mock_google_user_exists, mock_google_CallGA
     assert "password random changepassword" in call_args
 
     mock_google_add_user_to_group.assert_called_once()
+
+
+def test_create_user_notify(mock_google_user_exists, mock_google_CallGAMCommand, mock_google_add_user_to_group):
+    mock_google_user_exists.return_value = False
+
+    args = Namespace(username="username", notify="[email protected]")
+    res = create(args)
+
+    assert res == RESULT_SUCCESS
+
+    mock_google_CallGAMCommand.assert_called_once()
+    call_args = " ".join(mock_google_CallGAMCommand.call_args[0][0])
+    assert "create user" in call_args
+    assert "password random changepassword" in call_args
+    assert f"notify [email protected] from {USER_HELLO}" in call_args
+
+    mock_google_add_user_to_group.assert_called_once()
+
+
+def test_create_user_extras(mock_google_user_exists, mock_google_CallGAMCommand, mock_google_add_user_to_group):
+    mock_google_user_exists.return_value = False
+
+    args = Namespace(username="username")
+    res = create(args, "extra1", "extra2")
+
+    assert res == RESULT_SUCCESS
+
+    mock_google_CallGAMCommand.assert_called_once()
+    call_args = " ".join(mock_google_CallGAMCommand.call_args[0][0])
+    assert "create user" in call_args
+    assert "password random changepassword" in call_args
+    assert "extra1 extra2" in call_args
+
+    mock_google_add_user_to_group.assert_called_once()

tests/test_main.py

@@ -59,7 +59,25 @@ def test_main_create(mock_commands_create):
 
     mock_commands_create.assert_called_once()
     call_args = mock_commands_create.call_args.args
-    assert Namespace(command="create", username="username") in call_args
+    assert Namespace(command="create", username="username", notify=None) in call_args
+
+
+def test_main_create_notify(mock_commands_create):
+    main(argv=["create", "username", "--notify", "notification"])
+
+    mock_commands_create.assert_called_once()
+    call_args = mock_commands_create.call_args.args
+    assert Namespace(command="create", username="username", notify="notification") in call_args
+
+
+def test_main_create_extras(mock_commands_create):
+    main(argv=["create", "username", "extra1", "extra2"])
+
+    mock_commands_create.assert_called_once()
+    call_args = mock_commands_create.call_args.args
+    assert Namespace(command="create", username="username", notify=None) in call_args
+    assert "extra1" in call_args
+    assert "extra2" in call_args
 
 
 def test_main_create_no_username(mock_commands_create):