1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import unittest
import uuid
import pytest
import azure.cosmos.cosmos_client as cosmos_client
import test_config
from azure.cosmos.partition_key import PartitionKey
@pytest.mark.cosmosEmulator
@pytest.mark.cosmosQuery
class TestChangeFeedPKVariation(unittest.TestCase):
"""Test change feed with different partition key variations."""
configs = test_config.TestConfig
host = configs.host
masterKey = configs.masterKey
connectionPolicy = configs.connectionPolicy
client: cosmos_client.CosmosClient = None
# Items for Hash V1 partition key
single_hash_items = [
{"id": str(i), "pk": f"short_string"} for i in range(1, 101)
] + [
{"id": str(i), "pk": f"long_string_" + "a" * 251} for i in range(101, 201)
] + [
{"id": str(i), "pk": 1000} for i in range(201, 301)
] + [
{"id": str(i), "pk": 1000 * 1.1111} for i in range(301, 401)
] + [
{"id": str(i), "pk": True} for i in range(401, 501)
]
# Items for Hierarchical Partition Keys
hpk_items = [
{"id": str(i), "pk1": "level1_", "pk2": "level2_"} for i in range(1, 101)
] + [
{"id": str(i), "pk1": "level1_", "pk2": f"level2_long__" + "c" * 101} for i in range(101, 201)
] + [
{"id": str(i), "pk1": 10, "pk2": 1000} for i in range(201, 301)
] + [
{"id": str(i), "pk1": 10 * 1.1, "pk2": 10 * 2.2} for i in range(301, 401)
] + [
{"id": str(i), "pk1": True, 'pk2': False} for i in range(401, 501)
]
test_data_hash = [
{
"version": 1,
"expected_epk": (
"05C1DD5D8149640862636465666768696A6B6C6D6E6F70717273747576"
"7778797A7B62636465666768696A6B6C6D6E6F70717273747576777879"
"7A7B62636465666768696A6B6C6D6E6F707172737475767778797A7B62636465666768696A6B6C6D6E6F707172737475767700"
),
},
{
"version": 2,
"expected_epk": (
"2032D236DA8678BFB900E866D7EBCE76"
),
},
]
@classmethod
def setUpClass(cls):
cls.config = test_config.TestConfig()
if (cls.config.masterKey == '[YOUR_KEY_HERE]' or
cls.config.host == '[YOUR_ENDPOINT_HERE]'):
raise Exception(
"You must specify your Azure Cosmos account values for "
"'masterKey' and 'host' at the top of this class to run the "
"tests.")
cls.client = cosmos_client.CosmosClient(cls.config.host, cls.config.masterKey)
cls.db = cls.client.get_database_client(cls.config.TEST_DATABASE_ID)
def create_container(self, db, container_id, partition_key, version=None, throughput=None):
"""Helper to create a container with a specific partition key definition."""
if isinstance(partition_key, list):
# Assume multihash (hierarchical partition key) for the container
pk_definition = PartitionKey(path=partition_key, kind='MultiHash')
else:
pk_definition = PartitionKey(path=partition_key, kind='Hash', version=version)
if throughput:
return db.create_container(id=container_id, partition_key=pk_definition, offer_throughput=throughput)
return db.create_container(id=container_id, partition_key=pk_definition)
def insert_items(self, container, items):
"""Helper to insert items into a container."""
for item in items:
container.create_item(body=item)
def validate_changefeed(self, container):
"""Helper to validate changefeed results."""
partition_keys = ["short_string", "long_string_" + "a" * 251, 1000, 1000 * 1.1111, True]
for pk in partition_keys:
changefeed = container.query_items_change_feed(is_start_from_beginning=True, partition_key=pk)
changefeed_items = [item for item in changefeed]
# Perform a regular query
regular_query = container.query_items(query="SELECT * FROM c", partition_key=pk)
regular_query_items = [item for item in regular_query]
# Compare the number of documents returned
assert len(changefeed_items) == len(regular_query_items), (
f"Mismatch in document count for partition key {pk}: Changefeed returned {len(changefeed_items)} items,"
f"while regular query returned {len(regular_query_items)} items."
)
def validate_changefeed_hpk(self, container):
"""Helper to validate changefeed results for hierarchical partition keys."""
partition_keys = [
["level1_", "level2_"],
["level1_", "level2_long__" + "c" * 101],
[10, 1000],
[10 * 1.1, 10 * 2.2],
[True, False]
]
for pk in partition_keys:
# Perform a change feed query
changefeed = container.query_items_change_feed(is_start_from_beginning=True, partition_key=pk)
changefeed_items = [item for item in changefeed]
# Perform a regular query
regular_query = container.query_items(query="SELECT * FROM c", partition_key=pk)
regular_query_items = [item for item in regular_query]
# Compare the number of documents returned
assert len(changefeed_items) == len(regular_query_items), (
f"Mismatch in document count for partition key {pk}: Changefeed returned {len(changefeed_items)} items,"
f"while regular query returned {len(regular_query_items)} items."
)
def test_partition_key_hashing(self):
"""Test effective partition key string generation for different hash versions."""
for hash_data in self.test_data_hash:
version = hash_data["version"]
expected_epk = hash_data["expected_epk"]
part_k = ("abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghij"
"klmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz")
partition_key = PartitionKey(
path="/field1",
kind="Hash",
version=version
)
epk_str = partition_key._get_effective_partition_key_string(part_k)
assert epk_str.upper() == expected_epk
def test_hash_v1_partition_key(self):
"""Test changefeed with Hash V1 partition key."""
db = self.db
container = self.create_container(db, f"container_test_hash_V1_{uuid.uuid4()}",
"/pk", version=1)
items = self.single_hash_items
self.insert_items(container, items)
self.validate_changefeed(container)
self.db.delete_container(container.id)
def test_hash_v2_partition_key(self):
"""Test changefeed with Hash V2 partition key."""
db = self.db
container = self.create_container(db, f"container_test_hash_V2_{uuid.uuid4()}",
"/pk", version=2)
items = self.single_hash_items
self.insert_items(container, items)
self.validate_changefeed(container)
self.db.delete_container(container.id)
def test_hpk_partition_key(self):
"""Test changefeed with hierarchical partition key."""
db = self.db
container = self.create_container(db, f"container_test_hpk_{uuid.uuid4()}",
["/pk1", "/pk2"])
items = self.hpk_items
self.insert_items(container, items)
self.validate_changefeed_hpk(container)
self.db.delete_container(container.id)
def test_multiple_physical_partitions(self):
"""Test change feed with a container having multiple physical partitions."""
db = self.db
# Test for Hash V1 partition key
container_id_v1 = f"container_test_multiple_partitions_hash_v1_{uuid.uuid4()}"
throughput = 12000 # Ensure multiple physical partitions
container_v1 = self.create_container(db, container_id_v1, "/pk", version=1, throughput=throughput)
# Verify the container has more than one physical partition
feed_ranges_v1 = container_v1.read_feed_ranges()
feed_ranges_v1 = [feed_range for feed_range in feed_ranges_v1]
assert len(feed_ranges_v1) > 1, "Hash V1 container does not have multiple physical partitions."
# Insert items and validate change feed for Hash V1
self.insert_items(container_v1, self.single_hash_items)
self.validate_changefeed(container_v1)
self.db.delete_container(container_v1.id)
# Test for Hash V2 partition key
container_id_v2 = f"container_test_multiple_partitions_hash_v2_{uuid.uuid4()}"
container_v2 = self.create_container(db, container_id_v2, "/pk", version=2, throughput=throughput)
# Verify the container has more than one physical partition
feed_ranges_v2 = container_v2.read_feed_ranges()
feed_ranges_v2 = [feed_range for feed_range in feed_ranges_v2]
assert len(feed_ranges_v2) > 1, "Hash V2 container does not have multiple physical partitions."
# Insert items and validate change feed for Hash V2
self.insert_items(container_v2, self.single_hash_items)
self.validate_changefeed(container_v2)
self.db.delete_container(container_v2.id)
# Test for Hierarchical Partition Keys (HPK)
container_id_hpk = f"container_test_multiple_partitions_hpk_{uuid.uuid4()}"
container_hpk = self.create_container(db, container_id_hpk, ["/pk1", "/pk2"], throughput=throughput)
# Verify the container has more than one physical partition
feed_ranges_hpk = container_hpk.read_feed_ranges()
feed_ranges_hpk = [feed_range for feed_range in feed_ranges_hpk]
assert len(feed_ranges_hpk) > 1, "HPK container does not have multiple physical partitions."
# Insert items and validate change feed for HPK
self.insert_items(container_hpk, self.hpk_items)
self.validate_changefeed_hpk(container_hpk)
self.db.delete_container(container_hpk.id)
if __name__ == "__main__":
unittest.main()
|
