105 lines
3.7 KiB
Python
105 lines
3.7 KiB
Python
# Copyright 2016 NTT DATA
|
|
#
|
|
# 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 os
|
|
|
|
from oslo_log import log as logging
|
|
from stevedore import named
|
|
# For more information please visit: https://wiki.openstack.org/wiki/TaskFlow
|
|
from taskflow import formatters
|
|
from taskflow.listeners import base
|
|
from taskflow.listeners import logging as logging_listener
|
|
from taskflow import task
|
|
|
|
from masakari import exception
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def _make_task_name(cls, addons=None):
|
|
"""Makes a pretty name for a task class."""
|
|
base_name = ".".join([cls.__module__, cls.__name__])
|
|
extra = ''
|
|
if addons:
|
|
extra = ';%s' % (", ".join([str(a) for a in addons]))
|
|
return base_name + extra
|
|
|
|
|
|
class MasakariTask(task.Task):
|
|
"""The root task class for all masakari tasks.
|
|
|
|
It automatically names the given task using the module and class that
|
|
implement the given task as the task name.
|
|
"""
|
|
|
|
def __init__(self, addons=None, **kwargs):
|
|
super(MasakariTask, self).__init__(self.make_name(addons), **kwargs)
|
|
|
|
@classmethod
|
|
def make_name(cls, addons=None):
|
|
return _make_task_name(cls, addons)
|
|
|
|
|
|
class SpecialFormatter(formatters.FailureFormatter):
|
|
|
|
# Exception is an excepted case, don't include traceback in log if fails.
|
|
_NO_TRACE_EXCEPTIONS = (exception.SkipInstanceRecoveryException,
|
|
exception.SkipHostRecoveryException)
|
|
|
|
def __init__(self, engine):
|
|
super(SpecialFormatter, self).__init__(engine)
|
|
|
|
def format(self, fail, atom_matcher):
|
|
if fail.check(*self._NO_TRACE_EXCEPTIONS) is not None:
|
|
exc_info = None
|
|
exc_details = '%s%s' % (os.linesep, fail.pformat(traceback=False))
|
|
return (exc_info, exc_details)
|
|
else:
|
|
return super(SpecialFormatter, self).format(fail, atom_matcher)
|
|
|
|
|
|
class DynamicLogListener(logging_listener.DynamicLoggingListener):
|
|
"""This is used to attach to taskflow engines while they are running.
|
|
|
|
It provides a bunch of useful features that expose the actions happening
|
|
inside a taskflow engine, which can be useful for developers for debugging,
|
|
for operations folks for monitoring and tracking of the resource actions
|
|
and more...
|
|
"""
|
|
|
|
def __init__(self, engine,
|
|
task_listen_for=base.DEFAULT_LISTEN_FOR,
|
|
flow_listen_for=base.DEFAULT_LISTEN_FOR,
|
|
retry_listen_for=base.DEFAULT_LISTEN_FOR,
|
|
logger=LOG):
|
|
super(DynamicLogListener, self).__init__(
|
|
engine,
|
|
task_listen_for=task_listen_for,
|
|
flow_listen_for=flow_listen_for,
|
|
retry_listen_for=retry_listen_for,
|
|
log=logger, fail_formatter=SpecialFormatter(engine))
|
|
|
|
|
|
def get_recovery_flow(task_list, **kwargs):
|
|
"""This is used create extension object from provided task_list.
|
|
|
|
This method returns the extension object of the each task provided
|
|
in a list using stevedore extension manager.
|
|
"""
|
|
extensions = named.NamedExtensionManager(
|
|
'masakari.task_flow.tasks', names=task_list,
|
|
name_order=True, invoke_on_load=True, invoke_kwds=kwargs)
|
|
for extension in extensions.extensions:
|
|
yield extension.obj
|