archive
/
mitogen
mirror of https://github.com/mitogen-hq/mitogen.git
1
0
Fork 0
Code Releases Activity

able to load collection but the mitogen master proc was unable to serve it

Browse Source
pull/715/head
Steven Robertson 4 years ago
parent e99d63f4fc
commit ddc1eebec8
2 changed files with 438 additions and 441 deletions
Show Stats Download Patch File Download Diff File

872
ansible_mitogen/mixins.py
Unescape Escape View File

@ -75,452 +75,454 @@ except ImportError:
LOG = logging.getLogger(__name__) LOG = logging.getLogger(__name__)
try: try:
class ActionModuleMixin(ansible.plugins.action.ActionBase): BaseActionClass = ansible.plugins.action.ActionBase
""" except AttributeError:
The Mitogen-patched PluginLoader dynamically mixes this into every action # collections were added in https://github.com/ansible/ansible/pull/52194/files
class that Ansible attempts to load. It exists to override all the # monkeypatching collections since they don't have an actionBase
assumptions built into the base action class that should really belong in BaseActionClass = type('DummyActionBase', (object,), {})
some middle layer, or at least in the connection layer.
Functionality is defined here for: class ActionModuleMixin(BaseActionClass):
"""
* Capturing the final set of task variables and giving Connection a chance The Mitogen-patched PluginLoader dynamically mixes this into every action
to update its idea of the correct execution environment, before any class that Ansible attempts to load. It exists to override all the
attempt is made to call a Connection method. While it's not expected for assumptions built into the base action class that should really belong in
the interpreter to change on a per-task basis, Ansible permits this, and some middle layer, or at least in the connection layer.
so it must be supported.
Functionality is defined here for:
* Overriding lots of methods that try to call out to shell for mundane
reasons, such as copying files around, changing file permissions, * Capturing the final set of task variables and giving Connection a chance
creating temporary directories and suchlike. to update its idea of the correct execution environment, before any
attempt is made to call a Connection method. While it's not expected for
* Short-circuiting any use of Ansiballz or related code for executing a the interpreter to change on a per-task basis, Ansible permits this, and
module remotely using shell commands and SSH. so it must be supported.
* Short-circuiting most of the logic in dealing with the fact that Ansible * Overriding lots of methods that try to call out to shell for mundane
always runs become: tasks across at least the SSH user account and the reasons, such as copying files around, changing file permissions,
destination user account, and handling the security permission issues creating temporary directories and suchlike.
that crop up due to this. Mitogen always runs a task completely within
the target user account, so it's not a problem for us. * Short-circuiting any use of Ansiballz or related code for executing a
""" module remotely using shell commands and SSH.
def __init__(self, task, connection, *args, **kwargs):
""" * Short-circuiting most of the logic in dealing with the fact that Ansible
Verify the received connection is really a Mitogen connection. If not, always runs become: tasks across at least the SSH user account and the
transmute this instance back into the original unadorned base class. destination user account, and handling the security permission issues
that crop up due to this. Mitogen always runs a task completely within
This allows running the Mitogen strategy in mixed-target playbooks, the target user account, so it's not a problem for us.
where some targets use SSH while others use WinRM or some fancier UNIX """
connection plug-in. That's because when the Mitogen strategy is active, def __init__(self, task, connection, *args, **kwargs):
ActionModuleMixin is unconditionally mixed into any action module that """
is instantiated, and there is no direct way for the monkey-patch to Verify the received connection is really a Mitogen connection. If not,
know what kind of connection will be used upfront. transmute this instance back into the original unadorned base class.
"""
super(ActionModuleMixin, self).__init__(task, connection, *args, **kwargs) This allows running the Mitogen strategy in mixed-target playbooks,
if not isinstance(connection, ansible_mitogen.connection.Connection): where some targets use SSH while others use WinRM or some fancier UNIX
_, self.__class__ = type(self).__bases__ connection plug-in. That's because when the Mitogen strategy is active,
ActionModuleMixin is unconditionally mixed into any action module that
# required for python interpreter discovery is instantiated, and there is no direct way for the monkey-patch to
connection.templar = self._templar know what kind of connection will be used upfront.
self._finding_python_interpreter = False """
self._rediscovered_python = False super(ActionModuleMixin, self).__init__(task, connection, *args, **kwargs)
# redeclaring interpreter discovery vars here in case running ansible < 2.8.0 if not isinstance(connection, ansible_mitogen.connection.Connection):
self._discovered_interpreter_key = None _, self.__class__ = type(self).__bases__
self._discovered_interpreter = False
self._discovery_deprecation_warnings = [] # required for python interpreter discovery
self._discovery_warnings = [] connection.templar = self._templar
self._finding_python_interpreter = False
def run(self, tmp=None, task_vars=None): self._rediscovered_python = False
""" # redeclaring interpreter discovery vars here in case running ansible < 2.8.0
Override run() to notify Connection of task-specific data, so it has a self._discovered_interpreter_key = None
chance to know e.g. the Python interpreter in use. self._discovered_interpreter = False
""" self._discovery_deprecation_warnings = []
self._connection.on_action_run( self._discovery_warnings = []
task_vars=task_vars,
delegate_to_hostname=self._task.delegate_to, def run(self, tmp=None, task_vars=None):
loader_basedir=self._loader.get_basedir(), """
Override run() to notify Connection of task-specific data, so it has a
chance to know e.g. the Python interpreter in use.
"""
self._connection.on_action_run(
task_vars=task_vars,
delegate_to_hostname=self._task.delegate_to,
loader_basedir=self._loader.get_basedir(),
)
return super(ActionModuleMixin, self).run(tmp, task_vars)
COMMAND_RESULT = {
'rc': 0,
'stdout': '',
'stdout_lines': [],
'stderr': ''
}
def fake_shell(self, func, stdout=False):
"""
Execute a function and decorate its return value in the style of
_low_level_execute_command(). This produces a return value that looks
like some shell command was run, when really func() was implemented
entirely in Python.
If the function raises :py:class:`mitogen.core.CallError`, this will be
translated into a failed shell command with a non-zero exit status.
:param func:
Function invoked as `func()`.
:returns:
See :py:attr:`COMMAND_RESULT`.
"""
dct = self.COMMAND_RESULT.copy()
try:
rc = func()
if stdout:
dct['stdout'] = repr(rc)
except mitogen.core.CallError:
LOG.exception('While emulating a shell command')
dct['rc'] = 1
dct['stderr'] = traceback.format_exc()
return dct
def _remote_file_exists(self, path):
"""
Determine if `path` exists by directly invoking os.path.exists() in the
target user account.
"""
LOG.debug('_remote_file_exists(%r)', path)
return self._connection.get_chain().call(
ansible_mitogen.target.file_exists,
mitogen.utils.cast(path)
)
def _configure_module(self, module_name, module_args, task_vars=None):
"""
Mitogen does not use the Ansiballz framework. This call should never
happen when ActionMixin is active, so crash if it does.
"""
assert False, "_configure_module() should never be called."
def _is_pipelining_enabled(self, module_style, wrap_async=False):
"""
Mitogen does not use SSH pipelining. This call should never happen when
ActionMixin is active, so crash if it does.
"""
assert False, "_is_pipelining_enabled() should never be called."
def _generate_tmp_path(self):
return os.path.join(
self._connection.get_good_temp_dir(),
'ansible_mitogen_action_%016x' % (
random.getrandbits(8*8),
) )
return super(ActionModuleMixin, self).run(tmp, task_vars) )
COMMAND_RESULT = { def _make_tmp_path(self, remote_user=None):
'rc': 0, """
'stdout': '', Create a temporary subdirectory as a child of the temporary directory
'stdout_lines': [], managed by the remote interpreter.
'stderr': '' """
} LOG.debug('_make_tmp_path(remote_user=%r)', remote_user)
path = self._generate_tmp_path()
LOG.debug('Temporary directory: %r', path)
self._connection.get_chain().call_no_reply(os.mkdir, path)
self._connection._shell.tmpdir = path
return path
def _remove_tmp_path(self, tmp_path):
"""
Replace the base implementation's invocation of rm -rf, replacing it
with a pipelined call to :func:`ansible_mitogen.target.prune_tree`.
"""
LOG.debug('_remove_tmp_path(%r)', tmp_path)
if tmp_path is None and ansible.__version__ > '2.6':
tmp_path = self._connection._shell.tmpdir # 06f73ad578d
if tmp_path is not None:
self._connection.get_chain().call_no_reply(
ansible_mitogen.target.prune_tree,
tmp_path,
)
self._connection._shell.tmpdir = None
def fake_shell(self, func, stdout=False): def _transfer_data(self, remote_path, data):
""" """
Execute a function and decorate its return value in the style of Used by the base _execute_module(), and in <2.4 also by the template
_low_level_execute_command(). This produces a return value that looks action module, and probably others.
like some shell command was run, when really func() was implemented """
entirely in Python. if isinstance(data, dict):
data = jsonify(data)
If the function raises :py:class:`mitogen.core.CallError`, this will be if not isinstance(data, bytes):
translated into a failed shell command with a non-zero exit status. data = to_bytes(data, errors='surrogate_or_strict')
:param func: LOG.debug('_transfer_data(%r, %s ..%d bytes)',
Function invoked as `func()`. remote_path, type(data), len(data))
:returns: self._connection.put_data(remote_path, data)
See :py:attr:`COMMAND_RESULT`. return remote_path
"""
dct = self.COMMAND_RESULT.copy() #: Actions listed here cause :func:`_fixup_perms2` to avoid a needless
try: #: roundtrip, as they modify file modes separately afterwards. This is due
rc = func() #: to the method prototype having a default of `execute=True`.
if stdout: FIXUP_PERMS_RED_HERRING = set(['copy'])
dct['stdout'] = repr(rc)
except mitogen.core.CallError: def _fixup_perms2(self, remote_paths, remote_user=None, execute=True):
LOG.exception('While emulating a shell command') """
dct['rc'] = 1 Mitogen always executes ActionBase helper methods in the context of the
dct['stderr'] = traceback.format_exc() target user account, so it is never necessary to modify permissions
except to ensure the execute bit is set if requested.
return dct """
LOG.debug('_fixup_perms2(%r, remote_user=%r, execute=%r)',
def _remote_file_exists(self, path): remote_paths, remote_user, execute)
""" if execute and self._task.action not in self.FIXUP_PERMS_RED_HERRING:
Determine if `path` exists by directly invoking os.path.exists() in the return self._remote_chmod(remote_paths, mode='u+x')
target user account. return self.COMMAND_RESULT.copy()
"""
LOG.debug('_remote_file_exists(%r)', path) def _remote_chmod(self, paths, mode, sudoable=False):
return self._connection.get_chain().call( """
ansible_mitogen.target.file_exists, Issue an asynchronous set_file_mode() call for every path in `paths`,
mitogen.utils.cast(path) then format the resulting return value list with fake_shell().
"""
LOG.debug('_remote_chmod(%r, mode=%r, sudoable=%r)',
paths, mode, sudoable)
return self.fake_shell(lambda: mitogen.select.Select.all(
self._connection.get_chain().call_async(
ansible_mitogen.target.set_file_mode, path, mode
) )
for path in paths
))
def _configure_module(self, module_name, module_args, task_vars=None): def _remote_chown(self, paths, user, sudoable=False):
""" """
Mitogen does not use the Ansiballz framework. This call should never Issue an asynchronous os.chown() call for every path in `paths`, then
happen when ActionMixin is active, so crash if it does. format the resulting return value list with fake_shell().
""" """
assert False, "_configure_module() should never be called." LOG.debug('_remote_chown(%r, user=%r, sudoable=%r)',
paths, user, sudoable)
def _is_pipelining_enabled(self, module_style, wrap_async=False): ent = self._connection.get_chain().call(pwd.getpwnam, user)
""" return self.fake_shell(lambda: mitogen.select.Select.all(
Mitogen does not use SSH pipelining. This call should never happen when self._connection.get_chain().call_async(
ActionMixin is active, so crash if it does. os.chown, path, ent.pw_uid, ent.pw_gid
"""
assert False, "_is_pipelining_enabled() should never be called."
def _generate_tmp_path(self):
return os.path.join(
self._connection.get_good_temp_dir(),
'ansible_mitogen_action_%016x' % (
random.getrandbits(8*8),
)
) )
for path in paths
))
def _remote_expand_user(self, path, sudoable=True):
"""
Replace the base implementation's attempt to emulate
os.path.expanduser() with an actual call to os.path.expanduser().
def _make_tmp_path(self, remote_user=None): :param bool sudoable:
""" If :data:`True`, indicate unqualified tilde ("~" with no username)
Create a temporary subdirectory as a child of the temporary directory should be evaluated in the context of the login account, not any
managed by the remote interpreter. become_user.
""" """
LOG.debug('_make_tmp_path(remote_user=%r)', remote_user) LOG.debug('_remote_expand_user(%r, sudoable=%r)', path, sudoable)
path = self._generate_tmp_path() if not path.startswith('~'):
LOG.debug('Temporary directory: %r', path) # /home/foo -> /home/foo
self._connection.get_chain().call_no_reply(os.mkdir, path)
self._connection._shell.tmpdir = path
return path return path
if sudoable or not self._play_context.become:
if path == '~':
# ~ -> /home/dmw
return self._connection.homedir
if path.startswith('~/'):
# ~/.ansible -> /home/dmw/.ansible
return os.path.join(self._connection.homedir, path[2:])
# ~root/.ansible -> /root/.ansible
return self._connection.get_chain(use_login=(not sudoable)).call(
os.path.expanduser,
mitogen.utils.cast(path),
)
def get_task_timeout_secs(self):
"""
Return the task "async:" value, portable across 2.4-2.5.
"""
try:
return self._task.async_val
except AttributeError:
return getattr(self._task, 'async')
def _set_temp_file_args(self, module_args, wrap_async):
# Ansible>2.5 module_utils reuses the action's temporary directory if
# one exists. Older versions error if this key is present.
if ansible.__version__ > '2.5':
if wrap_async:
# Sharing is not possible with async tasks, as in that case,
# the directory must outlive the action plug-in.
module_args['_ansible_tmpdir'] = None
else:
module_args['_ansible_tmpdir'] = self._connection._shell.tmpdir
# If _ansible_tmpdir is unset, Ansible>2.6 module_utils will use
# _ansible_remote_tmp as the location to create the module's temporary
# directory. Older versions error if this key is present.
if ansible.__version__ > '2.6':
module_args['_ansible_remote_tmp'] = (
self._connection.get_good_temp_dir()
)
def _execute_module(self, module_name=None, module_args=None, tmp=None,
task_vars=None, persist_files=False,
delete_remote_tmp=True, wrap_async=False):
"""
Collect up a module's execution environment then use it to invoke
target.run_module() or helpers.run_module_async() in the target
context.
"""
if module_name is None:
module_name = self._task.action
if module_args is None:
module_args = self._task.args
if task_vars is None:
task_vars = {}
self._update_module_args(module_name, module_args, task_vars)
env = {}
self._compute_environment_string(env)
self._set_temp_file_args(module_args, wrap_async)
# there's a case where if a task shuts down the node and then immediately calls
# wait_for_connection, the `ping` test from Ansible won't pass because we lost connection
# clearing out context forces a reconnect
# see https://github.com/dw/mitogen/issues/655 and Ansible's `wait_for_connection` module for more info
if module_name == 'ping' and type(self).__name__ == 'wait_for_connection':
self._connection.context = None
self._connection._connect()
result = ansible_mitogen.planner.invoke(
ansible_mitogen.planner.Invocation(
action=self,
connection=self._connection,
module_name=mitogen.core.to_text(module_name),
module_args=mitogen.utils.cast(module_args),
task_vars=task_vars,
templar=self._templar,
env=mitogen.utils.cast(env),
wrap_async=wrap_async,
timeout_secs=self.get_task_timeout_secs(),
)
)
if tmp and ansible.__version__ < '2.5' and delete_remote_tmp:
# Built-in actions expected tmpdir to be cleaned up automatically
# on _execute_module().
self._remove_tmp_path(tmp)
# prevents things like discovered_interpreter_* or ansible_discovered_interpreter_* from being set
# handle ansible 2.3.3 that has remove_internal_keys in a different place
check = remove_internal_keys(result)
if check == 'Not found':
self._remove_internal_keys(result)
# taken from _execute_module of ansible 2.8.6
# propagate interpreter discovery results back to the controller
if self._discovered_interpreter_key:
if result.get('ansible_facts') is None:
result['ansible_facts'] = {}
# only cache discovered_interpreter if we're not running a rediscovery
# rediscovery happens in places like docker connections that could have different
# python interpreters than the main host
if not self._rediscovered_python:
result['ansible_facts'][self._discovered_interpreter_key] = self._discovered_interpreter
if self._discovery_warnings:
if result.get('warnings') is None:
result['warnings'] = []
result['warnings'].extend(self._discovery_warnings)
if self._discovery_deprecation_warnings:
if result.get('deprecations') is None:
result['deprecations'] = []
result['deprecations'].extend(self._discovery_deprecation_warnings)
return wrap_var(result)
def _postprocess_response(self, result):
"""
Apply fixups mimicking ActionBase._execute_module(); this is copied
verbatim from action/__init__.py, the guts of _parse_returned_data are
garbage and should be removed or reimplemented once tests exist.
:param dict result:
Dictionary with format::
{
"rc": int,
"stdout": "stdout data",
"stderr": "stderr data"
}
"""
data = self._parse_returned_data(result)
# Cutpasted from the base implementation.
if 'stdout' in data and 'stdout_lines' not in data:
data['stdout_lines'] = (data['stdout'] or u'').splitlines()
if 'stderr' in data and 'stderr_lines' not in data:
data['stderr_lines'] = (data['stderr'] or u'').splitlines()
return data
def _remove_tmp_path(self, tmp_path): def _low_level_execute_command(self, cmd, sudoable=True, in_data=None,
""" executable=None,
Replace the base implementation's invocation of rm -rf, replacing it encoding_errors='surrogate_then_replace',
with a pipelined call to :func:`ansible_mitogen.target.prune_tree`. chdir=None):
""" """
LOG.debug('_remove_tmp_path(%r)', tmp_path) Override the base implementation by simply calling
if tmp_path is None and ansible.__version__ > '2.6': target.exec_command() in the target context.
tmp_path = self._connection._shell.tmpdir # 06f73ad578d """
if tmp_path is not None: LOG.debug('_low_level_execute_command(%r, in_data=%r, exe=%r, dir=%r)',
self._connection.get_chain().call_no_reply( cmd, type(in_data), executable, chdir)
ansible_mitogen.target.prune_tree,
tmp_path, if executable is None: # executable defaults to False
) executable = self._play_context.executable
self._connection._shell.tmpdir = None if executable:
cmd = executable + ' -c ' + shlex_quote(cmd)
def _transfer_data(self, remote_path, data):
""" # TODO: HACK: if finding python interpreter then we need to keep
Used by the base _execute_module(), and in <2.4 also by the template # calling exec_command until we run into the right python we'll use
action module, and probably others. # chicken-and-egg issue, mitogen needs a python to run low_level_execute_command
""" # which is required by Ansible's discover_interpreter function
if isinstance(data, dict): if self._finding_python_interpreter:
data = jsonify(data) possible_pythons = [
if not isinstance(data, bytes): '/usr/bin/python',
data = to_bytes(data, errors='surrogate_or_strict') 'python3',
'python3.7',
LOG.debug('_transfer_data(%r, %s ..%d bytes)', 'python3.6',
remote_path, type(data), len(data)) 'python3.5',
self._connection.put_data(remote_path, data) 'python2.7',
return remote_path 'python2.6',
'/usr/libexec/platform-python',
#: Actions listed here cause :func:`_fixup_perms2` to avoid a needless '/usr/bin/python3',
#: roundtrip, as they modify file modes separately afterwards. This is due 'python'
#: to the method prototype having a default of `execute=True`. ]
FIXUP_PERMS_RED_HERRING = set(['copy']) else:
# not used, just adding a filler value
def _fixup_perms2(self, remote_paths, remote_user=None, execute=True): possible_pythons = ['python']
"""
Mitogen always executes ActionBase helper methods in the context of the def _run_cmd():
target user account, so it is never necessary to modify permissions return self._connection.exec_command(
except to ensure the execute bit is set if requested. cmd=cmd,
""" in_data=in_data,
LOG.debug('_fixup_perms2(%r, remote_user=%r, execute=%r)', sudoable=sudoable,
remote_paths, remote_user, execute) mitogen_chdir=chdir,
if execute and self._task.action not in self.FIXUP_PERMS_RED_HERRING:
return self._remote_chmod(remote_paths, mode='u+x')
return self.COMMAND_RESULT.copy()
def _remote_chmod(self, paths, mode, sudoable=False):
"""
Issue an asynchronous set_file_mode() call for every path in `paths`,
then format the resulting return value list with fake_shell().
"""
LOG.debug('_remote_chmod(%r, mode=%r, sudoable=%r)',
paths, mode, sudoable)
return self.fake_shell(lambda: mitogen.select.Select.all(
self._connection.get_chain().call_async(
ansible_mitogen.target.set_file_mode, path, mode
)
for path in paths
))
def _remote_chown(self, paths, user, sudoable=False):
"""
Issue an asynchronous os.chown() call for every path in `paths`, then
format the resulting return value list with fake_shell().
"""
LOG.debug('_remote_chown(%r, user=%r, sudoable=%r)',
paths, user, sudoable)
ent = self._connection.get_chain().call(pwd.getpwnam, user)
return self.fake_shell(lambda: mitogen.select.Select.all(
self._connection.get_chain().call_async(
os.chown, path, ent.pw_uid, ent.pw_gid
)
for path in paths
))
def _remote_expand_user(self, path, sudoable=True):
"""
Replace the base implementation's attempt to emulate
os.path.expanduser() with an actual call to os.path.expanduser().
:param bool sudoable:
If :data:`True`, indicate unqualified tilde ("~" with no username)
should be evaluated in the context of the login account, not any
become_user.
"""
LOG.debug('_remote_expand_user(%r, sudoable=%r)', path, sudoable)
if not path.startswith('~'):
# /home/foo -> /home/foo
return path
if sudoable or not self._play_context.become:
if path == '~':
# ~ -> /home/dmw
return self._connection.homedir
if path.startswith('~/'):
# ~/.ansible -> /home/dmw/.ansible
return os.path.join(self._connection.homedir, path[2:])
# ~root/.ansible -> /root/.ansible
return self._connection.get_chain(use_login=(not sudoable)).call(
os.path.expanduser,
mitogen.utils.cast(path),
) )
def get_task_timeout_secs(self): for possible_python in possible_pythons:
"""
Return the task "async:" value, portable across 2.4-2.5.
"""
try: try:
return self._task.async_val self._possible_python_interpreter = possible_python
except AttributeError: rc, stdout, stderr = _run_cmd()
return getattr(self._task, 'async') # TODO: what exception is thrown?
except:
def _set_temp_file_args(self, module_args, wrap_async): # we've reached the last python attempted and failed
# Ansible>2.5 module_utils reuses the action's temporary directory if # TODO: could use enumerate(), need to check which version of python first had it though
# one exists. Older versions error if this key is present. if possible_python == 'python':
if ansible.__version__ > '2.5': raise
if wrap_async:
# Sharing is not possible with async tasks, as in that case,
# the directory must outlive the action plug-in.
module_args['_ansible_tmpdir'] = None
else: else:
module_args['_ansible_tmpdir'] = self._connection._shell.tmpdir continue
# If _ansible_tmpdir is unset, Ansible>2.6 module_utils will use
# _ansible_remote_tmp as the location to create the module's temporary
# directory. Older versions error if this key is present.
if ansible.__version__ > '2.6':
module_args['_ansible_remote_tmp'] = (
self._connection.get_good_temp_dir()
)
def _execute_module(self, module_name=None, module_args=None, tmp=None,
task_vars=None, persist_files=False,
delete_remote_tmp=True, wrap_async=False):
"""
Collect up a module's execution environment then use it to invoke
target.run_module() or helpers.run_module_async() in the target
context.
"""
if module_name is None:
module_name = self._task.action
if module_args is None:
module_args = self._task.args
if task_vars is None:
task_vars = {}
self._update_module_args(module_name, module_args, task_vars)
env = {}
self._compute_environment_string(env)
self._set_temp_file_args(module_args, wrap_async)
# there's a case where if a task shuts down the node and then immediately calls
# wait_for_connection, the `ping` test from Ansible won't pass because we lost connection
# clearing out context forces a reconnect
# see https://github.com/dw/mitogen/issues/655 and Ansible's `wait_for_connection` module for more info
if module_name == 'ping' and type(self).__name__ == 'wait_for_connection':
self._connection.context = None
self._connection._connect()
result = ansible_mitogen.planner.invoke(
ansible_mitogen.planner.Invocation(
action=self,
connection=self._connection,
module_name=mitogen.core.to_text(module_name),
module_args=mitogen.utils.cast(module_args),
task_vars=task_vars,
templar=self._templar,
env=mitogen.utils.cast(env),
wrap_async=wrap_async,
timeout_secs=self.get_task_timeout_secs(),
)
)
if tmp and ansible.__version__ < '2.5' and delete_remote_tmp: stdout_text = to_text(stdout, errors=encoding_errors)
# Built-in actions expected tmpdir to be cleaned up automatically
# on _execute_module(). return {
self._remove_tmp_path(tmp) 'rc': rc,
'stdout': stdout_text,
# prevents things like discovered_interpreter_* or ansible_discovered_interpreter_* from being set 'stdout_lines': stdout_text.splitlines(),
# handle ansible 2.3.3 that has remove_internal_keys in a different place 'stderr': stderr,
check = remove_internal_keys(result) }
if check == 'Not found':
self._remove_internal_keys(result)
# taken from _execute_module of ansible 2.8.6
# propagate interpreter discovery results back to the controller
if self._discovered_interpreter_key:
if result.get('ansible_facts') is None:
result['ansible_facts'] = {}
# only cache discovered_interpreter if we're not running a rediscovery
# rediscovery happens in places like docker connections that could have different
# python interpreters than the main host
if not self._rediscovered_python:
result['ansible_facts'][self._discovered_interpreter_key] = self._discovered_interpreter
if self._discovery_warnings:
if result.get('warnings') is None:
result['warnings'] = []
result['warnings'].extend(self._discovery_warnings)
if self._discovery_deprecation_warnings:
if result.get('deprecations') is None:
result['deprecations'] = []
result['deprecations'].extend(self._discovery_deprecation_warnings)
return wrap_var(result)
def _postprocess_response(self, result):
"""
Apply fixups mimicking ActionBase._execute_module(); this is copied
verbatim from action/__init__.py, the guts of _parse_returned_data are
garbage and should be removed or reimplemented once tests exist.
:param dict result:
Dictionary with format::
{
"rc": int,
"stdout": "stdout data",
"stderr": "stderr data"
}
"""
data = self._parse_returned_data(result)
# Cutpasted from the base implementation.
if 'stdout' in data and 'stdout_lines' not in data:
data['stdout_lines'] = (data['stdout'] or u'').splitlines()
if 'stderr' in data and 'stderr_lines' not in data:
data['stderr_lines'] = (data['stderr'] or u'').splitlines()
return data
def _low_level_execute_command(self, cmd, sudoable=True, in_data=None,
executable=None,
encoding_errors='surrogate_then_replace',
chdir=None):
"""
Override the base implementation by simply calling
target.exec_command() in the target context.
"""
LOG.debug('_low_level_execute_command(%r, in_data=%r, exe=%r, dir=%r)',
cmd, type(in_data), executable, chdir)
if executable is None: # executable defaults to False
executable = self._play_context.executable
if executable:
cmd = executable + ' -c ' + shlex_quote(cmd)
# TODO: HACK: if finding python interpreter then we need to keep
# calling exec_command until we run into the right python we'll use
# chicken-and-egg issue, mitogen needs a python to run low_level_execute_command
# which is required by Ansible's discover_interpreter function
if self._finding_python_interpreter:
possible_pythons = [
'/usr/bin/python',
'python3',
'python3.7',
'python3.6',
'python3.5',
'python2.7',
'python2.6',
'/usr/libexec/platform-python',
'/usr/bin/python3',
'python'
]
else:
# not used, just adding a filler value
possible_pythons = ['python']
def _run_cmd():
return self._connection.exec_command(
cmd=cmd,
in_data=in_data,
sudoable=sudoable,
mitogen_chdir=chdir,
)
for possible_python in possible_pythons:
try:
self._possible_python_interpreter = possible_python
rc, stdout, stderr = _run_cmd()
# TODO: what exception is thrown?
except:
# we've reached the last python attempted and failed
# TODO: could use enumerate(), need to check which version of python first had it though
if possible_python == 'python':
raise
else:
continue
stdout_text = to_text(stdout, errors=encoding_errors)
return {
'rc': rc,
'stdout': stdout_text,
'stdout_lines': stdout_text.splitlines(),
'stderr': stderr,
}
except AttributeError:
# if we're loading collections, there is no ActionBase
# collections are implemented via an import hook
# https://github.com/ansible/ansible/pull/52194/files
pass

7
ansible_mitogen/strategy.py
Unescape Escape View File

@ -138,12 +138,7 @@ def wrap_action_loader__get(name, *args, **kwargs):
klass = ansible_mitogen.loaders.action_loader__get(name, **get_kwargs) klass = ansible_mitogen.loaders.action_loader__get(name, **get_kwargs)
if klass: if klass:
try: bases = (ansible_mitogen.mixins.ActionModuleMixin, klass)
bases = (ansible_mitogen.mixins.ActionModuleMixin, klass)
except AttributeError:
# if we're loading a collection, there's no ActionModuleMixin
bases = (klass,)
adorned_klass = type(str(name), bases, {}) adorned_klass = type(str(name), bases, {})
if kwargs.get('class_only'): if kwargs.get('class_only'):
return adorned_klass return adorned_klass

Write Preview
Loading…
Cancel
Save