Adding support --order and --order_by for list operations

linodecli/api_request.py

@@ -150,6 +150,10 @@ def _build_filter_header(
         if p.name in parsed_args_dict:
             del parsed_args_dict[p.name]
 
+    # check for order_by and order
+    order_by = parsed_args_dict.pop("order_by")
+    order = parsed_args_dict.pop("order") or "asc"
+
     # The "+and" list to be used in the filter header
     filter_list = []
 
@@ -161,15 +165,16 @@ def _build_filter_header(
         new_filters = [{k: j} for j in v] if isinstance(v, list) else [{k: v}]
         filter_list.extend(new_filters)
 
-    if len(filter_list) < 1:
-        return None
-
-    return json.dumps(
-        # Only use +and if there are multiple attributes to filter on
-        {"+and": filter_list}
-        if len(filter_list) > 1
-        else filter_list[0]
-    )
+    result = {}
+    if len(filter_list) > 0:
+        if len(filter_list) == 1:
+            result = filter_list[0]
+        else:
+            result["+and"] = filter_list
+    if order_by is not None:
+        result["+order_by"] = order_by
+        result["+order"] = order
+    return json.dumps(result) if len(result) > 0 else None
 
 
 def _build_request_url(ctx, operation, parsed_args) -> str:

linodecli/baked/operation.py

@@ -6,6 +6,7 @@
 import json
 import platform
 import re
+import sys
 from getpass import getpass
 from os import environ, path
 
@@ -315,8 +316,10 @@ def parse_args(
 
         if self.method == "get":
             # build args for filtering
+            filterable_args = []
             for attr in self.response_model.attrs:
                 if attr.filterable:
+                    filterable_args.append(attr.name)
                     expected_type = TYPES[attr.datatype]
                     if expected_type == list:
                         parser.add_argument(
@@ -333,6 +336,21 @@ def parse_args(
                             metavar=attr.name,
                         )
 
+            # Add --order_by and --order argument
+            parser.add_argument(
+                "--order_by",
+                choices=filterable_args,
+                help="Attribute to order the results by - must be filterable.",
+                required="--order" in sys.argv,
+            )
+
+            parser.add_argument(
+                "--order",
+                choices=["asc", "desc"],
+                default="asc",
+                help="Either “asc” or “desc”. Defaults to “asc”. Requires +order_by",
+            )
+
         elif self.method in ("post", "put"):
             # build args for body JSON
             for arg in self.args:

tests/unit/test_api_request.py

@@ -109,6 +109,8 @@ def test_build_filter_header(self, list_operation):
             SimpleNamespace(
                 filterable_result="bar",
                 filterable_list_result=["foo", "bar"],
+                order_by=None,
+                order=None,
             ),
         )
 
@@ -130,6 +132,8 @@ def test_build_filter_header_single(self, list_operation):
             list_operation,
             SimpleNamespace(
                 filterable_result="bar",
+                order_by=None,
+                order=None,
             ),
         )
 
@@ -145,6 +149,8 @@ def test_build_filter_header_single_list(self, list_operation):
             list_operation,
             SimpleNamespace(
                 filterable_list_result=["foo", "bar"],
+                order_by=None,
+                order=None,
             ),
         )
 
@@ -160,6 +166,77 @@ def test_build_filter_header_single_list(self, list_operation):
             == result
         )
 
+    def test_build_filter_header_order_by(self, list_operation):
+        result = api_request._build_filter_header(
+            list_operation,
+            SimpleNamespace(
+                filterable_result="bar",
+                filterable_list_result=["foo", "bar"],
+                order_by="baz",
+                order=None,
+            ),
+        )
+
+        assert (
+            json.dumps(
+                {
+                    "+and": [
+                        {"filterable_result": "bar"},
+                        {"filterable_list_result": "foo"},
+                        {"filterable_list_result": "bar"},
+                    ],
+                    "+order_by": "baz",
+                    "+order": "asc",
+                }
+            )
+            == result
+        )
+
+    def test_build_filter_header_order(self, list_operation):
+        result = api_request._build_filter_header(
+            list_operation,
+            SimpleNamespace(
+                filterable_result="bar",
+                filterable_list_result=["foo", "bar"],
+                order_by="baz",
+                order="desc",
+            ),
+        )
+
+        assert (
+            json.dumps(
+                {
+                    "+and": [
+                        {"filterable_result": "bar"},
+                        {"filterable_list_result": "foo"},
+                        {"filterable_list_result": "bar"},
+                    ],
+                    "+order_by": "baz",
+                    "+order": "desc",
+                }
+            )
+            == result
+        )
+
+    def test_build_filter_header_only_order(self, list_operation):
+        result = api_request._build_filter_header(
+            list_operation,
+            SimpleNamespace(
+                order_by="baz",
+                order="desc",
+            ),
+        )
+
+        assert (
+            json.dumps(
+                {
+                    "+order_by": "baz",
+                    "+order": "desc",
+                }
+            )
+            == result
+        )
+
     def test_do_request_get(self, mock_cli, list_operation):
         mock_response = Mock(status_code=200, reason="OK")