fix: Use +and for X-Filter header and support filtering on multiple list entries (#476)

## 📝 Description

This change adds support for filtering on multiple entries of the same
response list when calling list endpoints. This works by flattening out
any parsed list arguments and appending all values to a `+and` filter.

For example:

```bash
linode-cli linodes ls --tags foo --tags bar
```

This command would previously ignore the first specified tag and only
filter on the second tag. With this fix, response rows will be required
to have both specified tags.

## ✔️ How to Test

```bash
make testunit
```

Author: lgarber-akamai

linodecli/api_request.py

@@ -77,18 +77,26 @@ def _build_filter_header(
     if filter_header is not None:
         return json.dumps(filter_header)
 
-    filters = vars(parsed_args)
+    parsed_args_dict = vars(parsed_args)
 
     # remove URL parameters
     for p in operation.params:
-        if p.name in filters:
-            del filters[p.name]
+        if p.name in parsed_args_dict:
+            del parsed_args_dict[p.name]
 
-    # remove empty filters
-    filters = {k: v for k, v in filters.items() if v is not None}
+    # The "+and" list to be used in the filter header
+    filter_list = []
 
-    if filters:
-        return json.dumps(filters)
+    for k, v in parsed_args_dict.items():
+        if v is None:
+            continue
+
+        # If this is a list, flatten it out
+        new_filters = [{k: j} for j in v] if isinstance(v, list) else [{k: v}]
+        filter_list.extend(new_filters)
+
+    if len(filter_list) > 0:
+        return json.dumps({"+and": filter_list})
 
     return None
 

linodecli/operation.py

@@ -272,6 +272,7 @@ def parse_args(
                             "--" + attr.name,
                             type=TYPES[attr.item_type],
                             metavar=attr.name,
+                            action="append",
                             nargs="?",
                         )
                     else:

tests/unit/conftest.py

@@ -118,7 +118,18 @@ def list_operation():
         "foo/bar",
         "get info",
         [],
-        ResponseModel([ModelAttr("filterable_result", True, True, "string")]),
+        ResponseModel(
+            [
+                ModelAttr("filterable_result", True, True, "string"),
+                ModelAttr(
+                    "filterable_list_result",
+                    True,
+                    True,
+                    "array",
+                    item_type="string",
+                ),
+            ]
+        ),
         [],
     )
 

tests/unit/test_api_request.py

@@ -88,18 +88,39 @@ def test_build_request_url_post(self, mock_cli, create_operation):
 
     def test_build_filter_header(self, list_operation):
         result = api_request._build_filter_header(
-            list_operation, SimpleNamespace(filterable_result="bar")
+            list_operation,
+            SimpleNamespace(
+                filterable_result="bar",
+                filterable_list_result=["foo", "bar"],
+            ),
         )
 
-        assert json.dumps({"filterable_result": "bar"}) == result
+        assert (
+            json.dumps(
+                {
+                    "+and": [
+                        {"filterable_result": "bar"},
+                        {"filterable_list_result": "foo"},
+                        {"filterable_list_result": "bar"},
+                    ]
+                }
+            )
+            == result
+        )
 
     def test_do_request_get(self, mock_cli, list_operation):
         mock_response = Mock(status_code=200, reason="OK")
 
         def validate_http_request(url, headers=None, data=None, **kwargs):
             assert url == "http://localhost/foo/bar?page=1&page_size=100"
             assert headers["X-Filter"] == json.dumps(
-                {"filterable_result": "cool"}
+                {
+                    "+and": [
+                        {"filterable_result": "cool"},
+                        {"filterable_list_result": "foo"},
+                        {"filterable_list_result": "bar"},
+                    ]
+                }
             )
             assert "Authorization" in headers
             assert data is None
@@ -108,7 +129,16 @@ def validate_http_request(url, headers=None, data=None, **kwargs):
 
         with patch("linodecli.api_request.requests.get", validate_http_request):
             result = api_request.do_request(
-                mock_cli, list_operation, ["--filterable_result", "cool"]
+                mock_cli,
+                list_operation,
+                [
+                    "--filterable_result",
+                    "cool",
+                    "--filterable_list_result",
+                    "foo",
+                    "--filterable_list_result",
+                    "bar",
+                ],
             )
 
         assert result == mock_response