From 61a40343fdbb89a1c6404ab03fcfd84daee31c9e Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Wed, 21 Jan 2015 15:02:58 -0600 Subject: Add filter to image list * Hides previously broken --page-size option * Adds --property to image list for filtering on properties * Adds Visibility, Protected, Owner, Properties/Tags to --long output * Adds api.utils.simple_filter() for selecting matches out of a list of objects * Adds tests for all of the above * Updates image docs There are additional filtering options to be added in later reviews. Change-Id: I32feff0ad61aae749b33621c817658d7dc90c3aa Closes-bug: 1401902 --- openstackclient/tests/api/fakes.py | 56 ++++++++++++ openstackclient/tests/api/test_api.py | 131 ++++++++++----------------- openstackclient/tests/api/test_utils.py | 115 +++++++++++++++++++++++ openstackclient/tests/image/v1/test_image.py | 53 ++++++++++- openstackclient/tests/image/v2/test_image.py | 91 +++++++++++++++++-- 5 files changed, 350 insertions(+), 96 deletions(-) create mode 100644 openstackclient/tests/api/fakes.py create mode 100644 openstackclient/tests/api/test_utils.py (limited to 'openstackclient/tests') diff --git a/openstackclient/tests/api/fakes.py b/openstackclient/tests/api/fakes.py new file mode 100644 index 00000000..85617ab7 --- /dev/null +++ b/openstackclient/tests/api/fakes.py @@ -0,0 +1,56 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# + +"""API Test Fakes""" + +from requests_mock.contrib import fixture + +from keystoneclient import session +from openstackclient.tests import utils + + +RESP_ITEM_1 = { + 'id': '1', + 'name': 'alpha', + 'status': 'UP', + 'props': {'a': 1, 'b': 2}, +} +RESP_ITEM_2 = { + 'id': '2', + 'name': 'beta', + 'status': 'DOWN', + 'props': {'a': 2, 'b': 2}, +} +RESP_ITEM_3 = { + 'id': '3', + 'name': 'delta', + 'status': 'UP', + 'props': {'a': 3, 'b': 1}, +} + +LIST_RESP = [RESP_ITEM_1, RESP_ITEM_2] + +LIST_BODY = { + 'p1': 'xxx', + 'p2': 'yyy', +} + + +class TestSession(utils.TestCase): + + BASE_URL = 'https://api.example.com:1234/vX' + + def setUp(self): + super(TestSession, self).setUp() + self.sess = session.Session() + self.requests_mock = self.useFixture(fixture.Fixture()) diff --git a/openstackclient/tests/api/test_api.py b/openstackclient/tests/api/test_api.py index 32042e4f..81197967 100644 --- a/openstackclient/tests/api/test_api.py +++ b/openstackclient/tests/api/test_api.py @@ -13,49 +13,12 @@ """Base API Library Tests""" -from requests_mock.contrib import fixture - -from keystoneclient import session from openstackclient.api import api from openstackclient.common import exceptions -from openstackclient.tests import utils - - -RESP_ITEM_1 = { - 'id': '1', - 'name': 'alpha', - 'status': 'UP', -} -RESP_ITEM_2 = { - 'id': '2', - 'name': 'beta', - 'status': 'DOWN', -} -RESP_ITEM_3 = { - 'id': '3', - 'name': 'delta', - 'status': 'UP', -} - -LIST_RESP = [RESP_ITEM_1, RESP_ITEM_2] - -LIST_BODY = { - 'p1': 'xxx', - 'p2': 'yyy', -} - - -class TestSession(utils.TestCase): - - BASE_URL = 'https://api.example.com:1234/vX' - - def setUp(self): - super(TestSession, self).setUp() - self.sess = session.Session() - self.requests_mock = self.useFixture(fixture.Fixture()) +from openstackclient.tests.api import fakes as api_fakes -class TestKeystoneSession(TestSession): +class TestKeystoneSession(api_fakes.TestSession): def setUp(self): super(TestKeystoneSession, self).setUp() @@ -68,14 +31,14 @@ class TestKeystoneSession(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz', - json=RESP_ITEM_1, + json=api_fakes.RESP_ITEM_1, status_code=200, ) ret = self.api._request('GET', '/qaz') - self.assertEqual(RESP_ITEM_1, ret.json()) + self.assertEqual(api_fakes.RESP_ITEM_1, ret.json()) -class TestBaseAPI(TestSession): +class TestBaseAPI(api_fakes.TestSession): def setUp(self): super(TestBaseAPI, self).setUp() @@ -88,21 +51,21 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'POST', self.BASE_URL + '/qaz', - json=RESP_ITEM_1, + json=api_fakes.RESP_ITEM_1, status_code=202, ) ret = self.api.create('qaz') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) def test_create_put(self): self.requests_mock.register_uri( 'PUT', self.BASE_URL + '/qaz', - json=RESP_ITEM_1, + json=api_fakes.RESP_ITEM_1, status_code=202, ) ret = self.api.create('qaz', method='PUT') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) def test_delete(self): self.requests_mock.register_uri( @@ -127,11 +90,11 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?id=1', - json={'qaz': [RESP_ITEM_1]}, + json={'qaz': [api_fakes.RESP_ITEM_1]}, status_code=200, ) ret = self.api.find_attr('qaz', '1') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) # value not found self.requests_mock.register_uri( @@ -157,23 +120,23 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?status=UP', - json={'qaz': [RESP_ITEM_1]}, + json={'qaz': [api_fakes.RESP_ITEM_1]}, status_code=200, ) ret = self.api.find_attr('qaz', 'UP', attr='status') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) ret = self.api.find_attr('qaz', value='UP', attr='status') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) def test_find_attr_by_name(self): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?name=alpha', - json={'qaz': [RESP_ITEM_1]}, + json={'qaz': [api_fakes.RESP_ITEM_1]}, status_code=200, ) ret = self.api.find_attr('qaz', 'alpha') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) # value not found self.requests_mock.register_uri( @@ -199,13 +162,13 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?status=UP', - json={'qaz': [RESP_ITEM_1]}, + json={'qaz': [api_fakes.RESP_ITEM_1]}, status_code=200, ) ret = self.api.find_attr('qaz', 'UP', attr='status') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) ret = self.api.find_attr('qaz', value='UP', attr='status') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) def test_find_attr_path_resource(self): @@ -219,37 +182,37 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/wsx?id=1', - json={'qaz': [RESP_ITEM_1]}, + json={'qaz': [api_fakes.RESP_ITEM_1]}, status_code=200, ) ret = self.api.find_attr('wsx', '1', resource='qaz') - self.assertEqual(RESP_ITEM_1, ret) + self.assertEqual(api_fakes.RESP_ITEM_1, ret) def test_find_bulk_none(self): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.find_bulk('qaz') - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) def test_find_bulk_one(self): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.find_bulk('qaz', id='1') - self.assertEqual([LIST_RESP[0]], ret) + self.assertEqual([api_fakes.LIST_RESP[0]], ret) ret = self.api.find_bulk('qaz', id='0') self.assertEqual([], ret) ret = self.api.find_bulk('qaz', name='beta') - self.assertEqual([LIST_RESP[1]], ret) + self.assertEqual([api_fakes.LIST_RESP[1]], ret) ret = self.api.find_bulk('qaz', error='bogus') self.assertEqual([], ret) @@ -258,11 +221,11 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.find_bulk('qaz', id='1', name='alpha') - self.assertEqual([LIST_RESP[0]], ret) + self.assertEqual([api_fakes.LIST_RESP[0]], ret) ret = self.api.find_bulk('qaz', id='1', name='beta') self.assertEqual([], ret) @@ -274,11 +237,11 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz', - json={'qaz': LIST_RESP}, + json={'qaz': api_fakes.LIST_RESP}, status_code=200, ) ret = self.api.find_bulk('qaz', id='1') - self.assertEqual([LIST_RESP[0]], ret) + self.assertEqual([api_fakes.LIST_RESP[0]], ret) # list tests @@ -286,77 +249,77 @@ class TestBaseAPI(TestSession): self.requests_mock.register_uri( 'GET', self.BASE_URL, - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.list('') - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.list('qaz') - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) def test_list_params(self): params = {'format': 'json'} self.requests_mock.register_uri( 'GET', self.BASE_URL + '?format=json', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.list('', **params) - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?format=json', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.list('qaz', **params) - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) def test_list_body(self): self.requests_mock.register_uri( 'POST', self.BASE_URL + '/qaz', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) - ret = self.api.list('qaz', body=LIST_BODY) - self.assertEqual(LIST_RESP, ret) + ret = self.api.list('qaz', body=api_fakes.LIST_BODY) + self.assertEqual(api_fakes.LIST_RESP, ret) def test_list_detailed(self): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz/details', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.list('qaz', detailed=True) - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) def test_list_filtered(self): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?attr=value', - json=LIST_RESP, + json=api_fakes.LIST_RESP, status_code=200, ) ret = self.api.list('qaz', attr='value') - self.assertEqual(LIST_RESP, ret) + self.assertEqual(api_fakes.LIST_RESP, ret) def test_list_wrapped(self): self.requests_mock.register_uri( 'GET', self.BASE_URL + '/qaz?attr=value', - json={'responses': LIST_RESP}, + json={'responses': api_fakes.LIST_RESP}, status_code=200, ) ret = self.api.list('qaz', attr='value') - self.assertEqual({'responses': LIST_RESP}, ret) + self.assertEqual({'responses': api_fakes.LIST_RESP}, ret) diff --git a/openstackclient/tests/api/test_utils.py b/openstackclient/tests/api/test_utils.py new file mode 100644 index 00000000..b87bdd13 --- /dev/null +++ b/openstackclient/tests/api/test_utils.py @@ -0,0 +1,115 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# + +"""API Utilities Library Tests""" + +import copy + +from openstackclient.api import api +from openstackclient.api import utils as api_utils +from openstackclient.tests.api import fakes as api_fakes + + +class TestBaseAPIFilter(api_fakes.TestSession): + """The filters can be tested independently""" + + def setUp(self): + super(TestBaseAPIFilter, self).setUp() + self.api = api.BaseAPI( + session=self.sess, + endpoint=self.BASE_URL, + ) + + self.input_list = [ + api_fakes.RESP_ITEM_1, + api_fakes.RESP_ITEM_2, + api_fakes.RESP_ITEM_3, + ] + + def test_simple_filter_none(self): + output = api_utils.simple_filter( + ) + self.assertIsNone(output) + + def test_simple_filter_no_attr(self): + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + ) + self.assertEqual(self.input_list, output) + + def test_simple_filter_attr_only(self): + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='status', + ) + self.assertEqual(self.input_list, output) + + def test_simple_filter_attr_value(self): + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='status', + value='', + ) + self.assertEqual([], output) + + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='status', + value='UP', + ) + self.assertEqual( + [api_fakes.RESP_ITEM_1, api_fakes.RESP_ITEM_3], + output, + ) + + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='fred', + value='UP', + ) + self.assertEqual([], output) + + def test_simple_filter_prop_attr_only(self): + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='b', + property_field='props', + ) + self.assertEqual(self.input_list, output) + + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='status', + property_field='props', + ) + self.assertEqual(self.input_list, output) + + def test_simple_filter_prop_attr_value(self): + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='b', + value=2, + property_field='props', + ) + self.assertEqual( + [api_fakes.RESP_ITEM_1, api_fakes.RESP_ITEM_2], + output, + ) + + output = api_utils.simple_filter( + copy.deepcopy(self.input_list), + attr='b', + value=9, + property_field='props', + ) + self.assertEqual([], output) diff --git a/openstackclient/tests/image/v1/test_image.py b/openstackclient/tests/image/v1/test_image.py index 88809966..355f8c82 100644 --- a/openstackclient/tests/image/v1/test_image.py +++ b/openstackclient/tests/image/v1/test_image.py @@ -407,8 +407,18 @@ class TestImageList(TestImage): detailed=True, ) - collist = ('ID', 'Name', 'Disk Format', 'Container Format', - 'Size', 'Status') + collist = ( + 'ID', + 'Name', + 'Disk Format', + 'Container Format', + 'Size', + 'Status', + 'Visibility', + 'Protected', + 'Owner', + 'Properties', + ) self.assertEqual(collist, columns) datalist = (( @@ -418,6 +428,45 @@ class TestImageList(TestImage): '', '', '', + 'public', + False, + image_fakes.image_owner, + "Alpha='a', Beta='b', Gamma='g'", + ), ) + self.assertEqual(datalist, tuple(data)) + + @mock.patch('openstackclient.api.utils.simple_filter') + def test_image_list_property_option(self, sf_mock): + sf_mock.return_value = [ + copy.deepcopy(image_fakes.IMAGE), + ] + + arglist = [ + '--property', 'a=1', + ] + verifylist = [ + ('property', {'a': '1'}), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + # DisplayCommandBase.take_action() returns two tuples + columns, data = self.cmd.take_action(parsed_args) + self.api_mock.image_list.assert_called_with( + detailed=True, + ) + sf_mock.assert_called_with( + [image_fakes.IMAGE], + attr='a', + value='1', + property_field='properties', + ) + + collist = ('ID', 'Name') + + self.assertEqual(columns, collist) + datalist = (( + image_fakes.image_id, + image_fakes.image_name, ), ) self.assertEqual(datalist, tuple(data)) diff --git a/openstackclient/tests/image/v2/test_image.py b/openstackclient/tests/image/v2/test_image.py index 831aad44..db3c32df 100644 --- a/openstackclient/tests/image/v2/test_image.py +++ b/openstackclient/tests/image/v2/test_image.py @@ -83,15 +83,14 @@ class TestImageList(TestImage): verifylist = [ ('public', False), ('private', False), + ('shared', False), ('long', False), ] parsed_args = self.check_parser(self.cmd, arglist, verifylist) # DisplayCommandBase.take_action() returns two tuples columns, data = self.cmd.take_action(parsed_args) - self.api_mock.image_list.assert_called_with( - detailed=False, - ) + self.api_mock.image_list.assert_called_with() collist = ('ID', 'Name') @@ -109,6 +108,7 @@ class TestImageList(TestImage): verifylist = [ ('public', True), ('private', False), + ('shared', False), ('long', False), ] parsed_args = self.check_parser(self.cmd, arglist, verifylist) @@ -116,7 +116,6 @@ class TestImageList(TestImage): # DisplayCommandBase.take_action() returns two tuples columns, data = self.cmd.take_action(parsed_args) self.api_mock.image_list.assert_called_with( - detailed=False, public=True, ) @@ -136,6 +135,7 @@ class TestImageList(TestImage): verifylist = [ ('public', False), ('private', True), + ('shared', False), ('long', False), ] parsed_args = self.check_parser(self.cmd, arglist, verifylist) @@ -143,7 +143,6 @@ class TestImageList(TestImage): # DisplayCommandBase.take_action() returns two tuples columns, data = self.cmd.take_action(parsed_args) self.api_mock.image_list.assert_called_with( - detailed=False, private=True, ) @@ -156,6 +155,33 @@ class TestImageList(TestImage): ), ) self.assertEqual(datalist, tuple(data)) + def test_image_list_shared_option(self): + arglist = [ + '--shared', + ] + verifylist = [ + ('public', False), + ('private', False), + ('shared', True), + ('long', False), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + # DisplayCommandBase.take_action() returns two tuples + columns, data = self.cmd.take_action(parsed_args) + self.api_mock.image_list.assert_called_with( + shared=True, + ) + + collist = ('ID', 'Name') + + self.assertEqual(columns, collist) + datalist = (( + image_fakes.image_id, + image_fakes.image_name, + ), ) + self.assertEqual(datalist, tuple(data)) + def test_image_list_long_option(self): arglist = [ '--long', @@ -167,13 +193,21 @@ class TestImageList(TestImage): # DisplayCommandBase.take_action() returns two tuples columns, data = self.cmd.take_action(parsed_args) - self.api_mock.image_list.assert_called_with( - detailed=True, + self.api_mock.image_list.assert_called_with() + + collist = ( + 'ID', + 'Name', + 'Disk Format', + 'Container Format', + 'Size', + 'Status', + 'Visibility', + 'Protected', + 'Owner', + 'Tags', ) - collist = ('ID', 'Name', 'Disk Format', 'Container Format', - 'Size', 'Status') - self.assertEqual(collist, columns) datalist = (( image_fakes.image_id, @@ -182,5 +216,42 @@ class TestImageList(TestImage): '', '', '', + '', + False, + image_fakes.image_owner, + '', + ), ) + self.assertEqual(datalist, tuple(data)) + + @mock.patch('openstackclient.api.utils.simple_filter') + def test_image_list_property_option(self, sf_mock): + sf_mock.return_value = [ + copy.deepcopy(image_fakes.IMAGE), + ] + + arglist = [ + '--property', 'a=1', + ] + verifylist = [ + ('property', {'a': '1'}), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + # DisplayCommandBase.take_action() returns two tuples + columns, data = self.cmd.take_action(parsed_args) + self.api_mock.image_list.assert_called_with() + sf_mock.assert_called_with( + [image_fakes.IMAGE], + attr='a', + value='1', + property_field='properties', + ) + + collist = ('ID', 'Name') + + self.assertEqual(columns, collist) + datalist = (( + image_fakes.image_id, + image_fakes.image_name, ), ) self.assertEqual(datalist, tuple(data)) -- cgit v1.2.1