Coverage for lib/ansible/module_utils/connection.py : 76%

# 

# This code is part of Ansible, but is an independent component. 

# This particular file snippet, and this file snippet only, is BSD licensed. 

# Modules you write using this snippet, which is embedded dynamically by Ansible 

# still belong to the author of the module, and may assign their own license 

# to the complete work. 

# 

# (c) 2017 Red Hat Inc. 

# 

# Redistribution and use in source and binary forms, with or without modification, 

# are permitted provided that the following conditions are met: 

# 

# * Redistributions of source code must retain the above copyright 

# notice, this list of conditions and the following disclaimer. 

# * Redistributions in binary form must reproduce the above copyright notice, 

# this list of conditions and the following disclaimer in the documentation 

# and/or other materials provided with the distribution. 

# 

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 

# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 

# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 

# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 

# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 

# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 

# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

import os 

import json 

import socket 

import struct 

import traceback 

import uuid 

from functools import partial 

from ansible.module_utils._text import to_bytes, to_text 

from ansible.module_utils.six import iteritems 

def send_data(s, data): 

packed_len = struct.pack('!Q', len(data)) 

return s.sendall(packed_len + data) 

def recv_data(s): 

header_len = 8 # size of a packed unsigned long long 

data = to_bytes("") 

while len(data) < header_len: 

d = s.recv(header_len - len(data)) 

if not d: 

return None 

data += d 

data_len = struct.unpack('!Q', data[:header_len])[0] 

data = data[header_len:] 

while len(data) < data_len: 

d = s.recv(data_len - len(data)) 

58 ↛ 59line 58 didn't jump to line 59, because the condition on line 58 was never true if not d: 

return None 

data += d 

return data 

def exec_command(module, command): 

connection = Connection(module._socket_path) 

try: 

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): 

reqid = str(uuid.uuid4()) 

req = {'jsonrpc': '2.0', 'method': method, 'id': reqid} 

params = args or kwargs or None 

if params: 

req['params'] = params 

return req 

class ConnectionError(Exception): 

def __init__(self, message, *args, **kwargs): 

super(ConnectionError, self).__init__(message) 

90 ↛ 91line 90 didn't jump to line 91, because the loop on line 90 never started for k, v in iteritems(kwargs): 

setattr(self, k, v) 

class Connection(object): 

def __init__(self, socket_path): 

97 ↛ 98line 97 didn't jump to line 98, because the condition on line 97 was never true if socket_path is None: 

raise AssertionError('socket_path must be a value') 

self.socket_path = socket_path 

def __getattr__(self, name): 

try: 

return self.__dict__[name] 

except KeyError: 

105 ↛ 106line 105 didn't jump to line 106, because the condition on line 105 was never true if name.startswith('_'): 

raise AttributeError("'%s' object has no attribute '%s'" % (self.__class__.__name__, name)) 

return partial(self.__rpc__, name) 

def _exec_jsonrpc(self, name, *args, **kwargs): 

req = request_builder(name, *args, **kwargs) 

reqid = req['id'] 

if not os.path.exists(self.socket_path): 

raise ConnectionError('socket_path does not exist or cannot be found') 

try: 

data = json.dumps(req) 

out = self.send(data) 

response = json.loads(out) 

except socket.error as e: 

raise ConnectionError('unable to connect to socket', err=to_text(e, errors='surrogate_then_replace'), exception=traceback.format_exc()) 

125 ↛ 126line 125 didn't jump to line 126, because the condition on line 125 was never true if response['id'] != reqid: 

raise ConnectionError('invalid json-rpc id received') 

return response 

def __rpc__(self, name, *args, **kwargs): 

"""Executes the json-rpc and returns the output received 

from remote device. 

:name: rpc method to be executed over connection plugin that implements jsonrpc 2.0 

:args: Ordered list of params passed as arguments to rpc method 

:kwargs: Dict of valid key, value pairs passed as arguments to rpc method 

For usage refer the respective connection plugin docs. 

""" 

response = self._exec_jsonrpc(name, *args, **kwargs) 

142 ↛ 143line 142 didn't jump to line 143, because the condition on line 142 was never true if 'error' in response: 

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')