From 4fb09d56931b1a405f584d08be3519bcf5a38074 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Thu, 18 Aug 2016 09:47:21 -0400 Subject: [PATCH] moved from extras repo where it incorrectly exists (#17124) * moved from extras repo where it incorrectly exists * added to sanity exclusion for 2.4 * changed license with author's consent --- lib/ansible/module_utils/lxd.py | 143 ++++++++++++++++++++++++++++++++ test/utils/shippable/sanity.sh | 2 +- 2 files changed, 144 insertions(+), 1 deletion(-) create mode 100644 lib/ansible/module_utils/lxd.py diff --git a/lib/ansible/module_utils/lxd.py b/lib/ansible/module_utils/lxd.py new file mode 100644 index 00000000000..b08cb3961ab --- /dev/null +++ b/lib/ansible/module_utils/lxd.py @@ -0,0 +1,143 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2016, Hiroaki Nakamura +# +# 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. +# +# 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. + +try: + import json +except ImportError: + import simplejson as json + +# httplib/http.client connection using unix domain socket +import socket +import ssl +try: + from httplib import HTTPConnection, HTTPSConnection +except ImportError: + # Python 3 + from http.client import HTTPConnection, HTTPSConnection + +class UnixHTTPConnection(HTTPConnection): + def __init__(self, path): + HTTPConnection.__init__(self, 'localhost') + self.path = path + + def connect(self): + sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + sock.connect(self.path) + self.sock = sock + +from ansible.module_utils.urls import generic_urlparse +try: + from urlparse import urlparse +except ImportError: + # Python 3 + from url.parse import urlparse + +class LXDClientException(Exception): + def __init__(self, msg, **kwargs): + self.msg = msg + self.kwargs = kwargs + +class LXDClient(object): + def __init__(self, url, key_file=None, cert_file=None, debug=False): + """LXD Client. + + :param url: The URL of the LXD server. (e.g. unix:/var/lib/lxd/unix.socket or https://127.0.0.1) + :type url: ``str`` + :param key_file: The path of the client certificate key file. + :type key_file: ``str`` + :param cert_file: The path of the client certificate file. + :type cert_file: ``str`` + :param debug: The debug flag. The request and response are stored in logs when debug is true. + :type debug: ``bool`` + """ + self.url = url + self.debug = debug + self.logs = [] + if url.startswith('https:'): + self.cert_file = cert_file + self.key_file = key_file + parts = generic_urlparse(urlparse(self.url)) + ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) + ctx.load_cert_chain(cert_file, keyfile=key_file) + self.connection = HTTPSConnection(parts.get('netloc'), context=ctx) + elif url.startswith('unix:'): + unix_socket_path = url[len('unix:'):] + self.connection = UnixHTTPConnection(unix_socket_path) + else: + raise LXDClientException('URL scheme must be unix: or https:') + + def do(self, method, url, body_json=None, ok_error_codes=None, timeout=None): + resp_json = self._send_request(method, url, body_json=body_json, ok_error_codes=ok_error_codes, timeout=timeout) + if resp_json['type'] == 'async': + url = '{0}/wait'.format(resp_json['operation']) + resp_json = self._send_request('GET', url) + if resp_json['metadata']['status'] != 'Success': + self._raise_err_from_json(resp_json) + return resp_json + + def authenticate(self, trust_password): + body_json = {'type': 'client', 'password': trust_password} + return self._send_request('POST', '/1.0/certificates', body_json=body_json) + + def _send_request(self, method, url, body_json=None, ok_error_codes=None, timeout=None): + try: + body = json.dumps(body_json) + self.connection.request(method, url, body=body) + resp = self.connection.getresponse() + resp_json = json.loads(resp.read()) + self.logs.append({ + 'type': 'sent request', + 'request': {'method': method, 'url': url, 'json': body_json, 'timeout': timeout}, + 'response': {'json': resp_json} + }) + resp_type = resp_json.get('type', None) + if resp_type == 'error': + if ok_error_codes is not None and resp_json['error_code'] in ok_error_codes: + return resp_json + self._raise_err_from_json(resp_json) + return resp_json + except socket.error as e: + raise LXDClientException('cannot connect to the LXD server', err=e) + + def _raise_err_from_json(self, resp_json): + err_params = {} + if self.debug: + err_params['logs'] = self.logs + raise LXDClientException(self._get_err_from_resp_json(resp_json), **err_params) + + @staticmethod + def _get_err_from_resp_json(resp_json): + err = None + metadata = resp_json.get('metadata', None) + if metadata is not None: + err = metadata.get('err', None) + if err is None: + err = resp_json.get('error', None) + return err diff --git a/test/utils/shippable/sanity.sh b/test/utils/shippable/sanity.sh index 0d16c7ee23c..335418d6c32 100755 --- a/test/utils/shippable/sanity.sh +++ b/test/utils/shippable/sanity.sh @@ -12,7 +12,7 @@ if [ "${TOXENV}" = 'py24' ]; then fi python2.4 -V - python2.4 -m compileall -fq -x 'module_utils/(a10|rax|openstack|ec2|gce|docker_common|azure_rm_common|vca|vmware|gcp|gcdns).py' lib/ansible/module_utils + python2.4 -m compileall -fq -x 'module_utils/(a10|rax|openstack|ec2|gce|lxd|docker_common|azure_rm_common|vca|vmware|gcp|gcdns).py' lib/ansible/module_utils else if [ "${install_deps}" != "" ]; then pip install -r "${source_root}/test/utils/shippable/sanity-requirements.txt" --upgrade