ActionExecutionDispatcher.__init__() - Code Metrics - Inspection of "Merge pull request #2823 from StackStorm/two_dispa..." - StackStorm/st2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 82f613...a5d438 )

by Plexxi

created 2016-07-24 06:42 UTC

ActionExecutionDispatcher.init() A

↳ Parent: ActionExecutionDispatcher

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

# Licensed to the StackStorm, Inc ('StackStorm') under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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 sys
import traceback

from kombu import Connection

from st2actions.container.base import RunnerContainer
from st2common import log as logging
from st2common.constants import action as action_constants
from st2common.exceptions.actionrunner import ActionRunnerException
from st2common.exceptions.db import StackStormDBObjectNotFoundError
from st2common.models.db.liveaction import LiveActionDB
from st2common.persistence.execution import ActionExecution
from st2common.services import executions
from st2common.transport import liveaction
from st2common.transport.consumers import MessageHandler
from st2common.transport.consumers import ActionsQueueConsumer
from st2common.transport import utils as transport_utils
from st2common.util import action_db as action_utils
from st2common.util import system_info


LOG = logging.getLogger(__name__)

ACTIONRUNNER_WORK_Q = liveaction.get_status_management_queue(
    'st2.actionrunner.work', routing_key=action_constants.LIVEACTION_STATUS_SCHEDULED)

ACTIONRUNNER_CANCEL_Q = liveaction.get_status_management_queue(
    'st2.actionrunner.canel', routing_key=action_constants.LIVEACTION_STATUS_CANCELING)


class ActionExecutionDispatcher(MessageHandler):
    message_type = LiveActionDB

    def __init__(self, connection, queues):
        super(ActionExecutionDispatcher, self).__init__(connection, queues)
        self.container = RunnerContainer()
        self._running_liveactions = set()

    def get_queue_consumer(self, connection, queues):
        # We want to use a special ActionsQueueConsumer which uses 2 dispatcher pools
        return ActionsQueueConsumer(connection=connection, queues=queues, handler=self)

    def process(self, liveaction):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
        """Dispatches the LiveAction to appropriate action runner.

        LiveAction in statuses other than "scheduled" and "canceling" are ignored. If
        LiveAction is already canceled and result is empty, the LiveAction
        is updated with a generic exception message.

        :param liveaction: Action execution request.
        :type liveaction: ``st2common.models.db.liveaction.LiveActionDB``

        :rtype: ``dict``
        """

        if liveaction.status == action_constants.LIVEACTION_STATUS_CANCELED:
            LOG.info('%s is not executing %s (id=%s) with "%s" status.',
                     self.__class__.__name__, type(liveaction), liveaction.id, liveaction.status)
            if not liveaction.result:
                updated_liveaction = action_utils.update_liveaction_status(
                    status=liveaction.status,
                    result={'message': 'Action execution canceled by user.'},
                    liveaction_id=liveaction.id)
                executions.update_execution(updated_liveaction)
            return

        if liveaction.status not in [action_constants.LIVEACTION_STATUS_SCHEDULED,
                                     action_constants.LIVEACTION_STATUS_CANCELING]:
            LOG.info('%s is not dispatching %s (id=%s) with "%s" status.',
                     self.__class__.__name__, type(liveaction), liveaction.id, liveaction.status)
            return

        try:
            liveaction_db = action_utils.get_liveaction_by_id(liveaction.id)
        except StackStormDBObjectNotFoundError:
            LOG.exception('Failed to find liveaction %s in the database.', liveaction.id)
            raise

        return (self._run_action(liveaction_db)
                if liveaction.status == action_constants.LIVEACTION_STATUS_SCHEDULED
                else self._cancel_action(liveaction_db))

    def shutdown(self):
        super(ActionExecutionDispatcher, self).shutdown()
        # Abandon running executions if incomplete
        while self._running_liveactions:
            liveaction_id = self._running_liveactions.pop()
            try:
                executions.abandon_execution_if_incomplete(liveaction_id=liveaction_id)
            except:
                LOG.exception('Failed to abandon liveaction %s.', liveaction_id)

    def _run_action(self, liveaction_db):
        # stamp liveaction with process_info
        runner_info = system_info.get_process_info()

        # Update liveaction status to "running"
        liveaction_db = action_utils.update_liveaction_status(
            status=action_constants.LIVEACTION_STATUS_RUNNING,
            runner_info=runner_info,
            liveaction_id=liveaction_db.id)

        self._running_liveactions.add(liveaction_db.id)

        action_execution_db = executions.update_execution(liveaction_db)

        # Launch action
        extra = {'action_execution_db': action_execution_db, 'liveaction_db': liveaction_db}
        LOG.audit('Launching action execution.', extra=extra)

        # the extra field will not be shown in non-audit logs so temporarily log at info.
        LOG.info('Dispatched {~}action_execution: %s / {~}live_action: %s with "%s" status.',
                 action_execution_db.id, liveaction_db.id, liveaction_db.status)

        extra = {'liveaction_db': liveaction_db}
        try:
            result = self.container.dispatch(liveaction_db)
            LOG.debug('Runner dispatch produced result: %s', result)
            if not result:
                raise ActionRunnerException('Failed to execute action.')
        except:
            _, ex, tb = sys.exc_info()
            extra['error'] = str(ex)
            LOG.info('Action "%s" failed: %s' % (liveaction_db.action, str(ex)), extra=extra)

            liveaction_db = action_utils.update_liveaction_status(
                status=action_constants.LIVEACTION_STATUS_FAILED,
                liveaction_id=liveaction_db.id,
                result={'error': str(ex), 'traceback': ''.join(traceback.format_tb(tb, 20))})
            executions.update_execution(liveaction_db)
            raise
        finally:
            self._running_liveactions.remove(liveaction_db.id)

        return result

    def _cancel_action(self, liveaction_db):
        action_execution_db = ActionExecution.get(liveaction__id=str(liveaction_db.id))
        extra = {'action_execution_db': action_execution_db, 'liveaction_db': liveaction_db}
        LOG.audit('Canceling action execution.', extra=extra)

        # the extra field will not be shown in non-audit logs so temporarily log at info.
        LOG.info('Dispatched {~}action_execution: %s / {~}live_action: %s with "%s" status.',
                 action_execution_db.id, liveaction_db.id, liveaction_db.status)

        try:
            result = self.container.dispatch(liveaction_db)
            LOG.debug('Runner dispatch produced result: %s', result)
        except:
            _, ex, tb = sys.exc_info()
            extra['error'] = str(ex)
            LOG.info('Failed to cancel action execution %s.' % (liveaction_db.id), extra=extra)
            raise

        return result


def get_worker():
    with Connection(transport_utils.get_messaging_urls()) as conn:
        return ActionExecutionDispatcher(conn, [ACTIONRUNNER_WORK_Q, ACTIONRUNNER_CANCEL_Q])


1			# Licensed to the StackStorm, Inc ('StackStorm') under one or more
2			# contributor license agreements. See the NOTICE file distributed with
3			# this work for additional information regarding copyright ownership.
4			# The ASF licenses this file to You under the Apache License, Version 2.0
5			# (the "License"); you may not use this file except in compliance with
6			# the License. You may obtain a copy of the License at
7			#
8			# http://www.apache.org/licenses/LICENSE-2.0
9			#
10			# Unless required by applicable law or agreed to in writing, software
11			# distributed under the License is distributed on an "AS IS" BASIS,
12			# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13			# See the License for the specific language governing permissions and
14			# limitations under the License.
15
16			import sys
17			import traceback
18
19			from kombu import Connection
20
21			from st2actions.container.base import RunnerContainer
22			from st2common import log as logging
23			from st2common.constants import action as action_constants
24			from st2common.exceptions.actionrunner import ActionRunnerException
25			from st2common.exceptions.db import StackStormDBObjectNotFoundError
26			from st2common.models.db.liveaction import LiveActionDB
27			from st2common.persistence.execution import ActionExecution
28			from st2common.services import executions
29			from st2common.transport import liveaction
30			from st2common.transport.consumers import MessageHandler
31			from st2common.transport.consumers import ActionsQueueConsumer
32			from st2common.transport import utils as transport_utils
33			from st2common.util import action_db as action_utils
34			from st2common.util import system_info
35
36
37			LOG = logging.getLogger(__name__)
38
39			ACTIONRUNNER_WORK_Q = liveaction.get_status_management_queue(
40			'st2.actionrunner.work', routing_key=action_constants.LIVEACTION_STATUS_SCHEDULED)
41
42			ACTIONRUNNER_CANCEL_Q = liveaction.get_status_management_queue(
43			'st2.actionrunner.canel', routing_key=action_constants.LIVEACTION_STATUS_CANCELING)
44
45
46			class ActionExecutionDispatcher(MessageHandler):
47			message_type = LiveActionDB
48
49			def __init__(self, connection, queues):
50			super(ActionExecutionDispatcher, self).__init__(connection, queues)
51			self.container = RunnerContainer()
52			self._running_liveactions = set()
53
54			def get_queue_consumer(self, connection, queues):
55			# We want to use a special ActionsQueueConsumer which uses 2 dispatcher pools
56			return ActionsQueueConsumer(connection=connection, queues=queues, handler=self)
57
58			def process(self, liveaction):
			0 ignored issues – show Comprehensibility Bug introduced 2016-02-04 14:00 UTC by Report Bug Copy Issue Report `liveaction` is re-defining a name which is already available in the outer-scope (previously defined on line `29`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
59			"""Dispatches the LiveAction to appropriate action runner.
60
61			LiveAction in statuses other than "scheduled" and "canceling" are ignored. If
62			LiveAction is already canceled and result is empty, the LiveAction
63			is updated with a generic exception message.
64
65			:param liveaction: Action execution request.
66			:type liveaction: ``st2common.models.db.liveaction.LiveActionDB``
67
68			:rtype: ``dict``
69			"""
70
71			if liveaction.status == action_constants.LIVEACTION_STATUS_CANCELED:
72			LOG.info('%s is not executing %s (id=%s) with "%s" status.',
73			self.__class__.__name__, type(liveaction), liveaction.id, liveaction.status)
74			if not liveaction.result:
75			updated_liveaction = action_utils.update_liveaction_status(
76			status=liveaction.status,
77			result={'message': 'Action execution canceled by user.'},
78			liveaction_id=liveaction.id)
79			executions.update_execution(updated_liveaction)
80			return
81
82			if liveaction.status not in [action_constants.LIVEACTION_STATUS_SCHEDULED,
83			action_constants.LIVEACTION_STATUS_CANCELING]:
84			LOG.info('%s is not dispatching %s (id=%s) with "%s" status.',
85			self.__class__.__name__, type(liveaction), liveaction.id, liveaction.status)
86			return
87
88			try:
89			liveaction_db = action_utils.get_liveaction_by_id(liveaction.id)
90			except StackStormDBObjectNotFoundError:
91			LOG.exception('Failed to find liveaction %s in the database.', liveaction.id)
92			raise
93
94			return (self._run_action(liveaction_db)
95			if liveaction.status == action_constants.LIVEACTION_STATUS_SCHEDULED
96			else self._cancel_action(liveaction_db))
97
98			def shutdown(self):
99			super(ActionExecutionDispatcher, self).shutdown()
100			# Abandon running executions if incomplete
101			while self._running_liveactions:
102			liveaction_id = self._running_liveactions.pop()
103			try:
104			executions.abandon_execution_if_incomplete(liveaction_id=liveaction_id)
105			except:
106			LOG.exception('Failed to abandon liveaction %s.', liveaction_id)
107
108			def _run_action(self, liveaction_db):
109			# stamp liveaction with process_info
110			runner_info = system_info.get_process_info()
111
112			# Update liveaction status to "running"
113			liveaction_db = action_utils.update_liveaction_status(
114			status=action_constants.LIVEACTION_STATUS_RUNNING,
115			runner_info=runner_info,
116			liveaction_id=liveaction_db.id)
117
118			self._running_liveactions.add(liveaction_db.id)
119
120			action_execution_db = executions.update_execution(liveaction_db)
121
122			# Launch action
123			extra = {'action_execution_db': action_execution_db, 'liveaction_db': liveaction_db}
124			LOG.audit('Launching action execution.', extra=extra)
125
126			# the extra field will not be shown in non-audit logs so temporarily log at info.
127			LOG.info('Dispatched {~}action_execution: %s / {~}live_action: %s with "%s" status.',
128			action_execution_db.id, liveaction_db.id, liveaction_db.status)
129
130			extra = {'liveaction_db': liveaction_db}
131			try:
132			result = self.container.dispatch(liveaction_db)
133			LOG.debug('Runner dispatch produced result: %s', result)
134			if not result:
135			raise ActionRunnerException('Failed to execute action.')
136			except:
137			_, ex, tb = sys.exc_info()
138			extra['error'] = str(ex)
139			LOG.info('Action "%s" failed: %s' % (liveaction_db.action, str(ex)), extra=extra)
140
141			liveaction_db = action_utils.update_liveaction_status(
142			status=action_constants.LIVEACTION_STATUS_FAILED,
143			liveaction_id=liveaction_db.id,
144			result={'error': str(ex), 'traceback': ''.join(traceback.format_tb(tb, 20))})
145			executions.update_execution(liveaction_db)
146			raise
147			finally:
148			self._running_liveactions.remove(liveaction_db.id)
149
150			return result
151
152			def _cancel_action(self, liveaction_db):
153			action_execution_db = ActionExecution.get(liveaction__id=str(liveaction_db.id))
154			extra = {'action_execution_db': action_execution_db, 'liveaction_db': liveaction_db}
155			LOG.audit('Canceling action execution.', extra=extra)
156
157			# the extra field will not be shown in non-audit logs so temporarily log at info.
158			LOG.info('Dispatched {~}action_execution: %s / {~}live_action: %s with "%s" status.',
159			action_execution_db.id, liveaction_db.id, liveaction_db.status)
160
161			try:
162			result = self.container.dispatch(liveaction_db)
163			LOG.debug('Runner dispatch produced result: %s', result)
164			except:
165			_, ex, tb = sys.exc_info()
166			extra['error'] = str(ex)
167			LOG.info('Failed to cancel action execution %s.' % (liveaction_db.id), extra=extra)
168			raise
169
170			return result
171
172
173			def get_worker():
174			with Connection(transport_utils.get_messaging_urls()) as conn:
175			return ActionExecutionDispatcher(conn, [ACTIONRUNNER_WORK_Q, ACTIONRUNNER_CANCEL_Q])
176

StackStorm / st2

Push — develop ( 82f613...a5d438 )

ActionExecutionDispatcher.__init__() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ActionExecutionDispatcher.init() A