From 4cf6bdb4acbec618640d819fe749a1a4430989e0 Mon Sep 17 00:00:00 2001 From: Luis Pabon Date: Thu, 29 Aug 2013 11:07:03 -0400 Subject: [PATCH] OpenStack Swift proxy controller unit tests These are a copy of the OpenStack Swift proxy controller unit tests as of version their 1.9.1. Change-Id: Ib05bc2a37dbb29d729346d78ea8f6de83b82375b Signed-off-by: Luis Pabon Reviewed-on: http://review.gluster.org/5735 Reviewed-by: Peter Portante Tested-by: Peter Portante --- test/unit/proxy/controllers/__init__.py | 0 test/unit/proxy/controllers/test_account.py | 45 +++ test/unit/proxy/controllers/test_base.py | 331 ++++++++++++++++++ test/unit/proxy/controllers/test_container.py | 45 +++ test/unit/proxy/controllers/test_obj.py | 64 ++++ 5 files changed, 485 insertions(+) create mode 100644 test/unit/proxy/controllers/__init__.py create mode 100644 test/unit/proxy/controllers/test_account.py create mode 100644 test/unit/proxy/controllers/test_base.py create mode 100644 test/unit/proxy/controllers/test_container.py create mode 100755 test/unit/proxy/controllers/test_obj.py diff --git a/test/unit/proxy/controllers/__init__.py b/test/unit/proxy/controllers/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/unit/proxy/controllers/test_account.py b/test/unit/proxy/controllers/test_account.py new file mode 100644 index 0000000..4d67d65 --- /dev/null +++ b/test/unit/proxy/controllers/test_account.py @@ -0,0 +1,45 @@ +# Copyright (c) 2010-2012 OpenStack, LLC. +# +# 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 mock +import unittest + +from swift.common.swob import Request +from swift.proxy import server as proxy_server +from swift.proxy.controllers.base import headers_to_account_info +from test.unit import fake_http_connect, FakeRing, FakeMemcache + + +class TestAccountController(unittest.TestCase): + def setUp(self): + self.app = proxy_server.Application(None, FakeMemcache(), + account_ring=FakeRing(), + container_ring=FakeRing(), + object_ring=FakeRing()) + + def test_account_info_in_response_env(self): + controller = proxy_server.AccountController(self.app, 'AUTH_bob') + with mock.patch('swift.proxy.controllers.base.http_connect', + fake_http_connect(200, 200, body='')): + req = Request.blank('/AUTH_bob', {'PATH_INFO': '/AUTH_bob'}) + resp = controller.HEAD(req) + self.assertEqual(2, resp.status_int // 100) + self.assertTrue('swift.account/AUTH_bob' in resp.environ) + self.assertEqual(headers_to_account_info(resp.headers), + resp.environ['swift.account/AUTH_bob']) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/unit/proxy/controllers/test_base.py b/test/unit/proxy/controllers/test_base.py new file mode 100644 index 0000000..02692eb --- /dev/null +++ b/test/unit/proxy/controllers/test_base.py @@ -0,0 +1,331 @@ +# Copyright (c) 2010-2012 OpenStack, LLC. +# +# 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 mock import patch +from swift.proxy.controllers.base import headers_to_container_info, \ + headers_to_account_info, get_container_info, get_container_memcache_key, \ + get_account_info, get_account_memcache_key, _get_cache_key, get_info, \ + Controller +from swift.common.swob import Request +from swift.common.utils import split_path +from test.unit import fake_http_connect, FakeRing, FakeMemcache +from swift.proxy import server as proxy_server + + +FakeResponse_status_int = 201 + + +class FakeResponse(object): + def __init__(self, headers, env, account, container): + self.headers = headers + self.status_int = FakeResponse_status_int + self.environ = env + cache_key, env_key = _get_cache_key(account, container) + if container: + info = headers_to_container_info(headers, FakeResponse_status_int) + else: + info = headers_to_account_info(headers, FakeResponse_status_int) + env[env_key] = info + + +class FakeRequest(object): + def __init__(self, env, path): + self.environ = env + (version, account, container, obj) = split_path(path, 2, 4, True) + self.account = account + self.container = container + stype = container and 'container' or 'account' + self.headers = {'x-%s-object-count' % (stype): 1000, + 'x-%s-bytes-used' % (stype): 6666} + + def get_response(self, app): + return FakeResponse(self.headers, self.environ, self.account, + self.container) + + +class FakeCache(object): + def __init__(self, val): + self.val = val + + def get(self, *args): + return self.val + + +class TestFuncs(unittest.TestCase): + def setUp(self): + self.app = proxy_server.Application(None, FakeMemcache(), + account_ring=FakeRing(), + container_ring=FakeRing(), + object_ring=FakeRing) + + def test_GETorHEAD_base(self): + base = Controller(self.app) + req = Request.blank('/a/c') + with patch('swift.proxy.controllers.base.' + 'http_connect', fake_http_connect(200)): + resp = base.GETorHEAD_base(req, 'container', FakeRing(), 'part', + '/a/c') + self.assertTrue('swift.container/a/c' in resp.environ) + self.assertEqual(resp.environ['swift.container/a/c']['status'], 200) + + req = Request.blank('/a') + with patch('swift.proxy.controllers.base.' + 'http_connect', fake_http_connect(200)): + resp = base.GETorHEAD_base(req, 'account', FakeRing(), 'part', + '/a') + self.assertTrue('swift.account/a' in resp.environ) + self.assertEqual(resp.environ['swift.account/a']['status'], 200) + + def test_get_info(self): + global FakeResponse_status_int + # Do a non cached call to account + env = {} + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + info_a = get_info(None, env, 'a') + # Check that you got proper info + self.assertEquals(info_a['status'], 201) + self.assertEquals(info_a['bytes'], 6666) + self.assertEquals(info_a['total_object_count'], 1000) + # Make sure the env cache is set + self.assertEquals(env, {'swift.account/a': info_a}) + + # Do an env cached call to account + info_a = get_info(None, env, 'a') + # Check that you got proper info + self.assertEquals(info_a['status'], 201) + self.assertEquals(info_a['bytes'], 6666) + self.assertEquals(info_a['total_object_count'], 1000) + # Make sure the env cache is set + self.assertEquals(env, {'swift.account/a': info_a}) + + # This time do env cached call to account and non cached to container + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + info_c = get_info(None, env, 'a', 'c') + # Check that you got proper info + self.assertEquals(info_a['status'], 201) + self.assertEquals(info_c['bytes'], 6666) + self.assertEquals(info_c['object_count'], 1000) + # Make sure the env cache is set + self.assertEquals(env['swift.account/a'], info_a) + self.assertEquals(env['swift.container/a/c'], info_c) + + # This time do a non cached call to account than non cached to container + env = {} # abandon previous call to env + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + info_c = get_info(None, env, 'a', 'c') + # Check that you got proper info + self.assertEquals(info_a['status'], 201) + self.assertEquals(info_c['bytes'], 6666) + self.assertEquals(info_c['object_count'], 1000) + # Make sure the env cache is set + self.assertEquals(env['swift.account/a'], info_a) + self.assertEquals(env['swift.container/a/c'], info_c) + + # This time do an env cached call to container while account is not cached + del(env['swift.account/a']) + info_c = get_info(None, env, 'a', 'c') + # Check that you got proper info + self.assertEquals(info_a['status'], 201) + self.assertEquals(info_c['bytes'], 6666) + self.assertEquals(info_c['object_count'], 1000) + # Make sure the env cache is set and account still not cached + self.assertEquals(env, {'swift.container/a/c': info_c}) + + # Do a non cached call to account not found with ret_not_found + env = {} + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + try: + FakeResponse_status_int = 404 + info_a = get_info(None, env, 'a', ret_not_found=True) + finally: + FakeResponse_status_int = 201 + # Check that you got proper info + self.assertEquals(info_a['status'], 404) + self.assertEquals(info_a['bytes'], 6666) + self.assertEquals(info_a['total_object_count'], 1000) + # Make sure the env cache is set + self.assertEquals(env, {'swift.account/a': info_a}) + + # Do a cached call to account not found with ret_not_found + info_a = get_info(None, env, 'a', ret_not_found=True) + # Check that you got proper info + self.assertEquals(info_a['status'], 404) + self.assertEquals(info_a['bytes'], 6666) + self.assertEquals(info_a['total_object_count'], 1000) + # Make sure the env cache is set + self.assertEquals(env, {'swift.account/a': info_a}) + + # Do a non cached call to account not found without ret_not_found + env = {} + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + try: + FakeResponse_status_int = 404 + info_a = get_info(None, env, 'a') + finally: + FakeResponse_status_int = 201 + # Check that you got proper info + self.assertEquals(info_a, None) + self.assertEquals(env['swift.account/a']['status'], 404) + + # Do a cached call to account not found without ret_not_found + info_a = get_info(None, env, 'a') + # Check that you got proper info + self.assertEquals(info_a, None) + self.assertEquals(env['swift.account/a']['status'], 404) + + def test_get_container_info_no_cache(self): + req = Request.blank("/v1/AUTH_account/cont", + environ={'swift.cache': FakeCache({})}) + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + resp = get_container_info(req.environ, 'xxx') + self.assertEquals(resp['bytes'], 6666) + self.assertEquals(resp['object_count'], 1000) + + def test_get_container_info_cache(self): + cached = {'status': 404, + 'bytes': 3333, + 'object_count': 10} + req = Request.blank("/v1/account/cont", + environ={'swift.cache': FakeCache(cached)}) + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + resp = get_container_info(req.environ, 'xxx') + self.assertEquals(resp['bytes'], 3333) + self.assertEquals(resp['object_count'], 10) + self.assertEquals(resp['status'], 404) + + def test_get_container_info_env(self): + cache_key = get_container_memcache_key("account", "cont") + env_key = 'swift.%s' % cache_key + req = Request.blank("/v1/account/cont", + environ={ env_key: {'bytes': 3867}, + 'swift.cache': FakeCache({})}) + resp = get_container_info(req.environ, 'xxx') + self.assertEquals(resp['bytes'], 3867) + + def test_get_account_info_no_cache(self): + req = Request.blank("/v1/AUTH_account", + environ={'swift.cache': FakeCache({})}) + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + resp = get_account_info(req.environ, 'xxx') + self.assertEquals(resp['bytes'], 6666) + self.assertEquals(resp['total_object_count'], 1000) + + def test_get_account_info_cache(self): + # The original test that we prefer to preserve + cached = {'status': 404, + 'bytes': 3333, + 'total_object_count': 10} + req = Request.blank("/v1/account/cont", + environ={'swift.cache': FakeCache(cached)}) + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + resp = get_account_info(req.environ, 'xxx') + self.assertEquals(resp['bytes'], 3333) + self.assertEquals(resp['total_object_count'], 10) + self.assertEquals(resp['status'], 404) + + # Here is a more realistic test + cached = {'status': 404, + 'bytes': '3333', + 'container_count': '234', + 'total_object_count': '10', + 'meta': {}} + req = Request.blank("/v1/account/cont", + environ={'swift.cache': FakeCache(cached)}) + with patch('swift.proxy.controllers.base.' + '_prepare_pre_auth_info_request', FakeRequest): + resp = get_account_info(req.environ, 'xxx') + self.assertEquals(resp['status'], 404) + self.assertEquals(resp['bytes'], '3333') + self.assertEquals(resp['container_count'], 234) + self.assertEquals(resp['meta'], {}) + self.assertEquals(resp['total_object_count'], '10') + + def test_get_account_info_env(self): + cache_key = get_account_memcache_key("account") + env_key = 'swift.%s' % cache_key + req = Request.blank("/v1/account", + environ={ env_key: {'bytes': 3867}, + 'swift.cache': FakeCache({})}) + resp = get_account_info(req.environ, 'xxx') + self.assertEquals(resp['bytes'], 3867) + + def test_headers_to_container_info_missing(self): + resp = headers_to_container_info({}, 404) + self.assertEquals(resp['status'], 404) + self.assertEquals(resp['read_acl'], None) + self.assertEquals(resp['write_acl'], None) + + def test_headers_to_container_info_meta(self): + headers = {'X-Container-Meta-Whatevs': 14, + 'x-container-meta-somethingelse': 0} + resp = headers_to_container_info(headers.items(), 200) + self.assertEquals(len(resp['meta']), 2) + self.assertEquals(resp['meta']['whatevs'], 14) + self.assertEquals(resp['meta']['somethingelse'], 0) + + def test_headers_to_container_info_values(self): + headers = { + 'x-container-read': 'readvalue', + 'x-container-write': 'writevalue', + 'x-container-sync-key': 'keyvalue', + 'x-container-meta-access-control-allow-origin': 'here', + } + resp = headers_to_container_info(headers.items(), 200) + self.assertEquals(resp['read_acl'], 'readvalue') + self.assertEquals(resp['write_acl'], 'writevalue') + self.assertEquals(resp['cors']['allow_origin'], 'here') + + headers['x-unused-header'] = 'blahblahblah' + self.assertEquals( + resp, + headers_to_container_info(headers.items(), 200)) + + def test_headers_to_account_info_missing(self): + resp = headers_to_account_info({}, 404) + self.assertEquals(resp['status'], 404) + self.assertEquals(resp['bytes'], None) + self.assertEquals(resp['container_count'], None) + + def test_headers_to_account_info_meta(self): + headers = {'X-Account-Meta-Whatevs': 14, + 'x-account-meta-somethingelse': 0} + resp = headers_to_account_info(headers.items(), 200) + self.assertEquals(len(resp['meta']), 2) + self.assertEquals(resp['meta']['whatevs'], 14) + self.assertEquals(resp['meta']['somethingelse'], 0) + + def test_headers_to_account_info_values(self): + headers = { + 'x-account-object-count': '10', + 'x-account-container-count': '20', + } + resp = headers_to_account_info(headers.items(), 200) + self.assertEquals(resp['total_object_count'], '10') + self.assertEquals(resp['container_count'], '20') + + headers['x-unused-header'] = 'blahblahblah' + self.assertEquals( + resp, + headers_to_account_info(headers.items(), 200)) diff --git a/test/unit/proxy/controllers/test_container.py b/test/unit/proxy/controllers/test_container.py new file mode 100644 index 0000000..c2e9483 --- /dev/null +++ b/test/unit/proxy/controllers/test_container.py @@ -0,0 +1,45 @@ +# Copyright (c) 2010-2012 OpenStack, LLC. +# +# 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 mock +import unittest + +from swift.common.swob import Request +from swift.proxy import server as proxy_server +from swift.proxy.controllers.base import headers_to_container_info +from test.unit import fake_http_connect, FakeRing, FakeMemcache + + +class TestContainerController(unittest.TestCase): + def setUp(self): + self.app = proxy_server.Application(None, FakeMemcache(), + account_ring=FakeRing(), + container_ring=FakeRing(), + object_ring=FakeRing()) + + def test_container_info_in_response_env(self): + controller = proxy_server.ContainerController(self.app, 'a', 'c') + with mock.patch('swift.proxy.controllers.base.http_connect', + fake_http_connect(200, 200, body='')): + req = Request.blank('/a/c', {'PATH_INFO': '/a/c'}) + resp = controller.HEAD(req) + self.assertEqual(2, resp.status_int // 100) + self.assertTrue("swift.container/a/c" in resp.environ) + self.assertEqual(headers_to_container_info(resp.headers), + resp.environ['swift.container/a/c']) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/unit/proxy/controllers/test_obj.py b/test/unit/proxy/controllers/test_obj.py new file mode 100755 index 0000000..e4af789 --- /dev/null +++ b/test/unit/proxy/controllers/test_obj.py @@ -0,0 +1,64 @@ +#!/usr/bin/env python +# Copyright (c) 2010-2012 OpenStack, LLC. +# +# 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.proxy import server as proxy_server +from test.unit import FakeRing, FakeMemcache + + +class TestObjControllerWriteAffinity(unittest.TestCase): + def setUp(self): + self.app = proxy_server.Application( + None, FakeMemcache(), account_ring=FakeRing(), + container_ring=FakeRing(), object_ring=FakeRing(max_more_nodes=9)) + self.app.request_node_count = lambda ring: 10000000 + self.app.sort_nodes = lambda l: l # stop shuffling the primary nodes + + def test_iter_nodes_local_first_noops_when_no_affinity(self): + controller = proxy_server.ObjectController(self.app, 'a', 'c', 'o') + self.app.write_affinity_is_local_fn = None + + all_nodes = self.app.object_ring.get_part_nodes(1) + all_nodes.extend(self.app.object_ring.get_more_nodes(1)) + + local_first_nodes = list(controller.iter_nodes_local_first( + self.app.object_ring, 1)) + + self.maxDiff = None + + self.assertEqual(all_nodes, local_first_nodes) + + def test_iter_nodes_local_first_moves_locals_first(self): + controller = proxy_server.ObjectController(self.app, 'a', 'c', 'o') + self.app.write_affinity_is_local_fn = (lambda node: node['region'] == 1) + self.app.write_affinity_node_count = lambda ring: 4 + + all_nodes = self.app.object_ring.get_part_nodes(1) + all_nodes.extend(self.app.object_ring.get_more_nodes(1)) + + local_first_nodes = list(controller.iter_nodes_local_first( + self.app.object_ring, 1)) + + # the local nodes move up in the ordering + self.assertEqual([1, 1, 1, 1], + [node['region'] for node in local_first_nodes[:4]]) + # we don't skip any nodes + self.assertEqual(sorted(all_nodes), sorted(local_first_nodes)) + + +if __name__ == '__main__': + unittest.main()