c0b3d73189
Adding a constraints middleware that allows different constraints for a Swift-on-File storage policy. Currently, Swift allows only one set of object naming and metadata rules per cluster. As new storage policies are implemented, it is possible that different storage back-ends have different set of rules on how objects should be created for that specific storage system. Swift-on-File has different rules as objects name are mapped to a POSIX filesystem directory structure. For example: no names with double slashes or ending with slashes are allowed. At first a solution was proposed to include a generic patch in the upstream swift code, but after discussing with the Swift community it became clear that it would be better to have a global set of constraints that covers the whole cluster and if a specific storage policy has specific constraints than it should have its own middleware. Link to patch for reference: https://review.openstack.org/#/c/113325/ Change-Id: I323ead5d98bf5c087930ccf446d3e8d83075e584 Signed-off-by: Thiago da Silva <thiago@redhat.com>
187 lines
7.9 KiB
Python
187 lines
7.9 KiB
Python
# Copyright (c) 2014 Red Hat, Inc.
|
|
#
|
|
# 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, Response
|
|
from swiftonfile.swift.common.middleware import check_constraints
|
|
from mock import Mock, patch
|
|
from contextlib import nested
|
|
|
|
|
|
class FakeApp(object):
|
|
|
|
def __call__(self, env, start_response):
|
|
return Response(body="OK")(env, start_response)
|
|
|
|
|
|
def check_object_creation(req, object_name):
|
|
return
|
|
|
|
|
|
class TestConstraintsMiddleware(unittest.TestCase):
|
|
|
|
""" Tests for common.middleware.constraints.check_constraints """
|
|
|
|
def setUp(self):
|
|
self.conf = {
|
|
'policies': 'swiftonfile,cephfs-policy'}
|
|
|
|
self.container1_info_mock = Mock()
|
|
self.container1_info_mock.return_value = {'status': 0,
|
|
'sync_key': None, 'storage_policy': '0', 'meta': {},
|
|
'cors': {'allow_origin': None, 'expose_headers': None,
|
|
'max_age': None}, 'sysmeta': {}, 'read_acl': None,
|
|
'object_count': None, 'write_acl': None, 'versions': None,
|
|
'bytes': None}
|
|
|
|
self.container2_info_mock = Mock()
|
|
self.container2_info_mock.return_value = {'status': 0,
|
|
'sync_key': None, 'storage_policy': '2', 'meta': {},
|
|
'cors': {'allow_origin': None, 'expose_headers': None,
|
|
'max_age': None}, 'sysmeta': {}, 'read_acl': None,
|
|
'object_count': None, 'write_acl': None, 'versions': None,
|
|
'bytes': None}
|
|
|
|
self.policies_mock = Mock()
|
|
self.sof_policy_mock = Mock()
|
|
self.sof_policy_mock.name = 'swiftonfile'
|
|
attrs = {'get_by_index.return_value': self.sof_policy_mock }
|
|
self.policies_mock.configure_mock(**attrs)
|
|
|
|
self.test_check = check_constraints.filter_factory(
|
|
self.conf)(FakeApp())
|
|
|
|
def test_GET(self):
|
|
path = '/V1.0/a/c/o'
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'GET'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 200)
|
|
|
|
def test_PUT_container(self):
|
|
path = '/V1.0/a/c'
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 200)
|
|
|
|
def test_PUT_object_with_double_slashes(self):
|
|
path = '/V1.0/a/c2//o'
|
|
|
|
with nested(
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"get_container_info", self.container2_info_mock),
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"POLICIES", self.policies_mock)):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 400)
|
|
self.assertTrue('Invalid object name' in resp.body)
|
|
self.assertTrue('cannot begin, end, or have' in resp.body)
|
|
|
|
def test_PUT_object_end_with_slashes(self):
|
|
path = '/V1.0/a/c2/o/'
|
|
|
|
with nested(
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"get_container_info", self.container2_info_mock),
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"POLICIES", self.policies_mock)):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 400)
|
|
self.assertTrue('Invalid object name' in resp.body)
|
|
self.assertTrue('cannot begin, end, or have' in resp.body)
|
|
|
|
def test_PUT_object_named_dot(self):
|
|
path = '/V1.0/a/c2/.'
|
|
|
|
with nested(
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"get_container_info", self.container2_info_mock),
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"POLICIES", self.policies_mock)):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 400)
|
|
self.assertTrue('Invalid object name' in resp.body)
|
|
self.assertTrue('cannot be . or ..' in resp.body)
|
|
|
|
def test_PUT_container_with_long_names(self):
|
|
longname = 'c' * 256
|
|
path = '/V1.0/a/' + longname
|
|
resp = Request.blank(path, method='PUT',
|
|
headers={'X-Storage-Policy': 'swiftonfile'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 400)
|
|
|
|
# test case where storage policy is not defined in header and
|
|
# container would be created in default policy, which happens to be
|
|
# a swiftonfile policy
|
|
default_policies_mock = Mock()
|
|
sof_policy_mock = Mock()
|
|
sof_policy_mock.name = 'swiftonfile'
|
|
attrs = {'default.return_value': self.sof_policy_mock }
|
|
default_policies_mock.configure_mock(**attrs)
|
|
with patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"POLICIES", default_policies_mock):
|
|
resp = Request.blank(path, method='PUT').get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 400)
|
|
|
|
def test_PUT_object_with_long_names(self):
|
|
for i in (220,221):
|
|
longname = 'o' * i
|
|
path = '/V1.0/a/c2/' + longname
|
|
|
|
with nested(
|
|
patch("swiftonfile.swift.common.middleware."
|
|
"check_constraints.get_container_info",
|
|
self.container2_info_mock),
|
|
patch("swiftonfile.swift.common.middleware."
|
|
"check_constraints.POLICIES", self.policies_mock)):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 200)
|
|
|
|
longname = 'o' * 222
|
|
path = '/V1.0/a/c2/' + longname
|
|
|
|
with nested(
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"get_container_info", self.container2_info_mock),
|
|
patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"POLICIES", self.policies_mock)):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 400)
|
|
self.assertTrue('too long' in resp.body)
|
|
|
|
def test_PUT_object_with_policy0(self):
|
|
path = '/V1.0/a/c1//o'
|
|
|
|
with patch("swiftonfile.swift.common.middleware."
|
|
"check_constraints.get_container_info",
|
|
self.container1_info_mock):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 200)
|
|
|
|
longname = 'o' * 222
|
|
path = '/V1.0/a/c2/' + longname
|
|
|
|
with patch("swiftonfile.swift.common.middleware.check_constraints."
|
|
"get_container_info", self.container1_info_mock):
|
|
resp = Request.blank(path, environ={'REQUEST_METHOD': 'PUT'}
|
|
).get_response(self.test_check)
|
|
self.assertEquals(resp.status_int, 200)
|