swift/test/unit/common/middleware/s3api/test_object_lock.py
Matthew Oliver 0996433fe5 s3api: Add basic GET object-lock support
Some tooling out there, like Ansible, will always call to see if
object-lock is enabled on a bucket/container. This fails as Swift doesn't
understand the object-lock or the get object lock api[0].

When you use the get-object-lock-configuration to a bucket in s3 that
doesn't have it applied it returns a specific 404:

  GET /?object-lock HTTP/1.1" 404 None
  ...

  <?xml version="1.0" encoding="UTF-8"?>
  <Error>
    <Code>ObjectLockConfigurationNotFoundError</Code>
    <Message>Object Lock configuration does not exist for this bucket</Message>
    <BucketName>bucket_name</BucketName>
    <RequestId>83VQBYP0SENV3VP4</RequestId>
  </Error>'

This patch doesn't add support for get_object lock, instead it always
returns a similar 404 as supplied by s3, so clients know it's not
enabled.

Also add a object-lock PUT 501 response.

[0] https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html

Change-Id: Icff8cf57474dfad975a4f45bf2d500c2682c1129
2023-10-05 16:38:35 +11:00

68 lines
2.7 KiB
Python

# Copyright (c) 2010-2023 OpenStack Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import unittest
from swift.common.swob import Request
from test.unit.common.middleware.s3api import S3ApiTestCase
from swift.common.middleware.s3api.etree import fromstring
class TestS3ApiObjectLock(S3ApiTestCase):
# The object-lock controller currently only returns a static response
# as disabled. Things like ansible need this. So there isn't much to test.
def test_get_object_lock(self):
req = Request.blank('/bucket?object-lock',
environ={'REQUEST_METHOD': 'GET',
'swift.trans_id': 'txt1234'},
headers={'Authorization': 'AWS test:tester:hmac',
'Date': self.get_date_header()})
status, headers, body = self.call_s3api(req)
self.assertEqual(status.split()[0], '404')
elem = fromstring(body, 'Error')
self.assertTrue(elem.getchildren())
for child in elem.iterchildren():
if child.tag == 'Code':
self.assertEqual(child.text,
'ObjectLockConfigurationNotFoundError')
elif child.tag == 'Message':
self.assertEqual(child.text,
'Object Lock configuration does not exist '
'for this bucket')
elif child.tag == 'RequestId':
self.assertEqual(child.text,
'txt1234')
elif child.tag == 'BucketName':
self.assertEqual(child.text, 'bucket')
else:
self.fail('Found unknown sub entry')
def test_put_object_lock(self):
req = Request.blank('/bucket?object-lock',
environ={'REQUEST_METHOD': 'PUT'},
headers={'Authorization': 'AWS test:tester:hmac',
'Date': self.get_date_header()})
status, headers, body = self.call_s3api(req)
# This currently isn't implemented.
self.assertEqual(status.split()[0], '501')
if __name__ == '__main__':
unittest.main()