mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 06:30:19 -07:00
Remove tmp as a parameter to the connection plugins
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.)
This commit is contained in:
parent
95b371dd60
commit
a1428d6bed
24 changed files with 81 additions and 73 deletions
|
@ -122,8 +122,17 @@ class ConnectionBase(with_metaclass(ABCMeta, object)):
|
|||
|
||||
@ensure_connect
|
||||
@abstractmethod
|
||||
def exec_command(self, cmd, tmp_path, in_data=None, executable=None, sudoable=True):
|
||||
"""Run a command on the remote host
|
||||
def exec_command(self, cmd, in_data=None, sudoable=True):
|
||||
"""Run a command on the remote host.
|
||||
|
||||
:arg cmd: byte string containing the command
|
||||
:kwarg in_data: If set, this data is passed to the command's stdin.
|
||||
This is used to implement pipelining. Currently not all
|
||||
connection plugins implement pipelining.
|
||||
:kwarg sudoable: Tell the connection plugin if we're executing
|
||||
a command via a privilege escalation mechanism. This may affect
|
||||
how the connection plugin returns data. Note that not all
|
||||
connections can handle privilege escalation.
|
||||
|
||||
:returns: a tuple of (return code, stdout, stderr) The return code is
|
||||
an int while stdout and stderr are both byte strings.
|
||||
|
|
|
@ -236,7 +236,7 @@ class Connection(ConnectionBase):
|
|||
else:
|
||||
return response.get('rc') == 0
|
||||
|
||||
def exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
def exec_command(self, cmd, become_user=None, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
''' run a command on the remote host '''
|
||||
|
||||
if sudoable and self.runner.become and self.runner.become_method not in self.become_methods_supported:
|
||||
|
@ -256,7 +256,6 @@ class Connection(ConnectionBase):
|
|||
data = dict(
|
||||
mode='command',
|
||||
cmd=cmd,
|
||||
tmp_path=tmp_path,
|
||||
executable=executable,
|
||||
)
|
||||
data = utils.jsonify(data)
|
||||
|
|
|
@ -83,7 +83,7 @@ class Connection(ConnectionBase):
|
|||
local_cmd += cmd
|
||||
return local_cmd
|
||||
|
||||
def _buffered_exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable='/bin/sh', in_data=None, stdin=subprocess.PIPE):
|
||||
def _buffered_exec_command(self, cmd, become_user=None, sudoable=False, executable='/bin/sh', in_data=None, stdin=subprocess.PIPE):
|
||||
''' run a command on the chroot. This is only needed for implementing
|
||||
put_file() get_file() so that we don't have to read the whole file
|
||||
into memory.
|
||||
|
@ -110,10 +110,10 @@ class Connection(ConnectionBase):
|
|||
|
||||
return p
|
||||
|
||||
def exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
def exec_command(self, cmd, become_user=None, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
''' run a command on the chroot '''
|
||||
|
||||
p = self._buffered_exec_command(cmd, tmp_path, become_user, sudoable, executable, in_data)
|
||||
p = self._buffered_exec_command(cmd, become_user, sudoable, executable, in_data)
|
||||
|
||||
stdout, stderr = p.communicate()
|
||||
return (p.returncode, stdout, stderr)
|
||||
|
@ -126,7 +126,7 @@ class Connection(ConnectionBase):
|
|||
try:
|
||||
with open(in_path, 'rb') as in_file:
|
||||
try:
|
||||
p = self._buffered_exec_command('dd of=%s bs=%s' % (out_path, self.BUFSIZE), None, stdin=in_file)
|
||||
p = self._buffered_exec_command('dd of=%s bs=%s' % (out_path, self.BUFSIZE), stdin=in_file)
|
||||
except OSError:
|
||||
raise AnsibleError("chroot connection requires dd command in the chroot")
|
||||
try:
|
||||
|
@ -145,7 +145,7 @@ class Connection(ConnectionBase):
|
|||
self._display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.chroot)
|
||||
|
||||
try:
|
||||
p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, self.BUFSIZE), None)
|
||||
p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, self.BUFSIZE))
|
||||
except OSError:
|
||||
raise AnsibleError("chroot connection requires dd command in the chroot")
|
||||
|
||||
|
|
|
@ -88,9 +88,9 @@ class Connection(ConnectionBase):
|
|||
|
||||
return self
|
||||
|
||||
def exec_command(self, cmd, tmp_path, in_data=None, sudoable=False):
|
||||
def exec_command(self, cmd, in_data=None, sudoable=False):
|
||||
""" Run a command on the local host """
|
||||
super(Connection, self).exec_command(cmd, tmp_path, in_data=in_data, sudoable=sudoable)
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
|
||||
# Don't currently support su
|
||||
if in_data:
|
||||
|
|
|
@ -55,7 +55,7 @@ class Connection(object):
|
|||
self.client = fc.Client(self.host)
|
||||
return self
|
||||
|
||||
def exec_command(self, cmd, tmp_path, become_user=None, sudoable=False,
|
||||
def exec_command(self, cmd, become_user=None, sudoable=False,
|
||||
executable='/bin/sh', in_data=None):
|
||||
''' run a command on the remote minion '''
|
||||
|
||||
|
|
|
@ -101,7 +101,7 @@ class Connection(object):
|
|||
local_cmd += cmd
|
||||
return local_cmd
|
||||
|
||||
def _buffered_exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable='/bin/sh', in_data=None, stdin=subprocess.PIPE):
|
||||
def _buffered_exec_command(self, cmd, become_user=None, sudoable=False, executable='/bin/sh', in_data=None, stdin=subprocess.PIPE):
|
||||
''' run a command on the jail. This is only needed for implementing
|
||||
put_file() get_file() so that we don't have to read the whole file
|
||||
into memory.
|
||||
|
@ -127,10 +127,10 @@ class Connection(object):
|
|||
|
||||
return p
|
||||
|
||||
def exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
def exec_command(self, cmd, become_user=None, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
''' run a command on the jail '''
|
||||
|
||||
p = self._buffered_exec_command(cmd, tmp_path, become_user, sudoable, executable, in_data)
|
||||
p = self._buffered_exec_command(cmd, become_user, sudoable, executable, in_data)
|
||||
|
||||
stdout, stderr = p.communicate()
|
||||
return (p.returncode, stdout, stderr)
|
||||
|
|
|
@ -69,7 +69,7 @@ class Connection(object):
|
|||
local_cmd = '%s -q -c lxc:/// lxc-enter-namespace %s -- %s' % (self.cmd, self.lxc, cmd)
|
||||
return local_cmd
|
||||
|
||||
def exec_command(self, cmd, tmp_path, become_user, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
def exec_command(self, cmd, become_user, sudoable=False, executable='/bin/sh', in_data=None):
|
||||
''' run a command on the chroot '''
|
||||
|
||||
if sudoable and self.runner.become and self.runner.become_method not in self.become_methods_supported:
|
||||
|
|
|
@ -46,10 +46,10 @@ class Connection(ConnectionBase):
|
|||
self._connected = True
|
||||
return self
|
||||
|
||||
def exec_command(self, cmd, tmp_path, in_data=None, sudoable=True):
|
||||
def exec_command(self, cmd, in_data=None, sudoable=True):
|
||||
''' run a command on the local host '''
|
||||
|
||||
super(Connection, self).exec_command(cmd, tmp_path, in_data=in_data, sudoable=sudoable)
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
|
||||
self._display.debug("in local.exec_command()")
|
||||
|
||||
|
|
|
@ -189,10 +189,10 @@ class Connection(ConnectionBase):
|
|||
|
||||
return ssh
|
||||
|
||||
def exec_command(self, cmd, tmp_path, in_data=None, sudoable=True):
|
||||
def exec_command(self, cmd, in_data=None, sudoable=True):
|
||||
''' run a command on the remote host '''
|
||||
|
||||
super(Connection, self).exec_command(cmd, tmp_path, in_data=in_data, sudoable=sudoable)
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
|
||||
if in_data:
|
||||
raise AnsibleError("Internal Error: this module does not support optimized module pipelining")
|
||||
|
|
|
@ -285,10 +285,10 @@ class Connection(ConnectionBase):
|
|||
|
||||
return return_tuple
|
||||
|
||||
def _exec_command(self, cmd, tmp_path, in_data=None, sudoable=True):
|
||||
def _exec_command(self, cmd, in_data=None, sudoable=True):
|
||||
''' run a command on the remote host '''
|
||||
|
||||
super(Connection, self).exec_command(cmd, tmp_path, in_data=in_data, sudoable=sudoable)
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
|
||||
self._display.vvv("ESTABLISH SSH CONNECTION FOR USER: {0}".format(self._play_context.remote_user), host=self._play_context.remote_addr)
|
||||
|
||||
|
|
|
@ -172,8 +172,8 @@ class Connection(ConnectionBase):
|
|||
self.protocol = self._winrm_connect()
|
||||
return self
|
||||
|
||||
def exec_command(self, cmd, tmp_path, in_data=None, sudoable=True):
|
||||
super(Connection, self).exec_command(cmd, tmp_path, in_data=in_data, sudoable=sudoable)
|
||||
def exec_command(self, cmd, in_data=None, sudoable=True):
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
cmd_parts = shlex.split(to_bytes(cmd), posix=False)
|
||||
cmd_parts = map(to_unicode, cmd_parts)
|
||||
script = None
|
||||
|
|
|
@ -110,7 +110,7 @@ class Connection(object):
|
|||
local_cmd += cmd
|
||||
return local_cmd
|
||||
|
||||
def _buffered_exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable=None, in_data=None, stdin=subprocess.PIPE):
|
||||
def _buffered_exec_command(self, cmd, become_user=None, sudoable=False, executable=None, in_data=None, stdin=subprocess.PIPE):
|
||||
''' run a command on the zone. This is only needed for implementing
|
||||
put_file() get_file() so that we don't have to read the whole file
|
||||
into memory.
|
||||
|
@ -136,14 +136,14 @@ class Connection(object):
|
|||
|
||||
return p
|
||||
|
||||
def exec_command(self, cmd, tmp_path, become_user=None, sudoable=False, executable=None, in_data=None):
|
||||
def exec_command(self, cmd, become_user=None, sudoable=False, executable=None, in_data=None):
|
||||
''' run a command on the zone '''
|
||||
|
||||
### TODO: Why all the precautions not to specify /bin/sh? (vs jail.py)
|
||||
if executable == '/bin/sh':
|
||||
executable = None
|
||||
|
||||
p = self._buffered_exec_command(cmd, tmp_path, become_user, sudoable, executable, in_data)
|
||||
p = self._buffered_exec_command(cmd, become_user, sudoable, executable, in_data)
|
||||
|
||||
stdout, stderr = p.communicate()
|
||||
return (p.returncode, stdout, stderr)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue