diff --git a/bin/ansible b/bin/ansible deleted file mode 100755 index 03891b728f5..00000000000 --- a/bin/ansible +++ /dev/null @@ -1,153 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -# (c) 2012, Michael DeHaan -# -# 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 . - -# PYTHON_ARGCOMPLETE_OK - -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - -__requires__ = ['ansible'] - - -import os -import shutil -import sys -import traceback - -from ansible import context -from ansible.errors import AnsibleError, AnsibleOptionsError, AnsibleParserError -from ansible.module_utils._text import to_text - - -# Used for determining if the system is running a new enough python version -# and should only restrict on our documented minimum versions -_PY3_MIN = sys.version_info[:2] >= (3, 5) -_PY2_MIN = (2, 6) <= sys.version_info[:2] < (3,) -_PY_MIN = _PY3_MIN or _PY2_MIN -if not _PY_MIN: - raise SystemExit('ERROR: Ansible requires a minimum of Python2 version 2.6 or Python3 version 3.5. Current version: %s' % ''.join(sys.version.splitlines())) - - -class LastResort(object): - # OUTPUT OF LAST RESORT - def display(self, msg, log_only=None): - print(msg, file=sys.stderr) - - def error(self, msg, wrap_text=None): - print(msg, file=sys.stderr) - - -if __name__ == '__main__': - - display = LastResort() - - try: # bad ANSIBLE_CONFIG or config options can force ugly stacktrace - import ansible.constants as C - from ansible.utils.display import Display - except AnsibleOptionsError as e: - display.error(to_text(e), wrap_text=False) - sys.exit(5) - - cli = None - me = os.path.basename(sys.argv[0]) - - try: - display = Display() - display.debug("starting run") - - sub = None - target = me.split('-') - if target[-1][0].isdigit(): - # Remove any version or python version info as downstreams - # sometimes add that - target = target[:-1] - - if len(target) > 1: - sub = target[1] - myclass = "%sCLI" % sub.capitalize() - elif target[0] == 'ansible': - sub = 'adhoc' - myclass = 'AdHocCLI' - else: - raise AnsibleError("Unknown Ansible alias: %s" % me) - - try: - mycli = getattr(__import__("ansible.cli.%s" % sub, fromlist=[myclass]), myclass) - except ImportError as e: - # ImportError members have changed in py3 - if 'msg' in dir(e): - msg = e.msg - else: - msg = e.message - if msg.endswith(' %s' % sub): - raise AnsibleError("Ansible sub-program not implemented: %s" % me) - else: - raise - - try: - args = [to_text(a, errors='surrogate_or_strict') for a in sys.argv] - except UnicodeError: - display.error('Command line args are not in utf-8, unable to continue. Ansible currently only understands utf-8') - display.display(u"The full traceback was:\n\n%s" % to_text(traceback.format_exc())) - exit_code = 6 - else: - cli = mycli(args) - exit_code = cli.run() - - except AnsibleOptionsError as e: - cli.parser.print_help() - display.error(to_text(e), wrap_text=False) - exit_code = 5 - except AnsibleParserError as e: - display.error(to_text(e), wrap_text=False) - exit_code = 4 -# TQM takes care of these, but leaving comment to reserve the exit codes -# except AnsibleHostUnreachable as e: -# display.error(str(e)) -# exit_code = 3 -# except AnsibleHostFailed as e: -# display.error(str(e)) -# exit_code = 2 - except AnsibleError as e: - display.error(to_text(e), wrap_text=False) - exit_code = 1 - except KeyboardInterrupt: - display.error("User interrupted execution") - exit_code = 99 - except Exception as e: - if C.DEFAULT_DEBUG: - # Show raw stacktraces in debug mode, It also allow pdb to - # enter post mortem mode. - raise - have_cli_options = bool(context.CLIARGS) - display.error("Unexpected Exception, this is probably a bug: %s" % to_text(e), wrap_text=False) - if not have_cli_options or have_cli_options and context.CLIARGS['verbosity'] > 2: - log_only = False - if hasattr(e, 'orig_exc'): - display.vvv('\nexception type: %s' % to_text(type(e.orig_exc))) - why = to_text(e.orig_exc) - if to_text(e) != why: - display.vvv('\noriginal msg: %s' % why) - else: - display.display("to see the full traceback, use -vvv") - log_only = True - display.display(u"the full traceback was:\n\n%s" % to_text(traceback.format_exc()), log_only=log_only) - exit_code = 250 - - sys.exit(exit_code) diff --git a/bin/ansible b/bin/ansible new file mode 120000 index 00000000000..1acbe23019a --- /dev/null +++ b/bin/ansible @@ -0,0 +1 @@ +../lib/ansible/cli/scripts/ansible_cli_stub.py \ No newline at end of file diff --git a/bin/ansible-connection b/bin/ansible-connection deleted file mode 100755 index 2b4855410ec..00000000000 --- a/bin/ansible-connection +++ /dev/null @@ -1,335 +0,0 @@ -#!/usr/bin/env python -# Copyright: (c) 2017, Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -from __future__ import (absolute_import, division, print_function) - -__metaclass__ = type -__requires__ = ['ansible'] - - -import fcntl -import hashlib -import os -import signal -import socket -import sys -import time -import traceback -import errno -import json - -from contextlib import contextmanager - -from ansible import constants as C -from ansible.module_utils._text import to_bytes, to_text -from ansible.module_utils.six import PY3 -from ansible.module_utils.six.moves import cPickle, StringIO -from ansible.module_utils.connection import Connection, ConnectionError, send_data, recv_data -from ansible.module_utils.service import fork_process -from ansible.parsing.ajson import AnsibleJSONEncoder, AnsibleJSONDecoder -from ansible.playbook.play_context import PlayContext -from ansible.plugins.loader import connection_loader -from ansible.utils.path import unfrackpath, makedirs_safe -from ansible.utils.display import Display -from ansible.utils.jsonrpc import JsonRpcServer - - -def read_stream(byte_stream): - size = int(byte_stream.readline().strip()) - - data = byte_stream.read(size) - if len(data) < size: - raise Exception("EOF found before data was complete") - - data_hash = to_text(byte_stream.readline().strip()) - if data_hash != hashlib.sha1(data).hexdigest(): - raise Exception("Read {0} bytes, but data did not match checksum".format(size)) - - # restore escaped loose \r characters - data = data.replace(br'\r', b'\r') - - return data - - -@contextmanager -def file_lock(lock_path): - """ - Uses contextmanager to create and release a file lock based on the - given path. This allows us to create locks using `with file_lock()` - to prevent deadlocks related to failure to unlock properly. - """ - - lock_fd = os.open(lock_path, os.O_RDWR | os.O_CREAT, 0o600) - fcntl.lockf(lock_fd, fcntl.LOCK_EX) - yield - fcntl.lockf(lock_fd, fcntl.LOCK_UN) - os.close(lock_fd) - - -class ConnectionProcess(object): - ''' - The connection process wraps around a Connection object that manages - the connection to a remote device that persists over the playbook - ''' - def __init__(self, fd, play_context, socket_path, original_path, ansible_playbook_pid=None): - self.play_context = play_context - self.socket_path = socket_path - self.original_path = original_path - - self.fd = fd - self.exception = None - - self.srv = JsonRpcServer() - self.sock = None - - self.connection = None - self._ansible_playbook_pid = ansible_playbook_pid - - def start(self, variables): - try: - messages = list() - result = {} - - messages.append(('vvvv', 'control socket path is %s' % self.socket_path)) - - # If this is a relative path (~ gets expanded later) then plug the - # key's path on to the directory we originally came from, so we can - # find it now that our cwd is / - if self.play_context.private_key_file and self.play_context.private_key_file[0] not in '~/': - self.play_context.private_key_file = os.path.join(self.original_path, self.play_context.private_key_file) - self.connection = connection_loader.get(self.play_context.connection, self.play_context, '/dev/null', - ansible_playbook_pid=self._ansible_playbook_pid) - self.connection.set_options(var_options=variables) - - self.connection._connect() - - self.connection._socket_path = self.socket_path - self.srv.register(self.connection) - messages.extend([('vvvv', msg) for msg in sys.stdout.getvalue().splitlines()]) - messages.append(('vvvv', 'connection to remote device started successfully')) - - self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) - self.sock.bind(self.socket_path) - self.sock.listen(1) - messages.append(('vvvv', 'local domain socket listeners started successfully')) - except Exception as exc: - messages.extend(self.connection.pop_messages()) - result['error'] = to_text(exc) - result['exception'] = traceback.format_exc() - finally: - result['messages'] = messages - self.fd.write(json.dumps(result, cls=AnsibleJSONEncoder)) - self.fd.close() - - def run(self): - try: - while self.connection.connected: - signal.signal(signal.SIGALRM, self.connect_timeout) - signal.signal(signal.SIGTERM, self.handler) - signal.alarm(self.connection.get_option('persistent_connect_timeout')) - - self.exception = None - (s, addr) = self.sock.accept() - signal.alarm(0) - signal.signal(signal.SIGALRM, self.command_timeout) - while True: - data = recv_data(s) - if not data: - break - log_messages = self.connection.get_option('persistent_log_messages') - - if log_messages: - display.display("jsonrpc request: %s" % data, log_only=True) - - signal.alarm(self.connection.get_option('persistent_command_timeout')) - resp = self.srv.handle_request(data) - signal.alarm(0) - - if log_messages: - display.display("jsonrpc response: %s" % resp, log_only=True) - - send_data(s, to_bytes(resp)) - - s.close() - - except Exception as e: - # socket.accept() will raise EINTR if the socket.close() is called - if hasattr(e, 'errno'): - if e.errno != errno.EINTR: - self.exception = traceback.format_exc() - else: - self.exception = traceback.format_exc() - - finally: - # allow time for any exception msg send over socket to receive at other end before shutting down - time.sleep(0.1) - - # when done, close the connection properly and cleanup the socket file so it can be recreated - self.shutdown() - - def connect_timeout(self, signum, frame): - msg = 'persistent connection idle timeout triggered, timeout value is %s secs.\nSee the timeout setting options in the Network Debug and ' \ - 'Troubleshooting Guide.' % self.connection.get_option('persistent_connect_timeout') - display.display(msg, log_only=True) - raise Exception(msg) - - def command_timeout(self, signum, frame): - msg = 'command timeout triggered, timeout value is %s secs.\nSee the timeout setting options in the Network Debug and Troubleshooting Guide.'\ - % self.connection.get_option('persistent_command_timeout') - display.display(msg, log_only=True) - raise Exception(msg) - - def handler(self, signum, frame): - msg = 'signal handler called with signal %s.' % signum - display.display(msg, log_only=True) - raise Exception(msg) - - def shutdown(self): - """ Shuts down the local domain socket - """ - lock_path = unfrackpath("%s/.ansible_pc_lock_%s" % os.path.split(self.socket_path)) - if os.path.exists(self.socket_path): - try: - if self.sock: - self.sock.close() - if self.connection: - self.connection.close() - except Exception: - pass - finally: - if os.path.exists(self.socket_path): - os.remove(self.socket_path) - setattr(self.connection, '_socket_path', None) - setattr(self.connection, '_connected', False) - - if os.path.exists(lock_path): - os.remove(lock_path) - - display.display('shutdown complete', log_only=True) - - -def main(): - """ Called to initiate the connect to the remote device - """ - rc = 0 - result = {} - messages = list() - socket_path = None - - # Need stdin as a byte stream - if PY3: - stdin = sys.stdin.buffer - else: - stdin = sys.stdin - - # Note: update the below log capture code after Display.display() is refactored. - saved_stdout = sys.stdout - sys.stdout = StringIO() - - try: - # read the play context data via stdin, which means depickling it - vars_data = read_stream(stdin) - init_data = read_stream(stdin) - - if PY3: - pc_data = cPickle.loads(init_data, encoding='bytes') - variables = cPickle.loads(vars_data, encoding='bytes') - else: - pc_data = cPickle.loads(init_data) - variables = cPickle.loads(vars_data) - - play_context = PlayContext() - play_context.deserialize(pc_data) - display.verbosity = play_context.verbosity - - except Exception as e: - rc = 1 - result.update({ - 'error': to_text(e), - 'exception': traceback.format_exc() - }) - - if rc == 0: - ssh = connection_loader.get('ssh', class_only=True) - ansible_playbook_pid = sys.argv[1] - cp = ssh._create_control_path(play_context.remote_addr, play_context.port, play_context.remote_user, play_context.connection, ansible_playbook_pid) - - # create the persistent connection dir if need be and create the paths - # which we will be using later - tmp_path = unfrackpath(C.PERSISTENT_CONTROL_PATH_DIR) - makedirs_safe(tmp_path) - - socket_path = unfrackpath(cp % dict(directory=tmp_path)) - lock_path = unfrackpath("%s/.ansible_pc_lock_%s" % os.path.split(socket_path)) - - with file_lock(lock_path): - if not os.path.exists(socket_path): - messages.append(('vvvv', 'local domain socket does not exist, starting it')) - original_path = os.getcwd() - r, w = os.pipe() - pid = fork_process() - - if pid == 0: - try: - os.close(r) - wfd = os.fdopen(w, 'w') - process = ConnectionProcess(wfd, play_context, socket_path, original_path, ansible_playbook_pid) - process.start(variables) - except Exception: - messages.append(('error', traceback.format_exc())) - rc = 1 - - if rc == 0: - process.run() - else: - process.shutdown() - - sys.exit(rc) - - else: - os.close(w) - rfd = os.fdopen(r, 'r') - data = json.loads(rfd.read(), cls=AnsibleJSONDecoder) - messages.extend(data.pop('messages')) - result.update(data) - - else: - messages.append(('vvvv', 'found existing local domain socket, using it!')) - conn = Connection(socket_path) - conn.set_options(var_options=variables) - pc_data = to_text(init_data) - try: - conn.update_play_context(pc_data) - except Exception as exc: - # Only network_cli has update_play context, so missing this is - # not fatal e.g. netconf - if isinstance(exc, ConnectionError) and getattr(exc, 'code', None) == -32601: - pass - else: - result.update({ - 'error': to_text(exc), - 'exception': traceback.format_exc() - }) - - if os.path.exists(socket_path): - messages.extend(Connection(socket_path).pop_messages()) - messages.append(('vvvv', sys.stdout.getvalue())) - result.update({ - 'messages': messages, - 'socket_path': socket_path - }) - - sys.stdout = saved_stdout - if 'exception' in result: - rc = 1 - sys.stderr.write(json.dumps(result, cls=AnsibleJSONEncoder)) - else: - rc = 0 - sys.stdout.write(json.dumps(result, cls=AnsibleJSONEncoder)) - - sys.exit(rc) - - -if __name__ == '__main__': - display = Display() - main() diff --git a/bin/ansible-connection b/bin/ansible-connection new file mode 120000 index 00000000000..a20affdbe6a --- /dev/null +++ b/bin/ansible-connection @@ -0,0 +1 @@ +../lib/ansible/cli/scripts/ansible_connection_cli_stub.py \ No newline at end of file diff --git a/lib/ansible/cli/scripts/__init__.py b/lib/ansible/cli/scripts/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/lib/ansible/cli/scripts/ansible_cli_stub.py b/lib/ansible/cli/scripts/ansible_cli_stub.py new file mode 100755 index 00000000000..03891b728f5 --- /dev/null +++ b/lib/ansible/cli/scripts/ansible_cli_stub.py @@ -0,0 +1,153 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# (c) 2012, Michael DeHaan +# +# 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 . + +# PYTHON_ARGCOMPLETE_OK + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +__requires__ = ['ansible'] + + +import os +import shutil +import sys +import traceback + +from ansible import context +from ansible.errors import AnsibleError, AnsibleOptionsError, AnsibleParserError +from ansible.module_utils._text import to_text + + +# Used for determining if the system is running a new enough python version +# and should only restrict on our documented minimum versions +_PY3_MIN = sys.version_info[:2] >= (3, 5) +_PY2_MIN = (2, 6) <= sys.version_info[:2] < (3,) +_PY_MIN = _PY3_MIN or _PY2_MIN +if not _PY_MIN: + raise SystemExit('ERROR: Ansible requires a minimum of Python2 version 2.6 or Python3 version 3.5. Current version: %s' % ''.join(sys.version.splitlines())) + + +class LastResort(object): + # OUTPUT OF LAST RESORT + def display(self, msg, log_only=None): + print(msg, file=sys.stderr) + + def error(self, msg, wrap_text=None): + print(msg, file=sys.stderr) + + +if __name__ == '__main__': + + display = LastResort() + + try: # bad ANSIBLE_CONFIG or config options can force ugly stacktrace + import ansible.constants as C + from ansible.utils.display import Display + except AnsibleOptionsError as e: + display.error(to_text(e), wrap_text=False) + sys.exit(5) + + cli = None + me = os.path.basename(sys.argv[0]) + + try: + display = Display() + display.debug("starting run") + + sub = None + target = me.split('-') + if target[-1][0].isdigit(): + # Remove any version or python version info as downstreams + # sometimes add that + target = target[:-1] + + if len(target) > 1: + sub = target[1] + myclass = "%sCLI" % sub.capitalize() + elif target[0] == 'ansible': + sub = 'adhoc' + myclass = 'AdHocCLI' + else: + raise AnsibleError("Unknown Ansible alias: %s" % me) + + try: + mycli = getattr(__import__("ansible.cli.%s" % sub, fromlist=[myclass]), myclass) + except ImportError as e: + # ImportError members have changed in py3 + if 'msg' in dir(e): + msg = e.msg + else: + msg = e.message + if msg.endswith(' %s' % sub): + raise AnsibleError("Ansible sub-program not implemented: %s" % me) + else: + raise + + try: + args = [to_text(a, errors='surrogate_or_strict') for a in sys.argv] + except UnicodeError: + display.error('Command line args are not in utf-8, unable to continue. Ansible currently only understands utf-8') + display.display(u"The full traceback was:\n\n%s" % to_text(traceback.format_exc())) + exit_code = 6 + else: + cli = mycli(args) + exit_code = cli.run() + + except AnsibleOptionsError as e: + cli.parser.print_help() + display.error(to_text(e), wrap_text=False) + exit_code = 5 + except AnsibleParserError as e: + display.error(to_text(e), wrap_text=False) + exit_code = 4 +# TQM takes care of these, but leaving comment to reserve the exit codes +# except AnsibleHostUnreachable as e: +# display.error(str(e)) +# exit_code = 3 +# except AnsibleHostFailed as e: +# display.error(str(e)) +# exit_code = 2 + except AnsibleError as e: + display.error(to_text(e), wrap_text=False) + exit_code = 1 + except KeyboardInterrupt: + display.error("User interrupted execution") + exit_code = 99 + except Exception as e: + if C.DEFAULT_DEBUG: + # Show raw stacktraces in debug mode, It also allow pdb to + # enter post mortem mode. + raise + have_cli_options = bool(context.CLIARGS) + display.error("Unexpected Exception, this is probably a bug: %s" % to_text(e), wrap_text=False) + if not have_cli_options or have_cli_options and context.CLIARGS['verbosity'] > 2: + log_only = False + if hasattr(e, 'orig_exc'): + display.vvv('\nexception type: %s' % to_text(type(e.orig_exc))) + why = to_text(e.orig_exc) + if to_text(e) != why: + display.vvv('\noriginal msg: %s' % why) + else: + display.display("to see the full traceback, use -vvv") + log_only = True + display.display(u"the full traceback was:\n\n%s" % to_text(traceback.format_exc()), log_only=log_only) + exit_code = 250 + + sys.exit(exit_code) diff --git a/lib/ansible/cli/scripts/ansible_connection_cli_stub.py b/lib/ansible/cli/scripts/ansible_connection_cli_stub.py new file mode 100755 index 00000000000..2b4855410ec --- /dev/null +++ b/lib/ansible/cli/scripts/ansible_connection_cli_stub.py @@ -0,0 +1,335 @@ +#!/usr/bin/env python +# Copyright: (c) 2017, Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +from __future__ import (absolute_import, division, print_function) + +__metaclass__ = type +__requires__ = ['ansible'] + + +import fcntl +import hashlib +import os +import signal +import socket +import sys +import time +import traceback +import errno +import json + +from contextlib import contextmanager + +from ansible import constants as C +from ansible.module_utils._text import to_bytes, to_text +from ansible.module_utils.six import PY3 +from ansible.module_utils.six.moves import cPickle, StringIO +from ansible.module_utils.connection import Connection, ConnectionError, send_data, recv_data +from ansible.module_utils.service import fork_process +from ansible.parsing.ajson import AnsibleJSONEncoder, AnsibleJSONDecoder +from ansible.playbook.play_context import PlayContext +from ansible.plugins.loader import connection_loader +from ansible.utils.path import unfrackpath, makedirs_safe +from ansible.utils.display import Display +from ansible.utils.jsonrpc import JsonRpcServer + + +def read_stream(byte_stream): + size = int(byte_stream.readline().strip()) + + data = byte_stream.read(size) + if len(data) < size: + raise Exception("EOF found before data was complete") + + data_hash = to_text(byte_stream.readline().strip()) + if data_hash != hashlib.sha1(data).hexdigest(): + raise Exception("Read {0} bytes, but data did not match checksum".format(size)) + + # restore escaped loose \r characters + data = data.replace(br'\r', b'\r') + + return data + + +@contextmanager +def file_lock(lock_path): + """ + Uses contextmanager to create and release a file lock based on the + given path. This allows us to create locks using `with file_lock()` + to prevent deadlocks related to failure to unlock properly. + """ + + lock_fd = os.open(lock_path, os.O_RDWR | os.O_CREAT, 0o600) + fcntl.lockf(lock_fd, fcntl.LOCK_EX) + yield + fcntl.lockf(lock_fd, fcntl.LOCK_UN) + os.close(lock_fd) + + +class ConnectionProcess(object): + ''' + The connection process wraps around a Connection object that manages + the connection to a remote device that persists over the playbook + ''' + def __init__(self, fd, play_context, socket_path, original_path, ansible_playbook_pid=None): + self.play_context = play_context + self.socket_path = socket_path + self.original_path = original_path + + self.fd = fd + self.exception = None + + self.srv = JsonRpcServer() + self.sock = None + + self.connection = None + self._ansible_playbook_pid = ansible_playbook_pid + + def start(self, variables): + try: + messages = list() + result = {} + + messages.append(('vvvv', 'control socket path is %s' % self.socket_path)) + + # If this is a relative path (~ gets expanded later) then plug the + # key's path on to the directory we originally came from, so we can + # find it now that our cwd is / + if self.play_context.private_key_file and self.play_context.private_key_file[0] not in '~/': + self.play_context.private_key_file = os.path.join(self.original_path, self.play_context.private_key_file) + self.connection = connection_loader.get(self.play_context.connection, self.play_context, '/dev/null', + ansible_playbook_pid=self._ansible_playbook_pid) + self.connection.set_options(var_options=variables) + + self.connection._connect() + + self.connection._socket_path = self.socket_path + self.srv.register(self.connection) + messages.extend([('vvvv', msg) for msg in sys.stdout.getvalue().splitlines()]) + messages.append(('vvvv', 'connection to remote device started successfully')) + + self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + self.sock.bind(self.socket_path) + self.sock.listen(1) + messages.append(('vvvv', 'local domain socket listeners started successfully')) + except Exception as exc: + messages.extend(self.connection.pop_messages()) + result['error'] = to_text(exc) + result['exception'] = traceback.format_exc() + finally: + result['messages'] = messages + self.fd.write(json.dumps(result, cls=AnsibleJSONEncoder)) + self.fd.close() + + def run(self): + try: + while self.connection.connected: + signal.signal(signal.SIGALRM, self.connect_timeout) + signal.signal(signal.SIGTERM, self.handler) + signal.alarm(self.connection.get_option('persistent_connect_timeout')) + + self.exception = None + (s, addr) = self.sock.accept() + signal.alarm(0) + signal.signal(signal.SIGALRM, self.command_timeout) + while True: + data = recv_data(s) + if not data: + break + log_messages = self.connection.get_option('persistent_log_messages') + + if log_messages: + display.display("jsonrpc request: %s" % data, log_only=True) + + signal.alarm(self.connection.get_option('persistent_command_timeout')) + resp = self.srv.handle_request(data) + signal.alarm(0) + + if log_messages: + display.display("jsonrpc response: %s" % resp, log_only=True) + + send_data(s, to_bytes(resp)) + + s.close() + + except Exception as e: + # socket.accept() will raise EINTR if the socket.close() is called + if hasattr(e, 'errno'): + if e.errno != errno.EINTR: + self.exception = traceback.format_exc() + else: + self.exception = traceback.format_exc() + + finally: + # allow time for any exception msg send over socket to receive at other end before shutting down + time.sleep(0.1) + + # when done, close the connection properly and cleanup the socket file so it can be recreated + self.shutdown() + + def connect_timeout(self, signum, frame): + msg = 'persistent connection idle timeout triggered, timeout value is %s secs.\nSee the timeout setting options in the Network Debug and ' \ + 'Troubleshooting Guide.' % self.connection.get_option('persistent_connect_timeout') + display.display(msg, log_only=True) + raise Exception(msg) + + def command_timeout(self, signum, frame): + msg = 'command timeout triggered, timeout value is %s secs.\nSee the timeout setting options in the Network Debug and Troubleshooting Guide.'\ + % self.connection.get_option('persistent_command_timeout') + display.display(msg, log_only=True) + raise Exception(msg) + + def handler(self, signum, frame): + msg = 'signal handler called with signal %s.' % signum + display.display(msg, log_only=True) + raise Exception(msg) + + def shutdown(self): + """ Shuts down the local domain socket + """ + lock_path = unfrackpath("%s/.ansible_pc_lock_%s" % os.path.split(self.socket_path)) + if os.path.exists(self.socket_path): + try: + if self.sock: + self.sock.close() + if self.connection: + self.connection.close() + except Exception: + pass + finally: + if os.path.exists(self.socket_path): + os.remove(self.socket_path) + setattr(self.connection, '_socket_path', None) + setattr(self.connection, '_connected', False) + + if os.path.exists(lock_path): + os.remove(lock_path) + + display.display('shutdown complete', log_only=True) + + +def main(): + """ Called to initiate the connect to the remote device + """ + rc = 0 + result = {} + messages = list() + socket_path = None + + # Need stdin as a byte stream + if PY3: + stdin = sys.stdin.buffer + else: + stdin = sys.stdin + + # Note: update the below log capture code after Display.display() is refactored. + saved_stdout = sys.stdout + sys.stdout = StringIO() + + try: + # read the play context data via stdin, which means depickling it + vars_data = read_stream(stdin) + init_data = read_stream(stdin) + + if PY3: + pc_data = cPickle.loads(init_data, encoding='bytes') + variables = cPickle.loads(vars_data, encoding='bytes') + else: + pc_data = cPickle.loads(init_data) + variables = cPickle.loads(vars_data) + + play_context = PlayContext() + play_context.deserialize(pc_data) + display.verbosity = play_context.verbosity + + except Exception as e: + rc = 1 + result.update({ + 'error': to_text(e), + 'exception': traceback.format_exc() + }) + + if rc == 0: + ssh = connection_loader.get('ssh', class_only=True) + ansible_playbook_pid = sys.argv[1] + cp = ssh._create_control_path(play_context.remote_addr, play_context.port, play_context.remote_user, play_context.connection, ansible_playbook_pid) + + # create the persistent connection dir if need be and create the paths + # which we will be using later + tmp_path = unfrackpath(C.PERSISTENT_CONTROL_PATH_DIR) + makedirs_safe(tmp_path) + + socket_path = unfrackpath(cp % dict(directory=tmp_path)) + lock_path = unfrackpath("%s/.ansible_pc_lock_%s" % os.path.split(socket_path)) + + with file_lock(lock_path): + if not os.path.exists(socket_path): + messages.append(('vvvv', 'local domain socket does not exist, starting it')) + original_path = os.getcwd() + r, w = os.pipe() + pid = fork_process() + + if pid == 0: + try: + os.close(r) + wfd = os.fdopen(w, 'w') + process = ConnectionProcess(wfd, play_context, socket_path, original_path, ansible_playbook_pid) + process.start(variables) + except Exception: + messages.append(('error', traceback.format_exc())) + rc = 1 + + if rc == 0: + process.run() + else: + process.shutdown() + + sys.exit(rc) + + else: + os.close(w) + rfd = os.fdopen(r, 'r') + data = json.loads(rfd.read(), cls=AnsibleJSONDecoder) + messages.extend(data.pop('messages')) + result.update(data) + + else: + messages.append(('vvvv', 'found existing local domain socket, using it!')) + conn = Connection(socket_path) + conn.set_options(var_options=variables) + pc_data = to_text(init_data) + try: + conn.update_play_context(pc_data) + except Exception as exc: + # Only network_cli has update_play context, so missing this is + # not fatal e.g. netconf + if isinstance(exc, ConnectionError) and getattr(exc, 'code', None) == -32601: + pass + else: + result.update({ + 'error': to_text(exc), + 'exception': traceback.format_exc() + }) + + if os.path.exists(socket_path): + messages.extend(Connection(socket_path).pop_messages()) + messages.append(('vvvv', sys.stdout.getvalue())) + result.update({ + 'messages': messages, + 'socket_path': socket_path + }) + + sys.stdout = saved_stdout + if 'exception' in result: + rc = 1 + sys.stderr.write(json.dumps(result, cls=AnsibleJSONEncoder)) + else: + rc = 0 + sys.stdout.write(json.dumps(result, cls=AnsibleJSONEncoder)) + + sys.exit(rc) + + +if __name__ == '__main__': + display = Display() + main() diff --git a/test/sanity/ignore.txt b/test/sanity/ignore.txt index 3ecd20e362c..12dac1833c6 100644 --- a/test/sanity/ignore.txt +++ b/test/sanity/ignore.txt @@ -150,6 +150,8 @@ hacking/test-module.py metaclass-boilerplate hacking/tests/gen_distribution_version_testcase.py future-import-boilerplate hacking/tests/gen_distribution_version_testcase.py metaclass-boilerplate lib/ansible/cli/console.py pylint:blacklisted-name +lib/ansible/cli/scripts/ansible_cli_stub.py shebang +lib/ansible/cli/scripts/ansible_connection_cli_stub.py shebang lib/ansible/compat/selectors/_selectors2.py future-import-boilerplate # ignore bundled lib/ansible/compat/selectors/_selectors2.py metaclass-boilerplate # ignore bundled lib/ansible/compat/selectors/_selectors2.py pylint:blacklisted-name