F convenient admin

Summary

This MR adds a few convenience features to caosdb_admin:

• Allow activating users directly after creation.
• Allow setting a password on the command line.

This is important for allowing automated scripts to batch generate passwords and users.

Focus

I updated the documentation in argparse and hope that it matches the programming logic exactly. Please check.

Test Environment

Just check out this branch and create a user in an instance of your choice, e.g. using: python3 -m caosdb.utils.caosdb_admin create_user username email password

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related Issues
• Up-to-date CHANGELOG.md
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosdb/utils/caosdb_admin.py

@@ -116,13 +116,15 @@ def _promt_for_pw():
 
 
 def do_create_user(args):
-    password = None
+    password = args.user_password
 
     if args.ask_password is True:
         password = _promt_for_pw()
     try:
         admin._insert_user(name=args.user_name,
                            email=args.user_email, password=password)
+        if args.activate_user:
+            do_activate_user(args)
     except HTTPClientError as e:
         print(e.msg)
 
@@ -136,7 +138,10 @@ def do_deactivate_user(args):
 
 
 def do_set_user_password(args):
-    password = _promt_for_pw()
+    if args.user_password is None:
+        password = _promt_for_pw()
+    else:
+        password = args.user_password
     admin._update_user(name=args.user_name, password=password)
 
 
@@ -305,6 +310,8 @@ USAGE
     subparser.set_defaults(call=do_create_user)
     subparser.add_argument("-a", "--ask-password",
                            help="Prompt for a password.", action="store_true")
+    subparser.add_argument("-c", "--activate-user",
+                           help="Activate the user after creation.", action="store_true")
     subparser.add_argument(
         metavar='USERNAME',
         dest="user_name",
@@ -314,6 +321,12 @@ USAGE
         nargs='?',
         dest="user_email",
         help="The email address of the new user.")
+    subparser.add_argument(
+        metavar='PASSWORD',
+        nargs="?",
+        dest="user_password",
+        default=None,
+        help="The new user's password. This is overwritten by the -a option.")
 
     subparser = subparsers.add_parser(
         "activate_user", help="(Re-)activate an inactive (but existing) user.")
@@ -331,12 +344,18 @@ USAGE
 
     subparser = subparsers.add_parser(
         "set_user_password",
-        help="Set a new password for a user. The password is not to be given on the command line for security reasons. You will be prompted for the password.")
+        help="Set a new password for a user. You will be prompted for the password if PASSWORD is not given.")
     subparser.set_defaults(call=do_set_user_password)
     subparser.add_argument(
         metavar='USERNAME',
         dest="user_name",
         help="The name of the user who's password is to be set.")
+    subparser.add_argument(
+        metavar='PASSWORD',
+        nargs="?",
+        dest="user_password",
+        default=None,
+        help="The user's new password.")
 
     subparser = subparsers.add_parser(
         "set_user_entity",

[Alexander Schlemmer]

Please have a closer look at the logic: I think in this new implementation, giving a password is required. If it's not given on the command line, the program will ask for it. Is this the desired behaviour?