Fix all minor typos and modifications in tests
[kamaki] / kamaki / clients / __init__.py
index 7b9e2f4..bb0eef8 100644 (file)
 # interpreted as representing official policies, either expressed
 # or implied, of GRNET S.A.
 
+from urllib2 import quote, unquote
+from urlparse import urlparse
 from threading import Thread
 from json import dumps, loads
 from time import time
-import logging
-from kamaki.clients.connection.kamakicon import KamakiHTTPConnection
-from kamaki.clients.connection.errors import HTTPConnectionError
-from kamaki.clients.connection.errors import HTTPResponseError
+from httplib import ResponseNotReady
+from time import sleep
+from random import random
+from logging import getLogger
 
-sendlog = logging.getLogger('clients.send')
-recvlog = logging.getLogger('clients.recv')
+from objpool.http import PooledHTTPConnection
+
+
+TIMEOUT = 60.0   # seconds
+HTTP_METHODS = ['GET', 'POST', 'PUT', 'HEAD', 'DELETE', 'COPY', 'MOVE']
+
+log = getLogger(__name__)
+sendlog = getLogger('%s.send' % __name__)
+recvlog = getLogger('%s.recv' % __name__)
+
+
+def _encode(v):
+    if v and isinstance(v, unicode):
+        return quote(v.encode('utf-8'))
+    return v
 
 
 class ClientError(Exception):
     def __init__(self, message, status=0, details=None):
+        log.debug('ClientError: msg[%s], sts[%s], dtl[%s]' % (
+            message,
+            status,
+            details))
         try:
             message += '' if message and message[-1] == '\n' else '\n'
             serv_stat, sep, new_msg = message.partition('{')
-            new_msg = sep + new_msg
+            new_msg = sep + new_msg[:-1 if new_msg.endswith('\n') else 0]
             json_msg = loads(new_msg)
             key = json_msg.keys()[0]
+            serv_stat = serv_stat.strip()
 
             json_msg = json_msg[key]
-            message = '%s %s (%s)\n' % (serv_stat, key, json_msg['message'])\
-                if 'message' in json_msg else '%s %s' % (serv_stat, key)
-            if 'code' in json_msg:
-                status = json_msg['code']
+            message = '%s %s (%s)\n' % (
+                serv_stat,
+                key,
+                json_msg['message']) if (
+                    'message' in json_msg) else '%s %s' % (serv_stat, key)
+            status = json_msg.get('code', status)
             if 'details' in json_msg:
                 if not details:
                     details = []
-                elif not isinstance(details, list):
+                if not isinstance(details, list):
                     details = [details]
                 if json_msg['details']:
                     details.append(json_msg['details'])
-        except:
+        except Exception:
             pass
+        finally:
+            while message.endswith('\n\n'):
+                message = message[:-1]
+            super(ClientError, self).__init__(message)
+            self.status = status if isinstance(status, int) else 0
+            self.details = details if details else []
+
+
+class Logged(object):
+
+    LOG_TOKEN = False
+    LOG_DATA = False
+
+
+class RequestManager(Logged):
+    """Handle http request information"""
+
+    def _connection_info(self, url, path, params={}):
+        """ Set self.url to scheme://netloc/?params
+        :param url: (str or unicode) The service url
+
+        :param path: (str or unicode) The service path (url/path)
+
+        :param params: (dict) Parameters to add to final url
 
-        super(ClientError, self).__init__(message)
-        self.status = status
-        self.details = details if details else []
+        :returns: (scheme, netloc)
+        """
+        url = _encode(str(url)) if url else 'http://127.0.0.1/'
+        url += '' if url.endswith('/') else '/'
+        if path:
+            url += _encode(path[1:] if path.startswith('/') else path)
+        delim = '?'
+        for key, val in params.items():
+            val = _encode(val)
+            url += '%s%s%s' % (delim, key, ('=%s' % val) if val else '')
+            delim = '&'
+        parsed = urlparse(url)
+        self.url = url
+        self.path = parsed.path or '/'
+        if parsed.query:
+            self.path += '?%s' % parsed.query
+        return (parsed.scheme, parsed.netloc)
+
+    def __init__(
+            self, method, url, path,
+            data=None, headers={}, params={}):
+        method = method.upper()
+        assert method in HTTP_METHODS, 'Invalid http method %s' % method
+        if headers:
+            assert isinstance(headers, dict)
+        self.headers = dict(headers)
+        self.method, self.data = method, data
+        self.scheme, self.netloc = self._connection_info(url, path, params)
+
+    def dump_log(self):
+        sendlog.info('%s %s://%s%s\t[%s]' % (
+            self.method, self.scheme, self.netloc, self.path, self))
+        for key, val in self.headers.items():
+            if (not self.LOG_TOKEN) and key.lower() == 'x-auth-token':
+                continue
+            sendlog.info('  %s: %s\t[%s]' % (key, val, self))
+        if self.data:
+            sendlog.info('data size:%s\t[%s]' % (len(self.data), self))
+            if self.LOG_DATA:
+                sendlog.info(self.data)
+        else:
+            sendlog.info('data size:0\t[%s]' % self)
+        sendlog.info('')
+
+    def perform(self, conn):
+        """
+        :param conn: (httplib connection object)
+
+        :returns: (HTTPResponse)
+        """
+        conn.request(
+            method=str(self.method.upper()),
+            url=str(self.path),
+            headers=self.headers,
+            body=self.data)
+        self.dump_log()
+        keep_trying = TIMEOUT
+        while keep_trying > 0:
+            try:
+                return conn.getresponse()
+            except ResponseNotReady:
+                wait = 0.03 * random()
+                sleep(wait)
+                keep_trying -= wait
+        logmsg = 'Kamaki Timeout %s %s\t[%s]' % (self.method, self.path, self)
+        recvlog.debug(logmsg)
+        raise ClientError('HTTPResponse takes too long - kamaki timeout')
+
+
+class ResponseManager(Logged):
+    """Manage the http request and handle the response data, headers, etc."""
+
+    def __init__(self, request, poolsize=None):
+        """
+        :param request: (RequestManager)
+        """
+        self.request = request
+        self._request_performed = False
+        self.poolsize = poolsize
+
+    def _get_response(self):
+        if self._request_performed:
+            return
+
+        pool_kw = dict(size=self.poolsize) if self.poolsize else dict()
+        try:
+            with PooledHTTPConnection(
+                    self.request.netloc, self.request.scheme,
+                    **pool_kw) as connection:
+                self.request.LOG_TOKEN = self.LOG_TOKEN
+                self.request.LOG_DATA = self.LOG_DATA
+                r = self.request.perform(connection)
+                recvlog.info('\n%s <-- %s <-- [req: %s]\n' % (
+                    self, r, self.request))
+                self._request_performed = True
+                self._status_code, self._status = r.status, unquote(r.reason)
+                recvlog.info(
+                    '%d %s\t[p: %s]' % (self.status_code, self.status, self))
+                self._headers = dict()
+                for k, v in r.getheaders():
+                    if (not self.LOG_TOKEN) and k.lower() == 'x-auth-token':
+                        continue
+                    v = unquote(v)
+                    self._headers[k] = v
+                    recvlog.info('  %s: %s\t[p: %s]' % (k, v, self))
+                self._content = r.read()
+                recvlog.info('data size: %s\t[p: %s]' % (
+                    len(self._content) if self._content else 0,
+                    self))
+                if self.LOG_DATA and self._content:
+                    recvlog.info('%s\t[p: %s]' % (self._content, self))
+        except Exception as err:
+            from traceback import format_stack
+            recvlog.debug('\n'.join(['%s' % type(err)] + format_stack()))
+            raise ClientError(
+                'Failed while http-connecting to %s (%s)' % (
+                    self.request.url,
+                    err))
+
+    @property
+    def status_code(self):
+        self._get_response()
+        return self._status_code
+
+    @property
+    def status(self):
+        self._get_response()
+        return self._status
+
+    @property
+    def headers(self):
+        self._get_response()
+        return self._headers
+
+    @property
+    def content(self):
+        self._get_response()
+        return self._content
+
+    @property
+    def text(self):
+        """
+        :returns: (str) content
+        """
+        self._get_response()
+        return '%s' % self._content
+
+    @property
+    def json(self):
+        """
+        :returns: (dict) squeezed from json-formated content
+        """
+        self._get_response()
+        try:
+            return loads(self._content)
+        except ValueError as err:
+            raise ClientError('Response not formated in JSON - %s' % err)
 
 
 class SilentEvent(Thread):
-    """ Thread-run method(*args, **kwargs)
-        put exception in exception_bucket
-    """
+    """Thread-run method(*args, **kwargs)"""
     def __init__(self, method, *args, **kwargs):
         super(self.__class__, self).__init__()
         self.method = method
@@ -94,32 +292,45 @@ class SilentEvent(Thread):
         try:
             self._value = self.method(*(self.args), **(self.kwargs))
         except Exception as e:
-            print('______\n%s, \n_______' % (e, type(e)))
+            recvlog.debug('Thread %s got exception %s\n<%s %s' % (
+                self,
+                type(e),
+                e.status if isinstance(e, ClientError) else '',
+                e))
             self._exception = e
 
 
 class Client(object):
-    POOL_SIZE = 7
 
-    def __init__(self, base_url, token, http_client=KamakiHTTPConnection()):
+    MAX_THREADS = 7
+    DATE_FORMATS = [
+        '%a %b %d %H:%M:%S %Y',
+        '%A, %d-%b-%y %H:%M:%S GMT',
+        '%a, %d %b %Y %H:%M:%S GMT']
+    LOG_TOKEN = False
+    LOG_DATA = False
+
+    def __init__(self, base_url, token):
+        assert base_url, 'No base_url for client %s' % self
         self.base_url = base_url
         self.token = token
-        self.headers = {}
-        self.DATE_FORMATS = ["%a %b %d %H:%M:%S %Y",
-            "%A, %d-%b-%y %H:%M:%S GMT",
-            "%a, %d %b %Y %H:%M:%S GMT"]
-        self.http_client = http_client
+        self.headers, self.params = dict(), dict()
 
     def _init_thread_limit(self, limit=1):
+        assert isinstance(limit, int) and limit > 0, 'Thread limit not a +int'
         self._thread_limit = limit
         self._elapsed_old = 0.0
         self._elapsed_new = 0.0
 
     def _watch_thread_limit(self, threadlist):
-        if self._elapsed_old > self._elapsed_new\
-        and self._thread_limit < self.POOL_SIZE:
+        self._thread_limit = getattr(self, '_thread_limit', 1)
+        self._elapsed_new = getattr(self, '_elapsed_new', 0.0)
+        self._elapsed_old = getattr(self, '_elapsed_old', 0.0)
+        recvlog.debug('# running threads: %s' % len(threadlist))
+        if self._elapsed_old and self._elapsed_old >= self._elapsed_new and (
+                self._thread_limit < self.MAX_THREADS):
             self._thread_limit += 1
-        elif self._elapsed_old < self._elapsed_new and self._thread_limit > 1:
+        elif self._elapsed_old <= self._elapsed_new and self._thread_limit > 1:
             self._thread_limit -= 1
 
         self._elapsed_old = self._elapsed_new
@@ -134,7 +345,8 @@ class Client(object):
         return threadlist
 
     def _raise_for_status(self, r):
-        status_msg = getattr(r, 'status', '')
+        log.debug('raise err from [%s] of type[%s]' % (r, type(r)))
+        status_msg = getattr(r, 'status', None) or ''
         try:
             message = '%s %s\n' % (status_msg, r.text)
         except:
@@ -145,86 +357,54 @@ class Client(object):
     def set_header(self, name, value, iff=True):
         """Set a header 'name':'value'"""
         if value is not None and iff:
-            self.http_client.set_header(name, value)
+            self.headers[name] = unicode(value)
 
     def set_param(self, name, value=None, iff=True):
         if iff:
-            self.http_client.set_param(name, value)
-
-    def set_default_header(self, name, value):
-        self.http_client.headers.setdefault(name, value)
-
-    def request(self,
-        method,
-        path,
-        async_headers={},
-        async_params={},
-        **kwargs):
-        """In threaded/asynchronous requests, headers and params are not safe
-        Therefore, the standard self.set_header/param system can be used only
-        for headers and params that are common for all requests. All other
-        params and headers should passes as
-        @param async_headers
-        @async_params
-        E.g. in most queries the 'X-Auth-Token' header might be the same for
-        all, but the 'Range' header might be different from request to request.
+            self.params[name] = unicode(value)
+
+    def request(
+            self, method, path,
+            async_headers=dict(), async_params=dict(),
+            **kwargs):
+        """Commit an HTTP request to base_url/path
+        Requests are commited to and performed by Request/ResponseManager
+        These classes perform a lazy http request. Present method, by default,
+        enforces them to perform the http call. Hint: call present method with
+        success=None to get a non-performed ResponseManager object.
         """
-
+        assert isinstance(method, str) or isinstance(method, unicode)
+        assert method
+        assert isinstance(path, str) or isinstance(path, unicode)
         try:
+            headers = dict(self.headers)
+            headers.update(async_headers)
+            params = dict(self.params)
+            params.update(async_params)
             success = kwargs.pop('success', 200)
-
             data = kwargs.pop('data', None)
-            self.set_default_header('X-Auth-Token', self.token)
-
+            headers.setdefault('X-Auth-Token', self.token)
             if 'json' in kwargs:
                 data = dumps(kwargs.pop('json'))
-                self.set_default_header('Content-Type', 'application/json')
+                headers.setdefault('Content-Type', 'application/json')
             if data:
-                self.set_default_header('Content-Length', unicode(len(data)))
-
-            self.http_client.url = self.base_url
-            self.http_client.path = path
-            r = self.http_client.perform_request(method,
-                data,
-                async_headers,
-                async_params)
-
-            req = self.http_client
-            sendlog.info('%s %s', method, req.url)
-            headers = dict(req.headers)
-            headers.update(async_headers)
-
-            for key, val in headers.items():
-                sendlog.info('\t%s: %s', key, val)
-            sendlog.info('')
-            if data:
-                sendlog.debug('%s', data)
-
-            recvlog.info('%d %s', r.status_code, r.status)
-            for key, val in r.headers.items():
-                recvlog.info('%s: %s', key, val)
-            if r.content:
-                recvlog.debug(r.content)
-
-        except (HTTPResponseError, HTTPConnectionError) as err:
-            from traceback import format_stack
-            recvlog.debug('\n'.join(['%s' % type(err)] + format_stack()))
-            self.http_client.reset_headers()
-            self.http_client.reset_params()
-            errstr = '%s' % err
-            if not errstr:
-                errstr = ('%s' % type(err))[7:-2]
-            raise ClientError('%s\n' % errstr,
-                status=getattr(err, 'status', 0) or getattr(err, 'errno', 0))
-
-        self.http_client.reset_headers()
-        self.http_client.reset_params()
+                headers.setdefault('Content-Length', '%s' % len(data))
+
+            sendlog.debug('\n\nCMT %s@%s\t[%s]', method, self.base_url, self)
+            req = RequestManager(
+                method, self.base_url, path,
+                data=data, headers=headers, params=params)
+            #  req.log()
+            r = ResponseManager(req)
+            r.LOG_TOKEN, r.LOG_DATA = self.LOG_TOKEN, self.LOG_DATA
+        finally:
+            self.headers = dict()
+            self.params = dict()
 
         if success is not None:
-            # Success can either be an in or a collection
+            # Success can either be an int or a collection
             success = (success,) if isinstance(success, int) else success
             if r.status_code not in success:
-                r.release()
                 self._raise_for_status(r)
         return r