openstack/python-openstackclient
Code Issues Proposed changes

Add extra-specs support for volume-type

Browse Source 
changed to volume-type
changed command to --long, added a formatter for key=value
Just noticed there is an option in cinder for a command called
extra-specs-list, only relates to volume-types, to list the
meta-data key/value pair. Added that functionality.
Also made minor changes so delete/set/unset can be called by name.

Change-Id: If534ccd1d8a3abc6d235c60ec9a964b88e3fa66d
This commit is contained in:
Steve Martinelli 2013-03-09 00:10:05 -06:00
parent 95c6e5f11d
commit b175184f23
2 changed files with 72 additions and 45 deletions
openstackclient/volume/v1
type.py
setup.py

105
openstackclient/volume/v1/type.py

@ -24,18 +24,18 @@ from cliff import show
from openstackclient.common import utils from openstackclient.common import utils
class CreateType(show.ShowOne): class CreateVolumeType(show.ShowOne):
"""Create type command""" """Create volume type command"""
api = 'volume' api = 'volume'
log = logging.getLogger(__name__ + '.CreateType') log = logging.getLogger(__name__ + '.CreateVolumeType')
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(CreateType, self).get_parser(prog_name) parser = super(CreateVolumeType, self).get_parser(prog_name)
parser.add_argument( parser.add_argument(
'name', 'name',
metavar='<name>', metavar='<name>',
help='New type name', help='New volume type name',
) )
return parser return parser
@ -51,59 +51,71 @@ class CreateType(show.ShowOne):
return zip(*sorted(info.iteritems())) return zip(*sorted(info.iteritems()))
class DeleteType(command.Command): class DeleteVolumeType(command.Command):
"""Delete type command""" """Delete volume type command"""
api = 'volume' api = 'volume'
log = logging.getLogger(__name__ + '.DeleteType') log = logging.getLogger(__name__ + '.DeleteVolumeType')
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(DeleteType, self).get_parser(prog_name) parser = super(DeleteVolumeType, self).get_parser(prog_name)
parser.add_argument( parser.add_argument(
'type', 'volume_type',
metavar='<type>', metavar='<volume-type>',
help='Name or ID of type to delete', help='Name or ID of volume type to delete',
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
self.log.debug('take_action(%s)' % parsed_args) self.log.debug('take_action(%s)' % parsed_args)
volume_client = self.app.client_manager.volume volume_client = self.app.client_manager.volume
volume_type = utils.find_resource( volume_type_id = utils.find_resource(
volume_client.volume_types, parsed_args.type) volume_client.volume_types, parsed_args.volume_type).id
volume_client.volume_types.delete(volume_type.id) volume_client.volume_types.delete(volume_type_id)
return return
class ListType(lister.Lister): class ListVolumeType(lister.Lister):
"""List type command""" """List volume type command"""
api = 'volume' api = 'volume'
log = logging.getLogger(__name__ + '.ListType') log = logging.getLogger(__name__ + '.ListVolumeType')
def get_parser(self, prog_name):
parser = super(ListVolumeType, self).get_parser(prog_name)
parser.add_argument(
'--long',
action='store_true',
default=False,
help='Additional fields are listed in output')
return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
self.log.debug('take_action(%s)' % parsed_args) self.log.debug('take_action(%s)' % parsed_args)
columns = ('ID', 'Name') if parsed_args.long:
columns = ('ID', 'Name', 'Extra Specs')
else:
columns = ('ID', 'Name')
data = self.app.client_manager.volume.volume_types.list() data = self.app.client_manager.volume.volume_types.list()
return (columns, return (columns,
(utils.get_item_properties( (utils.get_item_properties(
s, columns, s, columns,
formatters={}, formatters={'Extra Specs': _format_type_list_extra_specs},
) for s in data)) ) for s in data))
class SetType(command.Command): class SetVolumeType(command.Command):
"""Set type command""" """Set volume type command"""
api = 'volume' api = 'volume'
log = logging.getLogger(__name__ + '.SetType') log = logging.getLogger(__name__ + '.SetVolumeType')
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(SetType, self).get_parser(prog_name) parser = super(SetVolumeType, self).get_parser(prog_name)
parser.add_argument( parser.add_argument(
'type', 'volume_type',
metavar='<type>', metavar='<volume-type>',
help='Type ID to update', help='Volume type name or ID to update',
) )
parser.add_argument( parser.add_argument(
'meta_data', 'meta_data',
@ -117,27 +129,26 @@ class SetType(command.Command):
meta = dict(v.split('=') for v in parsed_args.meta_data.split(' ')) meta = dict(v.split('=') for v in parsed_args.meta_data.split(' '))
volume_client = self.app.client_manager.volume volume_client = self.app.client_manager.volume
volume_type = volume_client.volume_types.get( volume_type = utils.find_resource(
parsed_args.type volume_client.volume_types, parsed_args.volume_type)
)
volume_type.set_keys(meta) volume_type.set_keys(meta)
return return
class UnsetType(command.Command): class UnsetVolumeType(command.Command):
"""Unset type command""" """Unset volume type command"""
api = 'volume' api = 'volume'
log = logging.getLogger(__name__ + '.UnsetType') log = logging.getLogger(__name__ + '.UnsetVolumeType')
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(UnsetType, self).get_parser(prog_name) parser = super(UnsetVolumeType, self).get_parser(prog_name)
parser.add_argument( parser.add_argument(
'type', 'volume_type',
metavar='<type>', metavar='<volume-type>',
help='Type ID to update', help='Type ID or name to update',
) )
parser.add_argument( parser.add_argument(
'meta_data', 'meta_data',
@ -149,11 +160,25 @@ class UnsetType(command.Command):
def take_action(self, parsed_args): def take_action(self, parsed_args):
self.log.debug('take_action(%s)' % parsed_args) self.log.debug('take_action(%s)' % parsed_args)
volume_client = self.app.client_manager.volume volume_client = self.app.client_manager.volume
volume_type = volume_client.volume_types.get( volume_type = utils.find_resource(
parsed_args.type volume_client.volume_types, parsed_args.volume_type)
)
key_list = [] key_list = []
key_list.append(parsed_args.meta_data) key_list.append(parsed_args.meta_data)
volume_type.unset_keys(key_list) volume_type.unset_keys(key_list)
return return
def _format_type_list_extra_specs(vol_type):
"""Return a string containing the key value pairs
:param server: a single VolumeType resource
:rtype: a string formatted to key=value
"""
keys = vol_type.get_keys()
output = ""
for s in keys:
output = output + s + "=" + keys[s] + "; "
return output

12
setup.py

@ -191,11 +191,13 @@ setuptools.setup(
'unpause_server=openstackclient.compute.v2.server:UnpauseServer', 'unpause_server=openstackclient.compute.v2.server:UnpauseServer',
], ],
'openstack.volume.v1': [ 'openstack.volume.v1': [
'create_type=openstackclient.volume.v1.type:CreateType', 'create_volume-type=' +
'delete_type=openstackclient.volume.v1.type:DeleteType', 'openstackclient.volume.v1.type:CreateVolumeType',
'list_type=openstackclient.volume.v1.type:ListType', 'delete_volume-type=' +
'set_type=openstackclient.volume.v1.type:SetType', 'openstackclient.volume.v1.type:DeleteVolumeType',
'unset_type=openstackclient.volume.v1.type:UnsetType', 'list_volume-type=openstackclient.volume.v1.type:ListVolumeType',
'set_volume-type=openstackclient.volume.v1.type:SetVolumeType',
'unset_volume-type=openstackclient.volume.v1.type:UnsetVolumeType',
'show_quota=openstackclient.volume.v1.quota:ShowQuota', 'show_quota=openstackclient.volume.v1.quota:ShowQuota',
'list_quota=openstackclient.volume.v1.quota:ListQuota', 'list_quota=openstackclient.volume.v1.quota:ListQuota',
'set_quota=openstackclient.volume.v1.quota:SetQuota', 'set_quota=openstackclient.volume.v1.quota:SetQuota',