st2actions.ActionExecutionDispatcher.shutdown() - Code Metrics - Inspection of "Avoid leaving zombie executions" - StackStorm/st2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2299)

by Manas

created 2015-12-17 01:10 UTC

st2actions.ActionExecutionDispatcher.shutdown() A

↳ Parent: st2actions.ActionExecutionDispatcher

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	9
rs	9.6667
cc	3

# 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 consumers, liveaction
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(consumers.MessageHandler):
    message_type = LiveActionDB

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

    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 consumers, liveaction
30			from st2common.transport import utils as transport_utils
31			from st2common.util import action_db as action_utils
32			from st2common.util import system_info
33
34
35			LOG = logging.getLogger(__name__)
36
37			ACTIONRUNNER_WORK_Q = liveaction.get_status_management_queue(
38			'st2.actionrunner.work', routing_key=action_constants.LIVEACTION_STATUS_SCHEDULED)
39
40			ACTIONRUNNER_CANCEL_Q = liveaction.get_status_management_queue(
41			'st2.actionrunner.canel', routing_key=action_constants.LIVEACTION_STATUS_CANCELING)
42
43
44			class ActionExecutionDispatcher(consumers.MessageHandler):
45			message_type = LiveActionDB
46
47			def __init__(self, connection, queues):
48			super(ActionExecutionDispatcher, self).__init__(connection, queues)
49			self.container = RunnerContainer()
50			self._running_liveactions = set()
51
52			def process(self, liveaction):
			0 ignored issues – show Comprehensibility Bug introduced 2015-11-20 23:04 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...
53			"""Dispatches the LiveAction to appropriate action runner.
54
55			LiveAction in statuses other than "scheduled" and "canceling" are ignored. If
56			LiveAction is already canceled and result is empty, the LiveAction
57			is updated with a generic exception message.
58
59			:param liveaction: Action execution request.
60			:type liveaction: ``st2common.models.db.liveaction.LiveActionDB``
61
62			:rtype: ``dict``
63			"""
64
65			if liveaction.status == action_constants.LIVEACTION_STATUS_CANCELED:
66			LOG.info('%s is not executing %s (id=%s) with "%s" status.',
67			self.__class__.__name__, type(liveaction), liveaction.id, liveaction.status)
68			if not liveaction.result:
69			updated_liveaction = action_utils.update_liveaction_status(
70			status=liveaction.status,
71			result={'message': 'Action execution canceled by user.'},
72			liveaction_id=liveaction.id)
73			executions.update_execution(updated_liveaction)
74			return
75
76			if liveaction.status not in [action_constants.LIVEACTION_STATUS_SCHEDULED,
77			action_constants.LIVEACTION_STATUS_CANCELING]:
78			LOG.info('%s is not dispatching %s (id=%s) with "%s" status.',
79			self.__class__.__name__, type(liveaction), liveaction.id, liveaction.status)
80			return
81
82			try:
83			liveaction_db = action_utils.get_liveaction_by_id(liveaction.id)
84			except StackStormDBObjectNotFoundError:
85			LOG.exception('Failed to find liveaction %s in the database.', liveaction.id)
86			raise
87
88			return (self._run_action(liveaction_db)
89			if liveaction.status == action_constants.LIVEACTION_STATUS_SCHEDULED
90			else self._cancel_action(liveaction_db))
91
92			def shutdown(self):
93			super(ActionExecutionDispatcher, self).shutdown()
94			# Abandon running executions if incomplete
95			while self._running_liveactions:
96			liveaction_id = self._running_liveactions.pop()
97			try:
98			executions.abandon_execution_if_incomplete(liveaction_id=liveaction_id)
99			except:
100			LOG.exception('Failed to abandon liveaction %s.', liveaction_id)
101
102			def _run_action(self, liveaction_db):
103			# stamp liveaction with process_info
104			runner_info = system_info.get_process_info()
105
106			# Update liveaction status to "running"
107			liveaction_db = action_utils.update_liveaction_status(
108			status=action_constants.LIVEACTION_STATUS_RUNNING,
109			runner_info=runner_info,
110			liveaction_id=liveaction_db.id)
111
112			self._running_liveactions.add(liveaction_db.id)
113
114			action_execution_db = executions.update_execution(liveaction_db)
115
116			# Launch action
117			extra = {'action_execution_db': action_execution_db, 'liveaction_db': liveaction_db}
118			LOG.audit('Launching action execution.', extra=extra)
119
120			# the extra field will not be shown in non-audit logs so temporarily log at info.
121			LOG.info('Dispatched {~}action_execution: %s / {~}live_action: %s with "%s" status.',
122			action_execution_db.id, liveaction_db.id, liveaction_db.status)
123
124			extra = {'liveaction_db': liveaction_db}
125			try:
126			result = self.container.dispatch(liveaction_db)
127			LOG.debug('Runner dispatch produced result: %s', result)
128			if not result:
129			raise ActionRunnerException('Failed to execute action.')
130			except:
131			_, ex, tb = sys.exc_info()
132			extra['error'] = str(ex)
133			LOG.info('Action "%s" failed: %s' % (liveaction_db.action, str(ex)), extra=extra)
134
135			liveaction_db = action_utils.update_liveaction_status(
136			status=action_constants.LIVEACTION_STATUS_FAILED,
137			liveaction_id=liveaction_db.id,
138			result={'error': str(ex), 'traceback': ''.join(traceback.format_tb(tb, 20))})
139			executions.update_execution(liveaction_db)
140			raise
141			finally:
142			self._running_liveactions.remove(liveaction_db.id)
143
144			return result
145
146			def _cancel_action(self, liveaction_db):
147			action_execution_db = ActionExecution.get(liveaction__id=str(liveaction_db.id))
148			extra = {'action_execution_db': action_execution_db, 'liveaction_db': liveaction_db}
149			LOG.audit('Canceling action execution.', extra=extra)
150
151			# the extra field will not be shown in non-audit logs so temporarily log at info.
152			LOG.info('Dispatched {~}action_execution: %s / {~}live_action: %s with "%s" status.',
153			action_execution_db.id, liveaction_db.id, liveaction_db.status)
154
155			try:
156			result = self.container.dispatch(liveaction_db)
157			LOG.debug('Runner dispatch produced result: %s', result)
158			except:
159			_, ex, tb = sys.exc_info()
160			extra['error'] = str(ex)
161			LOG.info('Failed to cancel action execution %s.' % (liveaction_db.id), extra=extra)
162			raise
163
164			return result
165
166
167			def get_worker():
168			with Connection(transport_utils.get_messaging_urls()) as conn:
169			return ActionExecutionDispatcher(conn, [ACTIONRUNNER_WORK_Q, ACTIONRUNNER_CANCEL_Q])
170

StackStorm / st2

Pull Request — master (#2299)

st2actions.ActionExecutionDispatcher.shutdown() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like