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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
|
import pytest
from pymongo import IndexModel
from beanie import Document, Indexed, init_beanie
from beanie.exceptions import CollectionWasNotInitialized
from beanie.odm.utils.projection import get_projection
from tests.odm.models import (
Color,
DocumentTestModel,
DocumentTestModelIndexFlagsAnnotated,
DocumentTestModelStringImport,
DocumentTestModelWithComplexIndex,
DocumentTestModelWithCustomCollectionName,
DocumentTestModelWithDroppedIndex,
DocumentTestModelWithIndexFlags,
DocumentTestModelWithIndexFlagsAliases,
DocumentTestModelWithSimpleIndex,
DocumentWithCustomInit,
DocumentWithIndexMerging2,
DocumentWithLink,
DocumentWithListLink,
DocumentWithUnionTypeExpressionOptionalBackLink,
)
async def test_init_collection_was_not_initialized():
class NewDocument(Document):
test_str: str
with pytest.raises(CollectionWasNotInitialized):
NewDocument(test_str="test")
async def test_init_connection_string(settings):
class NewDocumentCS(Document):
test_str: str
await init_beanie(
connection_string=settings.mongodb_dsn, document_models=[NewDocumentCS]
)
assert (
NewDocumentCS.get_pymongo_collection().database.name
== settings.mongodb_dsn.split("/")[-1]
)
async def test_init_wrong_params(settings, db):
class NewDocumentCS(Document):
test_str: str
with pytest.raises(ValueError):
await init_beanie(
database=db,
connection_string=settings.mongodb_dsn,
document_models=[NewDocumentCS],
)
with pytest.raises(ValueError):
await init_beanie(document_models=[NewDocumentCS])
with pytest.raises(ValueError):
await init_beanie(connection_string=settings.mongodb_dsn)
async def test_collection_with_custom_name():
collection = (
DocumentTestModelWithCustomCollectionName.get_pymongo_collection()
)
assert collection.name == "custom"
async def test_simple_index_creation():
collection = DocumentTestModelWithSimpleIndex.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info["test_int_1"] == {"key": [("test_int", 1)], "v": 2}
assert index_info["test_str_text"]["key"] == [
("_fts", "text"),
("_ftsx", 1),
]
async def test_flagged_index_creation():
collection = DocumentTestModelWithIndexFlags.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info["test_int_1"] == {
"key": [("test_int", 1)],
"sparse": True,
"v": 2,
}
assert index_info["test_str_-1"] == {
"key": [("test_str", -1)],
"unique": True,
"v": 2,
}
async def test_flagged_index_creation_with_alias():
collection = (
DocumentTestModelWithIndexFlagsAliases.get_pymongo_collection()
)
index_info = await collection.index_information()
assert index_info["testInt_1"] == {
"key": [("testInt", 1)],
"sparse": True,
"v": 2,
}
assert index_info["testStr_-1"] == {
"key": [("testStr", -1)],
"unique": True,
"v": 2,
}
async def test_annotated_index_creation():
collection = DocumentTestModelIndexFlagsAnnotated.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info["str_index_text"]["key"] == [
("_fts", "text"),
("_ftsx", 1),
]
assert index_info["str_index_annotated_1"] == {
"key": [("str_index_annotated", 1)],
"v": 2,
}
assert index_info["uuid_index_annotated_1"] == {
"key": [("uuid_index_annotated", 1)],
"unique": True,
"v": 2,
}
if "uuid_index" in index_info:
assert index_info["uuid_index"] == {
"key": [("uuid_index", 1)],
"unique": True,
"v": 2,
}
async def test_complex_index_creation():
collection = DocumentTestModelWithComplexIndex.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info == {
"_id_": {"key": [("_id", 1)], "v": 2},
"test_int_1": {"key": [("test_int", 1)], "v": 2},
"test_int_1_test_str_-1": {
"key": [("test_int", 1), ("test_str", -1)],
"v": 2,
},
"test_string_index_DESCENDING": {"key": [("test_str", -1)], "v": 2},
}
async def test_index_dropping_is_allowed(db):
await init_beanie(
database=db, document_models=[DocumentTestModelWithComplexIndex]
)
collection = DocumentTestModelWithComplexIndex.get_pymongo_collection()
await init_beanie(
database=db,
document_models=[DocumentTestModelWithDroppedIndex],
allow_index_dropping=True,
)
collection = DocumentTestModelWithComplexIndex.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info == {
"_id_": {"key": [("_id", 1)], "v": 2},
"test_int_1": {"key": [("test_int", 1)], "v": 2},
}
async def test_index_dropping_is_not_allowed(db):
await init_beanie(
database=db, document_models=[DocumentTestModelWithComplexIndex]
)
await init_beanie(
database=db,
document_models=[DocumentTestModelWithDroppedIndex],
allow_index_dropping=False,
)
collection = DocumentTestModelWithComplexIndex.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info == {
"_id_": {"key": [("_id", 1)], "v": 2},
"test_int_1": {"key": [("test_int", 1)], "v": 2},
"test_int_1_test_str_-1": {
"key": [("test_int", 1), ("test_str", -1)],
"v": 2,
},
"test_string_index_DESCENDING": {"key": [("test_str", -1)], "v": 2},
}
async def test_index_dropping_is_not_allowed_as_default(db):
await init_beanie(
database=db, document_models=[DocumentTestModelWithComplexIndex]
)
await init_beanie(
database=db,
document_models=[DocumentTestModelWithDroppedIndex],
)
collection = DocumentTestModelWithComplexIndex.get_pymongo_collection()
index_info = await collection.index_information()
assert index_info == {
"_id_": {"key": [("_id", 1)], "v": 2},
"test_int_1": {"key": [("test_int", 1)], "v": 2},
"test_int_1_test_str_-1": {
"key": [("test_int", 1), ("test_str", -1)],
"v": 2,
},
"test_string_index_DESCENDING": {"key": [("test_str", -1)], "v": 2},
}
async def test_document_string_import(db):
await init_beanie(
database=db,
document_models=[
"tests.odm.models.DocumentTestModelStringImport",
],
)
document = DocumentTestModelStringImport(test_int=1)
assert document.id is None
await document.insert()
assert document.id is not None
with pytest.raises(ValueError):
await init_beanie(
database=db,
document_models=[
"tests",
],
)
with pytest.raises(AttributeError):
await init_beanie(
database=db,
document_models=[
"tests.wrong",
],
)
async def test_projection():
projection = get_projection(DocumentTestModel)
assert projection == {
"_id": 1,
"test_int": 1,
"test_list": 1,
"test_str": 1,
"test_doc": 1,
"revision_id": 1,
}
async def test_index_recreation(db):
class Sample1(Document):
name: Indexed(str, unique=True)
class Settings:
name = "sample"
class Sample2(Document):
name: str
status: str = "active"
class Settings:
indexes = [
IndexModel(
"name",
unique=True,
partialFilterExpression={"is_active": {"$eq": "active"}},
),
]
name = "sample"
await db.drop_collection("sample")
await init_beanie(
database=db,
document_models=[Sample1],
)
await init_beanie(
database=db, document_models=[Sample2], allow_index_dropping=True
)
await db.drop_collection("sample")
async def test_merge_indexes():
assert (
await DocumentWithIndexMerging2.get_pymongo_collection().index_information()
== {
"_id_": {"key": [("_id", 1)], "v": 2},
"s0_1": {"key": [("s0", 1)], "v": 2},
"s1_1": {"key": [("s1", 1)], "v": 2},
"s2_-1": {"key": [("s2", -1)], "v": 2},
"s3_index": {"key": [("s3", -1)], "v": 2},
"s4_index": {"key": [("s4", 1)], "v": 2},
}
)
async def test_custom_init():
assert DocumentWithCustomInit.s == "TEST2"
async def test_index_on_custom_types(db):
class Sample1(Document):
name: Indexed(Color, unique=True)
class Settings:
name = "sample"
await db.drop_collection("sample")
await init_beanie(
database=db,
document_models=[Sample1],
)
await db.drop_collection("sample")
async def test_init_document_with_union_type_expression_optional_back_link(db):
await init_beanie(
database=db,
document_models=[
DocumentWithUnionTypeExpressionOptionalBackLink,
DocumentWithListLink,
DocumentWithLink,
],
)
assert (
DocumentWithUnionTypeExpressionOptionalBackLink.get_link_fields().keys()
== {
"back_link_list",
"back_link",
}
)
async def test_init_document_can_inhert_and_extend_settings(db):
class Sample1(Document):
class Settings:
name = "sample1"
bson_encoders = {Color: lambda x: x.value}
class Sample2(Sample1):
class Settings(Sample1.Settings):
name = "sample2"
await init_beanie(
database=db,
document_models=[Sample2],
)
assert Sample2.get_settings().bson_encoders != {}
assert Sample2.get_settings().name == "sample2"
async def test_init_beanie_with_skip_indexes(db):
class NewDocument(Document):
test_str: str
class Settings:
indexes = ["test_str"]
await init_beanie(
database=db,
document_models=[NewDocument],
skip_indexes=True,
)
# To force collection creation
await NewDocument(test_str="Roman Right").save()
collection = NewDocument.get_pymongo_collection()
index_info = await collection.index_information()
assert len(index_info) == 1 # Only the default _id index should be present
|