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
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# this file creates several documents using bad or no types because
# these are still supported and should be kept functional in spite
# of not having appropriate type hints. For that reason the comment
# below disables many mypy checks that fails as a result of this.
# mypy: disable-error-code="assignment, index, arg-type, call-arg, operator, comparison-overlap, attr-defined"
from datetime import datetime
from ipaddress import ip_address
from typing import TYPE_CHECKING, Any, AsyncIterator, Dict, List, Optional, Tuple, Union
import pytest
from pytest import raises
from pytz import timezone
from elasticsearch import AsyncElasticsearch, ConflictError, NotFoundError
from elasticsearch.dsl import (
AsyncDocument,
AsyncSearch,
Binary,
Boolean,
Date,
DenseVector,
Double,
InnerDoc,
Ip,
Keyword,
Long,
M,
Mapping,
MetaField,
Nested,
Object,
Q,
RankFeatures,
Text,
analyzer,
mapped_field,
)
from elasticsearch.dsl.query import Match
from elasticsearch.dsl.types import MatchQuery
from elasticsearch.dsl.utils import AttrList
from elasticsearch.helpers.errors import BulkIndexError
snowball = analyzer("my_snow", tokenizer="standard", filter=["lowercase", "snowball"])
class User(InnerDoc):
name = Text(fields={"raw": Keyword()})
class Wiki(AsyncDocument):
owner = Object(User)
views = Long()
ranked = RankFeatures()
class Index:
name = "test-wiki"
class Repository(AsyncDocument):
owner = Object(User)
created_at = Date()
description = Text(analyzer=snowball)
tags = Keyword()
@classmethod
def search(cls) -> AsyncSearch["Repository"]: # type: ignore[override]
return super().search().filter("term", commit_repo="repo")
class Index:
name = "git"
class Commit(AsyncDocument):
committed_date = Date()
authored_date = Date()
description = Text(analyzer=snowball)
class Index:
name = "flat-git"
class Meta:
mapping = Mapping()
class History(InnerDoc):
timestamp = Date()
diff = Text()
class Comment(InnerDoc):
content = Text()
created_at = Date()
author = Object(User)
history = Nested(History)
class Meta:
dynamic = MetaField(False)
class PullRequest(AsyncDocument):
comments = Nested(Comment)
created_at = Date()
class Index:
name = "test-prs"
class SerializationDoc(AsyncDocument):
i = Long()
b = Boolean()
d = Double()
bin = Binary()
ip = Ip()
class Index:
name = "test-serialization"
class Tags(AsyncDocument):
tags = Keyword(multi=True)
class Index:
name = "tags"
@pytest.mark.asyncio
async def test_serialization(async_write_client: AsyncElasticsearch) -> None:
await SerializationDoc.init()
await async_write_client.index(
index="test-serialization",
id=42,
body={
"i": [1, 2, "3", None],
"b": [True, False, "true", "false", None],
"d": [0.1, "-0.1", None],
"bin": ["SGVsbG8gV29ybGQ=", None],
"ip": ["::1", "127.0.0.1", None],
},
)
sd = await SerializationDoc.get(id=42)
assert sd is not None
assert sd.i == [1, 2, 3, None]
assert sd.b == [True, False, True, False, None]
assert sd.d == [0.1, -0.1, None]
assert sd.bin == [b"Hello World", None]
assert sd.ip == [ip_address("::1"), ip_address("127.0.0.1"), None]
assert sd.to_dict() == {
"b": [True, False, True, False, None],
"bin": ["SGVsbG8gV29ybGQ=", None],
"d": [0.1, -0.1, None],
"i": [1, 2, 3, None],
"ip": ["::1", "127.0.0.1", None],
}
@pytest.mark.asyncio
async def test_nested_inner_hits_are_wrapped_properly(async_pull_request: Any) -> None:
history_query = Q(
"nested",
path="comments.history",
inner_hits={},
query=Q("match", comments__history__diff="ahoj"),
)
s = PullRequest.search().query(
"nested", inner_hits={}, path="comments", query=history_query
)
response = await s.execute()
pr = response.hits[0]
assert isinstance(pr, PullRequest)
assert isinstance(pr.comments[0], Comment)
assert isinstance(pr.comments[0].history[0], History)
comment = pr.meta.inner_hits.comments.hits[0]
assert isinstance(comment, Comment)
assert comment.author.name == "honzakral"
assert isinstance(comment.history[0], History)
history = comment.meta.inner_hits["comments.history"].hits[0]
assert isinstance(history, History)
assert history.timestamp == datetime(2012, 1, 1)
assert "score" in history.meta
@pytest.mark.asyncio
async def test_nested_inner_hits_are_deserialized_properly(
async_pull_request: Any,
) -> None:
s = PullRequest.search().query(
"nested",
inner_hits={},
path="comments",
query=Q("match", comments__content="hello"),
)
response = await s.execute()
pr = response.hits[0]
assert isinstance(pr.created_at, datetime)
assert isinstance(pr.comments[0], Comment)
assert isinstance(pr.comments[0].created_at, datetime)
@pytest.mark.asyncio
async def test_nested_top_hits_are_wrapped_properly(async_pull_request: Any) -> None:
s = PullRequest.search()
s.aggs.bucket("comments", "nested", path="comments").metric(
"hits", "top_hits", size=1
)
r = await s.execute()
print(r._d_)
assert isinstance(r.aggregations.comments.hits.hits[0], Comment)
@pytest.mark.asyncio
async def test_update_object_field(async_write_client: AsyncElasticsearch) -> None:
await Wiki.init()
w = Wiki(
owner=User(name="Honza Kral"),
_id="elasticsearch-py",
ranked={"test1": 0.1, "topic2": 0.2},
)
await w.save()
assert "updated" == await w.update(owner=[{"name": "Honza"}, User(name="Nick")])
assert w.owner[0].name == "Honza"
assert w.owner[1].name == "Nick"
w = await Wiki.get(id="elasticsearch-py")
assert w.owner[0].name == "Honza"
assert w.owner[1].name == "Nick"
assert w.ranked == {"test1": 0.1, "topic2": 0.2}
@pytest.mark.asyncio
async def test_update_script(async_write_client: AsyncElasticsearch) -> None:
await Wiki.init()
w = Wiki(owner=User(name="Honza Kral"), _id="elasticsearch-py", views=42)
await w.save()
await w.update(script="ctx._source.views += params.inc", inc=5)
w = await Wiki.get(id="elasticsearch-py")
assert w.views == 47
@pytest.mark.asyncio
async def test_update_script_with_dict(async_write_client: AsyncElasticsearch) -> None:
await Wiki.init()
w = Wiki(owner=User(name="Honza Kral"), _id="elasticsearch-py", views=42)
await w.save()
await w.update(
script={
"source": "ctx._source.views += params.inc1 + params.inc2",
"params": {"inc1": 2},
"lang": "painless",
},
inc2=3,
)
w = await Wiki.get(id="elasticsearch-py")
assert w.views == 47
@pytest.mark.asyncio
async def test_update_retry_on_conflict(async_write_client: AsyncElasticsearch) -> None:
await Wiki.init()
w = Wiki(owner=User(name="Honza Kral"), _id="elasticsearch-py", views=42)
await w.save()
w1 = await Wiki.get(id="elasticsearch-py")
w2 = await Wiki.get(id="elasticsearch-py")
assert w1 is not None
assert w2 is not None
await w1.update(
script="ctx._source.views += params.inc", inc=5, retry_on_conflict=1
)
await w2.update(
script="ctx._source.views += params.inc", inc=5, retry_on_conflict=1
)
w = await Wiki.get(id="elasticsearch-py")
assert w.views == 52
@pytest.mark.asyncio
@pytest.mark.parametrize("retry_on_conflict", [None, 0])
async def test_update_conflicting_version(
async_write_client: AsyncElasticsearch, retry_on_conflict: bool
) -> None:
await Wiki.init()
w = Wiki(owner=User(name="Honza Kral"), _id="elasticsearch-py", views=42)
await w.save()
w1 = await Wiki.get(id="elasticsearch-py")
w2 = await Wiki.get(id="elasticsearch-py")
assert w1 is not None
assert w2 is not None
await w1.update(script="ctx._source.views += params.inc", inc=5)
with raises(ConflictError):
await w2.update(
script="ctx._source.views += params.inc",
inc=5,
retry_on_conflict=retry_on_conflict,
)
@pytest.mark.asyncio
async def test_save_and_update_return_doc_meta(
async_write_client: AsyncElasticsearch,
) -> None:
await Wiki.init()
w = Wiki(owner=User(name="Honza Kral"), _id="elasticsearch-py", views=42)
resp = await w.save(return_doc_meta=True)
assert resp["_index"] == "test-wiki"
assert resp["result"] == "created"
assert set(resp.keys()) == {
"_id",
"_index",
"_primary_term",
"_seq_no",
"_shards",
"_version",
"result",
}
resp = await w.update(
script="ctx._source.views += params.inc", inc=5, return_doc_meta=True
)
assert resp["_index"] == "test-wiki"
assert resp["result"] == "updated"
assert set(resp.keys()) == {
"_id",
"_index",
"_primary_term",
"_seq_no",
"_shards",
"_version",
"result",
}
@pytest.mark.asyncio
async def test_init(async_write_client: AsyncElasticsearch) -> None:
await Repository.init(index="test-git")
assert await async_write_client.indices.exists(index="test-git")
@pytest.mark.asyncio
async def test_get_raises_404_on_index_missing(
async_data_client: AsyncElasticsearch,
) -> None:
with raises(NotFoundError):
await Repository.get("elasticsearch-dsl-php", index="not-there")
@pytest.mark.asyncio
async def test_get_raises_404_on_non_existent_id(
async_data_client: AsyncElasticsearch,
) -> None:
with raises(NotFoundError):
await Repository.get("elasticsearch-dsl-php")
@pytest.mark.asyncio
async def test_get_returns_none_if_404_ignored(
async_data_client: AsyncElasticsearch,
) -> None:
assert None is await Repository.get(
"elasticsearch-dsl-php", using=async_data_client.options(ignore_status=404)
)
@pytest.mark.asyncio
async def test_get_returns_none_if_404_ignored_and_index_doesnt_exist(
async_data_client: AsyncElasticsearch,
) -> None:
assert None is await Repository.get(
"42", index="not-there", using=async_data_client.options(ignore_status=404)
)
@pytest.mark.asyncio
async def test_get(async_data_client: AsyncElasticsearch) -> None:
elasticsearch_repo = await Repository.get("elasticsearch-dsl-py")
assert isinstance(elasticsearch_repo, Repository)
assert elasticsearch_repo.owner.name == "elasticsearch"
assert datetime(2014, 3, 3) == elasticsearch_repo.created_at
@pytest.mark.asyncio
async def test_exists_return_true(async_data_client: AsyncElasticsearch) -> None:
assert await Repository.exists("elasticsearch-dsl-py")
@pytest.mark.asyncio
async def test_exists_false(async_data_client: AsyncElasticsearch) -> None:
assert not await Repository.exists("elasticsearch-dsl-php")
@pytest.mark.asyncio
async def test_get_with_tz_date(async_data_client: AsyncElasticsearch) -> None:
first_commit = await Commit.get(
id="3ca6e1e73a071a705b4babd2f581c91a2a3e5037", routing="elasticsearch-dsl-py"
)
assert first_commit is not None
tzinfo = timezone("Europe/Prague")
assert (
tzinfo.localize(datetime(2014, 5, 2, 13, 47, 19, 123000))
== first_commit.authored_date
)
@pytest.mark.asyncio
async def test_save_with_tz_date(async_data_client: AsyncElasticsearch) -> None:
tzinfo = timezone("Europe/Prague")
first_commit = await Commit.get(
id="3ca6e1e73a071a705b4babd2f581c91a2a3e5037", routing="elasticsearch-dsl-py"
)
assert first_commit is not None
first_commit.committed_date = tzinfo.localize(
datetime(2014, 5, 2, 13, 47, 19, 123456)
)
await first_commit.save()
first_commit = await Commit.get(
id="3ca6e1e73a071a705b4babd2f581c91a2a3e5037", routing="elasticsearch-dsl-py"
)
assert first_commit is not None
assert (
tzinfo.localize(datetime(2014, 5, 2, 13, 47, 19, 123456))
== first_commit.committed_date
)
COMMIT_DOCS_WITH_MISSING = [
{"_id": "0"}, # Missing
{"_id": "3ca6e1e73a071a705b4babd2f581c91a2a3e5037"}, # Existing
{"_id": "f"}, # Missing
{"_id": "eb3e543323f189fd7b698e66295427204fff5755"}, # Existing
]
@pytest.mark.asyncio
async def test_mget(async_data_client: AsyncElasticsearch) -> None:
commits = await Commit.mget(COMMIT_DOCS_WITH_MISSING)
assert commits[0] is None
assert commits[1] is not None
assert commits[1].meta.id == "3ca6e1e73a071a705b4babd2f581c91a2a3e5037"
assert commits[2] is None
assert commits[3] is not None
assert commits[3].meta.id == "eb3e543323f189fd7b698e66295427204fff5755"
@pytest.mark.asyncio
async def test_mget_raises_exception_when_missing_param_is_invalid(
async_data_client: AsyncElasticsearch,
) -> None:
with raises(ValueError):
await Commit.mget(COMMIT_DOCS_WITH_MISSING, missing="raj")
@pytest.mark.asyncio
async def test_mget_raises_404_when_missing_param_is_raise(
async_data_client: AsyncElasticsearch,
) -> None:
with raises(NotFoundError):
await Commit.mget(COMMIT_DOCS_WITH_MISSING, missing="raise")
@pytest.mark.asyncio
async def test_mget_ignores_missing_docs_when_missing_param_is_skip(
async_data_client: AsyncElasticsearch,
) -> None:
commits = await Commit.mget(COMMIT_DOCS_WITH_MISSING, missing="skip")
assert commits[0] is not None
assert commits[0].meta.id == "3ca6e1e73a071a705b4babd2f581c91a2a3e5037"
assert commits[1] is not None
assert commits[1].meta.id == "eb3e543323f189fd7b698e66295427204fff5755"
@pytest.mark.asyncio
async def test_update_works_from_search_response(
async_data_client: AsyncElasticsearch,
) -> None:
elasticsearch_repo = (await Repository.search().execute())[0]
await elasticsearch_repo.update(owner={"other_name": "elastic"})
assert "elastic" == elasticsearch_repo.owner.other_name
new_version = await Repository.get("elasticsearch-dsl-py")
assert new_version is not None
assert "elastic" == new_version.owner.other_name
assert "elasticsearch" == new_version.owner.name
@pytest.mark.asyncio
async def test_update(async_data_client: AsyncElasticsearch) -> None:
elasticsearch_repo = await Repository.get("elasticsearch-dsl-py")
assert elasticsearch_repo is not None
v = elasticsearch_repo.meta.version
old_seq_no = elasticsearch_repo.meta.seq_no
await elasticsearch_repo.update(
owner={"new_name": "elastic"}, new_field="testing-update"
)
assert "elastic" == elasticsearch_repo.owner.new_name
assert "testing-update" == elasticsearch_repo.new_field
# assert version has been updated
assert elasticsearch_repo.meta.version == v + 1
new_version = await Repository.get("elasticsearch-dsl-py")
assert new_version is not None
assert "testing-update" == new_version.new_field
assert "elastic" == new_version.owner.new_name
assert "elasticsearch" == new_version.owner.name
assert "seq_no" in new_version.meta
assert new_version.meta.seq_no != old_seq_no
assert "primary_term" in new_version.meta
@pytest.mark.asyncio
async def test_save_updates_existing_doc(async_data_client: AsyncElasticsearch) -> None:
elasticsearch_repo = await Repository.get("elasticsearch-dsl-py")
assert elasticsearch_repo is not None
elasticsearch_repo.new_field = "testing-save"
old_seq_no = elasticsearch_repo.meta.seq_no
assert "updated" == await elasticsearch_repo.save()
new_repo = await async_data_client.get(index="git", id="elasticsearch-dsl-py")
assert "testing-save" == new_repo["_source"]["new_field"]
assert new_repo["_seq_no"] != old_seq_no
assert new_repo["_seq_no"] == elasticsearch_repo.meta.seq_no
@pytest.mark.asyncio
async def test_update_empty_field(async_client: AsyncElasticsearch) -> None:
await Tags._index.delete(ignore_unavailable=True)
await Tags.init()
d = Tags(id="123", tags=["a", "b"])
await d.save(refresh=True)
await d.update(tags=[], refresh=True)
assert d.tags == []
r = await Tags.search().execute()
assert r.hits[0].tags == []
@pytest.mark.asyncio
async def test_save_automatically_uses_seq_no_and_primary_term(
async_data_client: AsyncElasticsearch,
) -> None:
elasticsearch_repo = await Repository.get("elasticsearch-dsl-py")
assert elasticsearch_repo is not None
elasticsearch_repo.meta.seq_no += 1
with raises(ConflictError):
await elasticsearch_repo.save()
@pytest.mark.asyncio
async def test_delete_automatically_uses_seq_no_and_primary_term(
async_data_client: AsyncElasticsearch,
) -> None:
elasticsearch_repo = await Repository.get("elasticsearch-dsl-py")
assert elasticsearch_repo is not None
elasticsearch_repo.meta.seq_no += 1
with raises(ConflictError):
await elasticsearch_repo.delete()
def assert_doc_equals(expected: Any, actual: Any) -> None:
for f in expected:
assert f in actual
assert actual[f] == expected[f]
@pytest.mark.asyncio
async def test_can_save_to_different_index(
async_write_client: AsyncElasticsearch,
) -> None:
test_repo = Repository(description="testing", meta={"id": 42})
assert await test_repo.save(index="test-document")
assert_doc_equals(
{
"found": True,
"_index": "test-document",
"_id": "42",
"_source": {"description": "testing"},
},
await async_write_client.get(index="test-document", id=42),
)
@pytest.mark.asyncio
async def test_save_without_skip_empty_will_include_empty_fields(
async_write_client: AsyncElasticsearch,
) -> None:
test_repo = Repository(field_1=[], field_2=None, field_3={}, meta={"id": 42})
assert await test_repo.save(index="test-document", skip_empty=False)
assert_doc_equals(
{
"found": True,
"_index": "test-document",
"_id": "42",
"_source": {"field_1": [], "field_2": None, "field_3": {}},
},
await async_write_client.get(index="test-document", id=42),
)
@pytest.mark.asyncio
async def test_delete(async_write_client: AsyncElasticsearch) -> None:
await async_write_client.create(
index="test-document",
id="elasticsearch-dsl-py",
body={
"organization": "elasticsearch",
"created_at": "2014-03-03",
"owner": {"name": "elasticsearch"},
},
)
test_repo = Repository(meta={"id": "elasticsearch-dsl-py"})
test_repo.meta.index = "test-document"
await test_repo.delete()
assert not await async_write_client.exists(
index="test-document",
id="elasticsearch-dsl-py",
)
@pytest.mark.asyncio
async def test_search(async_data_client: AsyncElasticsearch) -> None:
assert await Repository.search().count() == 1
@pytest.mark.asyncio
async def test_search_returns_proper_doc_classes(
async_data_client: AsyncElasticsearch,
) -> None:
result = await Repository.search().execute()
elasticsearch_repo = result.hits[0]
assert isinstance(elasticsearch_repo, Repository)
assert elasticsearch_repo.owner.name == "elasticsearch"
@pytest.mark.asyncio
async def test_refresh_mapping(async_data_client: AsyncElasticsearch) -> None:
class Commit(AsyncDocument):
class Index:
name = "git"
await Commit._index.load_mappings()
assert "stats" in Commit._index._mapping
assert "committer" in Commit._index._mapping
assert "description" in Commit._index._mapping
assert "committed_date" in Commit._index._mapping
assert isinstance(Commit._index._mapping["committed_date"], Date)
@pytest.mark.asyncio
async def test_highlight_in_meta(async_data_client: AsyncElasticsearch) -> None:
commit = (
await Commit.search()
.query("match", description="inverting")
.highlight("description")
.execute()
)[0]
assert isinstance(commit, Commit)
assert "description" in commit.meta.highlight
assert isinstance(commit.meta.highlight["description"], AttrList)
assert len(commit.meta.highlight["description"]) > 0
@pytest.mark.asyncio
async def test_bulk(async_data_client: AsyncElasticsearch) -> None:
class Address(InnerDoc):
street: str
active: bool
class Doc(AsyncDocument):
if TYPE_CHECKING:
_id: int
name: str
age: int
languages: List[str] = mapped_field(Keyword())
addresses: List[Address]
class Index:
name = "bulk-index"
await Doc._index.delete(ignore_unavailable=True)
await Doc.init()
async def gen1() -> AsyncIterator[Union[Doc, Dict[str, Any]]]:
yield Doc(
name="Joe",
age=33,
languages=["en", "fr"],
addresses=[
Address(street="123 Main St", active=True),
Address(street="321 Park Dr.", active=False),
],
)
yield Doc(name="Susan", age=20, languages=["en"])
yield {"_op_type": "create", "_id": "45", "_source": Doc(name="Sarah", age=45)}
await Doc.bulk(gen1(), refresh=True)
docs = list(await Doc.search().execute())
assert len(docs) == 3
assert docs[0].to_dict() == {
"name": "Joe",
"age": 33,
"languages": [
"en",
"fr",
],
"addresses": [
{
"active": True,
"street": "123 Main St",
},
{
"active": False,
"street": "321 Park Dr.",
},
],
}
assert docs[1].to_dict() == {
"name": "Susan",
"age": 20,
"languages": ["en"],
}
assert docs[2].to_dict() == {
"name": "Sarah",
"age": 45,
}
assert docs[2].meta.id == "45"
async def gen2() -> AsyncIterator[Union[Doc, Dict[str, Any]]]:
yield {"_op_type": "create", "_id": "45", "_source": Doc(name="Sarah", age=45)}
# a "create" action with an existing id should fail
with raises(BulkIndexError):
await Doc.bulk(gen2(), refresh=True)
async def gen3() -> AsyncIterator[Union[Doc, Dict[str, Any]]]:
yield Doc(_id="45", name="Sarah", age=45, languages=["es"])
yield {"_op_type": "delete", "_id": docs[1].meta.id}
await Doc.bulk(gen3(), refresh=True)
with raises(NotFoundError):
await Doc.get(docs[1].meta.id)
doc = await Doc.get("45")
assert doc is not None
assert (doc).to_dict() == {
"name": "Sarah",
"age": 45,
"languages": ["es"],
}
@pytest.mark.asyncio
async def test_legacy_dense_vector(
async_client: AsyncElasticsearch, es_version: Tuple[int, ...]
) -> None:
if es_version >= (8, 16):
pytest.skip("this test is a legacy version for Elasticsearch 8.15 or older")
class Doc(AsyncDocument):
float_vector: List[float] = mapped_field(DenseVector(dims=3))
class Index:
name = "vectors"
await Doc._index.delete(ignore_unavailable=True)
await Doc.init()
doc = Doc(float_vector=[1.0, 1.2, 2.3])
await doc.save(refresh=True)
docs = await Doc.search().execute()
assert len(docs) == 1
assert docs[0].float_vector == doc.float_vector
@pytest.mark.asyncio
async def test_dense_vector(
async_client: AsyncElasticsearch, es_version: Tuple[int, ...]
) -> None:
if es_version < (8, 16):
pytest.skip("this test requires Elasticsearch 8.16 or newer")
class Doc(AsyncDocument):
float_vector: List[float] = mapped_field(DenseVector())
byte_vector: List[int] = mapped_field(DenseVector(element_type="byte"))
bit_vector: str = mapped_field(DenseVector(element_type="bit"))
class Index:
name = "vectors"
await Doc._index.delete(ignore_unavailable=True)
await Doc.init()
doc = Doc(
float_vector=[1.0, 1.2, 2.3], byte_vector=[12, 23, 34, 45], bit_vector="12abf0"
)
await doc.save(refresh=True)
docs = await Doc.search().execute()
assert len(docs) == 1
assert docs[0].float_vector == doc.float_vector
assert docs[0].byte_vector == doc.byte_vector
assert docs[0].bit_vector == doc.bit_vector
@pytest.mark.asyncio
async def test_copy_to(async_client: AsyncElasticsearch) -> None:
class Person(AsyncDocument):
first_name: M[str] = mapped_field(Text(copy_to=["full_name", "all"]))
last_name: M[str] = mapped_field(Text(copy_to=["full_name", "all"]))
birth_place: M[str] = mapped_field(Text(copy_to="all"))
full_name: M[Optional[str]] = mapped_field(init=False)
all: M[Optional[str]] = mapped_field(init=False)
class Index:
name = "people"
await Person._index.delete(ignore_unavailable=True)
await Person.init()
person = Person(first_name="Jane", last_name="Doe", birth_place="Springfield")
await person.save()
await Person._index.refresh()
match = (
await Person.search()
.query(Match(Person.full_name, MatchQuery(query="Jane")))
.execute()
)
assert len(match) == 1
match = (
await Person.search()
.query(Match(Person.all, MatchQuery(query="Doe")))
.execute()
)
assert len(match) == 1
match = (
await Person.search()
.query(Match(Person.full_name, MatchQuery(query="Springfield")))
.execute()
)
assert len(match) == 0
match = (
await Person.search()
.query(Match(Person.all, MatchQuery(query="Springfield")))
.execute()
)
assert len(match) == 1
|