openstack/swift
Code Issues Proposed changes

use request_helpers import namespace for tests

Browse Source 
Change-Id: I8e18ff2036312d3049a420f3332a6ea6110447c4
This commit is contained in:
Clay Gerrard 2019-10-28 11:27:58 -05:00
parent b75d593935
commit dd235b6ac0
1 changed files with 50 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
test/unit/common/test_request_helpers.py
View File

@ -18,12 +18,7 @@
import unittest import unittest
from swift.common.swob import Request, HTTPException, HeaderKeyDict from swift.common.swob import Request, HTTPException, HeaderKeyDict
from swift.common.storage_policy import POLICIES, EC_POLICY, REPL_POLICY from swift.common.storage_policy import POLICIES, EC_POLICY, REPL_POLICY
from swift.common.request_helpers import is_sys_meta, is_user_meta, \ from swift.common import request_helpers as rh
is_sys_or_user_meta, strip_sys_meta_prefix, strip_user_meta_prefix, \
remove_items, copy_header_subset, get_name_and_placement, \
http_response_to_document_iters, is_object_transient_sysmeta, \
update_etag_is_at_header, resolve_etag_is_at_header, \
strip_object_transient_sysmeta_prefix
from test.unit import patch_policies from test.unit import patch_policies
from test.unit.common.test_utils import FakeResponse from test.unit.common.test_utils import FakeResponse
@ -36,70 +31,70 @@ class TestRequestHelpers(unittest.TestCase):
def test_is_user_meta(self): def test_is_user_meta(self):
m_type = 'meta' m_type = 'meta'
for st in server_types: for st in server_types:
self.assertTrue(is_user_meta(st, 'x-%s-%s-foo' % (st, m_type))) self.assertTrue(rh.is_user_meta(st, 'x-%s-%s-foo' % (st, m_type)))
self.assertFalse(is_user_meta(st, 'x-%s-%s-' % (st, m_type))) self.assertFalse(rh.is_user_meta(st, 'x-%s-%s-' % (st, m_type)))
self.assertFalse(is_user_meta(st, 'x-%s-%sfoo' % (st, m_type))) self.assertFalse(rh.is_user_meta(st, 'x-%s-%sfoo' % (st, m_type)))
def test_is_sys_meta(self): def test_is_sys_meta(self):
m_type = 'sysmeta' m_type = 'sysmeta'
for st in server_types: for st in server_types:
self.assertTrue(is_sys_meta(st, 'x-%s-%s-foo' % (st, m_type))) self.assertTrue(rh.is_sys_meta(st, 'x-%s-%s-foo' % (st, m_type)))
self.assertFalse(is_sys_meta(st, 'x-%s-%s-' % (st, m_type))) self.assertFalse(rh.is_sys_meta(st, 'x-%s-%s-' % (st, m_type)))
self.assertFalse(is_sys_meta(st, 'x-%s-%sfoo' % (st, m_type))) self.assertFalse(rh.is_sys_meta(st, 'x-%s-%sfoo' % (st, m_type)))
def test_is_sys_or_user_meta(self): def test_is_sys_or_user_meta(self):
m_types = ['sysmeta', 'meta'] m_types = ['sysmeta', 'meta']
for mt in m_types: for mt in m_types:
for st in server_types: for st in server_types:
self.assertTrue(is_sys_or_user_meta(st, 'x-%s-%s-foo' self.assertTrue(rh.is_sys_or_user_meta(
% (st, mt))) st, 'x-%s-%s-foo' % (st, mt)))
self.assertFalse(is_sys_or_user_meta(st, 'x-%s-%s-' self.assertFalse(rh.is_sys_or_user_meta(
% (st, mt))) st, 'x-%s-%s-' % (st, mt)))
self.assertFalse(is_sys_or_user_meta(st, 'x-%s-%sfoo' self.assertFalse(rh.is_sys_or_user_meta(
% (st, mt))) st, 'x-%s-%sfoo' % (st, mt)))
def test_strip_sys_meta_prefix(self): def test_strip_sys_meta_prefix(self):
mt = 'sysmeta' mt = 'sysmeta'
for st in server_types: for st in server_types:
self.assertEqual(strip_sys_meta_prefix(st, 'x-%s-%s-a' self.assertEqual(rh.strip_sys_meta_prefix(
% (st, mt)), 'a') st, 'x-%s-%s-a' % (st, mt)), 'a')
mt = 'not-sysmeta' mt = 'not-sysmeta'
for st in server_types: for st in server_types:
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
strip_sys_meta_prefix(st, 'x-%s-%s-a' % (st, mt)) rh.strip_sys_meta_prefix(st, 'x-%s-%s-a' % (st, mt))
def test_strip_user_meta_prefix(self): def test_strip_user_meta_prefix(self):
mt = 'meta' mt = 'meta'
for st in server_types: for st in server_types:
self.assertEqual(strip_user_meta_prefix(st, 'x-%s-%s-a' self.assertEqual(rh.strip_user_meta_prefix(
% (st, mt)), 'a') st, 'x-%s-%s-a' % (st, mt)), 'a')
mt = 'not-meta' mt = 'not-meta'
for st in server_types: for st in server_types:
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
strip_sys_meta_prefix(st, 'x-%s-%s-a' % (st, mt)) rh.strip_sys_meta_prefix(st, 'x-%s-%s-a' % (st, mt))
def test_is_object_transient_sysmeta(self): def test_is_object_transient_sysmeta(self):
self.assertTrue(is_object_transient_sysmeta( self.assertTrue(rh.is_object_transient_sysmeta(
'x-object-transient-sysmeta-foo')) 'x-object-transient-sysmeta-foo'))
self.assertFalse(is_object_transient_sysmeta( self.assertFalse(rh.is_object_transient_sysmeta(
'x-object-transient-sysmeta-')) 'x-object-transient-sysmeta-'))
self.assertFalse(is_object_transient_sysmeta( self.assertFalse(rh.is_object_transient_sysmeta(
'x-object-meatmeta-foo')) 'x-object-meatmeta-foo'))
def test_strip_object_transient_sysmeta_prefix(self): def test_strip_object_transient_sysmeta_prefix(self):
mt = 'object-transient-sysmeta' mt = 'object-transient-sysmeta'
self.assertEqual(strip_object_transient_sysmeta_prefix('x-%s-a' % mt), self.assertEqual(rh.strip_object_transient_sysmeta_prefix(
'a') 'x-%s-a' % mt), 'a')
mt = 'object-sysmeta-transient' mt = 'object-sysmeta-transient'
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
strip_object_transient_sysmeta_prefix('x-%s-a' % mt) rh.strip_object_transient_sysmeta_prefix('x-%s-a' % mt)
def test_remove_items(self): def test_remove_items(self):
src = {'a': 'b', src = {'a': 'b',
'c': 'd'} 'c': 'd'}
test = lambda x: x == 'a' test = lambda x: x == 'a'
rem = remove_items(src, test) rem = rh.remove_items(src, test)
self.assertEqual(src, {'c': 'd'}) self.assertEqual(src, {'c': 'd'})
self.assertEqual(rem, {'a': 'b'}) self.assertEqual(rem, {'a': 'b'})
@ -109,7 +104,7 @@ class TestRequestHelpers(unittest.TestCase):
from_req = Request.blank('/path', environ={}, headers=src) from_req = Request.blank('/path', environ={}, headers=src)
to_req = Request.blank('/path', {}) to_req = Request.blank('/path', {})
test = lambda x: x.lower() == 'a' test = lambda x: x.lower() == 'a'
copy_header_subset(from_req, to_req, test) rh.copy_header_subset(from_req, to_req, test)
self.assertTrue('A' in to_req.headers) self.assertTrue('A' in to_req.headers)
self.assertEqual(to_req.headers['A'], 'b') self.assertEqual(to_req.headers['A'], 'b')
self.assertFalse('c' in to_req.headers) self.assertFalse('c' in to_req.headers)
@ -121,7 +116,7 @@ class TestRequestHelpers(unittest.TestCase):
req = Request.blank(path, headers={ req = Request.blank(path, headers={
'X-Backend-Storage-Policy-Index': '0'}) 'X-Backend-Storage-Policy-Index': '0'})
device, part, account, container, obj, policy = \ device, part, account, container, obj, policy = \
get_name_and_placement(req, 5, 5, True) rh.get_name_and_placement(req, 5, 5, True)
self.assertEqual(device, 'device') self.assertEqual(device, 'device')
self.assertEqual(part, 'part') self.assertEqual(part, 'part')
self.assertEqual(account, 'account') self.assertEqual(account, 'account')
@ -132,7 +127,7 @@ class TestRequestHelpers(unittest.TestCase):
req.headers['X-Backend-Storage-Policy-Index'] = 1 req.headers['X-Backend-Storage-Policy-Index'] = 1
device, part, account, container, obj, policy = \ device, part, account, container, obj, policy = \
get_name_and_placement(req, 5, 5, True) rh.get_name_and_placement(req, 5, 5, True)
self.assertEqual(device, 'device') self.assertEqual(device, 'device')
self.assertEqual(part, 'part') self.assertEqual(part, 'part')
self.assertEqual(account, 'account') self.assertEqual(account, 'account')
@ -144,7 +139,7 @@ class TestRequestHelpers(unittest.TestCase):
req.headers['X-Backend-Storage-Policy-Index'] = 'foo' req.headers['X-Backend-Storage-Policy-Index'] = 'foo'
with self.assertRaises(HTTPException) as raised: with self.assertRaises(HTTPException) as raised:
device, part, account, container, obj, policy = \ device, part, account, container, obj, policy = \
get_name_and_placement(req, 5, 5, True) rh.get_name_and_placement(req, 5, 5, True)
e = raised.exception e = raised.exception
self.assertEqual(e.status_int, 503) self.assertEqual(e.status_int, 503)
self.assertEqual(str(e), '503 Service Unavailable') self.assertEqual(str(e), '503 Service Unavailable')
@ -157,7 +152,7 @@ class TestRequestHelpers(unittest.TestCase):
req = Request.blank(path, headers={ req = Request.blank(path, headers={
'X-Backend-Storage-Policy-Index': '0'}) 'X-Backend-Storage-Policy-Index': '0'})
device, partition, suffix_parts, policy = \ device, partition, suffix_parts, policy = \
get_name_and_placement(req, 2, 3, True) rh.get_name_and_placement(req, 2, 3, True)
self.assertEqual(device, 'device') self.assertEqual(device, 'device')
self.assertEqual(partition, 'part') self.assertEqual(partition, 'part')
self.assertEqual(suffix_parts, '012-345-678-9ab-cde') self.assertEqual(suffix_parts, '012-345-678-9ab-cde')
@ -168,7 +163,7 @@ class TestRequestHelpers(unittest.TestCase):
req = Request.blank(path, headers={ req = Request.blank(path, headers={
'X-Backend-Storage-Policy-Index': '1'}) 'X-Backend-Storage-Policy-Index': '1'})
device, partition, suffix_parts, policy = \ device, partition, suffix_parts, policy = \
get_name_and_placement(req, 2, 3, True) rh.get_name_and_placement(req, 2, 3, True)
self.assertEqual(device, 'device') self.assertEqual(device, 'device')
self.assertEqual(partition, 'part') self.assertEqual(partition, 'part')
self.assertIsNone(suffix_parts) # false-y self.assertIsNone(suffix_parts) # false-y
@ -179,7 +174,7 @@ class TestRequestHelpers(unittest.TestCase):
req = Request.blank(path, headers={ req = Request.blank(path, headers={
'X-Backend-Storage-Policy-Index': '1'}) 'X-Backend-Storage-Policy-Index': '1'})
device, partition, suffix_parts, policy = \ device, partition, suffix_parts, policy = \
get_name_and_placement(req, 2, 3, True) rh.get_name_and_placement(req, 2, 3, True)
self.assertEqual(device, 'device') self.assertEqual(device, 'device')
self.assertEqual(partition, 'part') self.assertEqual(partition, 'part')
self.assertEqual(suffix_parts, '') # still false-y self.assertEqual(suffix_parts, '') # still false-y
@ -194,7 +189,7 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
{'Content-Length': '10', 'Content-Type': 'application/lunch'}, {'Content-Length': '10', 'Content-Type': 'application/lunch'},
b'sandwiches') b'sandwiches')
doc_iters = http_response_to_document_iters(fr) doc_iters = rh.http_response_to_document_iters(fr)
first_byte, last_byte, length, headers, body = next(doc_iters) first_byte, last_byte, length, headers, body = next(doc_iters)
self.assertEqual(first_byte, 0) self.assertEqual(first_byte, 0)
self.assertEqual(last_byte, 9) self.assertEqual(last_byte, 9)
@ -212,7 +207,7 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
'Content-Type': 'application/lunch'}, 'Content-Type': 'application/lunch'},
b'sandwiches') b'sandwiches')
doc_iters = http_response_to_document_iters(fr) doc_iters = rh.http_response_to_document_iters(fr)
first_byte, last_byte, length, headers, body = next(doc_iters) first_byte, last_byte, length, headers, body = next(doc_iters)
self.assertEqual(first_byte, 0) self.assertEqual(first_byte, 0)
self.assertIsNone(last_byte) self.assertIsNone(last_byte)
@ -231,7 +226,7 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
'Content-Range': 'bytes 1-8/10'}, 'Content-Range': 'bytes 1-8/10'},
b'andwiche') b'andwiche')
doc_iters = http_response_to_document_iters(fr) doc_iters = rh.http_response_to_document_iters(fr)
first_byte, last_byte, length, headers, body = next(doc_iters) first_byte, last_byte, length, headers, body = next(doc_iters)
self.assertEqual(first_byte, 1) self.assertEqual(first_byte, 1)
self.assertEqual(last_byte, 8) self.assertEqual(last_byte, 8)
@ -251,7 +246,7 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
'Content-Range': 'bytes 1-8/10'}, 'Content-Range': 'bytes 1-8/10'},
b'andwiche') b'andwiche')
doc_iters = http_response_to_document_iters(fr) doc_iters = rh.http_response_to_document_iters(fr)
first_byte, last_byte, length, headers, body = next(doc_iters) first_byte, last_byte, length, headers, body = next(doc_iters)
self.assertEqual(first_byte, 1) self.assertEqual(first_byte, 1)
self.assertEqual(last_byte, 8) self.assertEqual(last_byte, 8)
@ -278,7 +273,7 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
b"ches\r\n" b"ches\r\n"
b"--asdfasdfasdf--")) b"--asdfasdfasdf--"))
doc_iters = http_response_to_document_iters(fr) doc_iters = rh.http_response_to_document_iters(fr)
first_byte, last_byte, length, headers, body = next(doc_iters) first_byte, last_byte, length, headers, body = next(doc_iters)
self.assertEqual(first_byte, 0) self.assertEqual(first_byte, 0)
@ -301,15 +296,15 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
def test_update_etag_is_at_header(self): def test_update_etag_is_at_header(self):
# start with no existing X-Backend-Etag-Is-At # start with no existing X-Backend-Etag-Is-At
req = Request.blank('/v/a/c/o') req = Request.blank('/v/a/c/o')
update_etag_is_at_header(req, 'X-Object-Sysmeta-My-Etag') rh.update_etag_is_at_header(req, 'X-Object-Sysmeta-My-Etag')
self.assertEqual('X-Object-Sysmeta-My-Etag', self.assertEqual('X-Object-Sysmeta-My-Etag',
req.headers['X-Backend-Etag-Is-At']) req.headers['X-Backend-Etag-Is-At'])
# add another alternate # add another alternate
update_etag_is_at_header(req, 'X-Object-Sysmeta-Ec-Etag') rh.update_etag_is_at_header(req, 'X-Object-Sysmeta-Ec-Etag')
self.assertEqual('X-Object-Sysmeta-My-Etag,X-Object-Sysmeta-Ec-Etag', self.assertEqual('X-Object-Sysmeta-My-Etag,X-Object-Sysmeta-Ec-Etag',
req.headers['X-Backend-Etag-Is-At']) req.headers['X-Backend-Etag-Is-At'])
with self.assertRaises(ValueError) as cm: with self.assertRaises(ValueError) as cm:
update_etag_is_at_header(req, 'X-Object-Sysmeta-,-Bad') rh.update_etag_is_at_header(req, 'X-Object-Sysmeta-,-Bad')
self.assertEqual('Header name must not contain commas', self.assertEqual('Header name must not contain commas',
cm.exception.args[0]) cm.exception.args[0])
@ -317,49 +312,49 @@ class TestHTTPResponseToDocumentIters(unittest.TestCase):
def do_test(): def do_test():
req = Request.blank('/v/a/c/o') req = Request.blank('/v/a/c/o')
# ok to have no X-Backend-Etag-Is-At # ok to have no X-Backend-Etag-Is-At
self.assertIsNone(resolve_etag_is_at_header(req, metadata)) self.assertIsNone(rh.resolve_etag_is_at_header(req, metadata))
# ok to have no matching metadata # ok to have no matching metadata
req.headers['X-Backend-Etag-Is-At'] = 'X-Not-There' req.headers['X-Backend-Etag-Is-At'] = 'X-Not-There'
self.assertIsNone(resolve_etag_is_at_header(req, metadata)) self.assertIsNone(rh.resolve_etag_is_at_header(req, metadata))
# selects from metadata # selects from metadata
req.headers['X-Backend-Etag-Is-At'] = 'X-Object-Sysmeta-Ec-Etag' req.headers['X-Backend-Etag-Is-At'] = 'X-Object-Sysmeta-Ec-Etag'
self.assertEqual('an etag value', self.assertEqual('an etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
req.headers['X-Backend-Etag-Is-At'] = 'X-Object-Sysmeta-My-Etag' req.headers['X-Backend-Etag-Is-At'] = 'X-Object-Sysmeta-My-Etag'
self.assertEqual('another etag value', self.assertEqual('another etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
# first in list takes precedence # first in list takes precedence
req.headers['X-Backend-Etag-Is-At'] = \ req.headers['X-Backend-Etag-Is-At'] = \
'X-Object-Sysmeta-My-Etag,X-Object-Sysmeta-Ec-Etag' 'X-Object-Sysmeta-My-Etag,X-Object-Sysmeta-Ec-Etag'
self.assertEqual('another etag value', self.assertEqual('another etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
# non-existent alternates are passed over # non-existent alternates are passed over
req.headers['X-Backend-Etag-Is-At'] = \ req.headers['X-Backend-Etag-Is-At'] = \
'X-Bogus,X-Object-Sysmeta-My-Etag,X-Object-Sysmeta-Ec-Etag' 'X-Bogus,X-Object-Sysmeta-My-Etag,X-Object-Sysmeta-Ec-Etag'
self.assertEqual('another etag value', self.assertEqual('another etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
# spaces in list are ok # spaces in list are ok
alts = 'X-Foo, X-Object-Sysmeta-My-Etag , X-Object-Sysmeta-Ec-Etag' alts = 'X-Foo, X-Object-Sysmeta-My-Etag , X-Object-Sysmeta-Ec-Etag'
req.headers['X-Backend-Etag-Is-At'] = alts req.headers['X-Backend-Etag-Is-At'] = alts
self.assertEqual('another etag value', self.assertEqual('another etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
# lower case in list is ok # lower case in list is ok
alts = alts.lower() alts = alts.lower()
req.headers['X-Backend-Etag-Is-At'] = alts req.headers['X-Backend-Etag-Is-At'] = alts
self.assertEqual('another etag value', self.assertEqual('another etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
# upper case in list is ok # upper case in list is ok
alts = alts.upper() alts = alts.upper()
req.headers['X-Backend-Etag-Is-At'] = alts req.headers['X-Backend-Etag-Is-At'] = alts
self.assertEqual('another etag value', self.assertEqual('another etag value',
resolve_etag_is_at_header(req, metadata)) rh.resolve_etag_is_at_header(req, metadata))
metadata = {'X-Object-Sysmeta-Ec-Etag': 'an etag value', metadata = {'X-Object-Sysmeta-Ec-Etag': 'an etag value',
'X-Object-Sysmeta-My-Etag': 'another etag value'} 'X-Object-Sysmeta-My-Etag': 'another etag value'}