openstack/swift
Code Issues Proposed changes

ShardName: add test and clarify docstrings

Browse Source 
Change-Id: Iebc9802ec06b39e55094972bab5822eae6431094
This commit is contained in:
Clay Gerrard 2022-09-08 13:42:11 -05:00 committed by Alistair Coles
parent 73bce63312
commit 032d7aa054
2 changed files with 32 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
swift/common/utils.py
View File

@ -5151,10 +5151,10 @@ class ShardName(object):
<account>/<root_container>-<parent_container_hash>-<timestamp>-<index> <account>/<root_container>-<parent_container_hash>-<timestamp>-<index>
Note: not all instances of :class:`~swift.common.utils.ShardRange` have Note: some instances of :class:`~swift.common.utils.ShardRange` have names
names that will parse as a :class:`~swift.common.utils.ShardName`; root that will NOT parse as a :class:`~swift.common.utils.ShardName`; e.g. a
container own shard ranges, for example, have a simpler name format of root container's own shard range will have a name format of
<account>/<root_container>. <account>/<root_container> which will raise ValueError if passed to parse.
""" """
def __init__(self, account, root_container, def __init__(self, account, root_container,
parent_container_hash, parent_container_hash,
@ -5204,7 +5204,9 @@ class ShardName(object):
container belongs. container belongs.
:param root_container: the name of the root container for the shard. :param root_container: the name of the root container for the shard.
:param parent_container: the name of the parent container for the :param parent_container: the name of the parent container for the
shard. shard; for initial first generation shards this should be the same
as ``root_container``; for shards of shards this should be the name
of the sharding shard container.
:param timestamp: an instance of :class:`~swift.common.utils.Timestamp` :param timestamp: an instance of :class:`~swift.common.utils.Timestamp`
:param index: a unique index that will distinguish the path from any :param index: a unique index that will distinguish the path from any
other path generated using the same combination of other path generated using the same combination of

25
test/unit/common/test_utils.py
View File

@ -7955,6 +7955,7 @@ class TestShardName(unittest.TestCase):
actual = str(created) actual = str(created)
self.assertEqual(expected, actual) self.assertEqual(expected, actual)
parsed = utils.ShardName.parse(actual) parsed = utils.ShardName.parse(actual)
# normally a ShardName will be in the .shards prefix
self.assertEqual('a', parsed.account) self.assertEqual('a', parsed.account)
self.assertEqual('root', parsed.root_container) self.assertEqual('root', parsed.root_container)
self.assertEqual(parent_hash, parsed.parent_container_hash) self.assertEqual(parent_hash, parsed.parent_container_hash)
@ -7971,6 +7972,30 @@ class TestShardName(unittest.TestCase):
self.assertEqual(utils.Timestamp(1234), parsed.timestamp) self.assertEqual(utils.Timestamp(1234), parsed.timestamp)
self.assertEqual(99, parsed.index) self.assertEqual(99, parsed.index)
def test_realistic_shard_range_names(self):
parsed = utils.ShardName.parse(
'.shards_a1/r1-'
'7c92cf1eee8d99cc85f8355a3d6e4b86-'
'1662475499.00000-1')
self.assertEqual('.shards_a1', parsed.account)
self.assertEqual('r1', parsed.root_container)
self.assertEqual('7c92cf1eee8d99cc85f8355a3d6e4b86',
parsed.parent_container_hash)
self.assertEqual(utils.Timestamp(1662475499), parsed.timestamp)
self.assertEqual(1, parsed.index)
parsed = utils.ShardName('.shards_a', 'c', 'hash',
utils.Timestamp(1234), 42)
self.assertEqual(
'.shards_a/c-hash-0000001234.00000-42',
str(parsed))
parsed = utils.ShardName.create('.shards_a', 'c', 'c',
utils.Timestamp(1234), 42)
self.assertEqual(
'.shards_a/c-4a8a08f09d37b73795649038408b5f33-0000001234.00000-42',
str(parsed))
def test_bad_parse(self): def test_bad_parse(self):
with self.assertRaises(ValueError) as cm: with self.assertRaises(ValueError) as cm:
utils.ShardName.parse('a') utils.ShardName.parse('a')