Merge pull request #1459 from caberos/issue1453

Add an --orderBy parameters to call-api

Author: allmightyspiff

SoftLayer/CLI/call_api.py

@@ -112,14 +112,20 @@ def _validate_parameters(ctx, param, value):  # pylint: disable=unused-argument
 @click.option('--mask', help="String-based object mask")
 @click.option('--limit', type=click.INT, help="Result limit")
 @click.option('--offset', type=click.INT, help="Result offset")
+@click.option('--orderBy', type=click.STRING,
+              help="To set the sort direction, ASC or DESC can be provided."
+                   "This should be of the form: '--orderBy nested.property' default DESC or "
+                   "'--orderBy nested.property=ASC', e.g. "
+                   " --orderBy subnets.id default DESC"
+                   " --orderBy subnets.id=ASC")
 @click.option('--output-python / --no-output-python',
               help="Show python example code instead of executing the call")
 @click.option('--json-filter', callback=_validate_filter,
               help="A JSON string to be passed in as the object filter to the API call. "
                    "Remember to use double quotes (\") for variable names. Can NOT be used with --filter. "
                    "Dont use whitespace outside of strings, or the slcli might have trouble parsing it.")
 @environment.pass_env
-def cli(env, service, method, parameters, _id, _filters, mask, limit, offset,
+def cli(env, service, method, parameters, _id, _filters, mask, limit, offset, orderby=None,
         output_python=False, json_filter=None):
     """Call arbitrary API endpoints with the given SERVICE and METHOD.
 
@@ -141,14 +147,19 @@ def cli(env, service, method, parameters, _id, _filters, mask, limit, offset,
             --json-filter  '{"virtualGuests":{"hostname":{"operation":"^= test"}}}' --limit=10
         slcli -v call-api SoftLayer_User_Customer addBulkPortalPermission --id=1234567 \\
             '[{"keyName": "NETWORK_MESSAGE_DELIVERY_MANAGE"}]'
+        slcli call-api Account getVirtualGuests \\
+            --orderBy virttualguests.id=ASC
     """
 
     if _filters and json_filter:
         raise exceptions.CLIAbort("--filter and --json-filter cannot be used together.")
 
     object_filter = _build_filters(_filters)
+    if orderby:
+        orderby = utils.build_filter_orderby(orderby)
+        object_filter = utils.dict_merge(object_filter, orderby)
     if json_filter:
-        object_filter.update(json_filter)
+        object_filter = utils.dict_merge(json_filter, object_filter)
 
     args = [service, method] + list(parameters)
     kwargs = {

SoftLayer/utils.py

@@ -218,6 +218,26 @@ def event_log_filter_less_than_date(date, utc):
     }
 
 
+def build_filter_orderby(orderby):
+    """Builds filters using the filter options passed into the CLI.
+
+    It only supports the orderBy option, the default value is DESC.
+    """
+    _filters = {}
+    reverse_filter = list(reversed(orderby.split('.')))
+    for keyword in reverse_filter:
+        _aux_filter = {}
+        if '=' in keyword:
+            _aux_filter[str(keyword).split('=')[0]] = query_filter_orderby(str(keyword).split('=')[1])
+            _filters = _aux_filter
+        elif keyword == list(reverse_filter)[0]:
+            _aux_filter[keyword] = query_filter_orderby('DESC')
+        else:
+            _aux_filter[keyword] = _filters
+        _filters = _aux_filter
+    return _filters
+
+
 class IdentifierMixin(object):
     """Mixin used to resolve ids from other names of objects.
 

tests/CLI/modules/call_api_tests.py

@@ -298,3 +298,21 @@ def test_json_filter(self):
         result = self.run_command(['call-api', 'Account', 'getObject', '--json-filter={"test":"something"}'])
         self.assert_no_fail(result)
         self.assert_called_with('SoftLayer_Account', 'getObject', filter={"test": "something"})
+
+    def test_call_api_orderBy(self):
+        result = self.run_command(['call-api', 'Account', 'getVirtualGuests',
+                                   '--orderBy', 'virtualGuests.id=DESC',
+                                   '--mask=virtualGuests.typeId,maxCpu',
+                                   '-f', 'virtualGuests.typeId=1'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Account', 'getVirtualGuests',
+                                filter={
+                                    'virtualGuests':
+                                        {'id':
+                                            {
+                                                'operation': 'orderBy',
+                                                'options': [{
+                                                    'name': 'sort',
+                                                    'value': ['DESC']}]},
+                                            'typeId': {'operation': 1}}
+                                })