add http-debug code;add http-debug case;

modify test_http_response

modify capital DEBUG; pop the DEBUG environment variable when test over

modify http_response logger

split get_response and http-debug

Author: wallisyan

aliyun-python-sdk-core/aliyunsdkcore/http/http_response.py

@@ -18,11 +18,20 @@
 # coding=utf-8
 
 import os
+import logging
+
 from aliyunsdkcore.vendored.requests import Request, Session
 from aliyunsdkcore.vendored.requests.packages import urllib3
 from aliyunsdkcore.http.http_request import HttpRequest
 from aliyunsdkcore.http import protocol_type as PT
 
+from aliyunsdkcore.vendored.requests import status_codes
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+ch = logging.StreamHandler()
+logger.addHandler(ch)
+
 DEFAULT_CONNECT_TIMEOUT = 5
 
 
@@ -61,6 +70,24 @@ def set_ssl_enable(self, enable):
     def get_ssl_enabled(self):
         return self.__ssl_enable
 
+    @staticmethod
+    def prepare_http_debug(request, symbol):
+        base = ''
+        for key, value in request.headers.items():
+            base += '\n%s %s : %s' % (symbol, key, value)
+        return base
+
+    def do_http_debug(self, request, response):
+        # logger the request
+        request_base = '\n> %s %s HTTP/1.1' % (self.get_method().upper(), self.get_url())
+        request_base += '\n> Host : %s' % self.get_host()
+        logger.debug(request_base + self.prepare_http_debug(request, '>'))
+
+        # logger the response
+        response_base = '\n< HTTP/1.1 %s %s' % (
+            response.status_code, status_codes._codes.get(response.status_code)[0].upper())
+        logger.debug(response_base + self.prepare_http_debug(response, '<'))
+
     def get_response_object(self):
         with Session() as s:
             current_protocol = 'https://' if self.get_ssl_enabled() else 'http://'
@@ -87,7 +114,15 @@ def get_response_object(self):
             }
             # ignore the warning-InsecureRequestWarning
             urllib3.disable_warnings()
+
             response = s.send(prepped, proxies=proxies,
                               timeout=(DEFAULT_CONNECT_TIMEOUT, self._timeout),
                               allow_redirects=False, verify=None, cert=None)
+
+            http_debug = os.environ.get('DEBUG')
+
+            if http_debug is not None and http_debug.lower() == 'sdk':
+                # http debug information
+                self.do_http_debug(prepped, response)
+
             return response.status_code, response.headers, response.content

aliyun-python-sdk-core/tests/__init__.py

@@ -3,7 +3,65 @@
 # The unittest module got a significant overhaul
 # in 2.7, so if we're in 2.6 we can use the backported
 # version unittest2.
+import threading
+
 if sys.version_info[:2] == (2, 6):
     import unittest2 as unittest
 else:
     import unittest
+
+
+# the version under py3 use the different package
+if sys.version_info[0] == 3:
+    from http.server import SimpleHTTPRequestHandler
+    from http.server import HTTPServer
+else:
+    from SimpleHTTPServer import SimpleHTTPRequestHandler
+    from BaseHTTPServer import HTTPServer
+
+
+class MyServer:
+    _headers = {}
+    _url = ''
+
+    def __enter__(self):
+        class ServerHandler(SimpleHTTPRequestHandler):
+
+            def do_GET(_self):
+                _self.protocol_version = 'HTTP/1.1'
+                self._headers = _self.headers
+                self._url = _self.path
+                _self.send_response(200)
+                _self.send_header("Content-type", "application/json")
+                _self.end_headers()
+                _self.wfile.write(b"{}")
+
+        self.server = HTTPServer(("", 51352), ServerHandler)
+
+        def thread_func():
+            self.server.serve_forever()
+
+        thread = threading.Thread(target=thread_func)
+        thread.start()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.server:
+            self.server.shutdown()
+            self.server = None
+
+    @property
+    def headers(self):
+        return self._headers
+
+    @property
+    def url(self):
+        return self._url
+
+    @property
+    def content(self):
+        class Response:
+            def __init__(self, headers):
+                self.headers = headers
+        response = Response(self._headers)
+        return response

aliyun-python-sdk-core/tests/http/test_http_response.py

@@ -1,11 +1,17 @@
 # coding=utf-8
+import os
+import sys
 
-from tests import unittest
+from tests import unittest, MyServer
 
 from aliyunsdkcore.http.http_response import HttpResponse
 from aliyunsdkcore.http.protocol_type import HTTPS
 
 
+from aliyunsdkcore.client import AcsClient
+from aliyunsdkcore.request import CommonRequest
+
+
 class TestHttpResponse(unittest.TestCase):
 
     def test_http_request(self):
@@ -15,3 +21,38 @@ def test_http_request(self):
         self.assertTrue(res.get_ssl_enabled())
         res = HttpResponse(protocol=HTTPS)
         self.assertTrue(res.get_ssl_enabled())
+
+    @staticmethod
+    def do_request(client, request):
+        with MyServer() as s:
+            client.do_action_with_exception(request)
+            return s.content
+
+    @staticmethod
+    def init_client():
+        return AcsClient("access_key_id", "access_key_secret",
+                         timeout=120, port=51352)
+
+    def test_http_debug(self):
+        os.environ.setdefault('DEBUG', 'SDK')
+
+        http_debug = os.environ.get('DEBUG')
+        if http_debug is not None and http_debug.lower() == 'sdk':
+            request = CommonRequest(
+                domain="ecs.aliyuncs.com",
+                version="2014-05-26",
+                action_name="DescribeRegions")
+            request.set_endpoint("localhost")
+            make_request = HttpResponse(request.endpoint, '/')
+            request.headers = {'User-Agent': 'ALIBABACloud'}
+
+            content = make_request.prepare_http_debug(request, '>')
+            self.assertTrue('User-Agent' in content)
+
+            client = self.init_client()
+            response = self.do_request(client, request)
+            if sys.version_info[0] == 3:
+                response = make_request.prepare_http_debug(response, '<')
+                self.assertTrue('User-Agent' in response)
+
+        os.environ.pop('DEBUG', None)

aliyun-python-sdk-core/tests/test_user_agent.py

@@ -1,59 +1,10 @@
 # encoding:utf-8
-import sys
-import threading
 
-from tests import unittest
+from tests import unittest, MyServer
 
 from aliyunsdkcore.client import AcsClient
 from aliyunsdkcore.request import CommonRequest
 
-# the version under py3 use the different package
-if sys.version_info[0] == 3:
-    from http.server import SimpleHTTPRequestHandler
-    from http.server import HTTPServer
-else:
-    from SimpleHTTPServer import SimpleHTTPRequestHandler
-    from BaseHTTPServer import HTTPServer
-
-
-class MyServer:
-    _headers = {}
-    _url = ''
-
-    def __enter__(self):
-        class ServerHandler(SimpleHTTPRequestHandler):
-
-            def do_GET(_self):
-                _self.protocol_version = 'HTTP/1.1'
-                self._headers = _self.headers
-                self._url = _self.path
-                _self.send_response(200)
-                _self.send_header("Content-type", "application/json")
-                _self.end_headers()
-                _self.wfile.write(b"{}")
-
-        self.server = HTTPServer(("", 51352), ServerHandler)
-
-        def thread_func():
-            self.server.serve_forever()
-
-        thread = threading.Thread(target=thread_func)
-        thread.start()
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        if self.server:
-            self.server.shutdown()
-            self.server = None
-
-    @property
-    def headers(self):
-        return self._headers
-
-    @property
-    def url(self):
-        return self._url
-
 
 class UserAgentTest(unittest.TestCase):