feat(user): get or refresh backup codes

Author: thekaveman

compiler_admin/commands/user/__init__.py

@@ -1,5 +1,6 @@
 import click
 
+from compiler_admin.commands.user.backupcodes import backupcodes
 from compiler_admin.commands.user.convert import convert
 from compiler_admin.commands.user.create import create
 from compiler_admin.commands.user.deactivate import deactivate
@@ -18,6 +19,7 @@ def user():
     pass
 
 
+user.add_command(backupcodes)
 user.add_command(convert)
 user.add_command(create)
 user.add_command(deactivate)

compiler_admin/commands/user/backupcodes.py

@@ -0,0 +1,24 @@
+import click
+
+from compiler_admin import RESULT_FAILURE
+from compiler_admin.services.google import (
+    get_backup_codes,
+    user_account_name,
+    user_exists,
+)
+
+
+@click.command()
+@click.argument("username")
+def backupcodes(username: str, **kwargs):
+    """
+    Get backup codes for the user, creating a new set if needed.
+    """
+    account = user_account_name(username)
+
+    if not user_exists(account):
+        click.echo(f"User does not exist: {account}")
+        raise SystemExit(RESULT_FAILURE)
+
+    backup_codes = get_backup_codes(account)
+    click.echo(backup_codes)

compiler_admin/services/google.py

@@ -77,6 +77,26 @@ def add_user_to_group(username: str, group: str) -> int:
     return CallGAMCommand(("user", username, "add", "groups", "member", group))
 
 
+def get_backup_codes(username: str) -> str:
+    if not user_exists(username):
+        print(f"User does not exist: {username}")
+        return ""
+
+    output = ""
+    command = ("user", username, "show", "backupcodes")
+    with NamedTemporaryFile("w+") as stdout:
+        CallGAMCommand(command, stdout=stdout.name, stderr="stdout")
+        output = "".join(stdout.readlines())
+
+    if "Show 0 Backup Verification Codes" in output:
+        command = ("user", username, "update", "backupcodes")
+        with NamedTemporaryFile("w+") as stdout:
+            CallGAMCommand(command, stdout=stdout.name, stderr="stdout")
+            output = "".join(stdout.readlines())
+
+    return output
+
+
 def move_user_ou(username: str, ou: str) -> int:
     """Move a user into a new OU."""
     return CallGAMCommand(("update", "ou", ou, "move", username))

tests/commands/user/test_backupcodes.py

@@ -0,0 +1,33 @@
+import pytest
+
+from compiler_admin import RESULT_FAILURE, RESULT_SUCCESS
+from compiler_admin.commands.user.backupcodes import backupcodes, __name__ as MODULE
+
+
+@pytest.fixture
+def mock_google_user_exists(mock_google_user_exists):
+    return mock_google_user_exists(MODULE)
+
+
+@pytest.fixture
+def mock_get_backup_codes(mocker):
+    return mocker.patch(f"{MODULE}.get_backup_codes")
+
+
+def test_backupcodes_user_does_not_exist(cli_runner, mock_google_user_exists, mock_get_backup_codes):
+    mock_google_user_exists.return_value = False
+
+    result = cli_runner.invoke(backupcodes, ["username"])
+
+    assert result.exit_code == RESULT_FAILURE
+    mock_get_backup_codes.assert_not_called()
+
+
+def test_backupcodes_user_exists(cli_runner, mock_google_user_exists, mock_get_backup_codes):
+    mock_google_user_exists.return_value = True
+    mock_get_backup_codes.return_value = "1234"
+
+    result = cli_runner.invoke(backupcodes, ["username"])
+
+    assert result.exit_code == RESULT_SUCCESS
+    mock_get_backup_codes.assert_called_once()

tests/commands/user/test_init.py

@@ -3,6 +3,8 @@
 from compiler_admin.commands.user import user
 
 
-@pytest.mark.parametrize("command", ["convert", "create", "deactivate", "delete", "offboard", "reset", "restore", "signout"])
+@pytest.mark.parametrize(
+    "command", ["backupcodes", "convert", "create", "deactivate", "delete", "offboard", "reset", "restore", "signout"]
+)
 def test_user_commands(command):
     assert command in user.commands