ActionRunner.get_pack_ref() - Code Metrics - Inspection of "Common pack lib for sensors and actions" - StackStorm/st2 - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#3658)

by Lakshmi

created 2017-11-07 16:14 UTC

ActionRunner.get_pack_ref() A

↳ Parent: ActionRunner

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
c	0
b	0
f	0
dl	0
loc	10
rs	9.4285

# 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 abc
import pkgutil

import six
import yaml
from oslo_config import cfg

from st2common import log as logging
from st2common.constants import action as action_constants
from st2common.constants import pack as pack_constants
from st2common.exceptions.actionrunner import ActionRunnerCreateError
from st2common.util import action_db as action_utils
from st2common.util.loader import register_runner, register_callback_module
from st2common.util.api import get_full_public_api_url
from st2common.util.deprecation import deprecated

__all__ = [
    'ActionRunner',
    'AsyncActionRunner',
    'ShellRunnerMixin',
    'get_runner',
    'get_metadata'
]


LOG = logging.getLogger(__name__)

# constants to lookup in runner_parameters
RUNNER_COMMAND = 'cmd'


def get_runner(module_name, config=None):
    """
    Load the module and return an instance of the runner.
    """

    LOG.debug('Runner loading python module: %s', module_name)
    try:
        # TODO: Explore modifying this to support register_plugin
        module = register_runner(module_name)
    except Exception as e:
        LOG.exception('Failed to import module %s.', module_name)
        raise ActionRunnerCreateError(e)

    LOG.debug('Instance of runner module: %s', module)

    if config:
        runner_kwargs = {'config': config}
    else:
        runner_kwargs = {}

    runner = module.get_runner(**runner_kwargs)
    LOG.debug('Instance of runner: %s', runner)
    return runner


def get_metadata(package_name):
    """
    Return runner related metadata for the provided runner package name.

    :rtype: ``list`` of ``dict``
    """
    file_path = pkgutil.get_data(package_name, 'metadata/runner.yaml')
    metadata = yaml.safe_load(file_path)
    return metadata


@six.add_metaclass(abc.ABCMeta)
class ActionRunner(object):
    """
        The interface that must be implemented by each StackStorm
        Action Runner implementation.
    """

    def __init__(self, runner_id):
        """
        :param id: Runner id.
        :type id: ``str``
        """
        self.runner_id = runner_id

        self.runner_type_db = None
        self.runner_parameters = None
        self.action = None
        self.action_name = None
        self.liveaction = None
        self.liveaction_id = None
        self.execution = None
        self.execution_id = None
        self.entry_point = None
        self.libs_dir_path = None
        self.context = None
        self.callback = None
        self.auth_token = None
        self.rerun_ex_ref = None

    def pre_run(self):
        runner_enabled = getattr(self.runner_type_db, 'enabled', True)
        runner_name = getattr(self.runner_type_db, 'name', 'unknown')
        if not runner_enabled:
            msg = ('Runner "%s" has been disabled by the administrator' %
                   (runner_name))
            raise ValueError(msg)

    # Run will need to take an action argument
    # Run may need result data argument
    @abc.abstractmethod
    def run(self, action_parameters):
        raise NotImplementedError()

    def pause(self):
        runner_name = getattr(self.runner_type_db, 'name', 'unknown')
        raise NotImplementedError('Pause is not supported for runner %s.' % runner_name)

    def resume(self):
        runner_name = getattr(self.runner_type_db, 'name', 'unknown')
        raise NotImplementedError('Resume is not supported for runner %s.' % runner_name)

    def cancel(self):
        return (
            action_constants.LIVEACTION_STATUS_CANCELED,
            self.liveaction.result,
            self.liveaction.context
        )

    def post_run(self, status, result):
        callback = self.callback or {}

        if callback and not (set(['url', 'source']) - set(callback.keys())):

            callback_url = callback['url']
            callback_module_name = callback['source']

            try:
                callback_module = register_callback_module(callback_module_name)
            except:
                LOG.exception('Failed importing callback module: %s', callback_module_name)

            callback_handler = callback_module.get_instance()

            callback_handler.callback(
                callback_url,
                self.context,
                status,
                result
            )

    @deprecated
    def get_pack_name(self):
        return self.get_pack_ref()

    def get_pack_ref(self):
        """
        Retrieve pack name for the action which is being currently executed.

        :rtype: ``str``
        """
        if self.action:
            return self.action.pack

        return pack_constants.DEFAULT_PACK_NAME

    def get_user(self):
        """
        Retrieve a name of the user which triggered this action execution.

        :rtype: ``str``
        """
        context = getattr(self, 'context', {}) or {}
        user = context.get('user', cfg.CONF.system_user.user)

        return user

    def _get_common_action_env_variables(self):
        """
        Retrieve common ST2_ACTION_ environment variables which will be available to the action.

        Note: Environment variables are prefixed with ST2_ACTION_* so they don't clash with CLI
        environment variables.

        :rtype: ``dict``
        """
        result = {}
        result['ST2_ACTION_PACK_NAME'] = self.get_pack_ref()
        result['ST2_ACTION_EXECUTION_ID'] = str(self.execution_id)
        result['ST2_ACTION_API_URL'] = get_full_public_api_url()

        if self.auth_token:
            result['ST2_ACTION_AUTH_TOKEN'] = self.auth_token.token

        return result

    def __str__(self):
        attrs = ', '.join(['%s=%s' % (k, v) for k, v in six.iteritems(self.__dict__)])
        return '%s@%s(%s)' % (self.__class__.__name__, str(id(self)), attrs)


@six.add_metaclass(abc.ABCMeta)
class AsyncActionRunner(ActionRunner):
    pass


class ShellRunnerMixin(object):
    """
    Class which contains utility functions to be used by shell runners.
    """

    def _transform_named_args(self, named_args):
        """
        Transform named arguments to the final form.

        :param named_args: Named arguments.
        :type named_args: ``dict``

        :rtype: ``dict``
        """
        if named_args:
            return {self._kwarg_op + k: v for (k, v) in six.iteritems(named_args)}
        return None

    def _get_script_args(self, action_parameters):
        """
        :param action_parameters: Action parameters.
        :type action_parameters: ``dict``

        :return: (positional_args, named_args)
        :rtype: (``str``, ``dict``)
        """
        # TODO: return list for positional args, command classes should escape it
        # and convert it to string

        is_script_run_as_cmd = self.runner_parameters.get(RUNNER_COMMAND, None)

        pos_args = ''
        named_args = {}

        if is_script_run_as_cmd:
            pos_args = self.runner_parameters.get(RUNNER_COMMAND, '')
            named_args = action_parameters
        else:
            pos_args, named_args = action_utils.get_args(action_parameters, self.action)

        return pos_args, named_args


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 abc
17			import pkgutil
18
19			import six
20			import yaml
21			from oslo_config import cfg
22
23			from st2common import log as logging
24			from st2common.constants import action as action_constants
25			from st2common.constants import pack as pack_constants
26			from st2common.exceptions.actionrunner import ActionRunnerCreateError
27			from st2common.util import action_db as action_utils
28			from st2common.util.loader import register_runner, register_callback_module
29			from st2common.util.api import get_full_public_api_url
30			from st2common.util.deprecation import deprecated
31
32			__all__ = [
33			'ActionRunner',
34			'AsyncActionRunner',
35			'ShellRunnerMixin',
36			'get_runner',
37			'get_metadata'
38			]
39
40
41			LOG = logging.getLogger(__name__)
42
43			# constants to lookup in runner_parameters
44			RUNNER_COMMAND = 'cmd'
45
46
47			def get_runner(module_name, config=None):
48			"""
49			Load the module and return an instance of the runner.
50			"""
51
52			LOG.debug('Runner loading python module: %s', module_name)
53			try:
54			# TODO: Explore modifying this to support register_plugin
55			module = register_runner(module_name)
56			except Exception as e:
57			LOG.exception('Failed to import module %s.', module_name)
58			raise ActionRunnerCreateError(e)
59
60			LOG.debug('Instance of runner module: %s', module)
61
62			if config:
63			runner_kwargs = {'config': config}
64			else:
65			runner_kwargs = {}
66
67			runner = module.get_runner(**runner_kwargs)
68			LOG.debug('Instance of runner: %s', runner)
69			return runner
70
71
72			def get_metadata(package_name):
73			"""
74			Return runner related metadata for the provided runner package name.
75
76			:rtype: ``list`` of ``dict``
77			"""
78			file_path = pkgutil.get_data(package_name, 'metadata/runner.yaml')
79			metadata = yaml.safe_load(file_path)
80			return metadata
81
82
83			@six.add_metaclass(abc.ABCMeta)
84			class ActionRunner(object):
85			"""
86			The interface that must be implemented by each StackStorm
87			Action Runner implementation.
88			"""
89
90			def __init__(self, runner_id):
91			"""
92			:param id: Runner id.
93			:type id: ``str``
94			"""
95			self.runner_id = runner_id
96
97			self.runner_type_db = None
98			self.runner_parameters = None
99			self.action = None
100			self.action_name = None
101			self.liveaction = None
102			self.liveaction_id = None
103			self.execution = None
104			self.execution_id = None
105			self.entry_point = None
106			self.libs_dir_path = None
107			self.context = None
108			self.callback = None
109			self.auth_token = None
110			self.rerun_ex_ref = None
111
112			def pre_run(self):
113			runner_enabled = getattr(self.runner_type_db, 'enabled', True)
114			runner_name = getattr(self.runner_type_db, 'name', 'unknown')
115			if not runner_enabled:
116			msg = ('Runner "%s" has been disabled by the administrator' %
117			(runner_name))
118			raise ValueError(msg)
119
120			# Run will need to take an action argument
121			# Run may need result data argument
122			@abc.abstractmethod
123			def run(self, action_parameters):
124			raise NotImplementedError()
125
126			def pause(self):
127			runner_name = getattr(self.runner_type_db, 'name', 'unknown')
128			raise NotImplementedError('Pause is not supported for runner %s.' % runner_name)
129
130			def resume(self):
131			runner_name = getattr(self.runner_type_db, 'name', 'unknown')
132			raise NotImplementedError('Resume is not supported for runner %s.' % runner_name)
133
134			def cancel(self):
135			return (
136			action_constants.LIVEACTION_STATUS_CANCELED,
137			self.liveaction.result,
138			self.liveaction.context
139			)
140
141			def post_run(self, status, result):
142			callback = self.callback or {}
143
144			if callback and not (set(['url', 'source']) - set(callback.keys())):
			0 ignored issues – show Unused Code Coding Style introduced 2017-04-18 08:10 UTC by Report Bug Copy Issue Report There is an unnecessary parenthesis after `not`. Loading history...
145			callback_url = callback['url']
146			callback_module_name = callback['source']
147
148			try:
149			callback_module = register_callback_module(callback_module_name)
150			except:
151			LOG.exception('Failed importing callback module: %s', callback_module_name)
152
153			callback_handler = callback_module.get_instance()
154
155			callback_handler.callback(
156			callback_url,
157			self.context,
158			status,
159			result
160			)
161
162			@deprecated
163			def get_pack_name(self):
164			return self.get_pack_ref()
165
166			def get_pack_ref(self):
167			"""
168			Retrieve pack name for the action which is being currently executed.
169
170			:rtype: ``str``
171			"""
172			if self.action:
173			return self.action.pack
174
175			return pack_constants.DEFAULT_PACK_NAME
176
177			def get_user(self):
178			"""
179			Retrieve a name of the user which triggered this action execution.
180
181			:rtype: ``str``
182			"""
183			context = getattr(self, 'context', {}) or {}
184			user = context.get('user', cfg.CONF.system_user.user)
185
186			return user
187
188			def _get_common_action_env_variables(self):
189			"""
190			Retrieve common ST2_ACTION_ environment variables which will be available to the action.
191
192			Note: Environment variables are prefixed with ST2_ACTION_* so they don't clash with CLI
193			environment variables.
194
195			:rtype: ``dict``
196			"""
197			result = {}
198			result['ST2_ACTION_PACK_NAME'] = self.get_pack_ref()
199			result['ST2_ACTION_EXECUTION_ID'] = str(self.execution_id)
200			result['ST2_ACTION_API_URL'] = get_full_public_api_url()
201
202			if self.auth_token:
203			result['ST2_ACTION_AUTH_TOKEN'] = self.auth_token.token
204
205			return result
206
207			def __str__(self):
208			attrs = ', '.join(['%s=%s' % (k, v) for k, v in six.iteritems(self.__dict__)])
209			return '%s@%s(%s)' % (self.__class__.__name__, str(id(self)), attrs)
210
211
212			@six.add_metaclass(abc.ABCMeta)
213			class AsyncActionRunner(ActionRunner):
214			pass
215
216
217			class ShellRunnerMixin(object):
218			"""
219			Class which contains utility functions to be used by shell runners.
220			"""
221
222			def _transform_named_args(self, named_args):
223			"""
224			Transform named arguments to the final form.
225
226			:param named_args: Named arguments.
227			:type named_args: ``dict``
228
229			:rtype: ``dict``
230			"""
231			if named_args:
232			return {self._kwarg_op + k: v for (k, v) in six.iteritems(named_args)}
233			return None
234
235			def _get_script_args(self, action_parameters):
236			"""
237			:param action_parameters: Action parameters.
238			:type action_parameters: ``dict``
239
240			:return: (positional_args, named_args)
241			:rtype: (``str``, ``dict``)
242			"""
243			# TODO: return list for positional args, command classes should escape it
244			# and convert it to string
245
246			is_script_run_as_cmd = self.runner_parameters.get(RUNNER_COMMAND, None)
247
248			pos_args = ''
249			named_args = {}
250
251			if is_script_run_as_cmd:
252			pos_args = self.runner_parameters.get(RUNNER_COMMAND, '')
253			named_args = action_parameters
254			else:
255			pos_args, named_args = action_utils.get_args(action_parameters, self.action)
256
257			return pos_args, named_args
258

StackStorm / st2

Pull Request — master (#3658)

ActionRunner.get_pack_ref() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like