Small cleanup

Author: lwesterhof

groups.py

@@ -1412,8 +1412,6 @@ def rule_sram_migration(ctx: rule.Context, log_file: bool, dry_run: bool, conver
     :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
@@ -1478,4 +1476,3 @@ def rule_sram_migration(ctx: rule.Context, log_file: bool, dry_run: bool, conver
             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))
-

tools/sram/sram-migration-script.py

@@ -4,36 +4,53 @@
 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 migrate SRAM groups to non-SRAM groups:
+python3 sram-migration-script.py -c non-sram -f sram-groups-to-non-sram.csv
 
-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
+To output the results in a log file:
+python3 sram-migration-script.py -c non-sram -f sram-groups-to-non-sram.csv -l
 
+To dry run the migration script:
+python3 sram-migration-script.py -c non-sram -f sram-groups-to-non-sram.csv -d
 """
 import argparse
 import subprocess
 
 
 def parse_args():
+    """Parse command-line arguments."""
     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.")
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    parser.add_argument(
+        "-l", "--log-file",
+        action='store_true',
+        help="Write output to log file at /var/lib/irods/log/sram-migration.log"
+    )
+    parser.add_argument(
+        "-d", "--dry-run",
+        action='store_true',
+        help="Run the migration script in dry-run mode without making changes"
+    )
+    parser.add_argument(
+        "-c", "--convert-group",
+        type=str,
+        required=True,
+        choices=['sram', 'non-sram'],
+        help="Convert groups to either 'sram' or 'non-sram'"
+    )
+    parser.add_argument(
+        "-f", "--file-name",
+        type=str,
+        required=True,
+        help="Path to CSV file containing group names to be migrated"
+    )
     return parser.parse_args()
 
 def main():
+    """Execute the SRAM migration rule."""
     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 ''}"

tools/sram/sram-migration.r

@@ -1,5 +1,7 @@
 #!/usr/bin/irule -r irods_rule_engine_plugin-irods_rule_language-instance -F
 #
+# Migrates groups between SRAM and non-SRAM by reading from a CSV file.
+#
 import csv
 
 def main(rule_args, callback, rei):
@@ -10,12 +12,11 @@ def main(rule_args, callback, rei):
 
     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
+output ruleExecOut