feat(commands/offboard): confirm unless forced

Author: thekaveman

compiler_admin/commands/offboard.py

@@ -39,6 +39,12 @@ def offboard(args: Namespace) -> int:
         print(f"Alias target user does not exist: {alias_account}")
         return RESULT_FAILURE
 
+    if getattr(args, "force", False) is False:
+        cont = input(f"Offboard account {account} {' (assigning alias to '+ alias_account +')' if alias else ''}? (Y/n)")
+        if not cont.lower().startswith("y"):
+            print("Aborting offboard.")
+            return RESULT_SUCCESS
+
     print(f"User exists, offboarding: {account}")
     res = RESULT_SUCCESS
 

compiler_admin/main.py

@@ -56,6 +56,9 @@ def _subcmd(name, help, add_username_arg=True) -> argparse.ArgumentParser:
 
     offboard_parser = _subcmd("offboard", help="Offboard a user account.")
     offboard_parser.add_argument("--alias", help="Account to assign username as an alias.")
+    offboard_parser.add_argument(
+        "--force", action="store_true", default=False, help="Don't ask for confirmation before offboarding."
+    )
 
     _subcmd("restore", help="Restore an email backup from a prior offboarding.")
 

tests/commands/test_offboard.py

@@ -5,6 +5,20 @@
 from compiler_admin.commands.offboard import offboard, __name__ as MODULE
 
 
+@pytest.fixture
+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_NamedTemporaryFile(mock_NamedTemporaryFile):
     return mock_NamedTemporaryFile(MODULE, ["Overall Transfer Status: completed"])
@@ -42,7 +56,8 @@ def test_offboard_user_username_required():
         offboard(args)
 
 
-def test_offboard_user_exists(
+@pytest.mark.usefixtures("mock_input_yes")
+def test_offboard_confirm_yes(
     mock_google_user_exists,
     mock_google_CallGAMCommand,
     mock_google_CallGYBCommand,
@@ -64,6 +79,27 @@ def test_offboard_user_exists(
     mock_commands_delete.assert_called_once()
 
 
+@pytest.mark.usefixtures("mock_input_no")
+def test_offboard_confirm_no(
+    mock_google_user_exists,
+    mock_google_CallGAMCommand,
+    mock_google_CallGYBCommand,
+    mock_commands_signout,
+    mock_commands_delete,
+):
+    mock_google_user_exists.return_value = True
+
+    args = Namespace(username="username")
+    res = offboard(args)
+
+    assert res == RESULT_SUCCESS
+    mock_google_CallGAMCommand.assert_not_called()
+    mock_google_CallGYBCommand.assert_not_called()
+
+    mock_commands_signout.assert_not_called()
+    mock_commands_delete.assert_not_called()
+
+
 def test_offboard_user_does_not_exist(mock_google_user_exists, mock_google_CallGAMCommand):
     mock_google_user_exists.return_value = False
 

tests/test_main.py

@@ -152,15 +152,23 @@ def test_main_offboard(mock_commands_offboard):
 
     mock_commands_offboard.assert_called_once()
     call_args = mock_commands_offboard.call_args.args
-    assert Namespace(command="offboard", username="username", alias=None) in call_args
+    assert Namespace(command="offboard", username="username", alias=None, force=False) in call_args
+
+
+def test_main_offboard_force(mock_commands_offboard):
+    main(argv=["offboard", "username", "--force"])
+
+    mock_commands_offboard.assert_called_once()
+    call_args = mock_commands_offboard.call_args.args
+    assert Namespace(command="offboard", username="username", alias=None, force=True) in call_args
 
 
 def test_main_offboard_with_alias(mock_commands_offboard):
     main(argv=["offboard", "username", "--alias", "anotheruser"])
 
     mock_commands_offboard.assert_called_once()
     call_args = mock_commands_offboard.call_args.args
-    assert Namespace(command="offboard", username="username", alias="anotheruser") in call_args
+    assert Namespace(command="offboard", username="username", alias="anotheruser", force=False) in call_args
 
 
 def test_main_offboard_no_username(mock_commands_offboard):