mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02: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
113 lines
4.1 KiB
Python
113 lines
4.1 KiB
Python
#
|
|
# (c) 2017, Red Hat, Inc.
|
|
#
|
|
# 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
|
|
import re
|
|
import time
|
|
import glob
|
|
|
|
from ansible.plugins.action.asa import ActionModule as _ActionModule
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.six.moves.urllib.parse import urlsplit
|
|
from ansible.utils.vars import merge_hash
|
|
|
|
PRIVATE_KEYS_RE = re.compile('__.+__')
|
|
|
|
|
|
class ActionModule(_ActionModule):
|
|
|
|
def run(self, tmp=None, task_vars=None):
|
|
|
|
if self._task.args.get('src'):
|
|
try:
|
|
self._handle_template()
|
|
except ValueError as exc:
|
|
return dict(failed=True, msg=exc.message)
|
|
|
|
result = super(ActionModule, self).run(tmp, task_vars)
|
|
del tmp # tmp no longer has any effect
|
|
|
|
if self._task.args.get('backup') and result.get('__backup__'):
|
|
# User requested backup and no error occurred in module.
|
|
# NOTE: If there is a parameter error, _backup key may not be in results.
|
|
filepath = self._write_backup(task_vars['inventory_hostname'],
|
|
result['__backup__'])
|
|
|
|
result['backup_path'] = filepath
|
|
|
|
# strip out any keys that have two leading and two trailing
|
|
# underscore characters
|
|
for key in result.keys():
|
|
if PRIVATE_KEYS_RE.match(key):
|
|
del result[key]
|
|
|
|
return result
|
|
|
|
def _get_working_path(self):
|
|
cwd = self._loader.get_basedir()
|
|
if self._task._role is not None:
|
|
cwd = self._task._role._role_path
|
|
return cwd
|
|
|
|
def _write_backup(self, host, contents):
|
|
backup_path = self._get_working_path() + '/backup'
|
|
if not os.path.exists(backup_path):
|
|
os.mkdir(backup_path)
|
|
for fn in glob.glob('%s/%s*' % (backup_path, host)):
|
|
os.remove(fn)
|
|
tstamp = time.strftime("%Y-%m-%d@%H:%M:%S", time.localtime(time.time()))
|
|
filename = '%s/%s_config.%s' % (backup_path, host, tstamp)
|
|
open(filename, 'w').write(contents)
|
|
return filename
|
|
|
|
def _handle_template(self):
|
|
src = self._task.args.get('src')
|
|
working_path = self._get_working_path()
|
|
|
|
if os.path.isabs(src) or urlsplit('src').scheme:
|
|
source = src
|
|
else:
|
|
source = self._loader.path_dwim_relative(working_path, 'templates', src)
|
|
if not source:
|
|
source = self._loader.path_dwim_relative(working_path, src)
|
|
|
|
if not os.path.exists(source):
|
|
raise ValueError('path specified in src not found')
|
|
|
|
try:
|
|
with open(source, 'r') as f:
|
|
template_data = to_text(f.read())
|
|
except IOError:
|
|
return dict(failed=True, msg='unable to load src file')
|
|
|
|
# Create a template search path in the following order:
|
|
# [working_path, self_role_path, dependent_role_paths, dirname(source)]
|
|
searchpath = [working_path]
|
|
if self._task._role is not None:
|
|
searchpath.append(self._task._role._role_path)
|
|
if hasattr(self._task, "_block:"):
|
|
dep_chain = self._task._block.get_dep_chain()
|
|
if dep_chain is not None:
|
|
for role in dep_chain:
|
|
searchpath.append(role._role_path)
|
|
searchpath.append(os.path.dirname(source))
|
|
self._templar.environment.loader.searchpath = searchpath
|
|
self._task.args['src'] = self._templar.template(template_data)
|