mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-20 23:30:22 -07:00
Connection plugins network_cli and netconf (#32521)
* implements jsonrpc message passing for ansible-connection * implements more generic mechanism for persistent connections * starts persistent connection in task_executor if enabled and supported * supports using network_cli as top level connection plugin * enhances logging for persistent connection to stdout * Update action plugins * Fix Python3 RPC * Fix Junos bytes<-->str issues * supports using netconf as top level connection plugin * Error message when running netconf on an unsupported platform * Update tests * Fix `authorize: yes` for `connection: local` * Handle potentially JSON data in terminal * Add clarifying detail if possible on ConnectionError
This commit is contained in:
Nathaniel Case
GitHub
parent
897b31f249
commit
9c0275a879
26 changed files with 722 additions and 798 deletions
|
|
@ -27,6 +27,7 @@
|
|||
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
import os
|
||||
import json
|
||||
import socket
|
||||
import struct
|
||||
import traceback
|
||||
|
|
@ -35,6 +36,7 @@ import uuid
|
|||
from functools import partial
|
||||
|
||||
from ansible.module_utils._text import to_bytes, to_native, to_text
|
||||
from ansible.module_utils.six import iteritems
|
||||
|
||||
|
||||
def send_data(s, data):
|
||||
|
|
@ -61,23 +63,14 @@ def recv_data(s):
|
|||
|
||||
|
||||
def exec_command(module, command):
|
||||
connection = Connection(module._socket_path)
|
||||
try:
|
||||
sf = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||
sf.connect(module._socket_path)
|
||||
|
||||
data = "EXEC: %s" % command
|
||||
send_data(sf, to_bytes(data.strip()))
|
||||
|
||||
rc = int(recv_data(sf), 10)
|
||||
stdout = recv_data(sf)
|
||||
stderr = recv_data(sf)
|
||||
except socket.error as e:
|
||||
sf.close()
|
||||
module.fail_json(msg='unable to connect to socket', err=to_native(e), exception=traceback.format_exc())
|
||||
|
||||
sf.close()
|
||||
|
||||
return rc, to_native(stdout, errors='surrogate_or_strict'), to_native(stderr, errors='surrogate_or_strict')
|
||||
out = connection.exec_command(command)
|
||||
except ConnectionError as exc:
|
||||
code = getattr(exc, 'code', 1)
|
||||
message = getattr(exc, 'err', exc)
|
||||
return code, '', to_text(message, errors='surrogate_then_replace')
|
||||
return 0, out, ''
|
||||
|
||||
|
||||
def request_builder(method, *args, **kwargs):
|
||||
|
|
@ -91,10 +84,19 @@ def request_builder(method, *args, **kwargs):
|
|||
return req
|
||||
|
||||
|
||||
class ConnectionError(Exception):
|
||||
|
||||
def __init__(self, message, *args, **kwargs):
|
||||
super(ConnectionError, self).__init__(message)
|
||||
for k, v in iteritems(kwargs):
|
||||
setattr(self, k, v)
|
||||
|
||||
|
||||
class Connection:
|
||||
|
||||
def __init__(self, module):
|
||||
self._module = module
|
||||
def __init__(self, socket_path):
|
||||
assert socket_path is not None, 'socket_path must be a value'
|
||||
self.socket_path = socket_path
|
||||
|
||||
def __getattr__(self, name):
|
||||
try:
|
||||
|
|
@ -116,30 +118,40 @@ class Connection:
|
|||
req = request_builder(name, *args, **kwargs)
|
||||
reqid = req['id']
|
||||
|
||||
if not self._module._socket_path:
|
||||
self._module.fail_json(msg='provider support not available for this host')
|
||||
|
||||
if not os.path.exists(self._module._socket_path):
|
||||
self._module.fail_json(msg='provider socket does not exist, is the provider running?')
|
||||
if not os.path.exists(self.socket_path):
|
||||
raise ConnectionError('socket_path does not exist or cannot be found')
|
||||
|
||||
try:
|
||||
data = self._module.jsonify(req)
|
||||
rc, out, err = exec_command(self._module, data)
|
||||
data = json.dumps(req)
|
||||
out = self.send(data)
|
||||
response = json.loads(out)
|
||||
|
||||
except socket.error as e:
|
||||
self._module.fail_json(msg='unable to connect to socket', err=to_native(e),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
try:
|
||||
response = self._module.from_json(to_text(out, errors='surrogate_then_replace'))
|
||||
except ValueError as exc:
|
||||
self._module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||||
raise ConnectionError('unable to connect to socket', err=to_text(e, errors='surrogate_then_replace'), exception=traceback.format_exc())
|
||||
|
||||
if response['id'] != reqid:
|
||||
self._module.fail_json(msg='invalid id received')
|
||||
raise ConnectionError('invalid json-rpc id received')
|
||||
|
||||
if 'error' in response:
|
||||
msg = response['error'].get('data') or response['error']['message']
|
||||
self._module.fail_json(msg=to_text(msg, errors='surrogate_then_replace'))
|
||||
err = response.get('error')
|
||||
msg = err.get('data') or err['message']
|
||||
code = err['code']
|
||||
raise ConnectionError(to_text(msg, errors='surrogate_then_replace'), code=code)
|
||||
|
||||
return response['result']
|
||||
|
||||
def send(self, data):
|
||||
try:
|
||||
sf = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||
sf.connect(self.socket_path)
|
||||
|
||||
send_data(sf, to_bytes(data))
|
||||
response = recv_data(sf)
|
||||
|
||||
except socket.error as e:
|
||||
sf.close()
|
||||
raise ConnectionError('unable to connect to socket', err=to_text(e, errors='surrogate_then_replace'), exception=traceback.format_exc())
|
||||
|
||||
sf.close()
|
||||
|
||||
return to_text(response, errors='surrogate_or_strict')
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@
|
|||
#
|
||||
from contextlib import contextmanager
|
||||
|
||||
from ansible.module_utils._text import to_bytes, to_text
|
||||
from ansible.module_utils.connection import exec_command
|
||||
|
||||
try:
|
||||
|
|
@ -38,7 +39,7 @@ NS_MAP = {'nc': "urn:ietf:params:xml:ns:netconf:base:1.0"}
|
|||
|
||||
|
||||
def send_request(module, obj, check_rc=True, ignore_warning=True):
|
||||
request = tostring(obj)
|
||||
request = to_text(tostring(obj), errors='surrogate_or_strict')
|
||||
rc, out, err = exec_command(module, request)
|
||||
if rc != 0 and check_rc:
|
||||
error_root = fromstring(err)
|
||||
|
|
@ -59,7 +60,7 @@ def send_request(module, obj, check_rc=True, ignore_warning=True):
|
|||
else:
|
||||
module.fail_json(msg=str(err))
|
||||
return warnings
|
||||
return fromstring(out)
|
||||
return fromstring(to_bytes(out, errors='surrogate_or_strict'))
|
||||
|
||||
|
||||
def children(root, iterable):
|
||||
|
|
|
|||
|
|
@ -91,33 +91,14 @@ def fail_if_missing(module, found, service, msg=''):
|
|||
module.fail_json(msg='Could not find the requested service %s: %s' % (service, msg))
|
||||
|
||||
|
||||
def daemonize(module, cmd):
|
||||
def fork_process():
|
||||
'''
|
||||
Execute a command while detaching as a daemon, returns rc, stdout, and stderr.
|
||||
|
||||
:arg module: is an AnsibleModule object, used for it's utility methods
|
||||
:arg cmd: is a list or string representing the command and options to run
|
||||
|
||||
This is complex because daemonization is hard for people.
|
||||
What we do is daemonize a part of this module, the daemon runs the command,
|
||||
picks up the return code and output, and returns it to the main process.
|
||||
This function performs the double fork process to detach from the
|
||||
parent process and execute.
|
||||
'''
|
||||
pid = os.fork()
|
||||
|
||||
# init some vars
|
||||
chunk = 4096 # FIXME: pass in as arg?
|
||||
errors = 'surrogate_or_strict'
|
||||
|
||||
# start it!
|
||||
try:
|
||||
pipe = os.pipe()
|
||||
pid = os.fork()
|
||||
except OSError:
|
||||
module.fail_json(msg="Error while attempting to fork: %s", exception=traceback.format_exc())
|
||||
|
||||
# we don't do any locking as this should be a unique module/process
|
||||
if pid == 0:
|
||||
|
||||
os.close(pipe[0])
|
||||
# Set stdin/stdout/stderr to /dev/null
|
||||
fd = os.open(os.devnull, os.O_RDWR)
|
||||
|
||||
|
|
@ -140,7 +121,7 @@ def daemonize(module, cmd):
|
|||
# get new process session and detach
|
||||
sid = os.setsid()
|
||||
if sid == -1:
|
||||
module.fail_json(msg="Unable to detach session while daemonizing")
|
||||
raise Exception("Unable to detach session while daemonizing")
|
||||
|
||||
# avoid possible problems with cwd being removed
|
||||
os.chdir("/")
|
||||
|
|
@ -149,6 +130,38 @@ def daemonize(module, cmd):
|
|||
if pid > 0:
|
||||
os._exit(0)
|
||||
|
||||
return pid
|
||||
|
||||
|
||||
def daemonize(module, cmd):
|
||||
'''
|
||||
Execute a command while detaching as a daemon, returns rc, stdout, and stderr.
|
||||
|
||||
:arg module: is an AnsibleModule object, used for it's utility methods
|
||||
:arg cmd: is a list or string representing the command and options to run
|
||||
|
||||
This is complex because daemonization is hard for people.
|
||||
What we do is daemonize a part of this module, the daemon runs the command,
|
||||
picks up the return code and output, and returns it to the main process.
|
||||
'''
|
||||
|
||||
# init some vars
|
||||
chunk = 4096 # FIXME: pass in as arg?
|
||||
errors = 'surrogate_or_strict'
|
||||
|
||||
# start it!
|
||||
try:
|
||||
pipe = os.pipe()
|
||||
pid = fork_process()
|
||||
except OSError:
|
||||
module.fail_json(msg="Error while attempting to fork: %s", exception=traceback.format_exc())
|
||||
except Exception as exc:
|
||||
module.fail_json(msg=to_text(exc), exception=traceback.format_exc())
|
||||
|
||||
# we don't do any locking as this should be a unique module/process
|
||||
if pid == 0:
|
||||
os.close(pipe[0])
|
||||
|
||||
# if command is string deal with py2 vs py3 conversions for shlex
|
||||
if not isinstance(cmd, list):
|
||||
if PY2:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue