mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-28 13:21:25 -07:00
71f46d69d6
* First bit of fixing temporary to have one source of truth * Fix pep8 * Remove explicit make_tmp_path() in copy The copy action plugin sets TRANSFER_FILES=True so it does not need to set the temporary directory explicitly; the base class's run() method will do that for us. * Fix for calling a module's run when a shell has already created a temp path. * Remember to inform the rest of the world when tempdir is removed * New strategy for how to warn on passing tmp Now we just warn when calling the parent class run() early. If the module does a late call to the parent run() and doesn't make use of the temporary directory, then we don't check for the possibility that the user mistakenly is sending tmp in. If we truly deprecate this (rather than ignoring it forever) then we might want to switch back to checking for someone passing a value in as tmp. * Remove tmp parameter from _execute_module as well * Port all action plugins to not send tmp explicitly This is now handled inside of _execute_module via the _connection._shell.tempdir attribute. Also update warnings and docs to tell people to set the attribute instead of using _execute_module's tmp parameter. * Always set local tempdir variable
124 lines
5.1 KiB
Python
124 lines
5.1 KiB
Python
# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
|
|
# (c) 2013, Dylan Martin <dmartin@seattlecentral.edu>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from ansible.errors import AnsibleError, AnsibleAction, AnsibleActionFail, AnsibleActionSkip
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.parsing.convert_bool import boolean
|
|
from ansible.plugins.action import ActionBase
|
|
|
|
|
|
class ActionModule(ActionBase):
|
|
|
|
TRANSFERS_FILES = True
|
|
|
|
def run(self, tmp=None, task_vars=None):
|
|
''' handler for unarchive operations '''
|
|
if task_vars is None:
|
|
task_vars = dict()
|
|
|
|
result = super(ActionModule, self).run(tmp, task_vars)
|
|
del tmp # tmp no longer has any effect
|
|
|
|
source = self._task.args.get('src', None)
|
|
dest = self._task.args.get('dest', None)
|
|
remote_src = boolean(self._task.args.get('remote_src', False), strict=False)
|
|
creates = self._task.args.get('creates', None)
|
|
decrypt = self._task.args.get('decrypt', True)
|
|
|
|
try:
|
|
# "copy" is deprecated in favor of "remote_src".
|
|
if 'copy' in self._task.args:
|
|
# They are mutually exclusive.
|
|
if 'remote_src' in self._task.args:
|
|
raise AnsibleActionFail("parameters are mutually exclusive: ('copy', 'remote_src')")
|
|
# We will take the information from copy and store it in
|
|
# the remote_src var to use later in this file.
|
|
self._task.args['remote_src'] = remote_src = not boolean(self._task.args.pop('copy'), strict=False)
|
|
|
|
if source is None or dest is None:
|
|
raise AnsibleActionFail("src (or content) and dest are required")
|
|
|
|
if creates:
|
|
# do not run the command if the line contains creates=filename
|
|
# and the filename already exists. This allows idempotence
|
|
# of command executions.
|
|
creates = self._remote_expand_user(creates)
|
|
if self._remote_file_exists(creates):
|
|
raise AnsibleActionSkip("skipped, since %s exists" % creates)
|
|
|
|
dest = self._remote_expand_user(dest) # CCTODO: Fix path for Windows hosts.
|
|
source = os.path.expanduser(source)
|
|
|
|
if not remote_src:
|
|
try:
|
|
source = self._loader.get_real_file(self._find_needle('files', source), decrypt=decrypt)
|
|
except AnsibleError as e:
|
|
raise AnsibleActionFail(to_text(e))
|
|
|
|
try:
|
|
remote_stat = self._execute_remote_stat(dest, all_vars=task_vars, follow=True)
|
|
except AnsibleError as e:
|
|
raise AnsibleActionFail(to_text(e))
|
|
|
|
if not remote_stat['exists'] or not remote_stat['isdir']:
|
|
raise AnsibleActionFail("dest '%s' must be an existing dir" % dest)
|
|
|
|
if not remote_src:
|
|
# transfer the file to a remote tmp location
|
|
tmp_src = self._connection._shell.join_path(self._connection._shell.tempdir, 'source')
|
|
self._transfer_file(source, tmp_src)
|
|
|
|
# handle diff mode client side
|
|
# handle check mode client side
|
|
|
|
if not remote_src:
|
|
# fix file permissions when the copy is done as a different user
|
|
self._fixup_perms2((self._connection._shell.tempdir, tmp_src))
|
|
# Build temporary module_args.
|
|
new_module_args = self._task.args.copy()
|
|
new_module_args.update(
|
|
dict(
|
|
src=tmp_src,
|
|
original_basename=os.path.basename(source),
|
|
),
|
|
)
|
|
|
|
else:
|
|
new_module_args = self._task.args.copy()
|
|
new_module_args.update(
|
|
dict(
|
|
original_basename=os.path.basename(source),
|
|
),
|
|
)
|
|
|
|
# remove action plugin only key
|
|
for key in ('decrypt',):
|
|
if key in new_module_args:
|
|
del new_module_args[key]
|
|
|
|
# execute the unarchive module now, with the updated args
|
|
result.update(self._execute_module(module_args=new_module_args, task_vars=task_vars))
|
|
except AnsibleAction as e:
|
|
result.update(e.result)
|
|
finally:
|
|
self._remove_tmp_path(self._connection._shell.tempdir)
|
|
return result
|