#The MIT License (MIT) #Copyright (c) 2014 Microsoft Corporation #Permission is hereby granted, free of charge, to any person obtaining a copy #of this software and associated documentation files (the "Software"), to deal #in the Software without restriction, including without limitation the rights #to use, copy, modify, merge, publish, distribute, sublicense, and/or sell #copies of the Software, and to permit persons to whom the Software is #furnished to do so, subject to the following conditions: #The above copyright notice and this permission notice shall be included in all #copies or substantial portions of the Software. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, #FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE #AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER #LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE #SOFTWARE. import unittest import pytest from azure.cosmos.routing.collection_routing_map import _CollectionRoutingMap import azure.cosmos.routing.routing_range as routing_range from azure.cosmos.routing.routing_map_provider import _PartitionKeyRangeCache @pytest.mark.usefixtures("teardown") class CollectionRoutingMapTests(unittest.TestCase): def test_advanced(self): partition_key_ranges = [{u'id': u'0', u'minInclusive': u'', u'maxExclusive': u'05C1C9CD673398'}, {u'id': u'1', u'minInclusive': u'05C1C9CD673398', u'maxExclusive': u'05C1D9CD673398'}, {u'id': u'2', u'minInclusive': u'05C1D9CD673398', u'maxExclusive': u'05C1E399CD6732'}, {u'id': u'3', u'minInclusive': u'05C1E399CD6732', u'maxExclusive': u'05C1E9CD673398'}, {u'id': u'4', u'minInclusive': u'05C1E9CD673398', u'maxExclusive': u'FF'}] partitionRangeWithInfo = [(r, True) for r in partition_key_ranges] pkRange = routing_range._Range("", "FF", True, False) collection_routing_map = _CollectionRoutingMap.CompleteRoutingMap(partitionRangeWithInfo, 'sample collection id') overlapping_partition_key_ranges = collection_routing_map.get_overlapping_ranges(pkRange) self.assertEqual(len(overlapping_partition_key_ranges), len(partition_key_ranges)) self.assertEqual(overlapping_partition_key_ranges, partition_key_ranges) def test_partition_key_ranges_parent_filter(self): # for large collection with thousands of partitions, a split may complete between the read partition key ranges query pages, # causing the return map to have both the new children ranges and their ranges. This test is to verify the fix for that. Id = 'id' MinInclusive = 'minInclusive' MaxExclusive = 'maxExclusive' Parents = 'parents' # create a complete set of partition key ranges # some have parents as empty array while some don't have the parents partitionKeyRanges = \ [ {Id : "2", MinInclusive : "0000000050", MaxExclusive : "0000000070", Parents : []}, {Id : "0", MinInclusive : "", MaxExclusive : "0000000030"}, {Id : "1", MinInclusive : "0000000030", MaxExclusive : "0000000050"}, {Id : "3", MinInclusive : "0000000070", MaxExclusive : "FF", Parents : []} ] def get_range_id(r): return r[Id] # verify no thing is filtered out since there is no children ranges filteredRanges = _PartitionKeyRangeCache._discard_parent_ranges(partitionKeyRanges) self.assertEqual(['2', '0', '1', '3'], list(map(get_range_id, filteredRanges))) # add some children partition key ranges with parents Ids # e.g., range 0 was split in to range 4 and 5, and then range 4 was split into range 6 and 7 partitionKeyRanges.append({Id : "6", MinInclusive : "", MaxExclusive : "0000000010", Parents : ["0", "4"]}) partitionKeyRanges.append({Id : "7", MinInclusive : "0000000010", MaxExclusive : "0000000020", Parents : ["0", "4"]}) partitionKeyRanges.append({Id : "5", MinInclusive : "0000000020", MaxExclusive : "0000000030", Parents : ["0"]}) # verify the filtered range list has children ranges and the parent Ids are discarded filteredRanges = _PartitionKeyRangeCache._discard_parent_ranges(partitionKeyRanges) expectedRanges = ['2', '1', '3', '6', '7', '5'] self.assertEqual(expectedRanges, list(map(get_range_id, filteredRanges))) def test_collection_routing_map(self): Id = 'id' MinInclusive = 'minInclusive' MaxExclusive = 'maxExclusive' partitionKeyRanges = \ [ ({Id : "2", MinInclusive : "0000000050", MaxExclusive : "0000000070"}, 2), ({Id : "0", MinInclusive : "", MaxExclusive : "0000000030"}, 0), ({Id : "1", MinInclusive : "0000000030", MaxExclusive : "0000000050"}, 1), ({Id : "3", MinInclusive : "0000000070", MaxExclusive : "FF"}, 3) ] crm = _CollectionRoutingMap.CompleteRoutingMap(partitionKeyRanges, "") self.assertEqual("0", crm._orderedPartitionKeyRanges[0][Id]) self.assertEqual("1", crm._orderedPartitionKeyRanges[1][Id]) self.assertEqual("2", crm._orderedPartitionKeyRanges[2][Id]) self.assertEqual("3", crm._orderedPartitionKeyRanges[3][Id]) self.assertEqual(0, crm._orderedPartitionInfo[0]) self.assertEqual(1, crm._orderedPartitionInfo[1]) self.assertEqual(2, crm._orderedPartitionInfo[2]) self.assertEqual(3, crm._orderedPartitionInfo[3]) self.assertEqual("0", crm.get_range_by_effective_partition_key("")[Id]) self.assertEqual("0", crm.get_range_by_effective_partition_key("0000000000")[Id]) self.assertEqual("1", crm.get_range_by_effective_partition_key("0000000030")[Id]) self.assertEqual("1", crm.get_range_by_effective_partition_key("0000000031")[Id]) self.assertEqual("3", crm.get_range_by_effective_partition_key("0000000071")[Id]) self.assertEqual("0", crm.get_range_by_partition_key_range_id("0")[Id]) self.assertEqual("1", crm.get_range_by_partition_key_range_id("1")[Id]) fullRangeMinToMaxRange = routing_range._Range(_CollectionRoutingMap.MinimumInclusiveEffectivePartitionKey, _CollectionRoutingMap.MaximumExclusiveEffectivePartitionKey, True, False) overlappingRanges = crm.get_overlapping_ranges([fullRangeMinToMaxRange]) self.assertEqual(4, len(overlappingRanges)) onlyParitionRanges = [item[0] for item in partitionKeyRanges] def getKey(r): return r['id'] onlyParitionRanges.sort(key = getKey) self.assertEqual(overlappingRanges, onlyParitionRanges) noPoint = routing_range._Range(_CollectionRoutingMap.MinimumInclusiveEffectivePartitionKey, _CollectionRoutingMap.MinimumInclusiveEffectivePartitionKey, False, False) self.assertEqual(0, len(crm.get_overlapping_ranges([noPoint]))) onePoint = routing_range._Range("0000000040", "0000000040", True, True) overlappingPartitionKeyRanges = crm.get_overlapping_ranges([onePoint]) self.assertEqual(1, len(overlappingPartitionKeyRanges)) self.assertEqual("1", overlappingPartitionKeyRanges[0][Id]) ranges = [ routing_range._Range("0000000040", "0000000045", True, True), routing_range._Range("0000000045", "0000000046", True, True), routing_range._Range("0000000046", "0000000050", True, True) ] overlappingPartitionKeyRanges = crm.get_overlapping_ranges(ranges) self.assertEqual(2, len(overlappingPartitionKeyRanges)) self.assertEqual("1", overlappingPartitionKeyRanges[0][Id]) self.assertEqual("2", overlappingPartitionKeyRanges[1][Id]) def test_invalid_routing_map(self): partitionKeyRanges = \ [ ({ 'id' : "1", 'minInclusive' : "0000000020", 'maxExclusive' : "0000000030"}, 2), ({ 'id' : "2", 'minInclusive' : "0000000025", 'maxExclusive' : "0000000035"}, 2), ] collectionUniqueId = "" def createRoutingMap(): _CollectionRoutingMap.CompleteRoutingMap(partitionKeyRanges, collectionUniqueId) self.assertRaises(ValueError, createRoutingMap) def test_incomplete_routing_map(self): crm = _CollectionRoutingMap.CompleteRoutingMap( [ ({ 'id' : "2", 'minInclusive' : "", 'maxExclusive' : "0000000030"}, 2), ({ 'id' : "3", 'minInclusive' : "0000000031", 'maxExclusive' : "FF"}, 2), ] , "") self.assertIsNone(crm) crm = _CollectionRoutingMap.CompleteRoutingMap( [ ({ 'id' : "2", 'minInclusive' : "", 'maxExclusive' : "0000000030"}, 2), ({ 'id' : "2", 'minInclusive' : "0000000030", 'maxExclusive' : "FF"}, 2), ] , "") self.assertIsNotNone(crm) if __name__ == '__main__': unittest.main()