feat(commands/signout): confirm unless forced

Author: thekaveman

compiler_admin/commands/signout.py

@@ -21,6 +21,12 @@ def signout(args: Namespace) -> int:
         print(f"User does not exist: {account}")
         return RESULT_FAILURE
 
+    if getattr(args, "force", False) is False:
+        cont = input(f"Signout account {account} from all active sessions? (Y/n)")
+        if not cont.lower().startswith("y"):
+            print("Aborting signout.")
+            return RESULT_SUCCESS
+
     print(f"User exists, signing out from all active sessions: {account}")
 
     res = CallGAMCommand(("user", account, "signout"))

compiler_admin/main.py

@@ -62,7 +62,10 @@ def _subcmd(name, help, add_username_arg=True) -> argparse.ArgumentParser:
 
     _subcmd("restore", help="Restore an email backup from a prior offboarding.")
 
-    _subcmd("signout", help="Signs a user out from all active sessions.")
+    signout_parser = _subcmd("signout", help="Signs a user out from all active sessions.")
+    signout_parser.add_argument(
+        "--force", action="store_true", default=False, help="Don't ask for confirmation before signout."
+    )
 
     if len(argv) == 0:
         argv = ["info"]

tests/commands/test_signout.py

@@ -5,6 +5,20 @@
 from compiler_admin.commands.signout import signout, __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_google_user_exists(mock_google_user_exists):
     return mock_google_user_exists(MODULE)
@@ -22,7 +36,8 @@ def test_signout_user_username_required():
         signout(args)
 
 
-def test_signout_user_exists(mock_google_user_exists, mock_google_CallGAMCommand):
+@pytest.mark.usefixtures("mock_input_yes")
+def test_signout_confirm_yes(mock_google_user_exists, mock_google_CallGAMCommand):
     mock_google_user_exists.return_value = True
 
     args = Namespace(username="username")
@@ -34,11 +49,22 @@ def test_signout_user_exists(mock_google_user_exists, mock_google_CallGAMCommand
     assert "user" in call_args and "signout" in call_args
 
 
+@pytest.mark.usefixtures("mock_input_no")
+def test_signout_confirm_no(mock_google_user_exists, mock_google_CallGAMCommand):
+    mock_google_user_exists.return_value = True
+
+    args = Namespace(username="username")
+    res = signout(args)
+
+    assert res == RESULT_SUCCESS
+    mock_google_CallGAMCommand.assert_not_called()
+
+
 def test_signout_user_does_not_exist(mock_google_user_exists, mock_google_CallGAMCommand):
     mock_google_user_exists.return_value = False
 
     args = Namespace(username="username")
     res = signout(args)
 
     assert res == RESULT_FAILURE
-    assert mock_google_CallGAMCommand.call_count == 0
+    mock_google_CallGAMCommand.assert_not_called()

tests/test_main.py

@@ -196,7 +196,15 @@ def test_main_signout(mock_commands_signout):
 
     mock_commands_signout.assert_called_once()
     call_args = mock_commands_signout.call_args.args
-    assert Namespace(command="signout", username="username") in call_args
+    assert Namespace(command="signout", username="username", force=False) in call_args
+
+
+def test_main_signout_force(mock_commands_signout):
+    main(argv=["signout", "username", "--force"])
+
+    mock_commands_signout.assert_called_once()
+    call_args = mock_commands_signout.call_args.args
+    assert Namespace(command="signout", username="username", force=True) in call_args
 
 
 def test_main_signout_no_username(mock_commands_signout):