From da45b34828bbc4000b1ede68f10bbcc1e4a47cc1 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Sun, 14 Sep 2014 18:16:32 -0500 Subject: [PATCH] Add service catalog commands 'catalog list' and 'catalog show' for Identity v2 Identity v2 only so far. Change-Id: I9df0dac3d5bb7c18f38a81bd7d29f8119462d3a5 --- openstackclient/identity/v2_0/catalog.py | 98 ++++++++++++++++ .../tests/identity/v2_0/test_catalog.py | 107 ++++++++++++++++++ setup.cfg | 3 + 3 files changed, 208 insertions(+) create mode 100644 openstackclient/identity/v2_0/catalog.py create mode 100644 openstackclient/tests/identity/v2_0/test_catalog.py diff --git a/openstackclient/identity/v2_0/catalog.py b/openstackclient/identity/v2_0/catalog.py new file mode 100644 index 0000000000..7bda1acb68 --- /dev/null +++ b/openstackclient/identity/v2_0/catalog.py @@ -0,0 +1,98 @@ +# 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. +# + +"""Identity v2 Service Catalog action implementations""" + +import logging +import six + +from cliff import lister +from cliff import show + +from openstackclient.common import utils + + +def _format_endpoints(eps=None): + if not eps: + return "" + for index, ep in enumerate(eps): + ret = eps[index]['region'] + '\n' + for url in ['publicURL', 'internalURL', 'adminURL']: + ret += " %s: %s\n" % (url, eps[index]['publicURL']) + return ret + + +class ListCatalog(lister.Lister): + """List services in the service catalog""" + + log = logging.getLogger(__name__ + '.ListCatalog') + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)', parsed_args) + + # This is ugly because if auth hasn't happened yet we need + # to trigger it here. + sc = self.app.client_manager.session.auth.get_auth_ref( + self.app.client_manager.session, + ).service_catalog + + data = sc.get_data() + columns = ('Name', 'Type', 'Endpoints') + return (columns, + (utils.get_dict_properties( + s, columns, + formatters={ + 'Endpoints': _format_endpoints, + }, + ) for s in data)) + + +class ShowCatalog(show.ShowOne): + """Show service catalog details""" + + log = logging.getLogger(__name__ + '.ShowCatalog') + + def get_parser(self, prog_name): + parser = super(ShowCatalog, self).get_parser(prog_name) + parser.add_argument( + 'service', + metavar='', + help='Service to display (type, name or ID)', + ) + return parser + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)', parsed_args) + + # This is ugly because if auth hasn't happened yet we need + # to trigger it here. + sc = self.app.client_manager.session.auth.get_auth_ref( + self.app.client_manager.session, + ).service_catalog + + data = None + for service in sc.get_data(): + if ( + 'name' in service and + service['name'] != parsed_args.service and + 'type' in service and + service['type'] != parsed_args.service + ): + continue + + data = service + data['endpoints'] = _format_endpoints(data['endpoints']) + if 'endpoints_links' in data: + data.pop('endpoints_links') + + return zip(*sorted(six.iteritems(data))) diff --git a/openstackclient/tests/identity/v2_0/test_catalog.py b/openstackclient/tests/identity/v2_0/test_catalog.py new file mode 100644 index 0000000000..5289cac439 --- /dev/null +++ b/openstackclient/tests/identity/v2_0/test_catalog.py @@ -0,0 +1,107 @@ +# 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. +# + +import mock + +from openstackclient.identity.v2_0 import catalog +from openstackclient.tests import utils + + +class TestCatalog(utils.TestCommand): + + fake_service = { + 'id': 'qwertyuiop', + 'type': 'compute', + 'name': 'supernova', + 'endpoints': [{ + 'region': 'onlyone', + 'publicURL': 'https://public.example.com', + 'adminURL': 'https://admin.example.com', + }], + } + + def setUp(self): + super(TestCatalog, self).setUp() + + self.sc_mock = mock.MagicMock() + self.sc_mock.service_catalog.get_data.return_value = [ + self.fake_service, + ] + + self.auth_mock = mock.MagicMock() + self.app.client_manager.session = self.auth_mock + + self.auth_mock.auth.get_auth_ref.return_value = self.sc_mock + + +class TestCatalogList(TestCatalog): + + def setUp(self): + super(TestCatalogList, self).setUp() + + # Get the command object to test + self.cmd = catalog.ListCatalog(self.app, None) + + def test_catalog_list(self): + arglist = [] + verifylist = [] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + # DisplayCommandBase.take_action() returns two tuples + columns, data = self.cmd.take_action(parsed_args) + self.sc_mock.service_catalog.get_data.assert_called_with() + + collist = ('Name', 'Type', 'Endpoints') + self.assertEqual(collist, columns) + datalist = (( + 'supernova', + 'compute', + 'onlyone\n publicURL: https://public.example.com\n ' + 'internalURL: https://public.example.com\n ' + 'adminURL: https://public.example.com\n', + ), ) + self.assertEqual(datalist, tuple(data)) + + +class TestCatalogShow(TestCatalog): + + def setUp(self): + super(TestCatalogShow, self).setUp() + + # Get the command object to test + self.cmd = catalog.ShowCatalog(self.app, None) + + def test_catalog_show(self): + arglist = [ + 'compute', + ] + verifylist = [ + ('service', 'compute'), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + # DisplayCommandBase.take_action() returns two tuples + columns, data = self.cmd.take_action(parsed_args) + self.sc_mock.service_catalog.get_data.assert_called_with() + + collist = ('endpoints', 'id', 'name', 'type') + self.assertEqual(collist, columns) + datalist = ( + 'onlyone\n publicURL: https://public.example.com\n ' + 'internalURL: https://public.example.com\n ' + 'adminURL: https://public.example.com\n', + 'qwertyuiop', + 'supernova', + 'compute', + ) + self.assertEqual(datalist, data) diff --git a/setup.cfg b/setup.cfg index 06523310bb..daf98a3758 100644 --- a/setup.cfg +++ b/setup.cfg @@ -128,6 +128,9 @@ openstack.compute.v2 = server_unset = openstackclient.compute.v2.server:UnsetServer openstack.identity.v2_0 = + catalog_list = openstackclient.identity.v2_0.catalog:ListCatalog + catalog_show = openstackclient.identity.v2_0.catalog:ShowCatalog + ec2_credentials_create = openstackclient.identity.v2_0.ec2creds:CreateEC2Creds ec2_credentials_delete = openstackclient.identity.v2_0.ec2creds:DeleteEC2Creds ec2_credentials_list = openstackclient.identity.v2_0.ec2creds:ListEC2Creds