Source code for heat.engine.clients.progress

#    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
#    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.

"""Helper classes that are simple key-value storages
meant to be passed between handle_* and check_*_complete,
being mutated during subsequent check_*_complete calls.

Some of them impose restrictions on client plugin API, thus they are
put in this client-plugin-agnostic module.


[docs]class ServerCreateProgress(object): def __init__(self, server_id, complete=False): self.complete = complete self.server_id = server_id
[docs]class ServerUpdateProgress(ServerCreateProgress): """Keeps track on particular server update task. ``handler`` is a method of client plugin performing required update operation. Its first positional argument must be ``server_id`` and this method must be resilent to intermittent failures, returning ``True`` if API was successfully called, ``False`` otherwise. If result of API call is asynchronous, client plugin must have corresponding ``check_<handler>`` method. Its first positional argument must be ``server_id`` and it must return ``True`` or ``False`` indicating completeness of the update operation. For synchronous API calls, set ``complete`` attribute of this object to ``True``. ``[handler|checker]_extra`` arguments, if passed to constructor, should be dictionaries of {'args': tuple(), 'kwargs': dict()} structure and contain parameters with which corresponding ``handler`` and ``check_<handler>`` methods of client plugin must be called. ``args`` is automatically prepended with ``server_id``. Missing ``args`` or ``kwargs`` are interpreted as empty tuple/dict respectively. Defaults are interpreted as both ``args`` and ``kwargs`` being empty. """ def __init__(self, server_id, handler, complete=False, called=False, handler_extra=None, checker_extra=None): super(ServerUpdateProgress, self).__init__(server_id, complete) self.called = called self.handler = handler self.checker = 'check_%s' % handler # set call arguments basing on incomplete values and defaults hargs = handler_extra or {} self.handler_args = (server_id,) + (hargs.get('args') or ()) self.handler_kwargs = hargs.get('kwargs') or {} cargs = checker_extra or {} self.checker_args = (server_id,) + (cargs.get('args') or ()) self.checker_kwargs = cargs.get('kwargs') or {}
[docs]class ServerDeleteProgress(object): def __init__(self, server_id, image_id=None, image_complete=True): self.server_id = server_id self.image_id = image_id self.image_complete = image_complete
[docs]class VolumeDetachProgress(object): def __init__(self, srv_id, vol_id, attach_id, task_complete=False): self.called = task_complete self.cinder_complete = task_complete self.nova_complete = task_complete self.srv_id = srv_id self.vol_id = vol_id self.attach_id = attach_id
[docs]class VolumeAttachProgress(object): def __init__(self, srv_id, vol_id, device, task_complete=False): self.called = task_complete self.complete = task_complete self.srv_id = srv_id self.vol_id = vol_id self.device = device
[docs]class VolumeDeleteProgress(object): def __init__(self, task_complete=False): self.backup = {'called': task_complete, 'complete': task_complete} self.delete = {'called': task_complete, 'complete': task_complete} self.backup_id = None
[docs]class VolumeResizeProgress(object): def __init__(self, task_complete=False, size=None): self.called = task_complete self.complete = task_complete self.size = size
[docs]class VolumeUpdateAccessModeProgress(object): def __init__(self, task_complete=False, read_only=None): self.called = task_complete self.read_only = read_only
[docs]class VolumeBackupRestoreProgress(object): def __init__(self, vol_id, backup_id): self.called = False self.complete = False self.vol_id = vol_id self.backup_id = backup_id
[docs]class PoolDeleteProgress(object): def __init__(self, task_complete=False): self.pool = {'delete_called': task_complete, 'deleted': task_complete} = {'delete_called': task_complete, 'deleted': task_complete}

Project Source