add EC (#329)

Author: zhuxiaolong37

oss2/api.py

@@ -1056,7 +1056,7 @@ def get_object_meta(self, key, params=None, headers=None):
         if Bucket.OBJECTMETA not in params:
             params[Bucket.OBJECTMETA] = ''
 
-        resp = self.__do_object('GET', key, params=params, headers=headers)
+        resp = self.__do_object('HEAD', key, params=params, headers=headers)
         logger.debug("Get object metadata done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
         return GetObjectMetaResult(resp)
 
@@ -1074,12 +1074,17 @@ def object_exists(self, key, headers=None):
         # 304 (NotModified)；不存在，则会返回NoSuchKey。get_object会受回源的影响，如果配置会404回源，get_object会判断错误。
         #
         # 目前的实现是通过get_object_meta判断文件是否存在。
+        # get_object_meta 为200时，不会返回响应体，所以该接口把GET方法修改为HEAD 方式
+        # 同时, 对于head 请求，服务端会通过x-oss-err 返回 错误响应信息,
+        # 考虑到兼容之前的行为，增加exceptions.NotFound 异常 当作NoSuchKey
 
         logger.debug("Start to check if object exists, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
         try:
             self.get_object_meta(key, headers=headers)
         except exceptions.NoSuchKey:
             return False
+        except exceptions.NotFound:
+            return False
         except:
             raise
 

oss2/exceptions.py

@@ -8,15 +8,14 @@
 """
 
 import re
-
+import base64
 import xml.etree.ElementTree as ElementTree
 from xml.parsers import expat
 
 
 from .compat import to_string
 from .headers import *
 
-
 _OSS_ERROR_TO_EXCEPTION = {}  # populated at end of module
 
 
@@ -47,6 +46,12 @@ def __init__(self, status, headers, body, details):
         #: OSS错误信息
         self.message = self.details.get('Message', '')
 
+        #: OSS新的错误码
+        self.ec = self.details.get('EC', '')
+
+        #: header信息
+        self.headers = headers
+
     def __str__(self):
         error = {'status': self.status,
                  OSS_REQUEST_ID : self.request_id,
@@ -317,7 +322,14 @@ def make_exception(resp):
     status = resp.status
     headers = resp.headers
     body = resp.read(4096)
-    details = _parse_error_body(body)
+    if not body and headers.get('x-oss-err') is not None:
+        try:
+            value = base64.b64decode(to_string(headers.get('x-oss-err')))
+        except:
+            value = body
+        details = _parse_error_body(value)
+    else:
+        details = _parse_error_body(body)
     code = details.get('Code', '')
 
     try:

tests/test_exception_ec.py

@@ -0,0 +1,43 @@
+from .common import *
+
+class TestExceptionEC(OssTestCase):
+    def setUp(self):
+        OssTestCase.setUp(self)
+
+    def tearDown(self):
+        try:
+            OssTestCase.tearDown(self)
+        except:
+            pass
+    def test_1_exception_normal(self):
+        key = 'a.txt'
+        try:
+            self.bucket.get_object(key)
+        except oss2.exceptions.ServerError as e:
+            self.assertEqual(e.headers.get('x-oss-ec'), '0026-00000001')
+            self.assertEqual(e.ec, '0026-00000001')
+
+    def test_2_exception_head(self):
+        key = 'a.txt'
+        try:
+            self.bucket.get_object_meta(key)
+        except oss2.exceptions.OssError as e:
+            self.assertEqual(e.ec, '0026-00000001')
+            self.assertEqual(e.headers.get('x-oss-ec'), '0026-00000001')
+
+    def test_3_exception_head_err(self):
+        # 模拟head请求下的签名错误
+        auth = oss2.AuthV4(OSS_ID, OSS_SECRET)
+        bucket = oss2.Bucket(auth, OSS_ENDPOINT, self.OSS_BUCKET, region='cn-hangzhou-test-1')
+        key = 'a.txt'
+
+        try:
+            bucket.head_object(key)
+        except oss2.exceptions.OssError as e:
+            self.assertEqual(e.ec, '0002-00000061')
+            self.assertEqual(e.headers.get('x-oss-ec'), '0002-00000061')
+            self.assertEqual(e.code, 'InvalidArgument')
+            self.assertEqual(e.message, 'Authorization header is invalid.')
+
+if __name__ == '__main__':
+    unittest.main()

unittests/test_object.py

@@ -129,7 +129,7 @@ def test_head(self, do_request):
 
     @patch('oss2.Session.do_request')
     def test_object_exists_true(self, do_request):
-        request_text = '''GET /sbowspxjhmccpmesjqcwagfw?objectMeta HTTP/1.1
+        request_text = '''HEAD /sbowspxjhmccpmesjqcwagfw?objectMeta HTTP/1.1
 Host: ming-oss-share.oss-cn-hangzhou.aliyuncs.com
 Accept-Encoding: identity
 Connection: keep-alive
@@ -154,7 +154,7 @@ def test_object_exists_true(self, do_request):
 
     @patch('oss2.Session.do_request')
     def test_object_exists_false(self, do_request):
-        request_text = '''GET /sbowspxjhmccpmesjqcwagfw?objectMeta HTTP/1.1
+        request_text = '''HEAD /sbowspxjhmccpmesjqcwagfw?objectMeta HTTP/1.1
 Host: ming-oss-share.oss-cn-hangzhou.aliyuncs.com
 Accept-Encoding: identity
 Connection: keep-alive
@@ -170,15 +170,57 @@ def test_object_exists_false(self, do_request):
 Content-Length: 287
 Connection: keep-alive
 x-oss-request-id: 566B6C3D6086505A0CFF0F68
+'''
 
-<?xml version="1.0" encoding="UTF-8"?>
-<Error>
-  <Code>NoSuchKey</Code>
-  <Message>The specified key does not exist.</Message>
-  <RequestId>566B6C3D6086505A0CFF0F68</RequestId>
-  <HostId>ming-oss-share.oss-cn-hangzhou.aliyuncs.com</HostId>
-  <Key>sbowspxjhmccpmesjqcwagfw</Key>
-</Error>'''
+        req_info = mock_response(do_request, response_text)
+        self.assertTrue(not bucket().object_exists('sbowspxjhmccpmesjqcwagfw'))
+        self.assertRequest(req_info, request_text)
+
+    @patch('oss2.Session.do_request')
+    def test_object_exists_false_with_err_header(self, do_request):
+        request_text = '''HEAD /sbowspxjhmccpmesjqcwagfw?objectMeta HTTP/1.1
+Host: ming-oss-share.oss-cn-hangzhou.aliyuncs.com
+Accept-Encoding: identity
+Connection: keep-alive
+date: Sat, 12 Dec 2015 00:37:17 GMT
+User-Agent: aliyun-sdk-python/2.0.2(Windows/7/;3.3.3)
+Accept: */*
+authorization: OSS ZCDmm7TPZKHtx77j:wopWcmMd/70eNKYOc9M6ZA21yY8='''     
+
+        response_text = '''HTTP/1.1 404 Not Found
+Server: AliyunOSS
+Date: Sat, 12 Dec 2015 00:37:17 GMT
+Content-Type: application/xml
+Content-Length: 287
+Connection: keep-alive
+x-oss-request-id: 566B6C3D6086505A0CFF0F68
+x-oss-err: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxFcnJvcj4NCiAgPENvZGU+Tm9TdWNoS2V5PC9Db2RlPg0KICA8TWVzc2FnZT5UaGUgc3BlY2lmaWVkIGtleSBkb2VzIG5vdCBleGlzdC48L01lc3NhZ2U+DQogIDxSZXF1ZXN0SWQ+NTY2QjZDM0Q2MDg2NTA1QTBDRkYwRjY4PC9SZXF1ZXN0SWQ+DQogIDxIb3N0SWQ+bWluZy1vc3Mtc2hhcmUub3NzLWNuLWhhbmd6aG91LmFsaXl1bmNzLmNvbTwvSG9zdElkPg0KICA8S2V5PnNib3dzcHhqaG1jY3BtZXNqcWN3YWdmdzwvS2V5Pg0KPC9FcnJvcj4=
+'''
+
+        req_info = mock_response(do_request, response_text)
+        self.assertTrue(not bucket().object_exists('sbowspxjhmccpmesjqcwagfw'))
+        self.assertRequest(req_info, request_text)
+
+    @patch('oss2.Session.do_request')
+    def test_object_exists_false_with_invalid_err_header(self, do_request):
+        request_text = '''HEAD /sbowspxjhmccpmesjqcwagfw?objectMeta HTTP/1.1
+Host: ming-oss-share.oss-cn-hangzhou.aliyuncs.com
+Accept-Encoding: identity
+Connection: keep-alive
+date: Sat, 12 Dec 2015 00:37:17 GMT
+User-Agent: aliyun-sdk-python/2.0.2(Windows/7/;3.3.3)
+Accept: */*
+authorization: OSS ZCDmm7TPZKHtx77j:wopWcmMd/70eNKYOc9M6ZA21yY8='''     
+
+        response_text = '''HTTP/1.1 404 Not Found
+Server: AliyunOSS
+Date: Sat, 12 Dec 2015 00:37:17 GMT
+Content-Type: application/xml
+Content-Length: 287
+Connection: keep-alive
+x-oss-request-id: 566B6C3D6086505A0CFF0F68
+x-oss-err: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxFcnJvcj4NCiAgPENvZGU+Tm9TdWNoS2V5PC9Db2RlPg0KICA8TWVzc2FnZT5UaGUgc3BlY2lmaWVkIGtleSBkb2VzIG5vdCBleGlzdC48L01lc3NhZ2U+DQogIDxSZXF1ZXN0SWQ+NTY2QjZDM0Q2MDg2NTA1QTBDRkYwRjY4PC9SZXF1ZXN0SWQ+DQogIDxIb3N0SWQ+bWluZy1vc3Mtc2hhcmUub3NzLWNuLWhhbmd6aG91LmFsaXl1bmNzLmNvbTwvSG9zdElkPg0KICA8S2V5PnNib3dzcHhqaG1jY3BtZXNqcWN3YWdmdzwvS2V5Pg0KPC9FcnJvcj4
+'''
 
         req_info = mock_response(do_request, response_text)
         self.assertTrue(not bucket().object_exists('sbowspxjhmccpmesjqcwagfw'))