compute: Fix filtering servers by tags

stephenfin · stephenfin · commit 3f4142d5ddfc · 2021-10-13T12:51:28.000+01:00
The nova API expects the 'tags' and 'not-tags' filters of the 'GET /servers' (list servers) API to be a CSV string [1]: tags (Optional) A list of tags to filter the server list by. Servers that match all tags in this list will be returned. Boolean expression in this case is 't1 AND t2'. Tags in query must be separated by comma. New in version 2.26 not-tags (Optional) A list of tags to filter the server list by. Servers that don’t match all tags in this list will be returned. Boolean expression in this case is 'NOT (t1 AND t2)'. Tags in query must be separated by comma. New in version 2.26 We were instead providing a Python list, which was simply being URL encoded. Correct this. [1] https://docs.openstack.org/api-ref/compute/?expanded=list-servers-detail#list-servers Change-Id: Ie0251a0dccdf3385089e5bbaedf646a5e928cc48 Signed-off-by: Stephen Finucane <sfinucan@redhat.com> Closes-Bug: #1946816 (cherry picked from commit 53debe7) (cherry picked from commit cbc64f9)
diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py
@@ -2201,7 +2201,7 @@ def take_action(self, parsed_args):
                 )
                 raise exceptions.CommandError(msg)
 
-            search_opts['tags'] = parsed_args.tags
+            search_opts['tags'] = ','.join(parsed_args.tags)
 
         if parsed_args.not_tags:
             if compute_client.api_version < api_versions.APIVersion('2.26'):
@@ -2211,7 +2211,7 @@ def take_action(self, parsed_args):
                 )
                 raise exceptions.CommandError(msg)
 
-            search_opts['not-tags'] = parsed_args.not_tags
+            search_opts['not-tags'] = ','.join(parsed_args.not_tags)
 
         if parsed_args.locked:
             if compute_client.api_version < api_versions.APIVersion('2.73'):
diff --git a/openstackclient/tests/unit/compute/v2/test_server.py b/openstackclient/tests/unit/compute/v2/test_server.py
@@ -4269,7 +4269,7 @@ def test_server_list_with_tag(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, data = self.cmd.take_action(parsed_args)
 
-        self.search_opts['tags'] = ['tag1', 'tag2']
+        self.search_opts['tags'] = 'tag1,tag2'
 
         self.servers_mock.list.assert_called_with(**self.kwargs)
 
@@ -4312,7 +4312,7 @@ def test_server_list_with_not_tag(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, data = self.cmd.take_action(parsed_args)
 
-        self.search_opts['not-tags'] = ['tag1', 'tag2']
+        self.search_opts['not-tags'] = 'tag1,tag2'
 
         self.servers_mock.list.assert_called_with(**self.kwargs)
 
diff --git a/releasenotes/notes/bug-1946816-7665858605453578.yaml b/releasenotes/notes/bug-1946816-7665858605453578.yaml
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Filtering servers by tags (``server list --tag``,
+    ``server list --not-tag``) now works correctly.
+    [Bug `1946816 <https://bugs.launchpad.net/bugs/1946816>`_]

Original file line number	Diff line number	Diff line change
`@@ -2201,7 +2201,7 @@ def take_action(self, parsed_args):`
`2201`	`2201`	`)`
`2202`	`2202`	`raise exceptions.CommandError(msg)`
`2203`	`2203`
`2204`		`- search_opts['tags'] = parsed_args.tags`
	`2204`	`+ search_opts['tags'] = ','.join(parsed_args.tags)`
`2205`	`2205`
`2206`	`2206`	`if parsed_args.not_tags:`
`2207`	`2207`	`if compute_client.api_version < api_versions.APIVersion('2.26'):`
`@@ -2211,7 +2211,7 @@ def take_action(self, parsed_args):`
`2211`	`2211`	`)`
`2212`	`2212`	`raise exceptions.CommandError(msg)`
`2213`	`2213`
`2214`		`- search_opts['not-tags'] = parsed_args.not_tags`
	`2214`	`+ search_opts['not-tags'] = ','.join(parsed_args.not_tags)`
`2215`	`2215`
`2216`	`2216`	`if parsed_args.locked:`
`2217`	`2217`	`if compute_client.api_version < api_versions.APIVersion('2.73'):`