Merge pull request #24 from cloudblue/feature/logger

Add logger functionality for openapi client

Author: marcserrat

connect/client/__init__.py

@@ -6,3 +6,4 @@
 from connect.client.exceptions import ClientError  # noqa
 from connect.client.fluent import AsyncConnectClient, ConnectClient  # noqa
 from connect.client.rql import R  # noqa
+from connect.client.logger import RequestLogger # noqa

connect/client/fluent.py

@@ -29,6 +29,7 @@ def __init__(
         default_headers=None,
         default_limit=100,
         max_retries=0,
+        logger=None,
     ):
         """
         Create a new instance of the ConnectClient.
@@ -42,6 +43,8 @@ def __init__(
         :type specs_location: str, optional
         :param default_headers: Http headers to apply to each request, defaults to {}
         :type default_headers: dict, optional
+        :param logger: HTTPP Request logger class, defaults to None
+        :type logger: RequestLogger, optional
         """
         if default_headers and 'Authorization' in default_headers:
             raise ValueError('`default_headers` cannot contains `Authorization`')
@@ -58,6 +61,7 @@ def __init__(
         if self._use_specs:
             self.specs = OpenAPISpecs(self.specs_location)
         self.response = None
+        self.logger = logger
         self._help_formatter = DefaultFormatter(self.specs)
 
     def __getattr__(self, name):

connect/client/logger.py

@@ -0,0 +1,47 @@
+import json
+import sys
+
+
+class RequestLogger:
+    def __init__(self, file=sys.stdout):
+        self._file = file
+
+    def log_request(self, method, url, kwargs):
+        other_args = {k: v for k, v in kwargs.items() if k not in ('headers', 'json', 'params')}
+
+        if 'params' in kwargs:
+            url += '&' if '?' in url else '?'
+            url += '&'.join([f'{k}={v}' for k, v in kwargs['params'].items()])
+
+        lines = [
+            '--- HTTP Request ---',
+            f'{method.upper()} {url} {other_args if other_args else ""}',
+        ]
+
+        if 'headers' in kwargs:
+            for k, v in kwargs['headers'].items():
+                lines.append(f'{k}: {v}')
+
+        if 'json' in kwargs:
+            lines.append(json.dumps(kwargs['json'], indent=4))
+
+        lines.append('')
+
+        print(*lines, sep='\n', file=self._file)
+
+    def log_response(self, response):
+        reason = response.raw.reason if getattr(response, 'raw', None) else response.reason_phrase
+        lines = [
+            '--- HTTP Response ---',
+            f'{response.status_code} {reason}',
+        ]
+
+        for k, v in response.headers.items():
+            lines.append(f'{k}: {v}')
+
+        if response.headers.get('Content-Type', None) == 'application/json':
+            lines.append(json.dumps(response.json(), indent=4))
+
+        lines.append('')
+
+        print(*lines, sep='\n', file=self._file)

connect/client/mixins.py

@@ -57,6 +57,7 @@ def execute(self, method, path, **kwargs):
 
         try:
             self._execute_http_call(method, url, kwargs)
+
             if self.response.status_code == 204:
                 return None
             if self.response.headers['Content-Type'] == 'application/json':
@@ -72,7 +73,14 @@ def execute(self, method, path, **kwargs):
     def _execute_http_call(self, method, url, kwargs):
         retry_count = 0
         while True:
+            if self.logger:
+                self.logger.log_request(method, url, kwargs)
+
             self.response = requests.request(method, url, **kwargs)
+
+            if self.logger:
+                self.logger.log_response(self.response)
+
             if (  # pragma: no branch
                 self.response.status_code == 502
                 and retry_count < self.max_retries
@@ -141,8 +149,15 @@ async def execute(self, method, path, **kwargs):
     async def _execute_http_call(self, method, url, kwargs):
         retry_count = 0
         while True:
+            if self.logger:
+                self.logger.log_request(method, url, kwargs)
+
             async with httpx.AsyncClient() as client:
                 self.response = await client.request(method, url, **kwargs)
+
+            if self.logger:
+                self.logger.log_response(self.response)
+
             if (  # pragma: no branch
                 self.response.status_code == 502
                 and retry_count < self.max_retries

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connect-openapi-client"
-version = "21.0.0"
+version = "22.0.8"
 description = "Connect Python OpenAPI Client"
 authors = ["CloudBlue"]
 license = "Apache-2.0"

tests/async_client/test_fluent.py

@@ -1,6 +1,9 @@
+import io
+
 import pytest
 
 from connect.client import AsyncConnectClient, ClientError
+from connect.client.logger import RequestLogger
 from connect.client.models import AsyncCollection, AsyncNS
 
 
@@ -89,7 +92,11 @@ async def test_execute(httpx_mock):
         json=expected,
     )
 
-    c = AsyncConnectClient('API_KEY', endpoint='https://localhost', use_specs=False)
+    ios = io.StringIO()
+    c = AsyncConnectClient('API_KEY',
+                           endpoint='https://localhost',
+                           use_specs=False,
+                           logger=RequestLogger(file=ios))
 
     results = await c.execute('get', 'resources')
 

tests/client/test_fluent.py

@@ -1,3 +1,5 @@
+import io
+
 import pytest
 
 import responses
@@ -7,6 +9,7 @@
 from connect.client.constants import CONNECT_ENDPOINT_URL, CONNECT_SPECS_URL
 from connect.client.exceptions import ClientError
 from connect.client.fluent import ConnectClient
+from connect.client.logger import RequestLogger
 from connect.client.models import Collection, NS
 
 
@@ -156,7 +159,11 @@ def test_execute(mocked_responses):
         json=expected,
     )
 
-    c = ConnectClient('API_KEY', endpoint='https://localhost', use_specs=False)
+    ios = io.StringIO()
+    c = ConnectClient('API_KEY',
+                      endpoint='https://localhost',
+                      use_specs=False,
+                      logger=RequestLogger(file=ios))
 
     results = c.execute('get', 'resources')
 

tests/client/test_logger.py

@@ -0,0 +1,96 @@
+import io
+
+from requests.models import Response
+
+from urllib3.response import HTTPResponse
+
+from connect.client.logger import RequestLogger
+
+
+def test_log_request():
+    LOG_REQUEST_HEADER = '--- HTTP Request ---\n'
+    PATH1 = 'https://some.host.name/some/path'
+    PATH2 = 'https://some.host.name/some/path?a=b'
+
+    ios = io.StringIO()
+    rl = RequestLogger(file=ios)
+
+    rl.log_request('get', PATH1, {})
+    assert ios.getvalue() == LOG_REQUEST_HEADER + 'GET ' + PATH1 + ' \n\n'
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+    rl.log_request('get', PATH1, {'headers': {'Auth': 'None', 'Cookie': 'XXX'}})
+    assert ios.getvalue() == LOG_REQUEST_HEADER + 'GET ' + PATH1 + ' \n' + """Auth: None
+Cookie: XXX
+
+"""
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+    rl.log_request('post', PATH1, {'json': {'id': 'XX-1234', 'name': 'XXX'}})
+    assert ios.getvalue() == LOG_REQUEST_HEADER + 'POST ' + PATH1 + ' \n' + """{
+    "id": "XX-1234",
+    "name": "XXX"
+}
+
+"""
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+    rl.log_request('get', PATH1, {'params': {'limit': 10, 'offset': 0}})
+    assert ios.getvalue() == LOG_REQUEST_HEADER + 'GET ' + PATH1 + '?limit=10&offset=0 \n\n'
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+    rl.log_request('get', PATH2, {})
+    assert ios.getvalue() == LOG_REQUEST_HEADER + 'GET ' + PATH2 + ' \n\n'
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+    rl.log_request('get', PATH2, {'params': {'limit': 10, 'offset': 0}})
+    assert ios.getvalue() == LOG_REQUEST_HEADER + 'GET ' + PATH2 + '&limit=10&offset=0 \n\n'
+
+
+def test_log_resposne(mocker):
+    LOG_RESPONSE_HEADER = '--- HTTP Response ---\n'
+
+    ios = io.StringIO()
+    rl = RequestLogger(file=ios)
+
+    rsp = Response()
+    rsp.raw = HTTPResponse()
+
+    rsp.status_code = 200
+    rsp.raw.reason = 'OK'
+    rl.log_response(rsp)
+    assert ios.getvalue() == LOG_RESPONSE_HEADER + '200 OK\n\n'
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+
+    rsp = Response()
+    rsp.status_code = 200
+    rsp.reason_phrase = 'OK'
+    rl.log_response(rsp)
+    assert ios.getvalue() == LOG_RESPONSE_HEADER + '200 OK\n\n'
+
+    ios.truncate(0)
+    ios.seek(0, 0)
+
+    json = {'id': 'XX-1234', 'name': 'XXX'}
+    mocker.patch('requests.models.Response.json', return_value=json)
+    rsp = Response()
+    rsp.raw = HTTPResponse()
+    rsp.headers = {'Content-Type': 'application/json'}
+    rsp.status_code = 200
+    rsp.raw.reason = 'OK'
+    rl.log_response(rsp)
+    assert ios.getvalue() == LOG_RESPONSE_HEADER + """200 OK
+Content-Type: application/json
+{
+    "id": "XX-1234",
+    "name": "XXX"
+}
+
+"""