YDA-6976 - Added script for SRAM migration

kaur16 · kaur16 · commit 73ac30e7b672 · 2026-05-28T15:08:06.000+02:00
diff --git a/groups.py b/groups.py
@@ -39,7 +39,8 @@
            'api_group_get_user_role',
            'api_group_remove_user_from_group',
            'rule_group_sram_sync',
-           'rule_external_users_sram_sync']
+           'rule_external_users_sram_sync',
+           'rule_sram_migration']
 
 
 def get_groups_data(ctx: rule.Context) -> Iterable[Any]:
@@ -1376,23 +1377,105 @@ def rule_external_users_sram_sync(ctx: rule.Context) -> None:
         group_name = group["name"]
         members = group['members'] + group['read'] + group['managers']
         invited = group['invited']
+        co_identifier = sram.get_co_identifier(ctx, group_name)
+        sram_co = group['sram_co']
+
+        if not co_identifier and sram_co:
+            log.write(ctx, f"Sync members of group {group_name} with SRAM external users CO")
+
+            for member in members:
+                # Check if member has valid email and is an external user.
+                username, _ = user.from_str(ctx, member)
+                if yoda_names.is_email_username(username) and not yoda_names.is_internal_user(username):
+                    # Remove invitation metadata if user is member of the external users CO.
+                    if username in co_members and member in invited:
+                        log.write(ctx, f"User {username} is member of group {group_name}, removing invitation metadata")
+                        if sram.is_user_marked_invited(ctx, username, group_name):
+                            msi.sudo_obj_meta_remove(ctx, member, "-u", "", constants.UUORGMETADATAPREFIX + "sram_invited", group_name, "", "")
+                    # Put invite and add invitation metadata if user is not member of the external users CO.
+                    elif username not in co_members and member not in invited:
+                        sram.put_collaboration_invitation(ctx, group_name, username, config.sram_external_users_co)
+                        if not sram.is_user_marked_invited(ctx, username, group_name):
+                            msi.sudo_obj_meta_add(ctx, member, "-u", constants.UUORGMETADATAPREFIX + "sram_invited", group_name, "", "")
+                        log.write(ctx, f"User {username} invited to group {group_name}")
 
-        log.write(ctx, f"Sync members of group {group_name} with SRAM external users CO")
+    log.write(ctx, "Finished syncing external users with SRAM")
+
+
+@rule.make(inputs=[0, 1, 2, 3])
+def rule_sram_migration(ctx: rule.Context, log_file: bool, dry_run:bool, convert_group: str, group_name: str) -> None:
+    """ Migrate existing groups to SRAM or non-SRAM group.
+
+    :param ctx:             Combined type of a ctx and rei struct
+    :param log_file:        If True, the log file will be generated at /var/lib/irods/log/sram-migration.log
+    :param dry_run:         If True, the migration will run all the steps without making the changes.
+    :param convert_group:   Convert group to either 'SRAM' or 'non-SRAM' group.
+    :param group_name:      Name of the group to be migrated
+    """
+    
+
+    if not user.is_rodsadmin(ctx):
+        log.write(ctx, "SRAM migration requires rodsadmin privileges")
+        return
+
+    if not config.enable_sram:
+        log.write(ctx, "SRAM needs to be enabled to migrate existing group")
+        return
+    
+    if not config.sram_external_users_co:
+        log.write(ctx, "SRAM external user CO needs to be configured for migration")
+        return
+    
+    # Get group data
+    group = get_group_data(ctx, group_name)
+    
+    # Get SRAM related metadata
+    co_identifier = sram.get_co_identifier(ctx, group_name)
+    sram_co = group['sram_co']
+
+    # Migrating SRAM to non-SRAM group
+    if convert_group == 'non-sram':
+        # Get external users CO members from SRAM
+        try:
+            co_members = [member['email'] for member in sram.get_co_members(ctx, config.sram_external_users_co)]
+        except Exception as e:
+            log.write(ctx, f"Migration failed during fetch: {e}")
+
+        # Check if external user exists in the group
+        members = group['members'] + group['read'] + group['managers']
 
         for member in members:
-            # Check if member has valid email and is an external user.
             username, _ = user.from_str(ctx, member)
             if yoda_names.is_email_username(username) and not yoda_names.is_internal_user(username):
-                # Remove invitation metadata if user is member of the external users CO.
-                if username in co_members and member in invited:
-                    log.write(ctx, f"User {username} is member of group {group_name}, removing invitation metadata")
-                    if sram.is_user_marked_invited(ctx, username, group_name):
-                        msi.sudo_obj_meta_remove(ctx, member, "-u", "", constants.UUORGMETADATAPREFIX + "sram_invited", group_name, "", "")
-                # Put invite and add invitation metadata if user is not member of the external users CO.
-                elif username not in co_members and member not in invited:
-                    sram.put_collaboration_invitation(ctx, group_name, username, config.sram_external_users_co)
-                    if not sram.is_user_marked_invited(ctx, username, group_name):
+                # Check if sram invitation metadata exists for this external user
+                if sram.is_user_marked_invited(ctx, username, group_name):
+                    # Delete invitation from SRAM
+                    try:
+                        sram.delete_pending_invitation(ctx, co_identifier, username)
+                    except Exception:
+                        log.write(ctx, f"Something went wrong while deleting the open invitation for user {username} in SRAM CO {group_name}.")
+
+                    # Delete SRAM invited metadata
+                    msi.sudo_obj_meta_remove(ctx, member, "-u", "", constants.UUORGMETADATAPREFIX + "sram_invited", group_name, "", "")
+                else:
+                    # Check if the user exists in SRAM external users CO, if not, then send the invitation
+                    if username not in co_members:
+                        sram.put_collaboration_invitation(ctx, group_name, username, config.sram_external_users_co)
                         msi.sudo_obj_meta_add(ctx, member, "-u", constants.UUORGMETADATAPREFIX + "sram_invited", group_name, "", "")
-                    log.write(ctx, f"User {username} invited to group {group_name}")
+                        log.write(ctx, f"User {username} invited to group {group_name}")
+                    else:
+                        log.write(ctx, f"User {username} already exists in SRAM external users CO.")
+        # Delete SRAM CO metadata
+        msi.sudo_obj_meta_remove(ctx, group_name, "-u", "", "co_identifier", co_identifier, "", "")
+        msi.sudo_obj_meta_remove(ctx, group_name, "-u", "", "sram_co", sram_co, "", "")
 
-    log.write(ctx, "Finished syncing external users with SRAM")
+        # Delete collaboration in SRAM
+        if co_identifier and not sram.delete_collaboration(ctx, co_identifier):
+            return api.Error('sram_error', 'Something went wrong deleting group "{}" in SRAM'.format(group_name))
+    elif convert_group == 'sram':
+        if not sram_co and co_identifier:
+            # Add sram_co metadata to SRAM group
+            msi.sudo_obj_meta_add(ctx, group_name, "-u", "sram_co", sram_co, "", "")
+    else:
+        log.write(ctx, "Could not convert group to {}. Invalid argument.".format(convert_group))
+    
diff --git a/sram.py b/sram.py
@@ -136,12 +136,7 @@ def put_collaboration_invitation(ctx: rule.Context, group_name: str, username: s
         return False
 
     # Request SRAM to lookup possible existing invitation for this user.
-    url = f"{config.sram_rest_api_url}/api/invitations/v1/invitations/{co_identifier}"
-
-    if config.sram_verbose_logging:
-        log.write(ctx, f"put_collaboration_invitation get: {url}")
-
-    response = requests.get(url, headers=_request_headers(), timeout=30, verify=config.sram_tls_verify)
+    response = get_open_invitations(ctx, co_identifier)
 
     if config.sram_verbose_logging:
         log.write(ctx, f"put_collaboration_invitation response: {response.status_code}")
@@ -373,3 +368,74 @@ def is_user_marked_invited(ctx: rule.Context, username: str, group_name: str) ->
             return True
 
     return False
+
+
+def get_open_invitations(ctx: rule.Context, co_identifier: str) -> str:
+    """Get open invitations for a SRAM CO.
+
+    :param ctx:           Combined type of a callback and rei struct
+    :param co_identifier: SRAM CO identifier
+
+    :returns: Response including status code
+    """
+    if not misc.is_valid_uuid(co_identifier):
+        log.write(ctx, f"put_collaboration_invitation error: CO identifier is invalid {co_identifier}")
+        return False
+
+    # Request SRAM to lookup possible existing invitation for this user.
+    url = f"{config.sram_rest_api_url}/api/invitations/v1/invitations/{co_identifier}"
+
+    if config.sram_verbose_logging:
+        log.write(ctx, f"get_open_invitations get: {url}")
+
+    response = requests.get(url, headers=_request_headers(), timeout=30, verify=config.sram_tls_verify)
+
+    if config.sram_verbose_logging:
+        log.write(ctx, f"get_open_invitations response: {response.status_code}")
+
+    if response.status_code != HTTP_OK:
+        log.write(ctx, f"get_open_invitations error: unable to retrieve existing invitations - http {response.status_code}")
+        return False
+    
+    return response
+
+
+def delete_pending_invitation(ctx: rule.Context, co_identifier: str, username: str) -> bool:
+    """Delete pending invitation for a user in SRAM Collaborative Organisation.
+
+    :param ctx:           Combined type of a callback and rei struct
+    :param co_identifier: SRAM CO identifier
+    :param username:      Name of the user whose invitation needs to be deleted
+
+    :returns: Boolean indicating of deletion of invitation succeeded
+    """
+    if not misc.is_valid_uuid(co_identifier):
+        log.write(ctx, f"delete_collaboration error: CO identifier is invalid {co_identifier}")
+        return False
+
+    invitation_uuid = ''
+
+    # Get unique id of open invitation for a user 
+    invitations = get_open_invitations(ctx, co_identifier)
+
+    if invitations:
+        for invite in invitations.json():
+            if invite['invitation']['email'] == username and invite['status'] == 'open':
+                invitation_uuid = invite['invitation']['identifier']
+
+    if not misc.is_valid_uuid(invitation_uuid):
+        log.write(ctx, f"No open invitations exist for user: {username}")
+        return True
+
+    url = f"{config.sram_rest_api_url}/api/invitations/v1/{invitation_uuid}"
+
+    if config.sram_verbose_logging:
+        log.write(ctx, f"delete_pending_invitation delete {url}")
+
+    response = requests.delete(url, headers=_request_headers(), timeout=30, verify=config.sram_tls_verify)
+
+    if config.sram_verbose_logging:
+        log.write(ctx, f"delete_pending_invitation response: {response.status_code}")
+
+
+    return response.status_code == HTTP_NO_CONTENT
diff --git a/tools/sram/sram-migration-script.py b/tools/sram/sram-migration-script.py
@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+"""This script takes CSV file as input and includes pre-existing SRAM groups to be migrated to non-SRAM groups.
+
+This script should be run before SRAM external users sync so that the sync has accurate user information as input.
+
+Example:
+To migrate SRAM groups to non-SRAM groups and output the results in a log file :
+python3 sram-migration-script.py -f sram-groups-to-non-sram.py
+
+To output the results in a log file :
+python3 sram-migration-script.py -l -f sram-groups-to-non-sram.py
+
+To dry run the migration script :
+python3 sram-migration-script.py -d -f sram-groups-to-non-sram.py
+
+"""
+import argparse
+import subprocess
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        prog="sram-migration-script.py",
+        description=__doc__,
+        formatter_class=argparse.RawTextHelpFormatter)
+    parser.add_argument("-l", "--log-file", action='store_true',
+                        help="If log file parameter is true then write to log at: /var/lib/irods/log/sram-migration.log")
+    parser.add_argument("-d", "--dry-run", action='store_true',
+                        help="Run the migration script offline.")
+    parser.add_argument("-c", "--convert-group", type=str, required=True,
+                        help="Convert the group to either 'sram' or 'non-sram' group.")
+    parser.add_argument("-f", "--file-name", type=str, required=True,
+                        help="CSV file containing SRAM group names to be migrated to non-SRAM group.")
+    return parser.parse_args()
+
+def main():
+    args = parse_args()
+    rule_name = "/etc/irods/yoda-ruleset/tools/sram/sram-migration.r"
+    log_loc = f"*log_loc={args.log_file if args.log_file else ''}"
+    dry_run = f"*dry_run={args.dry_run if args.dry_run else ''}"
+    convert_group = f"*convert_group={args.convert_group}"
+    file_name = f"*file_name={args.file_name}"
+
+    subprocess.call(['irule', '-r', 'irods_rule_engine_plugin-python-instance', '-F',
+                    rule_name, log_loc, dry_run, convert_group, file_name])
+
+if __name__ == '__main__':
+    main()
diff --git a/tools/sram/sram-migration.r b/tools/sram/sram-migration.r
@@ -0,0 +1,21 @@
+#!/usr/bin/irule -r irods_rule_engine_plugin-irods_rule_language-instance -F
+#
+import csv
+
+def main(rule_args, callback, rei):
+    log_loc = global_vars["*log_loc"]
+    dry_run = global_vars["*dry_run"]
+    convert_group = global_vars["*convert_group"]
+    file_name = global_vars["*file_name"]
+
+    with open(file_name, "r") as read_groups:
+        groups = csv.reader(read_groups)
+        
+
+        for row in groups:
+            callback.writeLine("stdout", row[0])
+            callback.rule_sram_migration(log_loc, dry_run, convert_group, row[0])
+
+
+input *log_loc="", *dry_run="", *convert_group= "non-sram", *file_name="/etc/irods/yoda-ruleset/tools/sram/test-sram-migration.csv"
+output ruleExecOut
