fix(user): rename reset password command/function

the implementation expects command name and function name to match
for the auto-discovery to work

previously we had 'reset-password' as the command name
and 'reset_password' as the function name

this normalizes them both to 'reset'

Author: thekaveman

README.md

@@ -114,16 +114,16 @@ The following commands are available to work with users in the Compiler domain:
 
 ```bash
 $ compiler-admin user -h
-usage: compiler-admin user [-h] {create,convert,delete,offboard,reset-password,restore,signout} ...
+usage: compiler-admin user [-h] {create,convert,delete,offboard,reset,restore,signout} ...
 
 positional arguments:
-  {create,convert,delete,offboard,reset-password,restore,signout}
+  {create,convert,delete,offboard,reset,restore,signout}
                         The user command to run.
     create              Create a new user in the Compiler domain.
     convert             Convert a user account to a new type.
     delete              Delete a user account.
     offboard            Offboard a user account.
-    reset-password      Reset a user's password to a randomly generated string.
+    reset               Reset a user's password to a randomly generated string.
     restore             Restore an email backup from a prior offboarding.
     signout             Signs a user out from all active sessions.
 

compiler_admin/commands/user/__init__.py

@@ -4,7 +4,7 @@
 from compiler_admin.commands.user.convert import convert  # noqa: F401
 from compiler_admin.commands.user.delete import delete  # noqa: F401
 from compiler_admin.commands.user.offboard import offboard  # noqa: F401
-from compiler_admin.commands.user.reset_password import reset_password  # noqa: F401
+from compiler_admin.commands.user.reset import reset  # noqa: F401
 from compiler_admin.commands.user.restore import restore  # noqa: F401
 from compiler_admin.commands.user.signout import signout  # noqa: F401
 

compiler_admin/commands/user/reset_password.py renamed to compiler_admin/commands/user/reset.py

@@ -5,7 +5,7 @@
 from compiler_admin.services.google import USER_HELLO, CallGAMCommand, user_account_name, user_exists
 
 
-def reset_password(args: Namespace) -> int:
+def reset(args: Namespace) -> int:
     """Reset a user's password.
 
     Optionally notify an email address with the new randomly generated password.

compiler_admin/main.py

@@ -149,7 +149,7 @@ def setup_user_command(cmd_parsers: _SubParsersAction):
     )
 
     user_reset = add_sub_cmd_with_username_arg(
-        user_subcmds, "reset-password", help="Reset a user's password to a randomly generated string."
+        user_subcmds, "reset", help="Reset a user's password to a randomly generated string."
     )
     user_reset.add_argument("--notify", help="An email address to send the newly generated password.")
 

tests/commands/user/test_reset_password.py renamed to tests/commands/user/test_reset.py

@@ -2,7 +2,7 @@
 import pytest
 
 from compiler_admin import RESULT_FAILURE, RESULT_SUCCESS
-from compiler_admin.commands.user.reset_password import reset_password, __name__ as MODULE
+from compiler_admin.commands.user.reset import reset, __name__ as MODULE
 from compiler_admin.services.google import USER_HELLO
 
 
@@ -21,27 +21,27 @@ def mock_google_CallGAMCommand(mock_google_CallGAMCommand):
     return mock_google_CallGAMCommand(MODULE)
 
 
-def test_reset_password_user_username_required():
+def test_reset_user_username_required():
     args = Namespace()
 
     with pytest.raises(ValueError, match="username is required"):
-        reset_password(args)
+        reset(args)
 
 
-def test_reset_password_user_does_not_exist(mock_google_user_exists):
+def test_reset_user_does_not_exist(mock_google_user_exists):
     mock_google_user_exists.return_value = False
 
     args = Namespace(username="username")
-    res = reset_password(args)
+    res = reset(args)
 
     assert res == RESULT_FAILURE
 
 
-def test_reset_password_user_exists(mock_google_user_exists, mock_google_CallGAMCommand, mock_commands_signout):
+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")
-    res = reset_password(args)
+    res = reset(args)
 
     assert res == RESULT_SUCCESS
 
@@ -53,11 +53,11 @@ def test_reset_password_user_exists(mock_google_user_exists, mock_google_CallGAM
     mock_commands_signout.assert_called_once_with(args)
 
 
-def test_reset_password_notify(mock_google_user_exists, mock_google_CallGAMCommand, mock_commands_signout):
+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="[email protected]")
-    res = reset_password(args)
+    res = reset(args)
 
     assert res == RESULT_SUCCESS
 

tests/conftest.py

@@ -70,9 +70,9 @@ def mock_commands_offboard(mock_module_name):
 
 
 @pytest.fixture
-def mock_commands_reset_password(mock_module_name):
-    """Fixture returns a function that patches the reset_password command function in a given module."""
-    return mock_module_name("reset_password")
+def mock_commands_reset(mock_module_name):
+    """Fixture returns a function that patches the reset command function in a given module."""
+    return mock_module_name("reset")
 
 
 @pytest.fixture

tests/test_main.py

@@ -388,33 +388,30 @@ def test_main_user_offboard_no_username(mock_commands_user):
         assert mock_commands_user.call_count == 0
 
 
-def test_main_user_reset_password(mock_commands_user):
-    main(argv=["user", "reset-password", "username"])
+def test_main_user_reset(mock_commands_user):
+    main(argv=["user", "reset", "username"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
     assert (
-        Namespace(func=mock_commands_user, command="user", subcommand="reset-password", username="username", notify=None)
-        in call_args
+        Namespace(func=mock_commands_user, command="user", subcommand="reset", username="username", notify=None) in call_args
     )
 
 
-def test_main_user_reset_password_notify(mock_commands_user):
-    main(argv=["user", "reset-password", "username", "--notify", "notification"])
+def test_main_user_reset_notify(mock_commands_user):
+    main(argv=["user", "reset", "username", "--notify", "notification"])
 
     mock_commands_user.assert_called_once()
     call_args = mock_commands_user.call_args.args
     assert (
-        Namespace(
-            func=mock_commands_user, command="user", subcommand="reset-password", username="username", notify="notification"
-        )
+        Namespace(func=mock_commands_user, command="user", subcommand="reset", username="username", notify="notification")
         in call_args
     )
 
 
-def test_main_user_reset_password_no_username(mock_commands_user):
+def test_main_user_reset_no_username(mock_commands_user):
     with pytest.raises(SystemExit):
-        main(argv=["user", "reset-password"])
+        main(argv=["user", "reset"])
         assert mock_commands_user.call_count == 0