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
|
# 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.
import json
from datetime import datetime, timedelta
from unittest.mock import call, patch
import pytest
from dateutil import tz
from elastic_transport import ApiResponseMeta, ObjectApiResponse
from elasticsearch import ApiError, helpers
from elasticsearch.helpers import ScanError
class FailingBulkClient:
def __init__(
self,
client,
fail_at=(2,),
fail_with=ApiError(
message="Error!",
body={},
meta=ApiResponseMeta(
status=599, headers={}, http_version="1.1", duration=0, node=None
),
),
):
self.client = client
self._otel = client._otel
self._called = 0
self._fail_at = fail_at
self.transport = client.transport
self._fail_with = fail_with
def bulk(self, *args, **kwargs):
self._called += 1
if self._called in self._fail_at:
raise self._fail_with
return self.client.bulk(*args, **kwargs)
def options(self, **kwargs) -> "FailingBulkClient":
return self
def test_bulk_actions_remain_unchanged(sync_client):
actions = [{"_id": 1}, {"_id": 2}]
for ok, item in helpers.streaming_bulk(sync_client, actions, index="test-index"):
assert ok
assert [{"_id": 1}, {"_id": 2}] == actions
def test_bulk_all_documents_get_inserted(sync_client):
docs = [{"answer": x, "_id": x} for x in range(100)]
for ok, item in helpers.streaming_bulk(
sync_client, docs, index="test-index", refresh=True
):
assert ok
assert 100 == sync_client.count(index="test-index")["count"]
assert {"answer": 42} == sync_client.get(index="test-index", id=42)["_source"]
def test_bulk_all_errors_from_chunk_are_raised_on_failure(sync_client):
sync_client.indices.create(
index="i",
body={
"mappings": {"properties": {"a": {"type": "integer"}}},
"settings": {"number_of_shards": 1, "number_of_replicas": 0},
},
)
try:
for ok, _ in helpers.streaming_bulk(
sync_client, [{"a": "b"}, {"a": "c"}], index="i", raise_on_error=True
):
assert ok
except helpers.BulkIndexError as e:
assert 2 == len(e.errors)
else:
assert False, "exception should have been raised"
def test_bulk_different_op_types(sync_client):
sync_client.index(index="i", id=45, body={})
sync_client.index(index="i", id=42, body={})
docs = [
{"_index": "i", "_id": 47, "f": "v"},
{"_op_type": "delete", "_index": "i", "_id": 45},
{"_op_type": "update", "_index": "i", "_id": 42, "doc": {"answer": 42}},
]
for ok, item in helpers.streaming_bulk(sync_client, docs):
assert ok
assert not sync_client.exists(index="i", id=45)
assert {"answer": 42} == sync_client.get(index="i", id=42)["_source"]
assert {"f": "v"} == sync_client.get(index="i", id=47)["_source"]
def test_bulk_transport_error_can_becaught(sync_client):
failing_client = FailingBulkClient(sync_client)
docs = [
{"_index": "i", "_id": 47, "f": "v"},
{"_index": "i", "_id": 45, "f": "v"},
{"_index": "i", "_id": 42, "f": "v"},
]
results = list(
helpers.streaming_bulk(
failing_client,
docs,
raise_on_exception=False,
raise_on_error=False,
chunk_size=1,
)
)
assert 3 == len(results)
assert [True, False, True] == [r[0] for r in results]
exc = results[1][1]["index"].pop("exception")
assert isinstance(exc, ApiError)
assert 599 == exc.status_code
assert {
"index": {
"_index": "i",
"_id": 45,
"data": {"f": "v"},
"error": "ApiError(599, 'Error!')",
"status": 599,
}
} == results[1][1]
def test_bulk_rejected_documents_are_retried(sync_client):
failing_client = FailingBulkClient(
sync_client,
fail_with=ApiError(
message="Rejected!",
body={},
meta=ApiResponseMeta(
status=429, headers={}, http_version="1.1", duration=0, node=None
),
),
)
docs = [
{"_index": "i", "_id": 47, "f": "v"},
{"_index": "i", "_id": 45, "f": "v"},
{"_index": "i", "_id": 42, "f": "v"},
]
results = list(
helpers.streaming_bulk(
failing_client,
docs,
index="i",
raise_on_exception=False,
raise_on_error=False,
chunk_size=1,
max_retries=1,
initial_backoff=0,
)
)
assert 3 == len(results)
print(results)
assert [True, True, True] == [r[0] for r in results]
sync_client.indices.refresh(index="i")
res = sync_client.search(index="i")
assert {"value": 3, "relation": "eq"} == res["hits"]["total"]
assert 4 == failing_client._called
@pytest.mark.parametrize("use_bytes", [False, True])
def test_bulk_rejected_documents_are_retried_when_bytes_or_string(
sync_client, use_bytes
):
failing_client = FailingBulkClient(
sync_client,
fail_with=ApiError(
message="Rejected!",
body={},
meta=ApiResponseMeta(
status=429, headers={}, http_version="1.1", duration=0, node=None
),
),
)
docs = [json.dumps({"field": x}, separators=(",", ":")) for x in range(3)]
if use_bytes:
docs = [doc.encode() for doc in docs]
results = list(
helpers.streaming_bulk(
failing_client,
docs,
index="i",
raise_on_exception=False,
raise_on_error=False,
chunk_size=1,
max_retries=1,
initial_backoff=0,
)
)
assert 3 == len(results)
assert [True, True, True] == [r[0] for r in results]
sync_client.indices.refresh(index="i")
res = sync_client.search(index="i")
assert {"value": 3, "relation": "eq"} == res["hits"]["total"]
assert 4 == failing_client._called
def test_bulk_rejected_documents_are_retried_at_most_max_retries_times(sync_client):
failing_client = FailingBulkClient(
sync_client,
fail_at=(1, 2),
fail_with=ApiError(
message="Rejected!",
body={},
meta=ApiResponseMeta(
status=429, headers={}, http_version="1.1", duration=0, node=None
),
),
)
docs = [
{"_index": "i", "_id": 47, "f": "v"},
{"_index": "i", "_id": 45, "f": "v"},
{"_index": "i", "_id": 42, "f": "v"},
]
results = list(
helpers.streaming_bulk(
failing_client,
docs,
raise_on_exception=False,
raise_on_error=False,
chunk_size=1,
max_retries=1,
initial_backoff=0,
)
)
assert 3 == len(results)
assert [False, True, True] == [r[0] for r in results]
sync_client.indices.refresh(index="i")
res = sync_client.search(index="i")
assert {"value": 2, "relation": "eq"} == res["hits"]["total"]
assert 4 == failing_client._called
def test_bulk_transport_error_is_raised_with_max_retries(sync_client):
failing_client = FailingBulkClient(
sync_client,
fail_at=(1, 2, 3, 4),
fail_with=ApiError(
message="Rejected!",
body={},
meta=ApiResponseMeta(
status=429, headers={}, http_version="1.1", duration=0, node=None
),
),
)
def streaming_bulk():
results = list(
helpers.streaming_bulk(
failing_client,
[{"a": 42}, {"a": 39}],
raise_on_exception=True,
max_retries=3,
initial_backoff=0,
)
)
return results
with pytest.raises(ApiError):
streaming_bulk()
assert 4 == failing_client._called
def test_connection_timeout_is_retried_with_retry_status_callback(sync_client):
failing_client = FailingBulkClient(
sync_client,
fail_with=ApiError(
message="Connection timed out!",
body={},
meta=ApiResponseMeta(
status=522, headers={}, http_version="1.1", duration=0, node=None
),
),
)
docs = [
{"_index": "i", "_id": 47, "f": "v"},
{"_index": "i", "_id": 45, "f": "v"},
{"_index": "i", "_id": 42, "f": "v"},
]
results = list(
helpers.streaming_bulk(
failing_client,
docs,
index="i",
raise_on_exception=False,
raise_on_error=False,
chunk_size=1,
retry_on_status=522,
max_retries=1,
initial_backoff=0,
)
)
assert 3 == len(results)
print(results)
assert [True, True, True] == [r[0] for r in results]
sync_client.indices.refresh(index="i")
res = sync_client.search(index="i")
assert {"value": 3, "relation": "eq"} == res["hits"]["total"]
assert 4 == failing_client._called
def test_bulk_works_with_single_item(sync_client):
docs = [{"answer": 42, "_id": 1}]
success, failed = helpers.bulk(sync_client, docs, index="test-index", refresh=True)
assert 1 == success
assert not failed
assert 1 == sync_client.count(index="test-index")["count"]
assert {"answer": 42} == sync_client.get(index="test-index", id=1)["_source"]
def test_all_documents_get_inserted(sync_client):
docs = [{"answer": x, "_id": x} for x in range(100)]
success, failed = helpers.bulk(sync_client, docs, index="test-index", refresh=True)
assert 100 == success
assert not failed
assert 100 == sync_client.count(index="test-index")["count"]
assert {"answer": 42} == sync_client.get(index="test-index", id=42)["_source"]
def test_stats_only_reports_numbers(sync_client):
docs = [{"answer": x} for x in range(100)]
success, failed = helpers.bulk(
sync_client, docs, index="test-index", refresh=True, stats_only=True
)
assert 100 == success
assert 0 == failed
assert 100 == sync_client.count(index="test-index")["count"]
def test_errors_are_reported_correctly(sync_client):
sync_client.indices.create(
index="i",
mappings={"properties": {"a": {"type": "integer"}}},
settings={"number_of_shards": 1, "number_of_replicas": 0},
)
success, failed = helpers.bulk(
sync_client,
[{"a": 42}, {"a": "c", "_id": 42}],
index="i",
raise_on_error=False,
)
assert 1 == success
assert 1 == len(failed)
error = failed[0]
assert "42" == error["index"]["_id"]
assert "i" == error["index"]["_index"]
print(error["index"]["error"])
assert error["index"]["error"]["type"] == "document_parsing_exception"
def test_error_is_raised(sync_client):
sync_client.indices.create(
index="i",
mappings={"properties": {"a": {"type": "integer"}}},
settings={"number_of_shards": 1, "number_of_replicas": 0},
)
with pytest.raises(helpers.BulkIndexError):
helpers.bulk(
sync_client,
[{"a": 42}, {"a": "c"}],
index="i",
)
def test_ignore_error_if_raised(sync_client):
# ignore the status code 400 in tuple
helpers.bulk(sync_client, [{"a": 42}, {"a": "c"}], index="i", ignore_status=(400,))
# ignore the status code 400 in list
helpers.bulk(
sync_client,
[{"a": 42}, {"a": "c"}],
index="i",
ignore_status=[
400,
],
)
# ignore the status code 400
helpers.bulk(sync_client, [{"a": 42}, {"a": "c"}], index="i", ignore_status=400)
# ignore only the status code in the `ignore_status` argument
with pytest.raises(helpers.BulkIndexError):
helpers.bulk(
sync_client,
[{"a": 42}, {"a": "c"}],
index="i",
ignore_status=(444,),
)
# ignore transport error exception
failing_client = FailingBulkClient(sync_client)
helpers.bulk(failing_client, [{"a": 42}], index="i", ignore_status=(599,))
def test_errors_are_collected_properly(sync_client):
sync_client.indices.create(
index="i",
mappings={"properties": {"a": {"type": "integer"}}},
settings={"number_of_shards": 1, "number_of_replicas": 0},
)
success, failed = helpers.bulk(
sync_client,
[{"a": 42}, {"a": "c"}],
index="i",
stats_only=True,
raise_on_error=False,
)
assert 1 == success
assert 1 == failed
mock_scroll_responses = [
ObjectApiResponse(
meta=None,
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 4, "total": 5, "skipped": 0},
"hits": {"hits": [{"scroll_data": 42}]},
},
),
ObjectApiResponse(
meta=None,
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 4, "total": 5, "skipped": 0},
"hits": {"hits": []},
},
),
]
@pytest.fixture(scope="function")
def scan_teardown(sync_client):
yield
sync_client.clear_scroll(scroll_id="_all")
@pytest.mark.usefixtures("scan_teardown")
def test_order_can_be_preserved(sync_client):
bulk = []
for x in range(100):
bulk.append({"index": {"_index": "test_index", "_id": x}})
bulk.append({"answer": x, "correct": x == 42})
sync_client.bulk(operations=bulk, refresh=True)
docs = list(
helpers.scan(
sync_client,
index="test_index",
query={"sort": "answer"},
preserve_order=True,
)
)
assert 100 == len(docs)
assert list(map(str, range(100))) == list(d["_id"] for d in docs)
assert list(range(100)) == list(d["_source"]["answer"] for d in docs)
@pytest.mark.usefixtures("scan_teardown")
def test_all_documents_are_read(sync_client):
bulk = []
for x in range(100):
bulk.append({"index": {"_index": "test_index", "_id": x}})
bulk.append({"answer": x, "correct": x == 42})
sync_client.bulk(operations=bulk, refresh=True)
docs = list(helpers.scan(sync_client, index="test_index", size=2))
assert 100 == len(docs)
assert set(map(str, range(100))) == {d["_id"] for d in docs}
assert set(range(100)) == {d["_source"]["answer"] for d in docs}
@pytest.mark.usefixtures("scan_teardown")
def test_scroll_error(sync_client):
bulk = []
for x in range(4):
bulk.append({"index": {"_index": "test_index"}})
bulk.append({"value": x})
sync_client.bulk(operations=bulk, refresh=True)
with (
patch.object(sync_client, "options", return_value=sync_client),
patch.object(sync_client, "scroll") as scroll_mock,
):
scroll_mock.side_effect = mock_scroll_responses
data = list(
helpers.scan(
sync_client,
index="test_index",
size=2,
raise_on_error=False,
clear_scroll=False,
)
)
assert len(data) == 3
assert data[-1] == {"scroll_data": 42}
scroll_mock.side_effect = mock_scroll_responses
with pytest.raises(ScanError):
data = list(
helpers.scan(
sync_client,
index="test_index",
size=2,
raise_on_error=True,
clear_scroll=False,
)
)
assert len(data) == 3
assert data[-1] == {"scroll_data": 42}
def test_initial_search_error(sync_client):
with (
patch.object(
sync_client,
"search",
return_value=ObjectApiResponse(
meta=None,
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 4, "total": 5, "skipped": 0},
"hits": {"hits": [{"search_data": 1}]},
},
),
),
patch.object(sync_client, "options", return_value=sync_client),
):
with (
patch.object(sync_client, "scroll") as scroll_mock,
patch.object(sync_client, "clear_scroll") as clear_scroll_mock,
):
scroll_mock.side_effect = mock_scroll_responses
data = list(
helpers.scan(
sync_client, index="test_index", size=2, raise_on_error=False
)
)
assert data == [{"search_data": 1}, {"scroll_data": 42}]
# Scrolled at least once and received a scroll_id to clear.
scroll_mock.assert_called_with(
scroll_id="dummy_id",
scroll="5m",
)
clear_scroll_mock.assert_called_once_with(
scroll_id="dummy_id",
)
with (
patch.object(sync_client, "scroll") as scroll_mock,
patch.object(sync_client, "clear_scroll") as clear_scroll_mock,
):
scroll_mock.side_effect = mock_scroll_responses
with pytest.raises(ScanError):
data = list(
helpers.scan(
sync_client, index="test_index", size=2, raise_on_error=True
)
)
assert data == [{"search_data": 1}]
# Never scrolled but did receive a scroll_id to clear.
scroll_mock.assert_not_called()
clear_scroll_mock.assert_called_once_with(
scroll_id="dummy_id",
)
def test_no_scroll_id_fast_route(sync_client):
with (
patch.object(
sync_client,
"search",
return_value=ObjectApiResponse(meta=None, raw={"no": "_scroll_id"}),
) as search_mock,
patch.object(sync_client, "scroll") as scroll_mock,
patch.object(sync_client, "clear_scroll") as clear_scroll_mock,
patch.object(sync_client, "options", return_value=sync_client) as options,
):
data = list(helpers.scan(sync_client, index="test_index"))
assert data == []
search_mock.assert_called_once_with(
sort="_doc",
scroll="5m",
size=1000,
index="test_index",
)
options.assert_called_once_with(request_timeout=None)
scroll_mock.assert_not_called()
clear_scroll_mock.assert_not_called()
@pytest.mark.parametrize(
"kwargs",
[
{"api_key": ("name", "value")},
{"http_auth": ("username", "password")},
{"basic_auth": ("username", "password")},
{"bearer_auth": "token"},
{"headers": {"custom", "header"}},
],
)
@pytest.mark.usefixtures("scan_teardown")
def test_scan_auth_kwargs_forwarded(sync_client, kwargs):
((key, val),) = kwargs.items()
with (
patch.object(sync_client, "options", return_value=sync_client) as options,
patch.object(
sync_client,
"search",
return_value=ObjectApiResponse(
meta=None,
raw={
"_scroll_id": "scroll_id",
"_shards": {"successful": 5, "total": 5, "skipped": 0},
"hits": {"hits": [{"search_data": 1}]},
},
),
),
patch.object(
sync_client,
"scroll",
return_value=ObjectApiResponse(
meta=None,
raw={
"_scroll_id": "scroll_id",
"_shards": {"successful": 5, "total": 5, "skipped": 0},
"hits": {"hits": []},
},
),
),
patch.object(
sync_client,
"clear_scroll",
return_value=ObjectApiResponse(meta=None, raw={}),
),
):
data = list(helpers.scan(sync_client, index="test_index", **kwargs))
assert data == [{"search_data": 1}]
assert options.call_args_list == [
call(
request_timeout=None, **{key if key != "http_auth" else "basic_auth": val}
),
call(ignore_status=404),
]
def test_scan_auth_kwargs_favor_scroll_kwargs_option(sync_client):
with (
patch.object(sync_client, "options", return_value=sync_client) as options_mock,
patch.object(
sync_client,
"search",
return_value=ObjectApiResponse(
raw={
"_scroll_id": "scroll_id",
"_shards": {"successful": 5, "total": 5, "skipped": 0},
"hits": {"hits": [{"search_data": 1}]},
},
meta=None,
),
) as search_mock,
patch.object(
sync_client,
"scroll",
return_value=ObjectApiResponse(
raw={
"_scroll_id": "scroll_id",
"_shards": {"successful": 5, "total": 5, "skipped": 0},
"hits": {"hits": []},
},
meta=None,
),
) as scroll_mock,
patch.object(
sync_client,
"clear_scroll",
return_value=ObjectApiResponse(raw={}, meta=None),
),
):
data = list(
helpers.scan(
sync_client,
index="test_index",
scroll_kwargs={"headers": {"scroll": "kwargs"}, "sort": "asc"},
headers={"not scroll": "kwargs"},
)
)
assert data == [{"search_data": 1}]
# Assert that we see 'scroll_kwargs' options used instead of 'kwargs'
assert options_mock.call_args_list == [
call(request_timeout=None, headers={"not scroll": "kwargs"}),
call(headers={"scroll": "kwargs"}),
call(ignore_status=404),
]
search_mock.assert_called_once_with(
sort="_doc", index="test_index", scroll="5m", size=1000
)
scroll_mock.assert_called_once_with(
scroll_id="scroll_id", scroll="5m", sort="asc"
)
def test_log_warning_on_shard_failures(sync_client):
bulk = []
for x in range(4):
bulk.append({"index": {"_index": "test_index"}})
bulk.append({"value": x})
sync_client.bulk(operations=bulk, refresh=True)
with (
patch("elasticsearch.helpers.actions.logger") as logger_mock,
patch.object(sync_client, "options", return_value=sync_client),
patch.object(sync_client, "scroll") as scroll_mock,
):
scroll_mock.side_effect = mock_scroll_responses
list(
helpers.scan(
sync_client,
index="test_index",
size=2,
raise_on_error=False,
clear_scroll=False,
)
)
logger_mock.warning.assert_called()
scroll_mock.side_effect = mock_scroll_responses
try:
list(
helpers.scan(
sync_client,
index="test_index",
size=2,
raise_on_error=True,
clear_scroll=False,
)
)
except ScanError:
pass
logger_mock.warning.assert_called()
def test_clear_scroll(sync_client):
bulk = []
for x in range(4):
bulk.append({"index": {"_index": "test_index"}})
bulk.append({"value": x})
sync_client.bulk(operations=bulk, refresh=True)
with (
patch.object(sync_client, "options", return_value=sync_client),
patch.object(
sync_client, "clear_scroll", wraps=sync_client.clear_scroll
) as clear_scroll_mock,
):
list(helpers.scan(sync_client, index="test_index", size=2))
clear_scroll_mock.assert_called_once()
clear_scroll_mock.reset_mock()
list(helpers.scan(sync_client, index="test_index", size=2, clear_scroll=True))
clear_scroll_mock.assert_called_once()
clear_scroll_mock.reset_mock()
list(helpers.scan(sync_client, index="test_index", size=2, clear_scroll=False))
clear_scroll_mock.assert_not_called()
def test_shards_no_skipped_field(sync_client):
# Test that scan doesn't fail if 'hits.skipped' isn't available.
with (
patch.object(sync_client, "options", return_value=sync_client),
patch.object(
sync_client,
"search",
return_value=ObjectApiResponse(
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 5, "total": 5},
"hits": {"hits": [{"search_data": 1}]},
},
meta=None,
),
),
patch.object(sync_client, "scroll") as scroll_mock,
patch.object(sync_client, "clear_scroll"),
):
scroll_mock.side_effect = [
ObjectApiResponse(
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 5, "total": 5},
"hits": {"hits": [{"scroll_data": 42}]},
},
meta=None,
),
ObjectApiResponse(
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 5, "total": 5},
"hits": {"hits": []},
},
meta=None,
),
]
data = list(
helpers.scan(sync_client, index="test_index", size=2, raise_on_error=True)
)
assert data == [{"search_data": 1}, {"scroll_data": 42}]
@pytest.mark.parametrize(
"scan_kwargs",
[
{"from": 1},
{"from_": 1},
{"query": {"from": 1}},
{"query": {"from_": 1}},
{"query": {"query": {"match_all": {}}}, "from": 1},
{"query": {"query": {"match_all": {}}}, "from_": 1},
],
)
def test_scan_from_keyword_is_aliased(sync_client, scan_kwargs):
with (
patch.object(sync_client, "options", return_value=sync_client),
patch.object(
sync_client,
"search",
return_value=ObjectApiResponse(
raw={
"_scroll_id": "dummy_id",
"_shards": {"successful": 5, "total": 5},
"hits": {"hits": []},
},
meta=None,
),
) as search_mock,
patch.object(sync_client, "clear_scroll"),
):
list(helpers.scan(sync_client, index="test_index", **scan_kwargs))
assert search_mock.call_args[1]["from_"] == 1
assert "from" not in search_mock.call_args[1]
@pytest.fixture(scope="function")
def reindex_setup(sync_client):
bulk = []
for x in range(100):
bulk.append({"index": {"_index": "test_index", "_id": x}})
bulk.append(
{
"answer": x,
"correct": x == 42,
"type": "answers" if x % 2 == 0 else "questions",
}
)
sync_client.bulk(operations=bulk, refresh=True)
@pytest.mark.usefixtures("reindex_setup")
def test_reindex_passes_kwargs_to_scan_and_bulk(sync_client):
helpers.reindex(
sync_client,
"test_index",
"prod_index",
scan_kwargs={"q": "type:answers"},
bulk_kwargs={"refresh": True},
)
assert sync_client.indices.exists(index="prod_index")
assert 50 == sync_client.count(index="prod_index", q="type:answers")["count"]
assert {"answer": 42, "correct": True, "type": "answers"} == sync_client.get(
index="prod_index", id=42
)["_source"]
@pytest.mark.usefixtures("reindex_setup")
def test_reindex_accepts_a_query(sync_client):
helpers.reindex(
sync_client,
"test_index",
"prod_index",
query={"query": {"bool": {"filter": {"term": {"type": "answers"}}}}},
)
sync_client.indices.refresh()
assert sync_client.indices.exists(index="prod_index")
assert 50 == sync_client.count(index="prod_index", q="type:answers")["count"]
assert {"answer": 42, "correct": True, "type": "answers"} == sync_client.get(
index="prod_index", id=42
)["_source"]
@pytest.mark.usefixtures("reindex_setup")
def test_all_documents_get_moved(sync_client):
helpers.reindex(sync_client, "test_index", "prod_index")
sync_client.indices.refresh()
assert sync_client.indices.exists(index="prod_index")
assert 50 == sync_client.count(index="prod_index", q="type:questions")["count"]
assert 50 == sync_client.count(index="prod_index", q="type:answers")["count"]
assert {"answer": 42, "correct": True, "type": "answers"} == sync_client.get(
index="prod_index", id=42
)["_source"]
@pytest.fixture(scope="function")
def parent_child_reindex_setup(sync_client):
body = {
"settings": {"number_of_shards": 1, "number_of_replicas": 0},
"mappings": {
"properties": {
"question_answer": {
"type": "join",
"relations": {"question": "answer"},
}
}
},
}
sync_client.indices.create(index="test-index", body=body)
sync_client.indices.create(index="real-index", body=body)
sync_client.index(index="test-index", id=42, body={"question_answer": "question"})
sync_client.index(
index="test-index",
id=47,
routing=42,
body={"some": "data", "question_answer": {"name": "answer", "parent": 42}},
)
sync_client.indices.refresh(index="test-index")
@pytest.mark.usefixtures("parent_child_reindex_setup")
def test_children_are_reindexed_correctly(sync_client):
helpers.reindex(sync_client, "test-index", "real-index")
q = sync_client.get(index="real-index", id=42)
assert {
"_id": "42",
"_index": "real-index",
"_primary_term": 1,
"_seq_no": 0,
"_source": {"question_answer": "question"},
"_version": 1,
"found": True,
} == q
q = sync_client.get(index="test-index", id=47, routing=42)
assert {
"_routing": "42",
"_id": "47",
"_index": "test-index",
"_primary_term": 1,
"_seq_no": 1,
"_source": {
"some": "data",
"question_answer": {"name": "answer", "parent": 42},
},
"_version": 1,
"found": True,
} == q
@pytest.fixture(scope="function")
def reindex_data_stream_setup(sync_client):
dt = datetime.now(tz=tz.UTC)
bulk = []
for x in range(100):
bulk.append({"index": {"_index": "test_index_stream", "_id": x}})
bulk.append(
{
"answer": x,
"correct": x == 42,
"type": "answers" if x % 2 == 0 else "questions",
"@timestamp": (dt - timedelta(days=x)).isoformat(),
}
)
sync_client.bulk(operations=bulk, refresh=True)
sync_client.indices.put_index_template(
name="my-index-template",
body={
"index_patterns": ["py-*-*"],
"data_stream": {},
},
)
sync_client.indices.create_data_stream(name="py-test-stream")
sync_client.indices.refresh()
@pytest.mark.usefixtures("reindex_data_stream_setup")
@pytest.mark.parametrize("op_type", [None, "create"])
def test_reindex_index_datastream(op_type, sync_client):
helpers.reindex(
sync_client,
source_index="test_index_stream",
target_index="py-test-stream",
query={"query": {"bool": {"filter": {"term": {"type": "answers"}}}}},
op_type=op_type,
)
sync_client.indices.refresh()
assert sync_client.indices.exists(index="py-test-stream")
assert 50 == sync_client.count(index="py-test-stream", q="type:answers")["count"]
@pytest.mark.usefixtures("reindex_data_stream_setup")
def test_reindex_index_datastream_op_type_index(sync_client):
with pytest.raises(
ValueError, match="Data streams must have 'op_type' set to 'create'"
):
helpers.reindex(
sync_client,
source_index="test_index_stream",
target_index="py-test-stream",
query={"query": {"bool": {"filter": {"term": {"type": "answers"}}}}},
op_type="_index",
)
|