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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
|
from typing import Dict, List, Optional, Tuple
import pytest
from bson import ObjectId as BsonObjectId
from inline_snapshot import snapshot
from motor.motor_asyncio import AsyncIOMotorClient
from pymongo import MongoClient
from odmantic.bson import ObjectId
from odmantic.engine import AIOEngine, SyncEngine
from odmantic.exceptions import DocumentNotFoundError, DocumentParsingError
from odmantic.field import Field
from odmantic.model import EmbeddedModel, Model
from odmantic.query import asc, desc
from tests.integration.conftest import only_on_replica
from tests.integration.utils import redact_objectid
from tests.zoo.book_reference import Book, Publisher
from ..zoo.person import PersonModel
pytestmark = pytest.mark.asyncio
def test_default_motor_client_creation():
engine = AIOEngine()
assert isinstance(engine.client, AsyncIOMotorClient)
def test_no_motor_raises_for_aioengine_client_creation():
import odmantic.engine
motor = odmantic.engine.motor
odmantic.engine.motor = None
with pytest.raises(RuntimeError) as e:
AIOEngine()
assert 'pip install "odmantic[motor]"' in str(e)
odmantic.engine.motor = motor
def test_default_pymongo_client_creation():
engine = SyncEngine()
assert isinstance(engine.client, MongoClient)
def test_no_motor_passes_with_syncengine_client_creation():
import odmantic.engine
motor = odmantic.engine.motor
odmantic.engine.motor = None
engine = SyncEngine()
assert isinstance(engine.client, MongoClient)
odmantic.engine.motor = motor
@pytest.mark.parametrize("illegal_character", ("/", "\\", ".", '"', "$"))
def test_invalid_database_name(illegal_character: str):
with pytest.raises(ValueError, match="database name cannot contain"):
AIOEngine(database=f"prefix{illegal_character}suffix")
with pytest.raises(ValueError, match="database name cannot contain"):
SyncEngine(database=f"prefix{illegal_character}suffix")
async def test_save(aio_engine: AIOEngine):
instance = await aio_engine.save(
PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
)
assert isinstance(instance.id, BsonObjectId)
def test_sync_save(sync_engine: SyncEngine):
instance = sync_engine.save(
PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
)
assert isinstance(instance.id, BsonObjectId)
async def test_save_find_find_one(aio_engine: AIOEngine):
initial_instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
await aio_engine.save(initial_instance)
found_instances = await aio_engine.find(PersonModel)
assert len(found_instances) == 1
assert found_instances[0].first_name == initial_instance.first_name
assert found_instances[0].last_name == initial_instance.last_name
single_fetched_instance = await aio_engine.find_one(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert single_fetched_instance is not None
assert single_fetched_instance.first_name == initial_instance.first_name
assert single_fetched_instance.last_name == initial_instance.last_name
def test_sync_save_find_find_one(sync_engine: SyncEngine):
initial_instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
sync_engine.save(initial_instance)
found_instances = list(sync_engine.find(PersonModel))
assert len(found_instances) == 1
assert found_instances[0].first_name == initial_instance.first_name
assert found_instances[0].last_name == initial_instance.last_name
single_fetched_instance = sync_engine.find_one(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert single_fetched_instance is not None
assert single_fetched_instance.first_name == initial_instance.first_name
assert single_fetched_instance.last_name == initial_instance.last_name
async def test_find_one_not_existing(aio_engine: AIOEngine):
fetched = await aio_engine.find_one(PersonModel)
assert fetched is None
def test_sync_find_one_not_existing(sync_engine: SyncEngine):
fetched = sync_engine.find_one(PersonModel)
assert fetched is None
@pytest.fixture(scope="function")
async def person_persisted(aio_engine: AIOEngine):
initial_instances = [
PersonModel(first_name="Jean-Pierre", last_name="Pernaud"),
PersonModel(first_name="Jean-Pierre", last_name="Castaldi"),
PersonModel(first_name="Michel", last_name="Drucker"),
]
return await aio_engine.save_all(initial_instances)
async def test_save_multiple_simple_find_find_one(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
found_instances = await aio_engine.find(
PersonModel, PersonModel.first_name == "Michel"
)
assert len(found_instances) == 1
assert found_instances[0].first_name == person_persisted[2].first_name
assert found_instances[0].last_name == person_persisted[2].last_name
found_instances = await aio_engine.find(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert len(found_instances) == 2
assert found_instances[0].id != found_instances[1].id
single_retrieved = await aio_engine.find_one(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert single_retrieved is not None
assert single_retrieved in person_persisted
def test_sync_save_multiple_simple_find_find_one(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
found_instances = list(
sync_engine.find(PersonModel, PersonModel.first_name == "Michel")
)
assert len(found_instances) == 1
assert found_instances[0].first_name == person_persisted[2].first_name
assert found_instances[0].last_name == person_persisted[2].last_name
found_instances = list(
sync_engine.find(PersonModel, PersonModel.first_name == "Jean-Pierre")
)
assert len(found_instances) == 2
assert found_instances[0].id != found_instances[1].id
single_retrieved = sync_engine.find_one(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert single_retrieved is not None
assert single_retrieved in person_persisted
async def test_find_sync_iteration(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
fetched = set()
for inst in await aio_engine.find(PersonModel):
fetched.add(inst.id)
assert set(i.id for i in person_persisted) == fetched
def test_sync_find_sync_iteration(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
fetched = set()
for inst in sync_engine.find(PersonModel):
fetched.add(inst.id)
assert set(i.id for i in person_persisted) == fetched
@pytest.mark.usefixtures("person_persisted")
async def test_find_sync_iteration_cached(aio_engine: AIOEngine, aio_mock_collection):
cursor = aio_engine.find(PersonModel)
initial = await cursor
collection = aio_mock_collection()
cached = await cursor
collection.aggregate.assert_not_awaited()
assert cached == initial
@pytest.mark.usefixtures("person_persisted")
def test_sync_find_sync_iteration_cached(sync_engine: SyncEngine, sync_mock_collection):
cursor = sync_engine.find(PersonModel)
initial = list(cursor)
collection = sync_mock_collection()
cached = list(cursor)
collection.aggregate.assert_not_called()
assert cached == initial
@pytest.mark.usefixtures("person_persisted")
async def test_find_async_iteration_cached(aio_engine: AIOEngine, aio_mock_collection):
cursor = aio_engine.find(PersonModel)
initial = []
async for inst in cursor:
initial.append(inst)
collection = aio_mock_collection()
cached = []
async for inst in cursor:
cached.append(inst)
collection.aggregate.assert_not_awaited()
assert cached == initial
@pytest.mark.usefixtures("person_persisted")
def test_sync_find_async_iteration_cached(
sync_engine: SyncEngine, sync_mock_collection
):
cursor = sync_engine.find(PersonModel)
initial = []
for inst in cursor:
initial.append(inst)
collection = sync_mock_collection()
cached = []
for inst in cursor:
cached.append(inst)
collection.aggregate.assert_not_called()
assert cached == initial
async def test_find_skip(aio_engine: AIOEngine, person_persisted: List[PersonModel]):
results = await aio_engine.find(PersonModel, skip=1)
assert len(results) == 2
for instance in results:
assert instance in person_persisted
def test_sync_find_skip(sync_engine: SyncEngine, person_persisted: List[PersonModel]):
results = list(sync_engine.find(PersonModel, skip=1))
assert len(results) == 2
for instance in results:
assert instance in person_persisted
async def test_find_one_bad_query(aio_engine: AIOEngine):
with pytest.raises(TypeError):
await aio_engine.find_one(PersonModel, True, False)
def test_sync_find_one_bad_query(sync_engine: SyncEngine):
with pytest.raises(TypeError):
sync_engine.find_one(PersonModel, True, False)
async def test_find_one_on_non_model(aio_engine: AIOEngine):
class BadModel:
pass
with pytest.raises(TypeError):
await aio_engine.find_one(BadModel) # type: ignore
def test_sync_find_one_on_non_model(sync_engine: SyncEngine):
class BadModel:
pass
with pytest.raises(TypeError):
sync_engine.find_one(BadModel) # type: ignore
async def test_find_invalid_limit(aio_engine: AIOEngine):
with pytest.raises(ValueError):
await aio_engine.find(PersonModel, limit=0)
with pytest.raises(ValueError):
await aio_engine.find(PersonModel, limit=-12)
def test_sync_find_invalid_limit(sync_engine: SyncEngine):
with pytest.raises(ValueError):
sync_engine.find(PersonModel, limit=0)
with pytest.raises(ValueError):
sync_engine.find(PersonModel, limit=-12)
async def test_find_invalid_skip(aio_engine: AIOEngine):
with pytest.raises(ValueError):
await aio_engine.find(PersonModel, skip=-1)
with pytest.raises(ValueError):
await aio_engine.find(PersonModel, limit=-12)
def test_sync_find_invalid_skip(sync_engine: SyncEngine):
with pytest.raises(ValueError):
sync_engine.find(PersonModel, skip=-1)
with pytest.raises(ValueError):
sync_engine.find(PersonModel, limit=-12)
@pytest.mark.usefixtures("person_persisted")
async def test_skip(aio_engine: AIOEngine):
p = await aio_engine.find(PersonModel, skip=1)
assert len(p) == 2
@pytest.mark.usefixtures("person_persisted")
def test_sync_skip(sync_engine: SyncEngine):
p = list(sync_engine.find(PersonModel, skip=1))
assert len(p) == 2
@pytest.mark.usefixtures("person_persisted")
async def test_limit(aio_engine: AIOEngine):
p = await aio_engine.find(PersonModel, limit=1)
assert len(p) == 1
@pytest.mark.usefixtures("person_persisted")
def test_sync_limit(sync_engine: SyncEngine):
p = list(sync_engine.find(PersonModel, limit=1))
assert len(p) == 1
@pytest.mark.usefixtures("person_persisted")
async def test_skip_limit(aio_engine: AIOEngine):
p = await aio_engine.find(PersonModel, skip=1, limit=1)
assert len(p) == 1
@pytest.mark.usefixtures("person_persisted")
def test_sync_skip_limit(sync_engine: SyncEngine):
p = list(sync_engine.find(PersonModel, skip=1, limit=1))
assert len(p) == 1
async def test_save_multiple_time_same_document(aio_engine: AIOEngine):
fixed_id = ObjectId()
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud", id=fixed_id)
await aio_engine.save(instance)
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud", id=fixed_id)
await aio_engine.save(instance)
assert await aio_engine.count(PersonModel, PersonModel.id == fixed_id) == 1
def test_sync_save_multiple_time_same_document(sync_engine: SyncEngine):
fixed_id = ObjectId()
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud", id=fixed_id)
sync_engine.save(instance)
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud", id=fixed_id)
sync_engine.save(instance)
assert sync_engine.count(PersonModel, PersonModel.id == fixed_id) == 1
@pytest.mark.usefixtures("person_persisted")
async def test_count(aio_engine: AIOEngine):
count = await aio_engine.count(PersonModel)
assert count == 3
count = await aio_engine.count(PersonModel, PersonModel.first_name == "Michel")
assert count == 1
count = await aio_engine.count(PersonModel, PersonModel.first_name == "Gérard")
assert count == 0
@pytest.mark.usefixtures("person_persisted")
def test_sync_count(sync_engine: SyncEngine):
count = sync_engine.count(PersonModel)
assert count == 3
count = sync_engine.count(PersonModel, PersonModel.first_name == "Michel")
assert count == 1
count = sync_engine.count(PersonModel, PersonModel.first_name == "Gérard")
assert count == 0
async def test_count_on_non_model_fails(aio_engine: AIOEngine):
class BadModel:
pass
with pytest.raises(TypeError):
await aio_engine.count(BadModel) # type: ignore
def test_sync_count_on_non_model_fails(sync_engine: SyncEngine):
class BadModel:
pass
with pytest.raises(TypeError):
sync_engine.count(BadModel) # type: ignore
async def test_find_on_embedded_raises(aio_engine: AIOEngine):
class BadModel(EmbeddedModel):
field: int
with pytest.raises(TypeError):
await aio_engine.find(BadModel) # type: ignore
def test_sync_find_on_embedded_raises(sync_engine: SyncEngine):
class BadModel(EmbeddedModel):
field: int
with pytest.raises(TypeError):
sync_engine.find(BadModel) # type: ignore
async def test_save_on_embedded(aio_engine: AIOEngine):
class BadModel(EmbeddedModel):
field: int
instance = BadModel(field=12)
with pytest.raises(TypeError):
await aio_engine.save(instance) # type: ignore
def test_sync_save_on_embedded(sync_engine: SyncEngine):
class BadModel(EmbeddedModel):
field: int
instance = BadModel(field=12)
with pytest.raises(TypeError):
sync_engine.save(instance) # type: ignore
@pytest.mark.usefixtures("person_persisted")
async def test_implicit_and(aio_engine: AIOEngine):
count = await aio_engine.count(
PersonModel,
PersonModel.first_name == "Michel",
PersonModel.last_name == "Drucker",
)
assert count == 1
@pytest.mark.usefixtures("person_persisted")
def test_sync_implicit_and(sync_engine: SyncEngine):
count = sync_engine.count(
PersonModel,
PersonModel.first_name == "Michel",
PersonModel.last_name == "Drucker",
)
assert count == 1
async def test_save_update(aio_engine: AIOEngine):
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
await aio_engine.save(instance)
assert await aio_engine.count(PersonModel, PersonModel.last_name == "Pernaud") == 1
instance.last_name = "Dupuis"
await aio_engine.save(instance)
assert await aio_engine.count(PersonModel, PersonModel.last_name == "Pernaud") == 0
assert await aio_engine.count(PersonModel, PersonModel.last_name == "Dupuis") == 1
def test_sync_save_update(sync_engine: SyncEngine):
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
sync_engine.save(instance)
assert sync_engine.count(PersonModel, PersonModel.last_name == "Pernaud") == 1
instance.last_name = "Dupuis"
sync_engine.save(instance)
assert sync_engine.count(PersonModel, PersonModel.last_name == "Pernaud") == 0
assert sync_engine.count(PersonModel, PersonModel.last_name == "Dupuis") == 1
async def test_delete_and_count(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
await aio_engine.delete(person_persisted[0])
assert await aio_engine.count(PersonModel) == 2
await aio_engine.delete(person_persisted[1])
assert await aio_engine.count(PersonModel) == 1
await aio_engine.delete(person_persisted[2])
assert await aio_engine.count(PersonModel) == 0
def test_sync_delete_and_count(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
sync_engine.delete(person_persisted[0])
assert sync_engine.count(PersonModel) == 2
sync_engine.delete(person_persisted[1])
assert sync_engine.count(PersonModel) == 1
sync_engine.delete(person_persisted[2])
assert sync_engine.count(PersonModel) == 0
async def test_delete_not_existing(aio_engine: AIOEngine):
non_persisted_instance = PersonModel(first_name="Jean", last_name="Paul")
with pytest.raises(DocumentNotFoundError) as exc:
await aio_engine.delete(non_persisted_instance)
assert exc.value.instance == non_persisted_instance
def test_sync_delete_not_existing(sync_engine: SyncEngine):
non_persisted_instance = PersonModel(first_name="Jean", last_name="Paul")
with pytest.raises(DocumentNotFoundError) as exc:
sync_engine.delete(non_persisted_instance)
assert exc.value.instance == non_persisted_instance
@pytest.mark.usefixtures("person_persisted")
async def test_remove_and_count(aio_engine: AIOEngine):
actual_delete_count = await aio_engine.remove(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert actual_delete_count == 2
assert await aio_engine.count(PersonModel) == 1
@pytest.mark.usefixtures("person_persisted")
def test_sync_remove_and_count(sync_engine: SyncEngine):
actual_delete_count = sync_engine.remove(
PersonModel, PersonModel.first_name == "Jean-Pierre"
)
assert actual_delete_count == 2
assert sync_engine.count(PersonModel) == 1
@pytest.mark.usefixtures("person_persisted")
async def test_remove_just_one(aio_engine: AIOEngine):
actual_delete_count = await aio_engine.remove(
PersonModel, PersonModel.first_name == "Jean-Pierre", just_one=True
)
assert actual_delete_count == 1
assert await aio_engine.count(PersonModel) == 2
@pytest.mark.usefixtures("person_persisted")
def test_sync_remove_just_one(sync_engine: SyncEngine):
actual_delete_count = sync_engine.remove(
PersonModel, PersonModel.first_name == "Jean-Pierre", just_one=True
)
assert actual_delete_count == 1
assert sync_engine.count(PersonModel) == 2
@only_on_replica
@pytest.mark.usefixtures("person_persisted")
async def test_remove_just_one_transaction(aio_engine: AIOEngine):
async with await aio_engine.client.start_session() as session:
async with session.start_transaction():
actual_delete_count = await aio_engine.remove(
PersonModel,
PersonModel.first_name == "Jean-Pierre",
just_one=True,
session=session,
)
assert actual_delete_count == 1
assert await aio_engine.count(PersonModel) == 2
@only_on_replica
@pytest.mark.usefixtures("person_persisted")
def test_sync_remove_just_one_transaction(sync_engine: SyncEngine):
with sync_engine.client.start_session() as session:
with session.start_transaction():
actual_delete_count = sync_engine.remove(
PersonModel,
PersonModel.first_name == "Jean-Pierre",
just_one=True,
session=session,
)
assert actual_delete_count == 1
assert sync_engine.count(PersonModel) == 2
@only_on_replica
@pytest.mark.usefixtures("person_persisted")
async def test_remove_transaction_failure(aio_engine: AIOEngine):
with pytest.raises(Exception):
async with await aio_engine.client.start_session() as session:
async with session.start_transaction():
await aio_engine.remove(
PersonModel,
PersonModel.first_name == "Jean-Pierre",
session=session,
)
raise Exception("oops")
assert await aio_engine.count(PersonModel) == 3 # type: ignore # (unreachable)
@only_on_replica
@pytest.mark.usefixtures("person_persisted")
def test_sync_remove_transaction_failure(sync_engine: SyncEngine):
with pytest.raises(Exception):
with sync_engine.client.start_session() as session:
with session.start_transaction():
sync_engine.remove(
PersonModel,
PersonModel.first_name == "Jean-Pierre",
session=session,
)
raise Exception("oops")
assert sync_engine.count(PersonModel) == 3 # type: ignore # (unreachable)
@pytest.mark.usefixtures("person_persisted")
async def test_remove_not_existing(aio_engine: AIOEngine):
instance = await aio_engine.find_one(
PersonModel, PersonModel.last_name == "NotInDatabase"
)
assert instance is None
deleted_count = await aio_engine.remove(
PersonModel, PersonModel.last_name == "NotInDatabase"
)
assert deleted_count == 0
@pytest.mark.usefixtures("person_persisted")
def test_sync_remove_not_existing(sync_engine: SyncEngine):
instance = sync_engine.find_one(
PersonModel, PersonModel.last_name == "NotInDatabase"
)
assert instance is None
deleted_count = sync_engine.remove(
PersonModel, PersonModel.last_name == "NotInDatabase"
)
assert deleted_count == 0
async def test_modified_fields_cleared_on_document_saved(aio_engine: AIOEngine):
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
assert len(instance.__fields_modified__) > 0
await aio_engine.save(instance)
assert len(instance.__fields_modified__) == 0
def test_sync_modified_fields_cleared_on_document_saved(sync_engine: SyncEngine):
instance = PersonModel(first_name="Jean-Pierre", last_name="Pernaud")
assert len(instance.__fields_modified__) > 0
sync_engine.save(instance)
assert len(instance.__fields_modified__) == 0
async def test_modified_fields_cleared_on_nested_document_saved(aio_engine: AIOEngine):
hachette = Publisher(name="Hachette Livre", founded=1826, location="FR")
book = Book(title="They Didn't See Us Coming", pages=304, publisher=hachette)
assert len(hachette.__fields_modified__) > 0
await aio_engine.save(book)
assert len(hachette.__fields_modified__) == 0
def test_sync_modified_fields_cleared_on_nested_document_saved(sync_engine: SyncEngine):
hachette = Publisher(name="Hachette Livre", founded=1826, location="FR")
book = Book(title="They Didn't See Us Coming", pages=304, publisher=hachette)
assert len(hachette.__fields_modified__) > 0
sync_engine.save(book)
assert len(hachette.__fields_modified__) == 0
@pytest.fixture()
async def engine_one_person(aio_engine: AIOEngine):
await aio_engine.save(PersonModel(first_name="Jean-Pierre", last_name="Pernaud"))
@pytest.mark.usefixtures("engine_one_person")
async def test_modified_fields_on_find(aio_engine: AIOEngine):
instance = await aio_engine.find_one(PersonModel)
assert instance is not None
assert len(instance.__fields_modified__) == 0
@pytest.mark.usefixtures("engine_one_person")
def test_sync_modified_fields_on_find(sync_engine: SyncEngine):
instance = sync_engine.find_one(PersonModel)
assert instance is not None
assert len(instance.__fields_modified__) == 0
@pytest.mark.usefixtures("engine_one_person")
async def test_modified_fields_on_document_change(aio_engine: AIOEngine):
instance = await aio_engine.find_one(PersonModel)
assert instance is not None
instance.first_name = "Jackie"
assert len(instance.__fields_modified__) == 1
instance.last_name = "Chan"
assert len(instance.__fields_modified__) == 2
@pytest.mark.usefixtures("engine_one_person")
def test_sync_modified_fields_on_document_change(sync_engine: SyncEngine):
instance = sync_engine.find_one(PersonModel)
assert instance is not None
instance.first_name = "Jackie"
assert len(instance.__fields_modified__) == 1
instance.last_name = "Chan"
assert len(instance.__fields_modified__) == 2
@pytest.mark.usefixtures("engine_one_person")
async def test_no_set_on_save_fetched_document(
aio_engine: AIOEngine, sync_mock_collection
):
instance = await aio_engine.find_one(PersonModel)
assert instance is not None
collection = sync_mock_collection()
await aio_engine.save(instance)
collection.update_one.assert_not_called()
@pytest.mark.usefixtures("engine_one_person")
def test_sync_no_set_on_save_fetched_document(
sync_engine: SyncEngine, sync_mock_collection
):
instance = sync_engine.find_one(PersonModel)
assert instance is not None
collection = sync_mock_collection()
sync_engine.save(instance)
collection.update_one.assert_not_called()
@pytest.mark.usefixtures("engine_one_person")
async def test_only_modified_set_on_save(aio_engine: AIOEngine, aio_mock_collection):
instance = await aio_engine.find_one(PersonModel)
assert instance is not None
instance.first_name = "John"
collection = aio_mock_collection()
await aio_engine.save(instance)
collection.update_one.assert_awaited_once()
(_, set_arg), _ = collection.update_one.await_args
assert set_arg == {"$set": {"first_name": "John"}}
@pytest.mark.usefixtures("engine_one_person")
def test_sync_only_modified_set_on_save(sync_engine: SyncEngine, sync_mock_collection):
instance = sync_engine.find_one(PersonModel)
assert instance is not None
instance.first_name = "John"
collection = sync_mock_collection()
sync_engine.save(instance)
collection.update_one.assert_called_once()
(_, set_arg), _ = collection.update_one.call_args
assert set_arg == {"$set": {"first_name": "John"}}
async def test_only_mutable_list_set_on_save(
aio_engine: AIOEngine, aio_mock_collection
):
class M(Model):
field: List[str]
immutable_field: int
instance = M(field=["hello"], immutable_field=12)
await aio_engine.save(instance)
collection = aio_mock_collection()
await aio_engine.save(instance)
collection.update_one.assert_awaited_once()
(_, set_arg), _ = collection.update_one.await_args
set_dict = set_arg["$set"]
assert list(set_dict.keys()) == ["field"]
def test_sync_only_mutable_list_set_on_save(
sync_engine: SyncEngine, sync_mock_collection
):
class M(Model):
field: List[str]
immutable_field: int
instance = M(field=["hello"], immutable_field=12)
sync_engine.save(instance)
collection = sync_mock_collection()
sync_engine.save(instance)
collection.update_one.assert_called_once()
(_, set_arg), _ = collection.update_one.call_args
set_dict = set_arg["$set"]
assert list(set_dict.keys()) == ["field"]
async def test_only_mutable_list_of_embedded_set_on_save(
aio_engine: AIOEngine, aio_mock_collection
):
class E(EmbeddedModel):
a: str
class M(Model):
field: List[E]
instance = M(field=[E(a="hello")])
await aio_engine.save(instance)
collection = aio_mock_collection()
await aio_engine.save(instance)
collection.update_one.assert_awaited_once()
(_, set_arg), _ = collection.update_one.await_args
set_dict = set_arg["$set"]
assert set_dict == {"field": [{"a": "hello"}]}
def test_sync_only_mutable_list_of_embedded_set_on_save(
sync_engine: SyncEngine, sync_mock_collection
):
class E(EmbeddedModel):
a: str
class M(Model):
field: List[E]
instance = M(field=[E(a="hello")])
sync_engine.save(instance)
collection = sync_mock_collection()
sync_engine.save(instance)
collection.update_one.assert_called_once()
(_, set_arg), _ = collection.update_one.call_args
set_dict = set_arg["$set"]
assert set_dict == {"field": [{"a": "hello"}]}
async def test_only_mutable_dict_of_embedded_set_on_save(
aio_engine: AIOEngine, aio_mock_collection
):
class E(EmbeddedModel):
a: str
class M(Model):
field: Dict[str, E]
instance = M(field={"hello": E(a="world")})
await aio_engine.save(instance)
collection = aio_mock_collection()
await aio_engine.save(instance)
collection.update_one.assert_awaited_once()
(_, set_arg), _ = collection.update_one.await_args
set_dict = set_arg["$set"]
assert set_dict == {"field": {"hello": {"a": "world"}}}
def test_sync_only_mutable_dict_of_embedded_set_on_save(
sync_engine: SyncEngine, sync_mock_collection
):
class E(EmbeddedModel):
a: str
class M(Model):
field: Dict[str, E]
instance = M(field={"hello": E(a="world")})
sync_engine.save(instance)
collection = sync_mock_collection()
sync_engine.save(instance)
collection.update_one.assert_called_once()
(_, set_arg), _ = collection.update_one.call_args
set_dict = set_arg["$set"]
assert set_dict == {"field": {"hello": {"a": "world"}}}
async def test_only_tuple_of_embedded_set_on_save(
aio_engine: AIOEngine, aio_mock_collection
):
class E(EmbeddedModel):
a: str
class M(Model):
field: Tuple[E]
instance = M(field=(E(a="world"),))
await aio_engine.save(instance)
collection = aio_mock_collection()
await aio_engine.save(instance)
collection.update_one.assert_awaited_once()
(_, set_arg), _ = collection.update_one.await_args
set_dict = set_arg["$set"]
assert set_dict == {
"field": [
{"a": "world"},
]
}
def test_sync_only_tuple_of_embedded_set_on_save(
sync_engine: SyncEngine, sync_mock_collection
):
class E(EmbeddedModel):
a: str
class M(Model):
field: Tuple[E]
instance = M(field=(E(a="world"),))
sync_engine.save(instance)
collection = sync_mock_collection()
sync_engine.save(instance)
collection.update_one.assert_called_once()
(_, set_arg), _ = collection.update_one.call_args
set_dict = set_arg["$set"]
assert set_dict == {
"field": [
{"a": "world"},
]
}
async def test_find_sort_asc(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
results = await aio_engine.find(PersonModel, sort=PersonModel.last_name)
assert results == sorted(person_persisted, key=lambda person: person.last_name)
def test_sync_find_sort_asc(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
results = list(sync_engine.find(PersonModel, sort=PersonModel.last_name))
assert results == sorted(person_persisted, key=lambda person: person.last_name)
async def test_find_sort_list(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
results = await aio_engine.find(
PersonModel, sort=(PersonModel.first_name, PersonModel.last_name)
)
assert results == sorted(
person_persisted, key=lambda person: (person.first_name, person.last_name)
)
def test_sync_find_sort_list(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
results = list(
sync_engine.find(
PersonModel, sort=(PersonModel.first_name, PersonModel.last_name)
)
)
assert results == sorted(
person_persisted, key=lambda person: (person.first_name, person.last_name)
)
async def test_find_sort_wrong_argument(aio_engine: AIOEngine):
with pytest.raises(
TypeError,
match=(
"sort has to be a Model field or "
"asc, desc descriptors or a tuple of these"
),
):
await aio_engine.find(PersonModel, sort="first_name")
def test_sync_find_sort_wrong_argument(sync_engine: SyncEngine):
with pytest.raises(
TypeError,
match=(
"sort has to be a Model field or "
"asc, desc descriptors or a tuple of these"
),
):
sync_engine.find(PersonModel, sort="first_name")
async def test_find_sort_wrong_tuple_argument(aio_engine: AIOEngine):
with pytest.raises(
TypeError,
match="sort elements have to be Model fields or asc, desc descriptors",
):
await aio_engine.find(PersonModel, sort=("first_name",))
def test_sync_find_sort_wrong_tuple_argument(sync_engine: SyncEngine):
with pytest.raises(
TypeError,
match="sort elements have to be Model fields or asc, desc descriptors",
):
sync_engine.find(PersonModel, sort=("first_name",))
async def test_find_sort_desc(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
results = await aio_engine.find(
PersonModel,
sort=PersonModel.last_name.desc(), # type: ignore
)
assert results == list(
reversed(sorted(person_persisted, key=lambda person: person.last_name))
)
def test_sync_find_sort_desc(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
results = list(
sync_engine.find(PersonModel, sort=PersonModel.last_name.desc()) # type: ignore
)
assert results == list(
reversed(sorted(person_persisted, key=lambda person: person.last_name))
)
async def test_find_sort_asc_function(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
results = await aio_engine.find(PersonModel, sort=asc(PersonModel.last_name))
assert results == sorted(person_persisted, key=lambda person: person.last_name)
def test_sync_find_sort_asc_function(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
results = list(sync_engine.find(PersonModel, sort=asc(PersonModel.last_name)))
assert results == sorted(person_persisted, key=lambda person: person.last_name)
async def test_find_sort_multiple_descriptors(aio_engine: AIOEngine):
class TestModel(Model):
a: int
b: int
c: int
persisted_models = [
TestModel(a=1, b=2, c=3),
TestModel(a=2, b=2, c=3),
TestModel(a=3, b=3, c=2),
]
await aio_engine.save_all(persisted_models)
results = await aio_engine.find(
TestModel,
sort=(
desc(TestModel.a),
TestModel.b,
TestModel.c.asc(), # type: ignore
),
)
assert results == sorted(
persisted_models,
key=lambda test_model: (-test_model.a, test_model.b, test_model.c),
)
def test_sync_find_sort_multiple_descriptors(sync_engine: SyncEngine):
class TestModel(Model):
a: int
b: int
c: int
persisted_models = [
TestModel(a=1, b=2, c=3),
TestModel(a=2, b=2, c=3),
TestModel(a=3, b=3, c=2),
]
sync_engine.save_all(persisted_models)
results = list(
sync_engine.find(
TestModel,
sort=(
desc(TestModel.a),
TestModel.b,
TestModel.c.asc(), # type: ignore
),
)
)
assert results == sorted(
persisted_models,
key=lambda test_model: (-test_model.a, test_model.b, test_model.c),
)
async def test_sort_embedded_field(aio_engine: AIOEngine):
class E(EmbeddedModel):
field: int
class M(Model):
e: E
instances = [M(e=E(field=0)), M(e=E(field=1)), M(e=E(field=2))]
await aio_engine.save_all(instances)
results = await aio_engine.find(M, sort=desc(M.e.field))
assert results == sorted(instances, key=lambda instance: -instance.e.field)
def test_sync_sort_embedded_field(sync_engine: SyncEngine):
class E(EmbeddedModel):
field: int
class M(Model):
e: E
instances = [M(e=E(field=0)), M(e=E(field=1)), M(e=E(field=2))]
sync_engine.save_all(instances)
results = list(sync_engine.find(M, sort=desc(M.e.field)))
assert results == sorted(instances, key=lambda instance: -instance.e.field)
async def test_find_one_sort(
aio_engine: AIOEngine, person_persisted: List[PersonModel]
):
person = await aio_engine.find_one(PersonModel, sort=PersonModel.last_name)
assert person is not None
assert person.last_name == "Castaldi"
def test_sync_find_one_sort(
sync_engine: SyncEngine, person_persisted: List[PersonModel]
):
person = sync_engine.find_one(PersonModel, sort=PersonModel.last_name)
assert person is not None
assert person.last_name == "Castaldi"
async def test_find_document_field_not_set_with_default(aio_engine: AIOEngine):
class M(Model):
field: Optional[str] = None
await aio_engine.get_collection(M).insert_one({"_id": ObjectId()})
gathered = await aio_engine.find_one(M)
assert gathered is not None
assert gathered.field is None
def test_sync_find_document_field_not_set_with_default(sync_engine: SyncEngine):
class M(Model):
field: Optional[str] = None
sync_engine.get_collection(M).insert_one({"_id": ObjectId()})
gathered = sync_engine.find_one(M)
assert gathered is not None
assert gathered.field is None
async def test_find_document_field_not_set_with_default_field_descriptor(
aio_engine: AIOEngine,
):
class M(Model):
field: str = Field(default="hello world")
await aio_engine.get_collection(M).insert_one({"_id": ObjectId()})
gathered = await aio_engine.find_one(M)
assert gathered is not None
assert gathered.field == "hello world"
def test_sync_find_document_field_not_set_with_default_field_descriptor(
sync_engine: SyncEngine,
):
class M(Model):
field: str = Field(default="hello world")
sync_engine.get_collection(M).insert_one({"_id": ObjectId()})
gathered = sync_engine.find_one(M)
assert gathered is not None
assert gathered.field == "hello world"
async def test_find_document_field_not_set_with_no_default(aio_engine: AIOEngine):
class M(Model):
field: str
oid = ObjectId()
await aio_engine.get_collection(M).insert_one({"_id": oid})
with pytest.raises(DocumentParsingError) as exc_info:
await aio_engine.find_one(M)
assert redact_objectid(str(exc_info.value), oid) == snapshot(
"""\
1 validation error for M
field
Key 'field' not found in document [type=odmantic::key_not_found_in_document, input_value={'_id': ObjectId('<ObjectId>')}, input_type=dict]\
""" # noqa: E501
)
def test_sync_find_document_field_not_set_with_no_default(sync_engine: SyncEngine):
class M(Model):
field: str
oid = ObjectId()
sync_engine.get_collection(M).insert_one({"_id": oid})
with pytest.raises(DocumentParsingError) as exc_info:
sync_engine.find_one(M)
assert redact_objectid(str(exc_info.value), oid) == snapshot(
"""\
1 validation error for M
field
Key 'field' not found in document [type=odmantic::key_not_found_in_document, input_value={'_id': ObjectId('<ObjectId>')}, input_type=dict]\
""" # noqa: E501
)
async def test_find_document_field_not_set_with_default_factory_disabled(
aio_engine: AIOEngine,
):
class M(Model):
field: str = Field(default_factory=lambda: "hello") # pragma: no cover
await aio_engine.get_collection(M).insert_one({"_id": ObjectId()})
with pytest.raises(DocumentParsingError, match="Key 'field' not found in document"):
await aio_engine.find_one(M)
def test_sync_find_document_field_not_set_with_default_factory_disabled(
sync_engine: SyncEngine,
):
class M(Model):
field: str = Field(default_factory=lambda: "hello") # pragma: no cover
sync_engine.get_collection(M).insert_one({"_id": ObjectId()})
with pytest.raises(DocumentParsingError, match="Key 'field' not found in document"):
sync_engine.find_one(M)
async def test_find_document_field_not_set_with_default_factory_enabled(
aio_engine: AIOEngine,
):
class M(Model):
field: str = Field(default_factory=lambda: "hello")
model_config = {"parse_doc_with_default_factories": True}
await aio_engine.get_collection(M).insert_one({"_id": ObjectId()})
instance = await aio_engine.find_one(M)
assert instance is not None
assert instance.field == "hello"
def test_sync_find_document_field_not_set_with_default_factory_enabled(
sync_engine: SyncEngine,
):
class M(Model):
field: str = Field(default_factory=lambda: "hello")
model_config = {
"parse_doc_with_default_factories": True,
}
sync_engine.get_collection(M).insert_one({"_id": ObjectId()})
instance = sync_engine.find_one(M)
assert instance is not None
assert instance.field == "hello"
|