Dev 2106 (#282)

* add transfer acceleration

Author: zhuxiaolong37

oss2/api.py

@@ -397,6 +397,7 @@ class Bucket(_Base):
     REPLICATION = "replication"
     REPLICATION_LOCATION = 'replicationLocation'
     REPLICATION_PROGRESS = 'replicationProgress'
+    TRANSFER_ACCELERATION = 'transferAcceleration'
 
 
     def __init__(self, auth, endpoint, bucket_name,
@@ -2492,6 +2493,33 @@ def _get_bucket_config(self, config):
         logger.debug("Get bucket config done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
         return resp
 
+    def put_bucket_transfer_acceleration(self, enabled):
+        """为存储空间（Bucket）配置传输加速
+
+        :param str enabled : 是否开启传输加速。true：开启传输加速; false：关闭传输加速.
+        :return: :class:`RequestResult <oss2.models.RequestResult>`
+        """
+        logger.debug("Start to bucket transfer acceleration, bucket: {0}, enabled: {1}."
+                     .format(self.bucket_name, enabled))
+        data = xml_utils.to_put_bucket_transfer_acceleration(enabled)
+        headers = http.CaseInsensitiveDict()
+        headers['Content-MD5'] = utils.content_md5(data)
+        resp = self.__do_bucket('PUT', data=data, params={Bucket.TRANSFER_ACCELERATION: ''}, headers=headers)
+        logger.debug("bucket transfer acceleration done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
+
+        return RequestResult(resp)
+
+    def get_bucket_transfer_acceleration(self):
+        """获取目标存储空间（Bucket）的传输加速配置
+
+        :return: :class:`GetBucketReplicationResult <oss2.models.GetBucketReplicationResult>`
+        """
+        logger.debug("Start to get bucket transfer acceleration: {0}".format(self.bucket_name))
+        resp = self.__do_bucket('GET', params={Bucket.TRANSFER_ACCELERATION: ''})
+        logger.debug("Get bucket transfer acceleration done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
+
+        return self._parse_result(resp, xml_utils.parse_get_bucket_transfer_acceleration_result, GetBucketTransferAccelerationResult)
+
     def __do_object(self, method, key, **kwargs):
         return self._do(method, self.bucket_name, key, **kwargs)
 

oss2/auth.py

@@ -83,7 +83,7 @@ class ProviderAuth(AuthBase):
          'versioning', 'versionId', 'policy', 'requestPayment', 'x-oss-traffic-limit', 'qosInfo', 'asyncFetch',
          'x-oss-request-payer', 'sequential', 'inventory', 'inventoryId', 'continuation-token', 'callback',
          'callback-var', 'worm', 'wormId', 'wormExtend', 'replication', 'replicationLocation',
-         'replicationProgress']
+         'replicationProgress', 'transferAcceleration']
     )
 
     def _sign_request(self, req, bucket_name, key):

oss2/exceptions.py

@@ -309,6 +309,9 @@ class InvalidWORMConfiguration(ServerError):
     status = 400
     code = 'InvalidWORMConfiguration'
 
+class NoSuchTransferAccelerationConfiguration(ServerError):
+    status = 404
+    code = 'NoSuchTransferAccelerationConfiguration'
 
 def make_exception(resp):
     status = resp.status

oss2/models.py

@@ -2175,3 +2175,14 @@ class GetBucketReplicationProgressResult(RequestResult):
     def __init__(self, resp):
         super(GetBucketReplicationProgressResult, self).__init__(resp)
         self.progress = None
+
+
+class GetBucketTransferAccelerationResult(RequestResult):
+    """获取目标存储空间（Bucket）的传输加速配置。
+
+    :param enabled: Bucket传输加速状态
+    :type progress: class:`GetBucketTransferAccelerationResult <oss2.models.GetBucketTransferAccelerationResult>`。
+    """
+    def __init__(self, resp):
+        super(GetBucketTransferAccelerationResult, self).__init__(resp)
+        self.enabled = None

oss2/xml_utils.py

@@ -1694,3 +1694,13 @@ def parse_get_bucket_replication_progress_result(result, body):
 
     result.progress = progress
 
+
+def to_put_bucket_transfer_acceleration(enabled):
+    root = ElementTree.Element('TransferAccelerationConfiguration')
+    _add_text_child(root, 'Enabled', str(enabled))
+    return _node_to_string(root)
+
+
+def parse_get_bucket_transfer_acceleration_result(result, body):
+    root = ElementTree.fromstring(body)
+    result.enabled = _find_tag(root, "Enabled")

tests/test_bucket_transfer_acceleration.py

@@ -0,0 +1,17 @@
+from .common import *
+
+
+class TestBucketTransferAccelerat(OssTestCase):
+    def test_bucket_transfer_acceleration_normal(self):
+        result = self.bucket.put_bucket_transfer_acceleration('true')
+        self.assertEqual(200, result.status)
+
+        get_result = self.bucket.get_bucket_transfer_acceleration()
+        self.assertEqual('true', get_result.enabled)
+
+    def test_bucket_worm_illegal(self):
+        self.assertRaises(oss2.exceptions.NoSuchTransferAccelerationConfiguration, self.bucket.get_bucket_transfer_acceleration)
+
+
+if __name__ == '__main__':
+    unittest.main()

unittests/test_bucket.py

@@ -820,6 +820,55 @@ def test_delete_bucket_policy(self, do_request):
 
         self.assertRequest(req_info, request_text)
 
+    @patch('oss2.Session.do_request')
+    def test_put_bucket_transfer_acceleration(self, do_request):
+        request_text = '''PUT /?transferAcceleration HTTP/1.1
+Date: Fri , 30 Apr 2021 13:08:38 GMT
+Content-Length：443
+Host: ming-oss-share.oss-cn-hangzhou.aliyuncs.com
+Authorization: OSS qn6qrrqxo2oawuk53otf****:PYbzsdWAIWAlMW8luk****
+
+<?xml version="1.0" encoding="UTF-8"?>
+<TransferAccelerationConfiguration><Enabled>true</Enabled>
+</TransferAccelerationConfiguration>'''
+
+        response_text = '''HTTP/1.1 200 OK
+x-oss-request-id: 534B371674A4D890****
+Date: Fri , 30 Apr 2021 13:08:38 GMT
+Content-Length: 443
+Connection: keep-alive
+Server: AliyunOSS'''
+
+        req_info = mock_response(do_request, response_text)
+
+        result = bucket().put_bucket_transfer_acceleration('true')
+
+        self.assertRequest(req_info, request_text)
+
+    @patch('oss2.Session.do_request')
+    def test_get_bucket_transfer_acceleration(self, do_request):
+        request_text = '''GET /?transferAcceleration HTTP/1.1
+Date: Fri , 30 Apr 2021 13:08:38 GMT
+Content-Length：443
+Host: ming-oss-share.oss-cn-hangzhou.aliyuncs.com
+Authorization: OSS qn6qrrqxo2oawuk53otf****:PYbzsdWAIWAlMW8luk****'''
+
+        response_text = '''HTTP/1.1 200 OK
+x-oss-request-id: 534B371674E88A4D8906****
+Date: Fri , 30 Apr 2021 13:08:38 GMT
+
+<?xml version="1.0" encoding="UTF-8"?>
+<TransferAccelerationConfiguration>
+ <Enabled>true</Enabled>
+</TransferAccelerationConfiguration>'''
+
+        req_info = mock_response(do_request, response_text)
+
+        result = bucket().get_bucket_transfer_acceleration()
+
+        self.assertRequest(req_info, request_text)
+        self.assertEqual(result.enabled, 'true')
+
 
 if __name__ == '__main__':
     unittest.main()