scripts: group.py: Add extra optional arg to specify uid

1 files changed, 71 insertions, 47 deletions

diff --git a/scripts/authentication/group.py b/scripts/authentication/group.py
index 460a6329..08652454 100755
--- a/scripts/authentication/group.py
+++ b/scripts/authentication/group.py
@@ -7,22 +7,40 @@ Assuming there are no groups and 'test@bonfacemunyoki.com' does not
 exist in Redis:
 
 .. code-block:: bash
-   python group.py -g "editors" -m "test@bonfacemunyoki.com"
+  python group.py -n "editors" \
+                  -m "me@bonfacemunyoki.com"
 
 results in::
 
-   Successfully created the group: 'editors'
-   Data: '{"admins": [], "members": []}'
+  Successfully created the group: 'editors'
+  `HGET groups 0360449f-5a96-4940-8522-b22d62085da9`: {'name': 'editors', 'admins': [], 'members': ['8ad942fe-490d-453e-bd37-56f252e41603'], 'changed_timestamp': 'Oct 19 2021 09:34AM', 'created_timestamp': 'Oct 19 2021 09:34AM'}
+  
 
-If 'me@bonfacemunyoki.com' exists in 'users' in Redis and we run:
+Assuming we have a group's unique id:
 
 .. code-block:: bash
-   python group.py -g "editors" -m "me@bonfacemunyoki.com"
+  python group.py -n "editors" \
+                  -m "me@bonfacemunyoki.com" \
+                  -g "8ad942fe-490d-453e-bd37-56f252e41603"
 
 now results in::
 
-   No new group was created.
-   Updated Data: {'admins': [], 'members': ['me@bonfacemunyoki.com']}
+  Successfully created the group: 'editors'
+  `HGET groups 8ad942fe-490d-453e-bd37-56f252e41603`: {'name': 'editors', 'admins': [], 'members': ['8ad942fe-490d-453e-bd37-56f252e41603'], 'changed_timestamp': 'Oct 19 2021 09:38AM', 'created_timestamp': 'Oct 19 2021 09:38AM'}
+  
+If 'me@bonfacemunyoki.com' exists in 'users' in Redis for the above
+command and we run:
+
+.. code-block:: bash
+  python group.py -n "editors" \
+                  -m "me@bonfacemunyoki.com" \
+                  -g "8ad942fe-490d-453e-bd37-56f252e41603"
+
+now results in::
+
+  No new group was created.
+  `HGET groups 8ad942fe-490d-453e-bd37-56f252e41603`: {'name': 'editors', 'admins': [], 'members': ['8ad942fe-490d-453e-bd37-56f252e41603'], 'changed_timestamp': 'Oct 19 2021 09:40AM'}
+
 
 """
 
@@ -37,44 +55,48 @@ from typing import Dict, Optional, Set
 
 def create_group_data(users: Dict, target_group: str,
                       members: Optional[str] = None,
-                      admins: Optional[str] = None) -> Dict:
-    """Return a dictionary that contains the following keys: "key",
-    "field", and "value" that can be used in a redis hash as follows:
-    HSET key field value
+                      admins: Optional[str] = None,
+                      group_id: Optional[str] = None) -> Dict:
+    """Create group data which is isomorphic to a redis HSET i.e.: KEY,
+    FIELD and VALUE.  If the group_id is not specified, a unique hash
+    will be generated.
 
     The "field" return value is a unique-id that is used to
     distinguish the groups.
 
-    Parameters:
-
-    - `users`: a list of users for example:
-
-    {'8ad942fe-490d-453e-bd37-56f252e41603':
-    '{"email_address": "me@test.com",
-      "full_name": "John Doe",
-      "organization": "Genenetwork",
-      "password": {"algorithm": "pbkdf2",
-                   "hashfunc": "sha256",
-                    "salt": "gJrd1HnPSSCmzB5veMPaVk2ozzDlS1Z7Ggcyl1+pciA=",
-                    "iterations": 100000, "keylength": 32,
-                    "created_timestamp": "2021-09-22T11:32:44.971912",
-                    "password": "edcdaa60e84526c6"},
-                    "user_id": "8ad942fe", "confirmed": 1,
-                    "registration_info": {
-                        "timestamp": "2021-09-22T11:32:45.028833",
-                        "ip_address": "127.0.0.1",
-                        "user_agent": "Mozilla/5.0"}}'}
-
-    - `target_group`: the group name that will be stored inside the
-      "groups" hash in Redis.
-
-    - `members`: a comma-separated list of values that contain members
-      of the `target_group` e.g. "me@test1.com, me@test2.com,
-      me@test3.com"
-
-    - `admins`: a comma-separated list of values that contain
-      administrators of the `target_group` e.g. "me@test1.com,
-      me@test2.com, me@test3.com"
+    Args:
+      - users: a list of users for example:
+      {'8ad942fe-490d-453e-bd37-56f252e41603':
+      '{"email_address": "me@test.com",
+        "full_name": "John Doe",
+        "organization": "Genenetwork",
+        "password": {"algorithm": "pbkdf2",
+                     "hashfunc": "sha256",
+                      "salt": "gJrd1HnPSSCmzB5veMPaVk2ozzDlS1Z7Ggcyl1+pciA=",
+                      "iterations": 100000, "keylength": 32,
+                      "created_timestamp": "2021-09-22T11:32:44.971912",
+                      "password": "edcdaa60e84526c6"},
+                      "user_id": "8ad942fe", "confirmed": 1,
+                      "registration_info": {
+                          "timestamp": "2021-09-22T11:32:45.028833",
+                          "ip_address": "127.0.0.1",
+                          "user_agent": "Mozilla/5.0"}}'}
+
+      - target_group: the group name that will be stored inside the
+        "groups" hash in Redis.
+      - members: an optional comma-separated list of values that
+        contain members of the `target_group` e.g. "me@test1.com,
+        me@test2.com, me@test3.com"
+      - admins: an optional comma-separated list of values that
+        contain administrators of the `target_group`
+        e.g. "me@test1.com, me@test2.com, me@test3.com"
+      - group_id: an optional unique identifier for a group. If not
+        set, a unique value will be auto-generated.
+
+    Returns:
+      A dictionary that contains the following keys: "key", "field",
+    and "value" that can be used in a redis hash as follows: HSET key
+    field value
 
     """
     # Emails
@@ -96,7 +118,7 @@ def create_group_data(users: Dict, target_group: str,
 
     timestamp: str = datetime.datetime.utcnow().strftime('%b %d %Y %I:%M%p')
     return {"key": "groups",
-            "field": str(uuid.uuid4()),
+            "field": (group_id or str(uuid.uuid4())),
             "value": json.dumps({
                 "name": target_group,
                 "admins": list(admin_ids),
@@ -108,8 +130,10 @@ def create_group_data(users: Dict, target_group: str,
 if __name__ == "__main__":
     # Initialising the parser CLI arguments
     parser = argparse.ArgumentParser()
-    parser.add_argument("-g", "--group-name",
+    parser.add_argument("-n", "--group-name",
                         help="This is the name of the GROUP mask")
+    parser.add_argument("-g", "--group-id",
+                        help="[Optional] This is the name of the GROUP mask")
     parser.add_argument("-m", "--members",
                         help="Members of the GROUP mask")
     parser.add_argument("-a", "--admins",
@@ -133,7 +157,8 @@ if __name__ == "__main__":
         users=USERS,
         target_group=args.group_name,
         members=members,
-        admins=admins)
+        admins=admins,
+        group_id=args.group_id)
 
     if not REDIS_CONN.hget("groups", data.get("field")):
         updated_data = json.loads(data["value"])
@@ -144,11 +169,10 @@ if __name__ == "__main__":
     created_p = REDIS_CONN.hset(data.get("key", ""),
                                 data.get("field", ""),
                                 data.get("value", ""))
-
     groups = json.loads(REDIS_CONN.hget("groups",
                                         data.get("field")))  # type: ignore
     if created_p:
         exit(f"\nSuccessfully created the group: '{args.group_name}'\n"
-             f"`HGETALL groups {args.group_name}`: {groups}\n")
+             f"`HGET groups {data.get('field')}`: {groups}\n")
     exit("\nNo new group was created.\n"
-         f"`HGETALL groups {args.group_name}`: {groups}\n")
+         f"`HGET groups {data.get('field')}`: {groups}\n")