mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -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.)
184 lines
7.1 KiB
Python
184 lines
7.1 KiB
Python
# Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
|
|
# and chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
|
|
# (c) 2013, Michael Scherer <misc@zarb.org>
|
|
# (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 distutils.spawn
|
|
import traceback
|
|
import os
|
|
import shlex
|
|
import subprocess
|
|
from ansible import errors
|
|
from ansible.utils.unicode import to_bytes
|
|
from ansible.callbacks import vvv
|
|
import ansible.constants as C
|
|
|
|
BUFSIZE = 65536
|
|
|
|
class Connection(object):
|
|
''' Local BSD Jail based connections '''
|
|
|
|
def _search_executable(self, executable):
|
|
cmd = distutils.spawn.find_executable(executable)
|
|
if not cmd:
|
|
raise errors.AnsibleError("%s command not found in PATH") % executable
|
|
return cmd
|
|
|
|
def list_jails(self):
|
|
p = subprocess.Popen([self.jls_cmd, '-q', 'name'],
|
|
cwd=self.runner.basedir,
|
|
stdin=subprocess.PIPE,
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
|
|
stdout, stderr = p.communicate()
|
|
|
|
return stdout.split()
|
|
|
|
def get_jail_path(self):
|
|
p = subprocess.Popen([self.jls_cmd, '-j', self.jail, '-q', 'path'],
|
|
cwd=self.runner.basedir,
|
|
stdin=subprocess.PIPE,
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
|
|
stdout, stderr = p.communicate()
|
|
# remove \n
|
|
return stdout[:-1]
|
|
|
|
def __init__(self, runner, host, port, *args, **kwargs):
|
|
self.jail = host
|
|
self.runner = runner
|
|
self.host = host
|
|
self.has_pipelining = False
|
|
self.become_methods_supported=C.BECOME_METHODS
|
|
|
|
if os.geteuid() != 0:
|
|
raise errors.AnsibleError("jail connection requires running as root")
|
|
|
|
self.jls_cmd = self._search_executable('jls')
|
|
self.jexec_cmd = self._search_executable('jexec')
|
|
|
|
if not self.jail in self.list_jails():
|
|
raise errors.AnsibleError("incorrect jail name %s" % self.jail)
|
|
|
|
|
|
self.host = host
|
|
# port is unused, since this is local
|
|
self.port = port
|
|
|
|
def connect(self, port=None):
|
|
''' connect to the jail; nothing to do here '''
|
|
|
|
vvv("THIS IS A LOCAL JAIL DIR", host=self.jail)
|
|
|
|
return self
|
|
|
|
# a modifier
|
|
def _generate_cmd(self, executable, cmd):
|
|
if executable:
|
|
local_cmd = [self.jexec_cmd, self.jail, executable, '-c', cmd]
|
|
else:
|
|
# Prev to python2.7.3, shlex couldn't handle unicode type strings
|
|
cmd = to_bytes(cmd)
|
|
cmd = shlex.split(cmd)
|
|
local_cmd = [self.jexec_cmd, self.jail]
|
|
local_cmd += cmd
|
|
return local_cmd
|
|
|
|
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.
|
|
|
|
compared to exec_command() it looses some niceties like being able to
|
|
return the process's exit code immediately.
|
|
'''
|
|
|
|
if sudoable and self.runner.become and self.runner.become_method not in self.become_methods_supported:
|
|
raise errors.AnsibleError("Internal Error: this module does not support running commands via %s" % self.runner.become_method)
|
|
|
|
if in_data:
|
|
raise errors.AnsibleError("Internal Error: this module does not support optimized module pipelining")
|
|
|
|
# We enter zone as root so we ignore privilege escalation (probably need to fix in case we have to become a specific used [ex: postgres admin])?
|
|
local_cmd = self._generate_cmd(executable, cmd)
|
|
|
|
vvv("EXEC %s" % (local_cmd), host=self.jail)
|
|
p = subprocess.Popen(local_cmd, shell=False,
|
|
cwd=self.runner.basedir,
|
|
stdin=stdin,
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
|
|
return p
|
|
|
|
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, become_user, sudoable, executable, in_data)
|
|
|
|
stdout, stderr = p.communicate()
|
|
return (p.returncode, stdout, stderr)
|
|
|
|
def put_file(self, in_path, out_path):
|
|
''' transfer a file from local to jail '''
|
|
|
|
vvv("PUT %s TO %s" % (in_path, out_path), host=self.jail)
|
|
|
|
try:
|
|
with open(in_path, 'rb') as in_file:
|
|
try:
|
|
p = self._buffered_exec_command('dd of=%s bs=%s' % (out_path, BUFSIZE), None, stdin=in_file)
|
|
except OSError:
|
|
raise errors.AnsibleError("jail connection requires dd command in the jail")
|
|
try:
|
|
stdout, stderr = p.communicate()
|
|
except:
|
|
traceback.print_exc()
|
|
raise errors.AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
|
|
if p.returncode != 0:
|
|
raise errors.AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
|
|
except IOError:
|
|
raise errors.AnsibleError("file or module does not exist at: %s" % in_path)
|
|
|
|
def fetch_file(self, in_path, out_path):
|
|
''' fetch a file from jail to local '''
|
|
|
|
vvv("FETCH %s TO %s" % (in_path, out_path), host=self.jail)
|
|
|
|
try:
|
|
p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE), None)
|
|
except OSError:
|
|
raise errors.AnsibleError("jail connection requires dd command in the jail")
|
|
|
|
with open(out_path, 'wb+') as out_file:
|
|
try:
|
|
chunk = p.stdout.read(BUFSIZE)
|
|
while chunk:
|
|
out_file.write(chunk)
|
|
chunk = p.stdout.read(BUFSIZE)
|
|
except:
|
|
traceback.print_exc()
|
|
raise errors.AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
|
|
stdout, stderr = p.communicate()
|
|
if p.returncode != 0:
|
|
raise errors.AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
|
|
|
|
def close(self):
|
|
''' terminate the connection; nothing to do here '''
|
|
pass
|