Create users with CLI arguments (piccolo-orm#231)

* added CLI arguments to 'user create' command

* added unit test for creating users with cli arguments

* fixed lint issues

* update `piccolo user create` docs

* ignore mypy error

Co-authored-by: Daniel Townsend <[email protected]>

Author: AliSayyah

docs/src/piccolo/authentication/baseuser.rst

@@ -26,12 +26,23 @@ The app comes with some useful commands.
 user create
 ~~~~~~~~~~~
 
-Create a new user.
+Creates a new user. It presents an interactive prompt, asking for the username,
+password etc.
 
 .. code-block:: bash
 
     piccolo user create
 
+If you'd prefer to create a user without the interactive prompt (perhaps in a
+script), you can pass all of the arguments in as follows:
+
+.. code-block:: bash
+
+    piccolo user create --username=bob --password=bob123 [email protected]  --is_admin=t --is_superuser=t --is_active=t
+
+If you choose this approach then be careful, as the password will be in the
+shell's history.
+
 user change_password
 ~~~~~~~~~~~~~~~~~~~~
 

piccolo/apps/user/commands/create.py

@@ -1,4 +1,5 @@
 import sys
+import typing as t
 from getpass import getpass, getuser
 
 from piccolo.apps.user.tables import BaseUser
@@ -55,24 +56,32 @@ def get_is_active() -> bool:
     return active == "y"
 
 
-def create():
+def create(
+    username: t.Optional[str] = None,
+    email: t.Optional[str] = None,
+    password: t.Optional[str] = None,
+    is_admin: t.Optional[bool] = None,
+    is_superuser: t.Optional[bool] = None,
+    is_active: t.Optional[bool] = None,
+):
     """
     Create a new user.
     """
-    username = get_username()
-    email = get_email()
-    password = get_password()
-    confirmed_password = get_confirmed_password()
+    username = get_username() if username is None else username
+    email = get_email() if email is None else email
+    if password is None:
+        password = get_password()
+        confirmed_password = get_confirmed_password()
 
-    if not password == confirmed_password:
-        sys.exit("Passwords don't match!")
+        if not password == confirmed_password:
+            sys.exit("Passwords don't match!")
 
     if len(password) < 4:
         sys.exit("The password is too short")
 
-    is_admin = get_is_admin()
-    is_superuser = get_is_superuser()
-    is_active = get_is_active()
+    is_admin = get_is_admin() if is_admin is None else is_admin
+    is_superuser = get_is_superuser() if is_superuser is None else is_superuser
+    is_active = get_is_active() if is_active is None else is_active
 
     user = BaseUser(
         username=username,
@@ -84,4 +93,4 @@ def create():
     )
     user.save().run_sync()
 
-    print(f"Created User {user.id}")
+    print(f"Created User {user.id}")  # type: ignore

tests/apps/user/commands/test_create.py

@@ -54,3 +54,26 @@ def test_create(self, *args, **kwargs):
             )
             .run_sync()
         )
+
+    def test_create_with_arguments(self, *args, **kwargs):
+        arguments = {
+            "username": "bob123",
+            "email": "[email protected]",
+            "password": "password123",
+            "is_admin": True,
+            "is_superuser": True,
+            "is_active": True,
+        }
+        create(**arguments)
+
+        self.assertTrue(
+            BaseUser.exists()
+            .where(
+                (BaseUser.admin == True)  # noqa: E712
+                & (BaseUser.username == "bob123")
+                & (BaseUser.email == "[email protected]")
+                & (BaseUser.superuser == True)
+                & (BaseUser.active == True)
+            )
+            .run_sync()
+        )