mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
bb998a3cd2
Currently socket path is send from `ansible-connection` (running as background process) over stdout. This can conflict with debug logs that are also send on stdout resulting in incorrect socket path received by the main process. To avoid this add a socket path delimiter string which is recevied by main process and socket path is retrieved based on delimiter string. This implementation will change in future when ansible-connection framework is made more robust.
106 lines
3.5 KiB
Python
106 lines
3.5 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 pty
|
|
import subprocess
|
|
import sys
|
|
|
|
from ansible.module_utils._text import to_bytes, to_text
|
|
from ansible.module_utils.six.moves import cPickle
|
|
from ansible.plugins.connection import ConnectionBase
|
|
|
|
try:
|
|
from __main__ import display
|
|
except ImportError:
|
|
from ansible.utils.display import Display
|
|
display = Display()
|
|
|
|
|
|
class Connection(ConnectionBase):
|
|
''' Local based connections '''
|
|
|
|
transport = 'persistent'
|
|
has_pipelining = False
|
|
|
|
def _connect(self):
|
|
self._connected = True
|
|
return self
|
|
|
|
def _do_it(self, action):
|
|
|
|
master, slave = pty.openpty()
|
|
p = subprocess.Popen(["ansible-connection"], stdin=slave, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
stdin = os.fdopen(master, 'wb', 0)
|
|
os.close(slave)
|
|
|
|
# Need to force a protocol that is compatible with both py2 and py3.
|
|
# That would be protocol=2 or less.
|
|
# Also need to force a protocol that excludes certain control chars as
|
|
# stdin in this case is a pty and control chars will cause problems.
|
|
# that means only protocol=0 will work.
|
|
src = cPickle.dumps(self._play_context.serialize(), protocol=0)
|
|
stdin.write(src)
|
|
|
|
stdin.write(b'\n#END_INIT#\n')
|
|
stdin.write(to_bytes(action))
|
|
stdin.write(b'\n\n')
|
|
|
|
(stdout, stderr) = p.communicate()
|
|
stdin.close()
|
|
|
|
return (p, stdout, stderr)
|
|
|
|
def exec_command(self, cmd, in_data=None, sudoable=True):
|
|
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
|
p, out, err = self._do_it('EXEC: ' + cmd)
|
|
return p.returncode, out, err
|
|
|
|
def put_file(self, in_path, out_path):
|
|
super(Connection, self).put_file(in_path, out_path)
|
|
self._do_it('PUT: %s %s' % (in_path, out_path))
|
|
|
|
def fetch_file(self, in_path, out_path):
|
|
super(Connection, self).fetch_file(in_path, out_path)
|
|
self._do_it('FETCH: %s %s' % (in_path, out_path))
|
|
|
|
def close(self):
|
|
self._connected = False
|
|
|
|
def run(self):
|
|
"""Returns the path of the persistent connection socket.
|
|
|
|
Attempts to ensure (within playcontext.timeout seconds) that the
|
|
socket path exists. If the path exists (or the timeout has expired),
|
|
returns the socket path.
|
|
"""
|
|
p, out, err = self._do_it('RUN:')
|
|
while True:
|
|
out = out.strip()
|
|
if out == b'':
|
|
# EOF file found
|
|
return None
|
|
elif out.startswith(b'#SOCKET_PATH#'):
|
|
break
|
|
else:
|
|
out = p.stdout.readline()
|
|
|
|
socket_path = out.split(b'#SOCKET_PATH#: ', 1)[1]
|
|
return to_text(socket_path, errors='surrogate_or_strict')
|