openstack/python-openstackclient
Code Issues Proposed changes

compute: Fix filtering servers by tags

Browse Source 
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 53debe7fe1)
This commit is contained in:
Stephen Finucane 2021-10-13 10:18:53 +01:00
parent ec637205a5
commit cbc64f9469
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
openstackclient/compute/v2/server.py
View File

@ -2204,7 +2204,7 @@ class ListServer(command.Lister):
)
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'):
@ -2214,7 +2214,7 @@ class ListServer(command.Lister):
)
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'):

4
openstackclient/tests/unit/compute/v2/test_server.py
View File

@ -4269,7 +4269,7 @@ class TestServerList(TestServer):
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 @@ class TestServerList(TestServer):
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)

6
releasenotes/notes/bug-1946816-7665858605453578.yaml Normal file
View File

@ -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>`_]