-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
api_test.py
633 lines (536 loc) · 26.1 KB
/
api_test.py
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
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
import csv
import io
import logging
import re
from datetime import datetime
from unittest.mock import Mock
import pytest
import requests_mock
from airbyte_cdk.models import AirbyteStream, ConfiguredAirbyteCatalog, ConfiguredAirbyteStream, DestinationSyncMode, SyncMode, Type
from conftest import encoding_symbols_parameters, generate_stream
from requests.exceptions import HTTPError
from source_salesforce.api import Salesforce
from source_salesforce.source import SourceSalesforce
from source_salesforce.streams import (
CSV_FIELD_SIZE_LIMIT,
BulkIncrementalSalesforceStream,
BulkSalesforceStream,
IncrementalRestSalesforceStream,
RestSalesforceStream,
)
def test_bulk_sync_creation_failed(stream_config, stream_api):
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
with requests_mock.Mocker() as m:
m.register_uri("POST", stream.path(), status_code=400, json=[{"message": "test_error"}])
with pytest.raises(HTTPError) as err:
stream_slices = next(iter(stream.stream_slices(sync_mode=SyncMode.incremental)))
next(stream.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slices))
assert err.value.response.json()[0]["message"] == "test_error"
def test_bulk_stream_fallback_to_rest(mocker, requests_mock, stream_config, stream_api):
"""
Here we mock BULK API with response returning error, saying BULK is not supported for this kind of entity.
On the other hand, we mock REST API for this same entity with a successful response.
After having instantiated a BulkStream, sync should succeed in case it falls back to REST API. Otherwise it would throw an error.
"""
stream = generate_stream("CustomEntity", stream_config, stream_api)
# mock a BULK API
requests_mock.register_uri(
"POST",
"https://fase-account.salesforce.com/services/data/v53.0/jobs/query",
status_code=400,
json=[{"errorCode": "INVALIDENTITY", "message": "CustomEntity is not supported by the Bulk API"}],
)
rest_stream_records = [
{"id": 1, "name": "custom entity", "created": "2010-11-11"},
{"id": 11, "name": "custom entity", "created": "2020-01-02"},
]
# mock REST API
mocker.patch("source_salesforce.source.RestSalesforceStream.read_records", lambda *args, **kwargs: iter(rest_stream_records))
assert type(stream) is BulkIncrementalSalesforceStream
stream_slices = next(iter(stream.stream_slices(sync_mode=SyncMode.incremental)))
assert list(stream.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slices)) == rest_stream_records
def test_stream_unsupported_by_bulk(stream_config, stream_api, caplog):
"""
Stream `AcceptedEventRelation` is not supported by BULK API, so that REST API stream will be used for it.
"""
stream_name = "AcceptedEventRelation"
stream = generate_stream(stream_name, stream_config, stream_api)
assert not isinstance(stream, BulkSalesforceStream)
def test_stream_contains_unsupported_properties_by_bulk(stream_config, stream_api_v2):
"""
Stream `Account` contains compound field such as BillingAddress, which is not supported by BULK API (csv),
in that case REST API stream will be used for it.
"""
stream_name = "Account"
stream = generate_stream(stream_name, stream_config, stream_api_v2)
assert not isinstance(stream, BulkSalesforceStream)
@pytest.mark.parametrize("item_number", [0, 15, 2000, 2324, 3000])
def test_bulk_sync_pagination(item_number, stream_config, stream_api):
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
test_ids = [i for i in range(1, item_number)]
pages = [test_ids[i : i + stream.page_size] for i in range(0, len(test_ids), stream.page_size)]
if not pages:
pages = [[]]
with requests_mock.Mocker() as m:
creation_responses = []
for page in range(len(pages)):
job_id = f"fake_job_{page}"
creation_responses.append({"json": {"id": job_id}})
m.register_uri("GET", stream.path() + f"/{job_id}", json={"state": "JobComplete"})
resp = ["Field1,LastModifiedDate,ID"] + [f"test,2021-11-16,{i}" for i in pages[page]]
m.register_uri("GET", stream.path() + f"/{job_id}/results", text="\n".join(resp))
m.register_uri("DELETE", stream.path() + f"/{job_id}")
m.register_uri("POST", stream.path(), creation_responses)
stream_slices = next(iter(stream.stream_slices(sync_mode=SyncMode.incremental)))
loaded_ids = [int(record["ID"]) for record in stream.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slices)]
assert not set(test_ids).symmetric_difference(set(loaded_ids))
post_request_count = len([r for r in m.request_history if r.method == "POST"])
assert post_request_count == len(pages)
def _prepare_mock(m, stream):
job_id = "fake_job_1"
m.register_uri("POST", stream.path(), json={"id": job_id})
m.register_uri("DELETE", stream.path() + f"/{job_id}")
m.register_uri("GET", stream.path() + f"/{job_id}/results", text="Field1,LastModifiedDate,ID\ntest,2021-11-16,1")
m.register_uri("PATCH", stream.path() + f"/{job_id}", text="")
return job_id
def _get_result_id(stream):
stream_slices = next(iter(stream.stream_slices(sync_mode=SyncMode.incremental)))
return int(list(stream.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slices))[0]["ID"])
def test_bulk_sync_successful(stream_config, stream_api):
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
with requests_mock.Mocker() as m:
job_id = _prepare_mock(m, stream)
m.register_uri("GET", stream.path() + f"/{job_id}", [{"json": {"state": "JobComplete"}}])
assert _get_result_id(stream) == 1
def test_bulk_sync_successful_long_response(stream_config, stream_api):
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
with requests_mock.Mocker() as m:
job_id = _prepare_mock(m, stream)
m.register_uri(
"GET",
stream.path() + f"/{job_id}",
[
{"json": {"state": "UploadComplete", "id": job_id}},
{"json": {"state": "InProgress", "id": job_id}},
{"json": {"state": "JobComplete", "id": job_id}},
],
)
assert _get_result_id(stream) == 1
# maximum timeout is wait_timeout * max_retry_attempt
# this test tries to check a job state 17 times with +-1second for very one
@pytest.mark.timeout(17)
def test_bulk_sync_successful_retry(stream_config, stream_api):
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
stream.DEFAULT_WAIT_TIMEOUT_SECONDS = 6 # maximum wait timeout will be 6 seconds
with requests_mock.Mocker() as m:
job_id = _prepare_mock(m, stream)
# 2 failed attempts, 3rd one should be successful
states = [{"json": {"state": "InProgress", "id": job_id}}] * 17
states.append({"json": {"state": "JobComplete", "id": job_id}})
# raise Exception(states)
m.register_uri("GET", stream.path() + f"/{job_id}", states)
assert _get_result_id(stream) == 1
@pytest.mark.timeout(30)
def test_bulk_sync_failed_retry(stream_config, stream_api):
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
stream.DEFAULT_WAIT_TIMEOUT_SECONDS = 6 # maximum wait timeout will be 6 seconds
with requests_mock.Mocker() as m:
job_id = _prepare_mock(m, stream)
m.register_uri("GET", stream.path() + f"/{job_id}", json={"state": "InProgress", "id": job_id})
with pytest.raises(Exception) as err:
stream_slices = next(iter(stream.stream_slices(sync_mode=SyncMode.incremental)))
next(stream.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slices))
assert "stream using BULK API was failed" in str(err.value)
@pytest.mark.parametrize(
"start_date_provided,stream_name,expected_start_date",
[
(True, "Account", "2010-01-18T21:18:20Z"),
(False, "Account", None),
(True, "ActiveFeatureLicenseMetric", "2010-01-18T21:18:20Z"),
(False, "ActiveFeatureLicenseMetric", None),
],
)
def test_stream_start_date(
start_date_provided,
stream_name,
expected_start_date,
stream_config,
stream_api,
stream_config_without_start_date,
):
if start_date_provided:
stream = generate_stream(stream_name, stream_config, stream_api)
assert stream.start_date == expected_start_date
else:
stream = generate_stream(stream_name, stream_config_without_start_date, stream_api)
assert datetime.strptime(stream.start_date, "%Y-%m-%dT%H:%M:%SZ").year == datetime.now().year - 2
def test_stream_start_date_should_be_converted_to_datetime_format(stream_config_date_format, stream_api):
stream: IncrementalRestSalesforceStream = generate_stream("ActiveFeatureLicenseMetric", stream_config_date_format, stream_api)
assert stream.start_date == "2010-01-18T00:00:00Z"
def test_stream_start_datetime_format_should_not_changed(stream_config, stream_api):
stream: IncrementalRestSalesforceStream = generate_stream("ActiveFeatureLicenseMetric", stream_config, stream_api)
assert stream.start_date == "2010-01-18T21:18:20Z"
def test_download_data_filter_null_bytes(stream_config, stream_api):
job_full_url: str = "https://fase-account.salesforce.com/services/data/v53.0/jobs/query/7504W00000bkgnpQAA"
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
with requests_mock.Mocker() as m:
m.register_uri("GET", f"{job_full_url}/results", content=b"\x00")
res = list(stream.read_with_chunks(*stream.download_data(url=job_full_url)))
assert res == []
m.register_uri("GET", f"{job_full_url}/results", content=b'"Id","IsDeleted"\n\x00"0014W000027f6UwQAI","false"\n\x00\x00')
res = list(stream.read_with_chunks(*stream.download_data(url=job_full_url)))
assert res == [{"Id": "0014W000027f6UwQAI", "IsDeleted": False}]
@pytest.mark.parametrize(
"chunk_size, content_type, content, expected_result",
encoding_symbols_parameters(),
ids=[f"charset: {x[1]}, chunk_size: {x[0]}" for x in encoding_symbols_parameters()],
)
def test_encoding_symbols(stream_config, stream_api, chunk_size, content_type, content, expected_result):
job_full_url: str = "https://fase-account.salesforce.com/services/data/v53.0/jobs/query/7504W00000bkgnpQAA"
stream: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
with requests_mock.Mocker() as m:
m.register_uri("GET", f"{job_full_url}/results", headers={"Content-Type": f"text/html; charset={content_type}"}, content=content)
res = list(stream.read_with_chunks(*stream.download_data(url=job_full_url, chunk_size=chunk_size)))
assert res == expected_result
@pytest.mark.parametrize(
"login_status_code, login_json_resp, discovery_status_code, discovery_resp_json, expected_error_msg",
(
(403, [{"errorCode": "REQUEST_LIMIT_EXCEEDED", "message": "TotalRequests Limit exceeded."}], 200, {}, "API Call limit is exceeded"),
(
200,
{"access_token": "access_token", "instance_url": "https://instance_url"},
403,
[{"errorCode": "FORBIDDEN", "message": "You do not have enough permissions"}],
'An error occurred: [{"errorCode": "FORBIDDEN", "message": "You do not have enough permissions"}]',
),
),
)
def test_check_connection_rate_limit(
stream_config, login_status_code, login_json_resp, discovery_status_code, discovery_resp_json, expected_error_msg
):
source = SourceSalesforce()
logger = logging.getLogger("airbyte")
with requests_mock.Mocker() as m:
m.register_uri("POST", "https://login.salesforce.com/services/oauth2/token", json=login_json_resp, status_code=login_status_code)
m.register_uri(
"GET", "https://instance_url/services/data/v53.0/sobjects", json=discovery_resp_json, status_code=discovery_status_code
)
result, msg = source.check_connection(logger, stream_config)
assert result is False
assert msg == expected_error_msg
def configure_request_params_mock(stream_1, stream_2):
stream_1.request_params = Mock()
stream_1.request_params.return_value = {"q": "query"}
stream_2.request_params = Mock()
stream_2.request_params.return_value = {"q": "query"}
def test_rate_limit_bulk(stream_config, stream_api, bulk_catalog, state):
"""
Connector should stop the sync if one stream reached rate limit
stream_1, stream_2, stream_3, ...
While reading `stream_1` if 403 (Rate Limit) is received, it should finish that stream with success and stop the sync process.
Next streams should not be executed.
"""
stream_1: BulkIncrementalSalesforceStream = generate_stream("Account", stream_config, stream_api)
stream_2: BulkIncrementalSalesforceStream = generate_stream("Asset", stream_config, stream_api)
streams = [stream_1, stream_2]
configure_request_params_mock(stream_1, stream_2)
stream_1.page_size = 6
stream_1.state_checkpoint_interval = 5
source = SourceSalesforce()
source.streams = Mock()
source.streams.return_value = streams
logger = logging.getLogger("airbyte")
json_response = [{"errorCode": "REQUEST_LIMIT_EXCEEDED", "message": "TotalRequests Limit exceeded."}]
with requests_mock.Mocker() as m:
for stream in streams:
creation_responses = []
for page in [1, 2]:
job_id = f"fake_job_{page}_{stream.name}"
creation_responses.append({"json": {"id": job_id}})
m.register_uri("GET", stream.path() + f"/{job_id}", json={"state": "JobComplete"})
resp = ["Field1,LastModifiedDate,Id"] + [f"test,2021-11-0{i},{i}" for i in range(1, 7)] # 6 records per page
if page == 1:
# Read the first page successfully
m.register_uri("GET", stream.path() + f"/{job_id}/results", text="\n".join(resp))
else:
# Requesting for results when reading second page should fail with 403 (Rate Limit error)
m.register_uri("GET", stream.path() + f"/{job_id}/results", status_code=403, json=json_response)
m.register_uri("DELETE", stream.path() + f"/{job_id}")
m.register_uri("POST", stream.path(), creation_responses)
result = [i for i in source.read(logger=logger, config=stream_config, catalog=bulk_catalog, state=state)]
assert stream_1.request_params.called
assert (
not stream_2.request_params.called
), "The second stream should not be executed, because the first stream finished with Rate Limit."
records = [item for item in result if item.type == Type.RECORD]
assert len(records) == 6 # stream page size: 6
state_record = [item for item in result if item.type == Type.STATE][0]
assert state_record.state.data["Account"]["LastModifiedDate"] == "2021-11-05" # state checkpoint interval is 5.
def test_rate_limit_rest(stream_config, stream_api, rest_catalog, state):
"""
Connector should stop the sync if one stream reached rate limit
stream_1, stream_2, stream_3, ...
While reading `stream_1` if 403 (Rate Limit) is received, it should finish that stream with success and stop the sync process.
Next streams should not be executed.
"""
stream_1: IncrementalRestSalesforceStream = generate_stream("KnowledgeArticle", stream_config, stream_api)
stream_2: IncrementalRestSalesforceStream = generate_stream("AcceptedEventRelation", stream_config, stream_api)
stream_1.state_checkpoint_interval = 3
configure_request_params_mock(stream_1, stream_2)
source = SourceSalesforce()
source.streams = Mock()
source.streams.return_value = [stream_1, stream_2]
logger = logging.getLogger("airbyte")
next_page_url = "/services/data/v53.0/query/012345"
response_1 = {
"done": False,
"totalSize": 10,
"nextRecordsUrl": next_page_url,
"records": [
{
"ID": 1,
"LastModifiedDate": "2021-11-15",
},
{
"ID": 2,
"LastModifiedDate": "2021-11-16",
},
{
"ID": 3,
"LastModifiedDate": "2021-11-17", # check point interval
},
{
"ID": 4,
"LastModifiedDate": "2021-11-18",
},
{
"ID": 5,
"LastModifiedDate": "2021-11-19",
},
],
}
response_2 = [{"errorCode": "REQUEST_LIMIT_EXCEEDED", "message": "TotalRequests Limit exceeded."}]
with requests_mock.Mocker() as m:
m.register_uri("GET", stream_1.path(), json=response_1, status_code=200)
m.register_uri("GET", next_page_url, json=response_2, status_code=403)
result = [i for i in source.read(logger=logger, config=stream_config, catalog=rest_catalog, state=state)]
assert stream_1.request_params.called
assert (
not stream_2.request_params.called
), "The second stream should not be executed, because the first stream finished with Rate Limit."
records = [item for item in result if item.type == Type.RECORD]
assert len(records) == 5
state_record = [item for item in result if item.type == Type.STATE][0]
assert state_record.state.data["KnowledgeArticle"]["LastModifiedDate"] == "2021-11-17"
def test_pagination_rest(stream_config, stream_api):
stream_name = "AcceptedEventRelation"
stream: RestSalesforceStream = generate_stream(stream_name, stream_config, stream_api)
stream.DEFAULT_WAIT_TIMEOUT_SECONDS = 6 # maximum wait timeout will be 6 seconds
next_page_url = "/services/data/v53.0/query/012345"
with requests_mock.Mocker() as m:
resp_1 = {
"done": False,
"totalSize": 4,
"nextRecordsUrl": next_page_url,
"records": [
{
"ID": 1,
"LastModifiedDate": "2021-11-15",
},
{
"ID": 2,
"LastModifiedDate": "2021-11-16",
},
],
}
resp_2 = {
"done": True,
"totalSize": 4,
"records": [
{
"ID": 3,
"LastModifiedDate": "2021-11-17",
},
{
"ID": 4,
"LastModifiedDate": "2021-11-18",
},
],
}
m.register_uri("GET", stream.path(), json=resp_1)
m.register_uri("GET", next_page_url, json=resp_2)
records = [record for record in stream.read_records(sync_mode=SyncMode.full_refresh)]
assert len(records) == 4
def test_csv_reader_dialect_unix():
stream: BulkSalesforceStream = BulkSalesforceStream(stream_name=None, sf_api=None, pk=None)
url = "https://fake-account.salesforce.com/services/data/v53.0/jobs/query/7504W00000bkgnpQAA"
data = [
{"Id": 1, "Name": '"first_name" "last_name"'},
{"Id": 2, "Name": "'" + 'first_name"\n' + "'" + 'last_name\n"'},
{"Id": 3, "Name": "first_name last_name"},
]
with io.StringIO("", newline="") as csvfile:
writer = csv.DictWriter(csvfile, fieldnames=["Id", "Name"], dialect="unix")
writer.writeheader()
for line in data:
writer.writerow(line)
text = csvfile.getvalue()
with requests_mock.Mocker() as m:
m.register_uri("GET", url + "/results", text=text)
result = [i for i in stream.read_with_chunks(*stream.download_data(url))]
assert result == data
@pytest.mark.parametrize(
"stream_names,catalog_stream_names,",
(
(
["stream_1", "stream_2", "Describe"],
None,
),
(
["stream_1", "stream_2"],
["stream_1", "stream_2", "Describe"],
),
(
["stream_1", "stream_2", "stream_3", "Describe"],
["stream_1", "Describe"],
),
),
)
def test_forwarding_sobject_options(stream_config, stream_names, catalog_stream_names) -> None:
sobjects_matcher = re.compile("/sobjects$")
token_matcher = re.compile("/token$")
describe_matcher = re.compile("/describe$")
catalog = None
if catalog_stream_names:
catalog = ConfiguredAirbyteCatalog(
streams=[
ConfiguredAirbyteStream(
stream=AirbyteStream(
name=catalog_stream_name, supported_sync_modes=[SyncMode.full_refresh], json_schema={"type": "object"}
),
sync_mode=SyncMode.full_refresh,
destination_sync_mode=DestinationSyncMode.overwrite,
)
for catalog_stream_name in catalog_stream_names
]
)
with requests_mock.Mocker() as m:
m.register_uri("POST", token_matcher, json={"instance_url": "https://fake-url.com", "access_token": "fake-token"})
m.register_uri(
"GET",
describe_matcher,
json={
"fields": [
{
"name": "field",
"type": "string",
}
]
},
)
m.register_uri(
"GET",
sobjects_matcher,
json={
"sobjects": [
{
"name": stream_name,
"flag1": True,
"queryable": True,
}
for stream_name in stream_names
if stream_name != "Describe"
],
},
)
source = SourceSalesforce()
source.catalog = catalog
streams = source.streams(config=stream_config)
expected_names = catalog_stream_names if catalog else stream_names
assert not set(expected_names).symmetric_difference(set(stream.name for stream in streams)), "doesn't match excepted streams"
for stream in streams:
if stream.name != "Describe":
assert stream.sobject_options == {"flag1": True, "queryable": True}
return
def test_csv_field_size_limit():
DEFAULT_CSV_FIELD_SIZE_LIMIT = 1024 * 128
field_size = 1024 * 1024
text = '"Id","Name"\n"1","' + field_size * "a" + '"\n'
csv.field_size_limit(DEFAULT_CSV_FIELD_SIZE_LIMIT)
reader = csv.reader(io.StringIO(text))
with pytest.raises(csv.Error):
for _ in reader:
pass
csv.field_size_limit(CSV_FIELD_SIZE_LIMIT)
reader = csv.reader(io.StringIO(text))
for _ in reader:
pass
def test_convert_to_standard_instance(stream_config, stream_api):
bulk_stream = generate_stream("Account", stream_config, stream_api)
rest_stream = bulk_stream.get_standard_instance()
assert isinstance(rest_stream, IncrementalRestSalesforceStream)
def test_rest_stream_init_with_too_many_properties(stream_config, stream_api_v2_too_many_properties):
with pytest.raises(AssertionError):
# v2 means the stream is going to be a REST stream.
# A missing primary key is not allowed
generate_stream("Account", stream_config, stream_api_v2_too_many_properties)
def test_too_many_properties(stream_config, stream_api_v2_pk_too_many_properties, requests_mock):
stream = generate_stream("Account", stream_config, stream_api_v2_pk_too_many_properties)
chunks = list(stream.chunk_properties())
for chunk in chunks:
assert stream.primary_key in chunk
chunks_len = len(chunks)
assert stream.too_many_properties
assert stream.primary_key
assert type(stream) == RestSalesforceStream
url = next_page_url = "https://fase-account.salesforce.com/services/data/v53.0/queryAll"
requests_mock.get(
url,
[
{
"json": {
"records": [
{"Id": 1, "propertyA": "A"},
{"Id": 2, "propertyA": "A"},
{"Id": 3, "propertyA": "A"},
{"Id": 4, "propertyA": "A"},
]
}
},
{"json": {"nextRecordsUrl": next_page_url, "records": [{"Id": 1, "propertyB": "B"}, {"Id": 2, "propertyB": "B"}]}},
# 2 for 2 chunks above
*[{"json": {"records": [{"Id": 1}, {"Id": 2}], "nextRecordsUrl": next_page_url}} for _ in range(chunks_len - 2)],
{"json": {"records": [{"Id": 3, "propertyB": "B"}, {"Id": 4, "propertyB": "B"}]}},
# 2 for 1 chunk above and 1 chunk had no next page
*[{"json": {"records": [{"Id": 3}, {"Id": 4}]}} for _ in range(chunks_len - 2)],
],
)
records = list(stream.read_records(sync_mode=SyncMode.full_refresh))
assert records == [
{"Id": 1, "propertyA": "A", "propertyB": "B"},
{"Id": 2, "propertyA": "A", "propertyB": "B"},
{"Id": 3, "propertyA": "A", "propertyB": "B"},
{"Id": 4, "propertyA": "A", "propertyB": "B"},
]
for call in requests_mock.request_history:
assert len(call.url) < Salesforce.REQUEST_SIZE_LIMITS
def test_stream_with_no_records_in_response(stream_config, stream_api_v2_pk_too_many_properties, requests_mock):
stream = generate_stream("Account", stream_config, stream_api_v2_pk_too_many_properties)
chunks = list(stream.chunk_properties())
for chunk in chunks:
assert stream.primary_key in chunk
assert stream.too_many_properties
assert stream.primary_key
assert type(stream) == RestSalesforceStream
url = "https://fase-account.salesforce.com/services/data/v53.0/queryAll"
requests_mock.get(
url,
[
{"json": {"records": []}},
],
)
records = list(stream.read_records(sync_mode=SyncMode.full_refresh))
assert records == []