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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
import random
import unittest
import uuid
import os
import pytest
import azure.cosmos.cosmos_client as cosmos_client
import test_config
from azure.cosmos import DatabaseProxy
from azure.cosmos.partition_key import PartitionKey
@pytest.mark.cosmosQuery
class TestMultiOrderBy(unittest.TestCase):
"""Multi Orderby and Composite Indexes Tests.
"""
NUMBER_FIELD = "numberField"
STRING_FIELD = "stringField"
NUMBER_FIELD_2 = "numberField2"
STRING_FIELD_2 = "stringField2"
BOOL_FIELD = "boolField"
NULL_FIELD = "nullField"
OBJECT_FIELD = "objectField"
ARRAY_FIELD = "arrayField"
SHORT_STRING_FIELD = "shortStringField"
MEDIUM_STRING_FIELD = "mediumStringField"
LONG_STRING_FIELD = "longStringField"
PARTITION_KEY = "pk"
items = []
host = test_config.TestConfig.host
masterKey = test_config.TestConfig.masterKey
connectionPolicy = test_config.TestConfig.connectionPolicy
configs = test_config.TestConfig
client: cosmos_client.CosmosClient = None
database: DatabaseProxy = None
@classmethod
def setUpClass(cls):
cls.client = cosmos_client.CosmosClient(cls.host, cls.masterKey)
cls.database = cls.client.get_database_client(cls.configs.TEST_DATABASE_ID)
if cls.host == "https://localhost:8081/":
os.environ["AZURE_COSMOS_DISABLE_NON_STREAMING_ORDER_BY"] = "True"
def generate_multi_orderby_item(self):
item = {'id': str(uuid.uuid4()), self.NUMBER_FIELD: random.randint(0, 5),
self.NUMBER_FIELD_2: random.randint(0, 5), self.BOOL_FIELD: random.randint(0, 2) % 2 == 0,
self.STRING_FIELD: str(random.randint(0, 5)), self.STRING_FIELD_2: str(random.randint(0, 5)),
self.NULL_FIELD: None, self.OBJECT_FIELD: "", self.ARRAY_FIELD: [],
self.SHORT_STRING_FIELD: "a" + str(random.randint(0, 100)),
self.MEDIUM_STRING_FIELD: "a" + str(random.randint(0, 128) + 100),
self.LONG_STRING_FIELD: "a" + str(random.randint(0, 255) + 128),
self.PARTITION_KEY: random.randint(0, 5)}
return item
def create_random_items(self, container, number_of_items, number_of_duplicates):
# type: (CosmosContainer, int, int) -> None
for i in range(0, number_of_items):
multi_orderby_item = self.generate_multi_orderby_item()
for j in range(0, number_of_duplicates):
# Add the item itself for exact duplicates
clone = multi_orderby_item.copy()
clone['id'] = str(uuid.uuid4())
self.items.append(clone)
# Permute all the fields so that there are duplicates with tie breaks
number_clone = multi_orderby_item.copy()
number_clone[self.NUMBER_FIELD] = random.randint(0, 5)
number_clone['id'] = str(uuid.uuid4())
self.items.append(number_clone)
string_clone = multi_orderby_item.copy()
string_clone[self.STRING_FIELD] = str(random.randint(0, 5))
string_clone['id'] = str(uuid.uuid4())
self.items.append(string_clone)
bool_clone = multi_orderby_item.copy()
bool_clone[self.BOOL_FIELD] = random.randint(0, 2) % 2 == 0
bool_clone['id'] = str(uuid.uuid4())
self.items.append(bool_clone)
# Also fuzz what partition it goes to
partition_clone = multi_orderby_item.copy()
partition_clone[self.PARTITION_KEY] = random.randint(0, 5)
partition_clone['id'] = str(uuid.uuid4())
self.items.append(partition_clone)
for item in self.items:
container.create_item(body=item)
def test_multi_orderby_queries(self):
indexingPolicy = {
"indexingMode": "consistent",
"automatic": True,
"includedPaths": [
{
"path": "/*",
"indexes": []
}
],
"excludedPaths": [
{
"path": "/\"_etag\"/?"
}
],
"compositeIndexes": [
[
{
"path": "/numberField",
"order": "ascending"
},
{
"path": "/stringField",
"order": "descending"
}
],
[
{
"path": "/numberField",
"order": "descending"
},
{
"path": "/stringField",
"order": "ascending"
},
{
"path": "/numberField2",
"order": "descending"
},
{
"path": "/stringField2",
"order": "ascending"
}
],
[
{
"path": "/numberField",
"order": "descending"
},
{
"path": "/stringField",
"order": "ascending"
},
{
"path": "/boolField",
"order": "descending"
},
{
"path": "/nullField",
"order": "ascending"
}
],
[
{
"path": "/stringField",
"order": "ascending"
},
{
"path": "/shortStringField",
"order": "ascending"
},
{
"path": "/mediumStringField",
"order": "ascending"
},
{
"path": "/longStringField",
"order": "ascending"
}
]
]
}
options = {'offerThroughput': 25100}
created_container = self.database.create_container(
id='multi_orderby_container' + str(uuid.uuid4()),
indexing_policy=indexingPolicy,
partition_key=PartitionKey(path='/pk'),
request_options=options
)
number_of_items = 5
self.create_random_items(created_container, number_of_items, number_of_items)
bool_vals = [True, False]
composite_indexes = indexingPolicy['compositeIndexes']
for composite_index in composite_indexes:
# for every order
for invert in bool_vals:
# for normal and inverted order
for has_top in bool_vals:
# with and without top
for has_filter in bool_vals:
# with and without filter
# Generate a multi order by from that index
orderby_items = []
select_items = []
for composite_path in composite_index:
is_desc = True if composite_path['order'] == "descending" else False
if invert:
is_desc = not is_desc
is_desc_string = "DESC" if is_desc else "ASC"
composite_path_name = composite_path['path'].replace("/", "")
orderby_items_string = "root." + composite_path_name + " " + is_desc_string
select_items_string = "root." + composite_path_name
orderby_items.append(orderby_items_string)
select_items.append(select_items_string)
top_count = 10
select_item_builder = ""
for select_item in select_items:
select_item_builder += select_item + ","
select_item_builder = select_item_builder[:-1]
orderby_item_builder = ""
for orderby_item in orderby_items:
orderby_item_builder += orderby_item + ","
orderby_item_builder = orderby_item_builder[:-1]
top_string = "TOP " + str(top_count) if has_top else ""
where_string = "WHERE root." + self.NUMBER_FIELD + " % 2 = 0" if has_filter else ""
query = "SELECT " + top_string + " [" + select_item_builder + "] " + \
"FROM root " + where_string + " " + \
"ORDER BY " + orderby_item_builder # nosec
expected_ordered_list = self.top(
self.sort(self.filter(self.items, has_filter), composite_index, invert), has_top, top_count)
result_ordered_list = list(
created_container.query_items(query=query, enable_cross_partition_query=True))
self.validate_results(expected_ordered_list, result_ordered_list, composite_index)
self.database.delete_container(created_container.id)
def top(self, items, has_top, top_count):
return items[0:top_count] if has_top else items
def sort(self, items, composite_index, invert):
current_docs = items
for composite_path in reversed(composite_index):
order = composite_path['order']
if invert:
order = "ascending" if order == "descending" else "descending"
path = composite_path['path'].replace("/", "")
if self.NULL_FIELD not in path:
current_docs = sorted(current_docs, key=lambda x: x[path],
reverse=True if order == "descending" else False)
return current_docs
def filter(self, items, has_filter):
return [x for x in items if x[self.NUMBER_FIELD] % 2 == 0] if has_filter else items
def validate_results(self, expected_ordered_list, result_ordered_list, composite_index):
self.assertEqual(len(expected_ordered_list), len(result_ordered_list))
for i in range(0, len(expected_ordered_list)):
result_values = result_ordered_list[i]['$1']
self.assertEqual(len(result_values), len(composite_index))
for j in range(0, len(composite_index)):
path = composite_index[j]['path'].replace("/", "")
if self.NULL_FIELD in path:
self.assertIsNone(expected_ordered_list[i][path])
self.assertIsNone(result_values[j])
else:
self.assertEqual(expected_ordered_list[i][path], result_values[j])
if __name__ == '__main__':
unittest.main()
|
