Merge "Add openstack client resource type list and show"

This commit is contained in:
Jenkins
2016-02-12 03:01:04 +00:00
committed by Gerrit Code Review
3 changed files with 262 additions and 0 deletions

View File

@@ -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.
#
"""Orchestration v1 resource type implementations"""
import logging
import six
from cliff import lister
from heatclient.common import format_utils
from heatclient.common import utils as heat_utils
from heatclient import exc as heat_exc
from openstackclient.common import exceptions as exc
from openstackclient.i18n import _
class ResourceTypeShow(format_utils.YamlFormat):
"""Show details and optionally generate a template for a resource type."""
log = logging.getLogger(__name__ + ".ResourceTypeShow")
def get_parser(self, prog_name):
parser = super(ResourceTypeShow,
self).get_parser(prog_name)
parser.add_argument(
'resource_type',
metavar='<RESOURCE_TYPE>',
help=_('Resource type to show details for'),
)
parser.add_argument(
'--template-type',
metavar='<TEMPLATE_TYPE>',
help=_('Optional template type to generate, hot or cfn')
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
heat_client = self.app.client_manager.orchestration
return _show_resourcetype(heat_client, parsed_args)
def _show_resourcetype(heat_client, parsed_args):
try:
if parsed_args.template_type:
template_type = parsed_args.template_type.lower()
if template_type not in ('hot', 'cfn'):
raise exc.CommandError(
_('Template type invalid: %s') % parsed_args.template_type)
fields = {'resource_type': parsed_args.resource_type,
'template_type': template_type}
data = heat_client.resource_types.generate_template(**fields)
else:
data = heat_client.resource_types.get(parsed_args.resource_type)
except heat_exc.HTTPNotFound:
raise exc.CommandError(
_('Resource type not found: %s') % parsed_args.resource_type)
rows = list(six.itervalues(data))
columns = list(six.iterkeys(data))
return columns, rows
class ResourceTypeList(lister.Lister):
"""List resource types."""
log = logging.getLogger(__name__ + '.ResourceTypeList')
def get_parser(self, prog_name):
parser = super(ResourceTypeList,
self).get_parser(prog_name)
parser.add_argument(
'--filter',
dest='filter',
metavar='<KEY=VALUE>',
help=_('Filter parameters to apply on returned resource types. '
'This can be specified multiple times. It can be any of '
'name, version or support_status'),
action='append'
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
heat_client = self.app.client_manager.orchestration
return _list_resourcetypes(heat_client, parsed_args)
def _list_resourcetypes(heat_client, parsed_args):
resource_types = heat_client.resource_types.list(
filters=heat_utils.format_parameters(parsed_args.filter))
columns = ['Resource Type']
rows = sorted([r.resource_type] for r in resource_types)
return (columns, rows)

View File

@@ -0,0 +1,153 @@
# 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.common import exceptions as exc
from heatclient import exc as heat_exc
from heatclient.osc.v1 import resource_type
from heatclient.tests.unit.osc.v1 import fakes as orchestration_fakes
from heatclient.v1 import resource_types
class TestResourceType(orchestration_fakes.TestOrchestrationv1):
def setUp(self):
super(TestResourceType, self).setUp()
self.mock_client = self.app.client_manager.orchestration
class TestResourceTypeShow(TestResourceType):
def setUp(self):
super(TestResourceTypeShow, self).setUp()
self.cmd = resource_type.ResourceTypeShow(self.app, None)
self.mock_client.resource_types.get = mock.Mock(
return_value={})
self.mock_client.resource_types.generate_template = mock.Mock(
return_value={})
def test_resourcetype_show(self):
arglist = ['OS::Heat::None']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.cmd.take_action(parsed_args)
self.mock_client.resource_types.get.assert_called_once_with(
'OS::Heat::None')
def test_resourcetype_show_json(self):
arglist = ['OS::Heat::None',
'--format', 'json']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.cmd.take_action(parsed_args)
self.mock_client.resource_types.get.assert_called_once_with(
'OS::Heat::None')
def test_resourcetype_show_error_get(self):
arglist = ['OS::Heat::None']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.mock_client.resource_types.get = mock.Mock(
side_effect=heat_exc.HTTPNotFound)
self.assertRaises(exc.CommandError, self.cmd.take_action, parsed_args)
def test_resourcetype_show_error_template(self):
arglist = ['OS::Heat::None',
'--template-type', 'hot']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.mock_client.resource_types.generate_template = mock.Mock(
side_effect=heat_exc.HTTPNotFound)
self.assertRaises(exc.CommandError, self.cmd.take_action, parsed_args)
def test_resourcetype_show_template_hot(self):
arglist = ['OS::Heat::None',
'--template-type', 'Hot']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.cmd.take_action(parsed_args)
self.mock_client.resource_types.generate_template.assert_called_with(
**{'resource_type': 'OS::Heat::None',
'template_type': 'hot'})
def test_resourcetype_show_template_cfn(self):
arglist = ['OS::Heat::None',
'--template-type', 'cfn']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.cmd.take_action(parsed_args)
self.mock_client.resource_types.generate_template.assert_called_with(
**{'resource_type': 'OS::Heat::None',
'template_type': 'cfn'})
def test_resourcetype_show_template_cfn_yaml(self):
arglist = ['OS::Heat::None',
'--template-type', 'Cfn',
'--format', 'yaml']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.cmd.take_action(parsed_args)
self.mock_client.resource_types.generate_template.assert_called_with(
**{'resource_type': 'OS::Heat::None',
'template_type': 'cfn'})
def test_resourcetype_show_invalid_template_type(self):
arglist = ['OS::Heat::None',
'--template-type', 'abc']
parsed_args = self.check_parser(self.cmd, arglist, [])
self.assertRaises(exc.CommandError, self.cmd.take_action, parsed_args)
class TestTypeList(TestResourceType):
expected_columns = ['Resource Type']
list_response = [
resource_types.ResourceType(None, 'BBB'),
resource_types.ResourceType(None, 'AAA'),
resource_types.ResourceType(None, 'CCC')
]
expected_rows = [
['AAA'],
['BBB'],
['CCC']
]
def setUp(self):
super(TestTypeList, self).setUp()
self.cmd = resource_type.ResourceTypeList(self.app, None)
self.mock_client.resource_types.list = mock.Mock(
return_value=self.list_response)
def test_resourcetype_list(self):
arglist = []
parsed_args = self.check_parser(self.cmd, arglist, [])
columns, rows = self.cmd.take_action(parsed_args)
self.mock_client.resource_types.list.assert_called_with(
filters={})
self.assertEqual(self.expected_columns, columns)
self.assertEqual(self.expected_rows, rows)
def test_resourcetype_list_filter(self):
arglist = ['--filter', 'name=B']
parsed_args = self.check_parser(self.cmd, arglist, [])
columns, rows = self.cmd.take_action(parsed_args)
self.mock_client.resource_types.list.assert_called_once_with(
filters={'name': 'B'})
self.assertEqual(self.expected_columns, columns)
self.assertEqual(self.expected_rows, rows)
def test_resourcetype_list_filters(self):
arglist = ['--filter', 'name=B', '--filter', 'version=123']
parsed_args = self.check_parser(self.cmd, arglist, [])
columns, rows = self.cmd.take_action(parsed_args)
self.mock_client.resource_types.list.assert_called_once_with(
filters={'name': 'B', 'version': '123'})
self.assertEqual(self.expected_columns, columns)
self.assertEqual(self.expected_rows, rows)

View File

@@ -32,6 +32,8 @@ openstack.cli.extension =
openstack.orchestration.v1 =
orchestration_template_function_list = heatclient.osc.v1.template:FunctionList
orchestration_template_version_list = heatclient.osc.v1.template:VersionList
orchestration_resource_type_list = heatclient.osc.v1.orchestration:OrchestrationResourceTypeList
orchestration_resource_type_show = heatclient.osc.v1.orchestration:OrchestrationResourceTypeShow
software_config_create = heatclient.osc.v1.software_config:CreateConfig
software_config_delete = heatclient.osc.v1.software_config:DeleteConfig
software_config_list = heatclient.osc.v1.software_config:ListConfig