|
| 1 | +""" |
| 2 | + SoftLayer.testing.xmprpc |
| 3 | + ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 4 | + XMP-RPC server which can use a transport to proxy requests for testing. |
| 5 | +
|
| 6 | + :license: MIT, see LICENSE for more details. |
| 7 | +""" |
| 8 | +import logging |
| 9 | +import threading |
| 10 | + |
| 11 | +import six |
| 12 | + |
| 13 | +import SoftLayer |
| 14 | +from SoftLayer import transports |
| 15 | +from SoftLayer import utils |
| 16 | + |
| 17 | +# pylint: disable=invalid-name, broad-except |
| 18 | + |
| 19 | + |
| 20 | +class TestServer(six.moves.BaseHTTPServer.HTTPServer): |
| 21 | + """Test HTTP server which holds a given transport.""" |
| 22 | + |
| 23 | + def __init__(self, transport, *args, **kw): |
| 24 | + six.moves.BaseHTTPServer.HTTPServer.__init__(self, *args, **kw) |
| 25 | + self.transport = transport |
| 26 | + |
| 27 | + |
| 28 | +class TestHandler(six.moves.BaseHTTPServer.BaseHTTPRequestHandler): |
| 29 | + """Test XML-RPC Handler which converts XML-RPC to transport requests.""" |
| 30 | + |
| 31 | + def do_POST(self): |
| 32 | + """Handle XML-RPC POSTs.""" |
| 33 | + try: |
| 34 | + length = int(self.headers['Content-Length']) |
| 35 | + data = self.rfile.read(length).decode('utf-8') |
| 36 | + args, method = utils.xmlrpc_client.loads(data) |
| 37 | + headers = args[0].get('headers', {}) |
| 38 | + |
| 39 | + # Form Request for the transport |
| 40 | + req = transports.Request() |
| 41 | + req.service = self.path.lstrip('/') |
| 42 | + req.method = method |
| 43 | + req.limit = utils.lookup(headers, 'resultLimit', 'limit') |
| 44 | + req.offset = utils.lookup(headers, 'resultLimit', 'offset') |
| 45 | + req.args = args[1:] |
| 46 | + req.filter = _item_by_key_postfix(headers, 'ObjectFilter') or None |
| 47 | + req.mask = _item_by_key_postfix(headers, 'ObjectMask').get('mask') |
| 48 | + req.identifier = _item_by_key_postfix(headers, |
| 49 | + 'InitParameters').get('id') |
| 50 | + req.transport_headers = dict(((k.lower(), v) |
| 51 | + for k, v in self.headers.items())) |
| 52 | + |
| 53 | + # Get response |
| 54 | + response = self.server.transport(req) |
| 55 | + |
| 56 | + response_body = utils.xmlrpc_client.dumps((response,), |
| 57 | + allow_none=True, |
| 58 | + methodresponse=1) |
| 59 | + |
| 60 | + self.send_response(200) |
| 61 | + self.send_header("Content-type", "application/xml") |
| 62 | + self.end_headers() |
| 63 | + self.wfile.write(response_body.encode('utf-8')) |
| 64 | + |
| 65 | + except SoftLayer.SoftLayerAPIError as ex: |
| 66 | + self.send_response(ex.faultCode or 500) |
| 67 | + self.end_headers() |
| 68 | + response = utils.xmlrpc_client.Fault(ex.faultCode, str(ex.reason)) |
| 69 | + response_body = utils.xmlrpc_client.dumps((response,), |
| 70 | + allow_none=True, |
| 71 | + methodresponse=1) |
| 72 | + self.wfile.write(response_body.encode('utf-8')) |
| 73 | + except Exception as ex: |
| 74 | + self.send_response(500) |
| 75 | + logging.exception("Error while handling request") |
| 76 | + |
| 77 | + def log_message(self, fmt, *args): |
| 78 | + """Override log_message.""" |
| 79 | + pass |
| 80 | + |
| 81 | + |
| 82 | +def _item_by_key_postfix(dictionary, key_prefix): |
| 83 | + """Get item from a dictionary which begins with the given prefix.""" |
| 84 | + for key, value in dictionary.items(): |
| 85 | + if key.endswith(key_prefix): |
| 86 | + return value |
| 87 | + |
| 88 | + return {} |
| 89 | + |
| 90 | + |
| 91 | +def create_test_server(transport, host='localhost', port=0): |
| 92 | + """Create a test XML-RPC server in a new thread.""" |
| 93 | + server = TestServer(transport, (host, port), TestHandler) |
| 94 | + thread = threading.Thread(target=server.serve_forever, |
| 95 | + kwargs={'poll_interval': 0.05}) |
| 96 | + thread.start() |
| 97 | + return server |
0 commit comments