mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
a1428d6bed
There doesn't appear to be anything that actually uses tmp_path in the connection plugins so we don't need to pass that in to exec_command. That change also means that we don't need to pass tmp_path around in many places in the action plugins any more. there may be more cleanup that can be done there as well (the action plugin's public run() method takes tmp as a keyword arg but that may not be necessary). As a sideeffect of this patch, some potential problems with chmod and the patch, assemble, copy, and template modules has been fixed (those modules called _remote_chmod() with the wrong order for their parameters. Removing the tmp parameter fixed them.)
128 lines
5.4 KiB
Python
128 lines
5.4 KiB
Python
# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
|
|
# (c) 2015 Toshio Kuratomi <tkuratomi@ansible.com>
|
|
#
|
|
# 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 traceback
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import select
|
|
import fcntl
|
|
|
|
import ansible.constants as C
|
|
|
|
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
|
from ansible.plugins.connection import ConnectionBase
|
|
|
|
class Connection(ConnectionBase):
|
|
''' Local based connections '''
|
|
|
|
@property
|
|
def transport(self):
|
|
''' used to identify this connection object '''
|
|
return 'local'
|
|
|
|
def _connect(self, port=None):
|
|
''' connect to the local host; nothing to do here '''
|
|
|
|
if not self._connected:
|
|
self._display.vvv("ESTABLISH LOCAL CONNECTION FOR USER: {0}".format(self._play_context.remote_user, host=self._play_context.remote_addr))
|
|
self._connected = True
|
|
return self
|
|
|
|
def exec_command(self, cmd, in_data=None, sudoable=True):
|
|
''' run a command on the local host '''
|
|
|
|
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
|
|
|
self._display.debug("in local.exec_command()")
|
|
|
|
if in_data:
|
|
raise AnsibleError("Internal Error: this module does not support optimized module pipelining")
|
|
executable = C.DEFAULT_EXECUTABLE.split()[0] if C.DEFAULT_EXECUTABLE else None
|
|
|
|
self._display.vvv("{0} EXEC {1}".format(self._play_context.remote_addr, cmd))
|
|
# FIXME: cwd= needs to be set to the basedir of the playbook
|
|
self._display.debug("opening command with Popen()")
|
|
p = subprocess.Popen(
|
|
cmd,
|
|
shell=isinstance(cmd, basestring),
|
|
executable=executable, #cwd=...
|
|
stdin=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
)
|
|
self._display.debug("done running command with Popen()")
|
|
|
|
if self._play_context.prompt and sudoable:
|
|
fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) | os.O_NONBLOCK)
|
|
fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) | os.O_NONBLOCK)
|
|
become_output = ''
|
|
while not self.check_become_success(become_output) and not self.check_password_prompt(become_output):
|
|
|
|
rfd, wfd, efd = select.select([p.stdout, p.stderr], [], [p.stdout, p.stderr], self._play_context.timeout)
|
|
if p.stdout in rfd:
|
|
chunk = p.stdout.read()
|
|
elif p.stderr in rfd:
|
|
chunk = p.stderr.read()
|
|
else:
|
|
stdout, stderr = p.communicate()
|
|
raise AnsibleError('timeout waiting for privilege escalation password prompt:\n' + become_output)
|
|
if not chunk:
|
|
stdout, stderr = p.communicate()
|
|
raise AnsibleError('privilege output closed while waiting for password prompt:\n' + become_output)
|
|
become_output += chunk
|
|
if not self.check_become_success(become_output):
|
|
p.stdin.write(self._play_context.become_pass + '\n')
|
|
fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) & ~os.O_NONBLOCK)
|
|
fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) & ~os.O_NONBLOCK)
|
|
|
|
self._display.debug("getting output with communicate()")
|
|
stdout, stderr = p.communicate()
|
|
self._display.debug("done communicating")
|
|
|
|
self._display.debug("done with local.exec_command()")
|
|
return (p.returncode, stdout, stderr)
|
|
|
|
def put_file(self, in_path, out_path):
|
|
''' transfer a file from local to local '''
|
|
|
|
super(Connection, self).put_file(in_path, out_path)
|
|
|
|
self._display.vvv("{0} PUT {1} TO {2}".format(self._play_context.remote_addr, in_path, out_path))
|
|
if not os.path.exists(in_path):
|
|
raise AnsibleFileNotFound("file or module does not exist: {0}".format(in_path))
|
|
try:
|
|
shutil.copyfile(in_path, out_path)
|
|
except shutil.Error:
|
|
raise AnsibleError("failed to copy: {0} and {1} are the same".format(in_path, out_path))
|
|
except IOError as e:
|
|
raise AnsibleError("failed to transfer file to {0}: {1}".format(out_path, e))
|
|
|
|
def fetch_file(self, in_path, out_path):
|
|
''' fetch a file from local to local -- for copatibility '''
|
|
|
|
super(Connection, self).fetch_file(in_path, out_path)
|
|
|
|
self._display.vvv("{0} FETCH {1} TO {2}".format(self._play_context.remote_addr, in_path, out_path))
|
|
self.put_file(in_path, out_path)
|
|
|
|
def close(self):
|
|
''' terminate the connection; nothing to do here '''
|
|
self._connected = False
|