feat(user): guard reset with --force flag

same as delete etc.

Author: thekaveman

compiler_admin/commands/user/reset.py

@@ -26,6 +26,12 @@ def reset(args: Namespace) -> int:
         print(f"User does not exist: {account}")
         return RESULT_FAILURE
 
+    if getattr(args, "force", False) is False:
+        cont = input(f"Reset password for {account}? (Y/n)")
+        if not cont.lower().startswith("y"):
+            print("Aborting password reset.")
+            return RESULT_SUCCESS
+
     command = ("update", "user", account, "password", "random", "changepassword")
 
     notify = getattr(args, "notify", None)

compiler_admin/main.py

@@ -151,6 +151,7 @@ def setup_user_command(cmd_parsers: _SubParsersAction):
     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.")

tests/commands/user/test_reset.py

@@ -7,15 +7,29 @@
 
 
 @pytest.fixture
-def mock_google_user_exists(mock_google_user_exists):
-    return mock_google_user_exists(MODULE)
+def mock_input_yes(mock_input):
+    fix = mock_input(MODULE)
+    fix.return_value = "y"
+    return fix
+
+
+@pytest.fixture
+def mock_input_no(mock_input):
+    fix = mock_input(MODULE)
+    fix.return_value = "n"
+    return fix
 
 
 @pytest.fixture
 def mock_commands_signout(mock_commands_signout):
     return mock_commands_signout(MODULE)
 
 
+@pytest.fixture
+def mock_google_user_exists(mock_google_user_exists):
+    return mock_google_user_exists(MODULE)
+
+
 @pytest.fixture
 def mock_google_CallGAMCommand(mock_google_CallGAMCommand):
     return mock_google_CallGAMCommand(MODULE)
@@ -37,10 +51,34 @@ def test_reset_user_does_not_exist(mock_google_user_exists):
     assert res == RESULT_FAILURE
 
 
+@pytest.mark.usefixtures("mock_input_yes")
+def test_reset_confirm_yes(mock_google_user_exists, mock_google_CallGAMCommand, mock_commands_signout):
+    mock_google_user_exists.return_value = True
+
+    args = Namespace(username="username", force=False)
+    res = reset(args)
+
+    assert res == RESULT_SUCCESS
+    mock_google_CallGAMCommand.assert_called_once()
+    mock_commands_signout.assert_called_once_with(args)
+
+
+@pytest.mark.usefixtures("mock_input_no")
+def test_reset_confirm_no(mock_google_user_exists, mock_google_CallGAMCommand, mock_commands_signout):
+    mock_google_user_exists.return_value = True
+
+    args = Namespace(username="username", force=False)
+    res = reset(args)
+
+    assert res == RESULT_SUCCESS
+    mock_google_CallGAMCommand.assert_not_called()
+    mock_commands_signout.assert_not_called()
+
+
 def test_reset_user_exists(mock_google_user_exists, mock_google_CallGAMCommand, mock_commands_signout):
     mock_google_user_exists.return_value = True
 
-    args = Namespace(username="username")
+    args = Namespace(username="username", force=True)
     res = reset(args)
 
     assert res == RESULT_SUCCESS
@@ -56,7 +94,7 @@ def test_reset_user_exists(mock_google_user_exists, mock_google_CallGAMCommand,
 def test_reset_notify(mock_google_user_exists, mock_google_CallGAMCommand, mock_commands_signout):
     mock_google_user_exists.return_value = True
 
-    args = Namespace(username="username", notify="notification@example.com")
+    args = Namespace(username="username", notify="notification@example.com", force=True)
     res = reset(args)
 
     assert res == RESULT_SUCCESS

tests/test_main.py

@@ -394,7 +394,8 @@ def test_main_user_reset(mock_commands_user):
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
     assert (
-        Namespace(func=mock_commands_user, command="user", subcommand="reset", username="username", notify=None) in call_args
+        Namespace(func=mock_commands_user, command="user", subcommand="reset", username="username", force=False, notify=None)
+        in call_args
     )
 
 
@@ -404,7 +405,25 @@ def test_main_user_reset_notify(mock_commands_user):
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
     assert (
-        Namespace(func=mock_commands_user, command="user", subcommand="reset", username="username", notify="notification")
+        Namespace(
+            func=mock_commands_user,
+            command="user",
+            subcommand="reset",
+            username="username",
+            notify="notification",
+            force=False,
+        )
+        in call_args
+    )
+
+
+def test_main_user_reset_force(mock_commands_user):
+    main(argv=["user", "reset", "username", "--force"])
+
+    mock_commands_user.assert_called_once()
+    call_args = mock_commands_user.call_args.args
+    assert (
+        Namespace(func=mock_commands_user, command="user", subcommand="reset", username="username", force=True, notify=None)
         in call_args
     )