# Copyright 2014 Red Hat, Inc. # # 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 json import logging from cliff import command from cliff import lister from cliff import show from openstackclient.common import utils def _get_client(obj, parsed_args): obj.log.debug("take_action(%s)" % parsed_args) return obj.app.client_manager.messaging class CreateQueue(show.ShowOne): """Create a queue""" log = logging.getLogger(__name__ + ".CreateQueue") def get_parser(self, prog_name): parser = super(CreateQueue, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue_name = parsed_args.queue_name data = client.queue(queue_name, force_create=True) columns = ('Name',) return columns, utils.get_item_properties(data, columns) class DeleteQueue(command.Command): """Delete a queue""" log = logging.getLogger(__name__ + ".DeleteQueue") def get_parser(self, prog_name): parser = super(DeleteQueue, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue_name = parsed_args.queue_name client.queue(queue_name).delete() class ListQueues(lister.Lister): """List available queues""" log = logging.getLogger(__name__ + ".ListQueues") def get_parser(self, prog_name): parser = super(ListQueues, self).get_parser(prog_name) parser.add_argument( "--marker", metavar="", help="Queue's paging marker") parser.add_argument( "--limit", metavar="", help="Page size limit") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) kwargs = {} if parsed_args.marker is not None: kwargs["marker"] = parsed_args.marker if parsed_args.limit is not None: kwargs["limit"] = parsed_args.limit data = client.queues(**kwargs) columns = ("Name", ) return (columns, (utils.get_item_properties(s, columns) for s in data)) class CheckQueueExistence(show.ShowOne): """Check queue existence""" log = logging.getLogger(__name__ + ".CheckQueueExistence") def get_parser(self, prog_name): parser = super(CheckQueueExistence, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue_name = parsed_args.queue_name queue = client.queue(queue_name, auto_create=False) columns = ('Exists',) data = dict(exists=queue.exists()) return columns, utils.get_dict_properties(data, columns) class SetQueueMetadata(command.Command): """Set queue metadata""" log = logging.getLogger(__name__ + ".SetQueueMetadata") def get_parser(self, prog_name): parser = super(SetQueueMetadata, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue") parser.add_argument( "queue_metadata", metavar="", help="Queue metadata") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue_name = parsed_args.queue_name queue_metadata = parsed_args.queue_metadata queue_exists = client.queue(queue_name, auto_create=False).exists() if not queue_exists: raise RuntimeError("Queue(%s) does not exist." % queue_name) try: valid_metadata = json.loads(queue_metadata) except ValueError: raise RuntimeError("Queue metadata(%s) is not a valid json." % queue_metadata) client.queue(queue_name, auto_create=False).\ metadata(new_meta=valid_metadata) class GetQueueMetadata(show.ShowOne): """Get queue metadata""" log = logging.getLogger(__name__ + ".GetQueueMetadata") def get_parser(self, prog_name): parser = super(GetQueueMetadata, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue_name = parsed_args.queue_name queue = client.queue(queue_name, auto_create=False) if not queue.exists(): raise RuntimeError("Queue(%s) does not exist." % queue_name) columns = ("Metadata",) data = dict(metadata=queue.metadata()) return columns, utils.get_dict_properties(data, columns) class GetQueueStats(show.ShowOne): """Get queue stats""" log = logging.getLogger(__name__ + ".GetQueueStats") def get_parser(self, prog_name): parser = super(GetQueueStats, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue_name = parsed_args.queue_name queue = client.queue(queue_name, auto_create=False) if not queue.exists(): raise RuntimeError('Queue(%s) does not exist.' % queue_name) columns = ("Stats",) data = dict(stats=queue.stats) return columns, utils.get_dict_properties(data, columns) class CreatePool(show.ShowOne): """Create a pool""" log = logging.getLogger(__name__ + ".CreatePool") def get_parser(self, prog_name): parser = super(CreatePool, self).get_parser(prog_name) parser.add_argument( "pool_name", metavar="", help="Name of the pool") parser.add_argument( "pool_uri", metavar="", help="Storage engine URI") parser.add_argument( "pool_weight", type=int, metavar="", help="weight of the pool") parser.add_argument( "--pool_group", metavar="", help="Group of the pool") parser.add_argument( "--pool_options", type=json.loads, default={}, metavar="", help="An optional request component " "related to storage-specific options") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) kw_arg = { 'uri': parsed_args.pool_uri, 'weight': parsed_args.pool_weight, 'options': parsed_args.pool_options } if parsed_args.pool_group: kw_arg.update({'group': parsed_args.pool_group}) data = client.pool(parsed_args.pool_name, **kw_arg) if not data: raise RuntimeError('Failed to create pool(%s).' % parsed_args.pool_name) columns = ('Name', 'Weight', 'URI', 'Group', 'Options') return columns, utils.get_item_properties(data, columns) class ShowPool(show.ShowOne): """Display pool details""" log = logging.getLogger(__name__ + ".ShowPool") def get_parser(self, prog_name): parser = super(ShowPool, self).get_parser(prog_name) parser.add_argument( "pool_name", metavar="", help="Pool to display (name)", ) return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) pool_data = client.pool(parsed_args.pool_name, auto_create=False).get() columns = ('Name', 'Weight', 'URI', 'Group', 'Options') return columns, utils.get_dict_properties(pool_data, columns) class UpdatePool(show.ShowOne): """Update a pool attribute""" log = logging.getLogger(__name__+".UpdatePool") def get_parser(self, prog_name): parser = super(UpdatePool, self).get_parser(prog_name) parser.add_argument( "pool_name", metavar="", help="Name of the pool") parser.add_argument( "--pool_uri", metavar="", help="Storage engine URI") parser.add_argument( "--pool_weight", type=int, metavar="", help="Weight of the pool") parser.add_argument( "--pool_group", metavar="", help="Group of the pool") parser.add_argument( "--pool_options", type=json.loads, metavar="", help="An optional request component " "related to storage-specific options") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) kw_arg = {} if parsed_args.pool_uri: kw_arg["uri"] = parsed_args.pool_uri if parsed_args.pool_weight: kw_arg["weight"] = parsed_args.pool_weight if parsed_args.pool_group: kw_arg["group"] = parsed_args.pool_group if parsed_args.pool_options: kw_arg["options"] = parsed_args.pool_options pool_obj = client.pool(parsed_args.pool_name, auto_create=False) pool_obj.update(kw_arg) pool_data = pool_obj.get() columns = ('Name', 'Weight', 'URI', 'Group', 'Options') return columns, utils.get_dict_properties(pool_data, columns) class DeletePool(command.Command): """Delete a pool""" log = logging.getLogger(__name__ + ".DeletePool") def get_parser(self, prog_name): parser = super(DeletePool, self).get_parser(prog_name) parser.add_argument( "pool_name", metavar="", help="Name of the pool") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) pool_name = parsed_args.pool_name client.pool(pool_name, auto_create=False).delete() class ListPools(lister.Lister): """List available Pools""" log = logging.getLogger(__name__ + ".ListPools") def get_parser(self, prog_name): parser = super(ListPools, self).get_parser(prog_name) parser.add_argument( "--marker", metavar="", help="Pool's paging marker") parser.add_argument( "--limit", metavar="", help="Page size limit") parser.add_argument( "--detailed", type=bool, metavar="", help="Detailed output") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) kwargs = {} columns = ["Name", "Weight", "URI", "Group"] if parsed_args.marker is not None: kwargs["marker"] = parsed_args.marker if parsed_args.limit is not None: kwargs["limit"] = parsed_args.limit if parsed_args.detailed is not None and parsed_args.detailed: kwargs["detailed"] = parsed_args.detailed columns.append("Options") data = client.pools(**kwargs) columns = tuple(columns) return (columns, (utils.get_item_properties(s, columns) for s in data)) class UpdateFlavor(show.ShowOne): """Update a flavor's attributes""" log = logging.getLogger(__name__+".UpdateFlavor") def get_parser(self, prog_name): parser = super(UpdateFlavor, self).get_parser(prog_name) parser.add_argument( "flavor_name", metavar="", help="Name of the flavor") parser.add_argument( "--pool_group", metavar="", help="Pool group the flavor sits on") parser.add_argument( "--capabilities", metavar="", type=json.loads, help="Describes flavor-specific capabilities.") return parser def take_action(self, parsed_args): self.log.debug("take_action(%s)" % parsed_args) client = self.app.client_manager.messaging kwargs = {} if parsed_args.pool_group: kwargs['pool'] = parsed_args.pool_group if parsed_args.capabilities: kwargs['capabilities'] = json.loads(parsed_args.capabilities) flavor = client.flavor(parsed_args.flavor_name, auto_create=False) columns = ('Name', 'Pool', 'Capabilities') flavor.update(kwargs) flavor_data = flavor.get() return columns, utils.get_dict_properties(flavor_data, columns) class CreateFlavor(show.ShowOne): """Create a pool flavor""" log = logging.getLogger(__name__ + ".CreateFlavor") def get_parser(self, prog_name): parser = super(CreateFlavor, self).get_parser(prog_name) parser.add_argument( "flavor_name", metavar="", help="Name of the flavor") parser.add_argument( "pool_group", metavar="", help="Pool group for flavor") parser.add_argument( "--capabilities", metavar="", type=json.loads, default={}, help="Describes flavor-specific capabilities, " "This option is only available in client api version < 2 .") return parser def take_action(self, parsed_args): self.log.debug("take_action(%s)" % parsed_args) client = self.app.client_manager.messaging # FIXME(flwang): For now, we still use `pool` though it's not really # correct since it's representing `pool_group` actually. But given we # will remove pool group soon and get a 1:n mapping for flavor:pool, # so let's keep it as it's, just for now. kwargs = {'capabilities': parsed_args.capabilities} data = client.flavor(parsed_args.flavor_name, pool=parsed_args.pool_group, **kwargs) columns = ('Name', 'Pool', 'Capabilities') return columns, utils.get_item_properties(data, columns) class DeleteFlavor(command.Command): """Delete a flavor""" log = logging.getLogger(__name__ + ".DeleteFlavor") def get_parser(self, prog_name): parser = super(DeleteFlavor, self).get_parser(prog_name) parser.add_argument( "flavor_name", metavar="", help="Name of the flavor") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) flavor_name = parsed_args.flavor_name client.flavor(flavor_name).delete() class ShowFlavor(show.ShowOne): """Display flavor details""" log = logging.getLogger(__name__ + ".ShowFlavor") def get_parser(self, prog_name): parser = super(ShowFlavor, self).get_parser(prog_name) parser.add_argument( "flavor_name", metavar="", help="Flavor to display (name)", ) return parser def take_action(self, parsed_args): self.log.debug("take_action(%s)", parsed_args) client = self.app.client_manager.messaging flavor_data = client.flavor(parsed_args.flavor_name, auto_create=False).get() columns = ('Name', 'Pool', 'Capabilities') return columns, utils.get_dict_properties(flavor_data, columns) class ListFlavors(lister.Lister): """List available flavors""" log = logging.getLogger(__name__ + ".ListFlavors") def get_parser(self, prog_name): parser = super(ListFlavors, self).get_parser(prog_name) parser.add_argument( "--marker", metavar="", help="Flavor's paging marker") parser.add_argument( "--limit", metavar="", help="Page size limit") parser.add_argument( "--detailed", type=bool, default=False, metavar="", help="If show detailed capabilities of flavor") return parser def take_action(self, parsed_args): self.log.debug("take_action(%s)" % parsed_args) client = self.app.client_manager.messaging kwargs = {'detailed': parsed_args.detailed} if parsed_args.marker is not None: kwargs["marker"] = parsed_args.marker if parsed_args.limit is not None: kwargs["limit"] = parsed_args.limit data = client.flavors(**kwargs) columns = ("Name", 'Pool', 'Capabilities') return (columns, (utils.get_item_properties(s, columns) for s in data)) class CreateClaim(lister.Lister): """Create claim and return a list of claimed messages""" log = logging.getLogger(__name__ + ".CreateClaim") def get_parser(self, prog_name): parser = super(CreateClaim, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the queue to be claim") parser.add_argument( "--ttl", metavar="", type=int, default=300, help="Time to live in seconds for claim") parser.add_argument( "--grace", metavar="", type=int, default=60, help="The message grace period in seconds") parser.add_argument( "--limit", metavar="", type=int, default=10, help="Claims a set of messages, up to limit") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) kwargs = {} if parsed_args.ttl is not None: kwargs["ttl"] = parsed_args.ttl if parsed_args.grace is not None: kwargs["grace"] = parsed_args.grace if parsed_args.limit is not None: kwargs["limit"] = parsed_args.limit queue = client.queue(parsed_args.queue_name, auto_create=False) keys = ("claim_id", "_id", "ttl", "age", 'body') columns = ("Claim_ID", "Message_ID", "TTL", "Age", "Messages") data = queue.claim(**kwargs) return (columns, (utils.get_item_properties(s, keys) for s in data)) class QueryClaim(lister.Lister): """Display claim details""" log = logging.getLogger(__name__ + ".QueryClaim") def get_parser(self, prog_name): parser = super(QueryClaim, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the claimed queue") parser.add_argument( "claim_id", metavar="", help="ID of the claim") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue = client.queue(parsed_args.queue_name, auto_create=False) keys = ("_id", "age", "ttl", "body") columns = ("Message_ID", "Age", "TTL", "Message") data = queue.claim(id=parsed_args.claim_id)._get() return (columns, (utils.get_item_properties(s, keys) for s in data)) class RenewClaim(lister.Lister): """Renew a claim""" log = logging.getLogger(__name__ + ".RenewClaim") def get_parser(self, prog_name): parser = super(RenewClaim, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the claimed queue") parser.add_argument( "claim_id", metavar="", help="Claim ID") parser.add_argument( "--ttl", metavar="", type=int, help="Time to live in seconds for claim") parser.add_argument( "--grace", metavar="", type=int, help="The message grace period in seconds") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue = client.queue(parsed_args.queue_name, auto_create=False) kwargs = {} if parsed_args.ttl is not None: kwargs["ttl"] = parsed_args.ttl if parsed_args.grace is not None: kwargs["grace"] = parsed_args.grace claim_obj = queue.claim(id=parsed_args.claim_id) claim_obj.update(**kwargs) data = claim_obj._get() keys = ("_id", "age", "ttl", "body") columns = ("Message_ID", "Age", "TTL", "Message") return (columns, (utils.get_item_properties(s, keys) for s in data)) class ReleaseClaim(command.Command): """Delete a claim""" log = logging.getLogger(__name__ + ".ReleaseClaim") def get_parser(self, prog_name): parser = super(ReleaseClaim, self).get_parser(prog_name) parser.add_argument( "queue_name", metavar="", help="Name of the claimed queue") parser.add_argument( "claim_id", metavar="", help="Claim ID to delete") return parser def take_action(self, parsed_args): client = _get_client(self, parsed_args) queue = client.queue(parsed_args.queue_name, auto_create=False) queue.claim(id=parsed_args.claim_id).delete()