feat(offboard): make delete optional

Author: thekaveman

compiler_admin/commands/user/offboard.py

@@ -16,19 +16,16 @@
 
 @click.command()
 @click.option("-a", "--alias", help="Another account to assign username as an alias.")
+@click.option("-d", "--delete", "_delete", is_flag=True, help="Also delete the account.")
 @click.option("-f", "--force", is_flag=True, help="Don't ask for confirmation.")
 @click.option("-n", "--notify", help="An email address to send the new password notification.")
 @click.argument("username")
 @click.pass_context
-def offboard(ctx: click.Context, username: str, alias: str = "", force: bool = False, **kwargs):
-    """Fully offboard a user from Compiler.
-
-    Args:
-        username (str): The user account to offboard.
+def offboard(ctx: click.Context, username: str, alias: str = "", _delete: bool = False, force: bool = False, **kwargs):
+    """
+    Fully offboard a user from Compiler.
 
-        alias (str): [Optional] account to assign username as an alias
-    Returns:
-        A value indicating if the operation succeeded or failed.
+    Deactivate, back up email, transfer Calendar/Drive, and optionally delete.
     """
     account = user_account_name(username)
 
@@ -65,11 +62,14 @@ def offboard(ctx: click.Context, username: str, alias: str = "", force: bool = F
             CallGAMCommand(("show", "transfers", "olduser", username), stdout=stdout.name, stderr="stdout")
             status = " ".join(stdout.readlines())
             stdout.seek(0)
+        click.echo("Transfer complete")
 
+    click.echo("Deprovisioning POP/IMAP")
     CallGAMCommand(("user", account, "deprovision", "popimap"))
 
     # call the delete command
-    ctx.forward(delete)
+    if _delete:
+        ctx.forward(delete)
 
     if alias_account:
         click.echo(f"Adding an alias to account: {alias_account}")

tests/commands/user/test_offboard.py

@@ -45,6 +45,7 @@ def mock_google_CallGYBCommand(mock_google_CallGYBCommand):
 
 
 @pytest.mark.usefixtures("mock_input_yes")
+@pytest.mark.parametrize("should_delete", [True, False])
 def test_offboard_confirm_yes(
     cli_runner,
     mock_google_user_exists,
@@ -53,18 +54,27 @@ def test_offboard_confirm_yes(
     mock_NamedTemporaryFile,
     mock_commands_deactivate,
     mock_commands_delete,
+    should_delete,
 ):
     mock_google_user_exists.return_value = True
 
-    result = cli_runner.invoke(offboard, ["username"])
+    args = ["username"]
+    if should_delete:
+        args.append("--delete")
+
+    result = cli_runner.invoke(offboard, args)
 
     assert result.exit_code == RESULT_SUCCESS
     assert mock_google_CallGAMCommand.call_count > 0
     mock_google_CallGYBCommand.assert_called_once()
     mock_NamedTemporaryFile.assert_called_once()
 
     mock_commands_deactivate.callback.assert_called_once()
-    mock_commands_delete.callback.assert_called_once()
+
+    if should_delete:
+        mock_commands_delete.callback.assert_called_once()
+    else:
+        mock_commands_delete.callback.assert_not_called()
 
 
 @pytest.mark.usefixtures("mock_input_no")