Client: Add csv option to list scopes rucio#7415

Author: voetberg

lib/rucio/client/commands/bin_legacy/rucio.py

@@ -546,7 +546,10 @@ def list_scopes(args, client, logger, console, spinner):
         spinner.start()
 
     scopes = client.list_scopes()
-    if cli_config == 'rich':
+
+    if args.csv:
+        print(*(scope for scope in scopes), sep=',')
+    elif cli_config == 'rich':
         table = generate_table([[scope] for scope in sorted(scopes)], headers=['SCOPE'], col_alignments=['left'])
         spinner.stop()
         print_output(table, console=console, no_pager=args.no_pager)
@@ -2476,6 +2479,7 @@ def get_parser():
     ''')
 
     scope_list_parser.set_defaults(function=list_scopes)
+    scope_list_parser.add_argument("--csv", action='store_true', help='List scopes as a csv')
 
     # The close command
     close_parser = subparsers.add_parser('close', help='Close a dataset or container.')

lib/rucio/client/commands/bin_legacy/rucio_admin.py

@@ -768,7 +768,10 @@ def list_scopes(args, client, logger, console, spinner):
         scopes = client.list_scopes_for_account(args.account)
     else:
         scopes = client.list_scopes()
-    if cli_config == 'rich':
+
+    if args.csv:
+        print(*(scope for scope in scopes if "mock" not in scopes), sep=',')
+    elif cli_config == 'rich':
         scopes = [[scope] for scope in sorted(scopes) if 'mock' not in scope]
         table = generate_table(scopes, headers=['SCOPE'], col_alignments=['left'])
         spinner.stop()
@@ -2125,6 +2128,7 @@ def get_parser():
                                                           '\n')
     list_scope_parser.set_defaults(which='list_scopes')
     list_scope_parser.add_argument('--account', dest='account', action='store', help='Account name')
+    list_scope_parser.add_argument("--csv", action='store_true', help='List scopes as a csv')
 
     # The config subparser
     config_parser = subparsers.add_parser('config',

lib/rucio/client/commands/scope.py

@@ -39,6 +39,7 @@ def usage_example(self) -> list[str]:
 
     def list_namespace(self, parser: "ArgumentParser") -> None:
         parser.add_argument("-a", "--account", help="Account name for filtering, attribution")
+        parser.add_argument("--csv", action="store_true", help="Output the list of scopes as a csv")
 
     def add_namespace(self, parser: "ArgumentParser") -> None:
         parser.add_argument("-a", "--account", help="Account name for filtering, attribution", required=True)

tests/test_bin_rucio.py

@@ -205,6 +205,35 @@ def test_add_scope(self):
         print(out, err)
         assert 'Added new scope to account: %s-%s\n' % (tmp_scp, tmp_acc) in out
 
+    def test_list_scopes(self):
+        """CLIENT(USER/ADMIN): List scope"""
+        tmp_account = account_name_generator()
+        execute(f'rucio-admin account add {tmp_account}')
+
+        tmp_scope = scope_name_generator()
+        tmp_scope = tmp_scope.replace("mock", "testing")  # admin filters out mock scopes
+        execute(f'rucio-admin scope add --account {tmp_account} --scope {tmp_scope}')
+
+        cmd = "rucio-admin scope list"
+        exitcode, out, err = execute(cmd)
+        assert exitcode == 0
+        assert tmp_scope in out.split('\n')
+
+        cmd = "rucio-admin scope list --csv"
+        exitcode, out, err = execute(cmd)
+        assert exitcode == 0
+        assert tmp_scope in [o.rstrip('\n') for o in out.split(',')]
+
+        cmd = "rucio list-scopes"
+        exitcode, out, err = execute(cmd)
+        assert exitcode == 0
+        assert tmp_scope in out.split('\n')
+
+        cmd = "rucio list-scopes --csv"
+        exitcode, out, err = execute(cmd)
+        assert exitcode == 0
+        assert tmp_scope in [o.rstrip('\n') for o in out.split(',')]
+
     def test_add_rse(self):
         """CLIENT(ADMIN): Add RSE"""
         tmp_val = rse_name_generator()