Add sort key and direction parameters

Author: petrutlucian94

coriolisclient/base.py

@@ -167,7 +167,7 @@ def __init__(self, client):
 
     @wrap_unauthorized_exception
     def _list(self, url, response_key=None, obj_class=None, json=None,
-              values_key='values', query: dict | None=None):
+              values_key='values', query: dict | list | None=None):
         """List the collection.
         :param url: a partial URL, e.g., '/servers'
         :param response_key: the key to be looked up in response dictionary,
@@ -177,7 +177,8 @@ def _list(self, url, response_key=None, obj_class=None, json=None,
             (self.resource_class will be used by default)
         :param json: data that will be encoded as JSON and passed in POST
             request (GET will be sent by default)
-        :param query: an optional dict containing query filters
+        :param query: an optional dict or list of (key, value) tuples
+            containing query filters
         """
 
         if query:

coriolisclient/cli/transfer_executions.py

@@ -22,6 +22,7 @@
 from cliff import show
 
 from coriolisclient.cli import formatter
+from coriolisclient.cli import utils as cli_utils
 
 
 class TransferExecutionFormatter(formatter.EntityFormatter):
@@ -186,9 +187,19 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--limit', type=int,
             help='Maximum number of executions to retrieve.')
+        parser.add_argument(
+            '--sort',
+            help='Comma-separated list of sort keys and directions in the form '
+           'of <key>[:<asc|desc>]. The direction defaults to descending if '
+           'not specified.')
         return parser
 
     def take_action(self, args):
+        sort_keys, sort_dirs = cli_utils.parse_sort_args(arg.sort)
         obj_list = self.app.client_manager.coriolis.transfer_executions.list(
-            args.transfer)
+            args.transfer,
+            marker=args.marker,
+            limit=args.limit,
+            sort_keys=sort_keys,
+            sort_dirs=sort_dirs)
         return TransferExecutionFormatter().list_objects(obj_list)

coriolisclient/cli/utils.py

@@ -20,6 +20,7 @@
 import uuid
 
 from coriolisclient import constants
+from coriolisclient import exceptions
 
 
 def add_storage_mappings_arguments_to_parser(parser):
@@ -264,3 +265,25 @@ def _split_pool_mapping_arg(arg):
                  'same OS type and which are compatible with OSMorphing '
                  'the guest OS of each afferent instance. The mappings must '
                  'be of the form "INSTANCE_IDENTIFIER=MINION_POOL_ID".')
+
+
+def parse_sort_arg(sort: str) -> tuple[list, list]:
+    """Parse sort CLI argument.
+
+    :param sort: Comma-separated list of sort keys and directions in the form
+                 of <key>[:<asc|desc>]. The direction defaults to descending if
+                 not specified.
+    :returns: (sort_keys, sort_dirs)
+    """
+    sort_keys = []
+    sort_dirs = []
+    for sort_entry in sort.split(','):
+        sort_key, _sep, sort_dir = sort_entry.partition(':')
+        if not sort_dir:
+            sort_dir = 'desc'
+        elif sort_dir not in ('asc', 'desc'):
+            raise exceptions.CoriolisException(
+                'Unknown sort direction: %s' % sort_dir)
+        sort_keys.append(sort_key)
+        sort_dirs.append(sort_dir)
+    return sort_keys, sort_dirs

coriolisclient/v1/transfer_executions.py

@@ -34,12 +34,20 @@ class TransferExecutionManager(base.BaseManager):
     def __init__(self, api):
         super(TransferExecutionManager, self).__init__(api)
 
-    def list(self, transfer, marker=None, limit=None):
-        query = {}
+    def list(self, transfer, marker=None, limit=None,
+             sort_keys=None, sort_dirs=None):
+        # List of key-value tuples.
+        query = []
         if marker is not None:
-            query['marker'] = marker
+            query.append(("marker", marker))
         if limit is not None:
-            query['limit'] = limit
+            query.append(("limit", limit))
+        if sort_keys is not None:
+            query.extend(('sort_key', sort_key)
+                         for sort_key in sort_keys)
+        if sort_dirs is not None:
+            query.extend(('sort_dir', sort_dir)
+                         for sort_dir in sort_dirs)
 
         return self._list(
             '/transfers/%s/executions' % base.getid(transfer), 'executions',