-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathtest_entity.py
More file actions
848 lines (638 loc) · 25.8 KB
/
test_entity.py
File metadata and controls
848 lines (638 loc) · 25.8 KB
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
import logging
import random
from copy import deepcopy
from datetime import UTC, date, datetime
from uuid import uuid4
import pandas as pd
import polars as pl
import pytest
import responses
from responses.matchers import header_matcher, json_params_matcher, query_param_matcher
from dataverse_api.dataverse import DataverseClient
from dataverse_api.entity import DataverseEntity
from dataverse_api.errors import DataverseError
from dataverse_api.metadata.base import BASE_TYPE
from dataverse_api.utils.data import convert_dataframe_to_dict, is_not_none, serialize_json
@pytest.fixture
def entity_name() -> str:
return "foo"
@pytest.fixture
def entity_set_name() -> str:
return "foos"
@pytest.fixture
def primary_id() -> str:
return "fooid"
@pytest.fixture
def primary_img() -> str:
return "fooimg"
@pytest.fixture
def altkey_1(primary_id: str) -> tuple[str, list[str]]:
return "foo_key", [primary_id]
@pytest.fixture
def altkey_2_name() -> str:
return "blergh"
@pytest.fixture
def altkey_2_cols() -> list[str]:
return ["moo", "mee"]
@pytest.fixture
def altkey_2(altkey_2_name: str, altkey_2_cols: list[str]) -> tuple[str, list[str]]:
return altkey_2_name, altkey_2_cols
@pytest.fixture
def sample_data():
return {"value": [{"data": 1}, {"data": 2}]}
@pytest.fixture
def small_data_package():
return [{"test": str(uuid4())} for _ in range(5)]
@pytest.fixture
def medium_data_package():
return [{"test": str(uuid4())} for _ in range(100)]
@pytest.fixture
def large_data_package():
return [{"test": str(uuid4())} for _ in range(2000)]
@pytest.fixture
def entity(
client: DataverseClient,
mocked_responses: responses.RequestsMock,
entity_name: str,
entity_set_name: str,
primary_id: str,
primary_img: str,
altkey_1: tuple[str, list[str]],
altkey_2: tuple[str, list[str]],
):
# Initial call
columns = ["EntitySetName", "PrimaryIdAttribute", "PrimaryImageAttribute"]
mocked_responses.get(
url=client._endpoint + f"EntityDefinitions(LogicalName='{entity_name}')",
status=200,
match=[query_param_matcher({"$select": ",".join(columns)})],
json={"EntitySetName": entity_set_name, "PrimaryIdAttribute": primary_id, "PrimaryImageAttribute": primary_img},
)
# Keys call
columns = ["SchemaName", "KeyAttributes"]
mocked_responses.get(
url=client._endpoint + f"EntityDefinitions(LogicalName='{entity_name}')/Keys",
status=200,
match=[query_param_matcher({"$select": ",".join(columns)})],
json={
"value": [
{"SchemaName": altkey_1[0], "KeyAttributes": altkey_1[1]},
{"SchemaName": altkey_2[0], "KeyAttributes": altkey_2[1]},
]
},
)
# Action SDK Messages call
mocked_responses.get(
url=client._endpoint + "sdkmessagefilters",
match=[
query_param_matcher(
{
"$select": "sdkmessagefilterid",
"$expand": "sdkmessageid($select=name)",
"$filter": (
"(sdkmessageid/name eq 'CreateMultiple' or "
+ "sdkmessageid/name eq 'UpdateMultiple') and "
+ f"primaryobjecttypecode eq '{entity_name}'"
),
}
)
],
json={
"value": [
{"sdkmessageid": {"name": "CreateMultiple"}},
{"sdkmessageid": {"name": "UpdateMultiple"}},
]
},
)
# Relationships calls
refd_entity = "ReferencedEntityNavigationPropertyName"
reffing_entity = "ReferencingEntityNavigationPropertyName"
# One-to-many
mocked_responses.get(
url=client._endpoint + f"EntityDefinitions(LogicalName='{entity_name}')/ManyToOneRelationships",
json={
"value": [
{refd_entity: "123", reffing_entity: "foo"},
{refd_entity: "456", reffing_entity: "bar"},
{refd_entity: "789", reffing_entity: "baz"},
]
},
)
# Many-to-one
mocked_responses.get(
url=client._endpoint + f"EntityDefinitions(LogicalName='{entity_name}')/OneToManyRelationships",
json={
"value": [
{refd_entity: "foo", reffing_entity: "bar"},
{refd_entity: "moo", reffing_entity: f"objectid_{entity_name}"},
{refd_entity: "schmoo", reffing_entity: f"regardingobjectid_{entity_name}"},
]
},
)
return client.entity(entity_name)
def test_entity_instantiation(
entity: DataverseEntity,
entity_name: str,
entity_set_name: str,
primary_id: str,
primary_img: str,
altkey_1: tuple[str, list[str]],
altkey_2: tuple[str, list[str]],
):
assert entity.logical_name == entity_name
assert entity.entity_set_name == entity_set_name
assert entity.primary_id_attr == primary_id
assert entity.primary_img_attr == primary_img
assert len(entity.alternate_keys) == 2
assert all(i in entity.alternate_keys for i in [altkey_1[0], altkey_2[0]])
assert entity.alternate_keys[altkey_1[0]] == altkey_1[1]
assert entity.alternate_keys[altkey_2[0]] == altkey_2[1]
assert entity.supports_create_multiple is True
assert entity.supports_update_multiple is True
assert entity.relationships.collection_valued == ["foo"]
assert entity.relationships.single_valued == ["foo", "bar", "baz"]
"""
entity.read()
"""
def test_entity_read(
entity: DataverseEntity,
entity_set_name: str,
mocked_responses: responses.RequestsMock,
sample_data: dict[str, list[dict[str, int]]],
):
# Reading without any args
url = entity._endpoint + entity_set_name
mocked_responses.get(url=url, json=sample_data)
resp = entity.read()
assert resp == sample_data["value"]
def test_entity_read_with_args(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
sample_data: dict[str, list[dict[str, int]]],
):
# Reading with args
url = entity._endpoint + entity.entity_set_name
select = "moo"
filter = "foo"
expand = "schmoo"
order_by = "blergh"
top = 123
params = {"$select": select, "$filter": filter, "$expand": expand, "$orderby": order_by, "$top": top}
page_size = 69
headers = {"Prefer": f"odata.maxpagesize={page_size}"}
mocked_responses.get(url=url, json=sample_data, match=[query_param_matcher(params), header_matcher(headers)]) # type: ignore
resp = entity.read(select=[select], filter=filter, top=top, order_by=order_by, expand=expand, page_size=page_size)
assert resp == sample_data["value"]
def test_entity_read_with_paging(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
sample_data: dict[str, list[dict[str, int]]],
):
url = entity._endpoint + entity.entity_set_name
next_url = entity._endpoint + "foooooo"
headers = {"Prefer": "odata.include-annotations=OData.Community.Display.V1.FormattedValue"}
# Mocking responses
matcher = [header_matcher(headers, strict_match=False)] # Headers should persist across calls # type: ignore
mocked_responses.get(url=next_url, json=sample_data, match=matcher)
sample_data["@odata.nextLink"] = next_url # type: ignore
mocked_responses.get(url=url, json=sample_data, match=matcher)
# Performing action
resp = entity.read(return_formatted_values=True) # Adds above Prefer header to calls
assert len(resp) == 2 * len(sample_data["value"])
assert resp == sample_data["value"] * 2
"""
entity.create()
"""
def test_entity_create_by_singles(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
small_data_package: list[dict[str, str]],
caplog: pytest.LogCaptureFixture,
):
# Data package
url = entity._endpoint + entity.entity_set_name
# Mock single requests
for row in small_data_package:
mocked_responses.post(url=url, match=[json_params_matcher(row)], status=204)
caplog.set_level(logging.DEBUG)
resp = entity.create(data=small_data_package)
assert all([x.status_code == 204 for x in resp])
assert "using individual inserts" in caplog.text
def test_entity_create_by_singles_write_timestamp(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
small_data_package: list[dict[str, str]],
caplog: pytest.LogCaptureFixture,
):
# Data package
url = entity._endpoint + entity.entity_set_name
data = [{"test": datetime.now(UTC)}, {"test": date.today()}, {"test": pd.Timestamp.now()}]
# Mock single requests
for row in data:
row_data = {k: v.isoformat() for k, v in row.items()}
mocked_responses.post(url=url, match=[json_params_matcher(row_data)], status=204)
caplog.set_level(logging.DEBUG)
resp = entity.create(data=data)
assert all([x.status_code == 204 for x in resp])
assert "using individual inserts" in caplog.text
def test_entity_create_by_createmultiple(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
medium_data_package: list[dict[str, str]],
caplog: pytest.LogCaptureFixture,
):
# Data package
out_data = deepcopy(medium_data_package)
for row in out_data:
row["@odata.type"] = BASE_TYPE + entity.logical_name
match_data = {"Targets": out_data}
url = f"{entity._endpoint}{entity.entity_set_name}/{BASE_TYPE + 'CreateMultiple'}"
# Mock request
mocked_responses.post(url=url, match=[json_params_matcher(match_data)], status=204)
caplog.set_level(logging.DEBUG)
resp = entity.create(medium_data_package, mode="multiple")
assert all([x.status_code == 204 for x in resp])
assert "using CreateMultiple" in caplog.text
def test_entity_create_multiple_not_supported(
entity: DataverseEntity,
medium_data_package: list[dict[str, str]],
):
# Setup
entity._DataverseEntity__supports_create_multiple = False # type: ignore
with pytest.raises(DataverseError, match=r"CreateMultiple is not supported.*"):
entity.create(medium_data_package, mode="multiple")
def test_entity_create_by_batch(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
medium_data_package: list[dict[str, str]],
caplog: pytest.LogCaptureFixture,
):
# Data package
url = f"{entity._endpoint}$batch"
# Mock request
mocked_responses.post(url=url, status=204)
caplog.set_level(logging.DEBUG)
resp = entity.create(medium_data_package, mode="batch")
assert all([x.status_code == 204 for x in resp])
assert "using batch" in caplog.text
def test_entity_create_with_args(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
small_data_package: list[dict[str, str]],
):
# Data package
url = entity._endpoint + entity.entity_set_name
header = {"MSCRM.SuppressDuplicateDetection": "false", "Prefer": "return=representation"}
# Mock single requests
for _ in small_data_package:
mocked_responses.post(url=url, match=[header_matcher(header)], status=200) # type: ignore
resp = entity.create(data=small_data_package, detect_duplicates=True, return_created=True)
assert all([x.status_code == 200 for x in resp])
def test_entity_create_with_pandas_df(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
):
data = pd.DataFrame([("abc"), ("def")], columns=["test"])
dict_data = convert_dataframe_to_dict(data)
url = entity._endpoint + entity.entity_set_name
for row in dict_data:
mocked_responses.post(url=url, status=204, match=[json_params_matcher(row)])
resp = entity.create(data=data)
assert all([x.status_code == 204 for x in resp])
def test_entity_create_with_polars_df(
entity: DataverseEntity,
mocked_responses: responses.RequestsMock,
):
data = pl.DataFrame([{"test": "abc"}, {"test": "def"}])
dict_data = convert_dataframe_to_dict(data)
url = entity._endpoint + entity.entity_set_name
for row in dict_data:
mocked_responses.post(url=url, status=204, match=[json_params_matcher(row)])
resp = entity.create(data=data)
assert all([x.status_code == 204 for x in resp])
def test_entity_create_mode_not_supported(
entity: DataverseEntity,
medium_data_package: list[dict[str, str]],
):
with pytest.raises(DataverseError, match=r"Mode .* is not supported.*"):
entity.create(medium_data_package, mode="foo") # type: ignore
"""
entity.delete()
"""
def test_entity_delete_singles_all(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
id = entity.primary_id_attr
return_payload = [{id: str(i)} for i in range(5)]
params = {"$select": entity.primary_id_attr}
# Fetching ids
mocked_responses.get(
url=f"{entity._endpoint}{entity.entity_set_name}",
status=200,
json={"value": return_payload},
match=[query_param_matcher(params)],
)
# Deleting ids
for row in return_payload:
mocked_responses.delete(
url=f"{entity._endpoint}{entity.entity_set_name}({row[id]})",
status=204,
)
resp = entity.delete(filter="all")
assert all([x.status_code == 204 for x in resp])
def test_entity_delete_batch_all(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
id = entity.primary_id_attr
return_payload = [{id: str(i)} for i in range(10)]
params = {"$select": entity.primary_id_attr}
# Fetching ids
mocked_responses.get(
url=f"{entity._endpoint}{entity.entity_set_name}",
status=200,
json={"value": return_payload},
match=[query_param_matcher(params)],
)
# Deleting
mocked_responses.post(url=f"{entity._endpoint}$batch")
resp = entity.delete(mode="batch", filter="all")
assert isinstance(resp[0].request.body, str) # type checking
for item in return_payload:
assert f"{entity._endpoint}{entity.entity_set_name}({item[id]})" in resp[0].request.body
def test_entity_delete_singles_ids(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
delete_ids = {"1", "2", "3"}
# Deleting ids
for item in delete_ids:
mocked_responses.delete(
url=f"{entity._endpoint}{entity.entity_set_name}({item})",
status=204,
)
resp = entity.delete(ids=delete_ids)
assert all([x.status_code == 204 for x in resp])
def test_entity_delete_singles_filter(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
id = entity.primary_id_attr
filter_str = "foo"
params = {"$filter": filter_str, "$select": entity.primary_id_attr}
return_payload = [{id: str(i)} for i in range(5)]
# Fetching ids
mocked_responses.get(
url=f"{entity._endpoint}{entity.entity_set_name}",
status=200,
json={"value": return_payload},
match=[query_param_matcher(params)],
)
# Deleting ids
for row in return_payload:
mocked_responses.delete(url=f"{entity._endpoint}{entity.entity_set_name}({row[id]})", status=204)
resp = entity.delete(filter=filter_str)
assert all([x.status_code == 204 for x in resp])
def test_entity_delete_bad_args(entity: DataverseEntity):
with pytest.raises(DataverseError, match=r"Function requires either.*"):
entity.delete() # type: ignore
def test_entity_delete_mode_not_supported(entity: DataverseEntity):
with pytest.raises(DataverseError, match=r"Mode .* is not supported.*"):
entity.delete(mode="foo", ids=["bar"]) # type: ignore
"""
entity.delete_column()
"""
def test_entity_delete_column_singles_all(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
id = entity.primary_id_attr
return_payload = [{id: str(i)} for i in range(3)]
params = {"$select": entity.primary_id_attr}
columns = ["Foo", "Bar"]
# Fetching ids
mocked_responses.get(
url=f"{entity._endpoint}{entity.entity_set_name}",
status=200,
json={"value": return_payload},
match=[query_param_matcher(params)],
)
# Deleting ids
for row in return_payload:
for col in columns:
mocked_responses.delete(url=f"{entity._endpoint}{entity.entity_set_name}({row[id]})/{col}", status=204)
resp = entity.delete_columns(columns=columns, filter="all")
assert all([x.status_code == 204 for x in resp])
def test_entity_delete_column_batch_all(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
id = entity.primary_id_attr
return_payload = [{id: str(i)} for i in range(10)]
params = {"$select": entity.primary_id_attr}
columns = ["Foo", "Bar"]
# Fetching ids
mocked_responses.get(
url=f"{entity._endpoint}{entity.entity_set_name}",
status=200,
json={"value": return_payload},
match=[query_param_matcher(params)],
)
# Deleting
mocked_responses.post(url=f"{entity._endpoint}$batch")
resp = entity.delete_columns(columns=columns, mode="batch", filter="all")
for item in return_payload:
for i, col in enumerate(columns):
assert f"{entity._endpoint}{entity.entity_set_name}({item[id]})/{col}" in resp[i].request.body # type: ignore
def test_entity_delete_column_singles_ids(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
delete_ids = {"1", "2", "3"}
columns = ["Foo", "Bar"]
# Deleting ids
for col in columns:
for item in delete_ids:
mocked_responses.delete(
url=f"{entity._endpoint}{entity.entity_set_name}({item})/{col}",
status=204,
)
resp = entity.delete_columns(columns=columns, ids=delete_ids)
assert all([x.status_code == 204 for x in resp])
def test_entity_delete_column_singles_filter(entity: DataverseEntity, mocked_responses: responses.RequestsMock):
# Setup
id = entity.primary_id_attr
filter_str = "foo"
params = {"$filter": filter_str, "$select": entity.primary_id_attr}
return_payload = [{id: str(i)} for i in range(3)]
columns = ["Foooo", "Baaar"]
# Fetching ids
mocked_responses.get(
url=f"{entity._endpoint}{entity.entity_set_name}",
status=200,
json={"value": return_payload},
match=[query_param_matcher(params)],
)
# Deleting ids
for row in return_payload:
for col in columns:
mocked_responses.delete(url=f"{entity._endpoint}{entity.entity_set_name}({row[id]})/{col}", status=204)
resp = entity.delete_columns(columns=columns, filter=filter_str)
assert all([x.status_code == 204 for x in resp])
def test_entity_delete_column_bad_args(entity: DataverseEntity):
with pytest.raises(DataverseError, match=r"Function requires either.*"):
entity.delete_columns(columns=["Foo", "Bar"]) # type: ignore
def test_entity_delete_column_mode_not_supported(entity: DataverseEntity):
with pytest.raises(DataverseError, match=r"Mode .* is not supported.*"):
entity.delete_columns(columns=["col"], mode="foo", ids=["bar"]) # type: ignore
"""
entity.upsert()
"""
def test_entity_upsert_individual_primaryid(
entity: DataverseEntity,
primary_id: str,
mocked_responses: responses.RequestsMock,
):
# Setup
data = [{primary_id: str(uuid4()), "test_val": random.randint(1, 10)} for _ in range(4)]
for row in data:
id = row[primary_id]
payload = {k: v for k, v in row.items() if k != primary_id}
mocked_responses.patch(
url=f"{entity._endpoint}{entity.entity_set_name}({id})",
match=[json_params_matcher(payload)],
status=204,
)
resp = entity.upsert(data, mode="individual")
for row in resp:
assert row.status_code == 204
def test_entity_upsert_batch_primaryid(
entity: DataverseEntity,
primary_id: str,
mocked_responses: responses.RequestsMock,
):
# Setup
data = [{primary_id: str(uuid4()), "test_val": random.randint(1, 10)} for _ in range(4)]
mocked_responses.post(url=f"{entity._endpoint}$batch")
resp = entity.upsert(data=data, mode="batch")
assert isinstance(resp[0].request.body, str) # type checking
elements = resp[0].request.body.split("--batch")[1:-1]
for out, expected in zip(elements, data):
assert f"{entity.entity_set_name}({expected.pop(primary_id)})" in out
assert serialize_json(expected) in out
def test_entity_upsert_batch_altkey(
entity: DataverseEntity,
primary_id: str,
mocked_responses: responses.RequestsMock,
altkey_2_name: str,
altkey_2_cols: list[str],
):
# Setup
a, b = altkey_2_cols
data = [
{
primary_id: str(uuid4()),
a: random.randint(1, 10),
b: random.randint(1, 20),
"data": random.randint(4, 30),
}
for _ in range(4)
]
mocked_responses.post(url=f"{entity._endpoint}$batch")
resp = entity.upsert(data=data, mode="batch", altkey_name=altkey_2_name)
assert isinstance(resp[0].request.body, str) # type checking
elements = resp[0].request.body.split("--batch")[1:-1]
for out, expected in zip(elements, data):
row = ",".join([f"{part}={expected.pop(part).__repr__()}" for part in altkey_2_cols])
assert f"{entity.entity_set_name}({row})" in out
assert serialize_json(expected) in out
def test_entity_upsert_mode_not_supported(entity: DataverseEntity):
with pytest.raises(DataverseError, match=r"Mode .* is not supported.*"):
entity.upsert([{"data": 1}], mode="foo") # type: ignore
def test_entity_upsert_bad_altkey(entity: DataverseEntity):
with pytest.raises(DataverseError, match=r"Altkey.*"):
entity.upsert([{"data": 1}], altkey_name="foo")
def test_entity_upsert_individual_prevent_create(
entity: DataverseEntity,
primary_id: str,
mocked_responses: responses.RequestsMock,
):
"""Test upsert with prevent_create (If-Match: *) - only update existing records."""
# Setup
data = [{primary_id: str(uuid4()), "test_val": random.randint(1, 10)} for _ in range(4)]
for row in data:
id = row[primary_id]
payload = {k: v for k, v in row.items() if k != primary_id}
mocked_responses.patch(
url=f"{entity._endpoint}{entity.entity_set_name}({id})",
match=[json_params_matcher(payload), header_matcher({"If-Match": "*"})],
status=204,
)
resp = entity.upsert(data, mode="individual", match="prevent_create")
for row in resp:
assert row.status_code == 204
def test_entity_upsert_individual_prevent_update(
entity: DataverseEntity,
primary_id: str,
mocked_responses: responses.RequestsMock,
):
"""Test upsert with prevent_update (If-None-Match: *) - only create new records."""
# Setup
data = [{primary_id: str(uuid4()), "test_val": random.randint(1, 10)} for _ in range(4)]
for row in data:
id = row[primary_id]
payload = {k: v for k, v in row.items() if k != primary_id}
mocked_responses.patch(
url=f"{entity._endpoint}{entity.entity_set_name}({id})",
match=[json_params_matcher(payload), header_matcher({"If-None-Match": "*"})],
status=204,
)
resp = entity.upsert(data, mode="individual", match="prevent_update")
for row in resp:
assert row.status_code == 204
def test_entity_upsert_batch_match_not_supported(entity: DataverseEntity, primary_id: str):
"""Test that using match parameter with batch mode raises an error."""
data = [{primary_id: str(uuid4()), "test_val": 1}]
with pytest.raises(DataverseError, match=r".*match.*only supported for individual mode.*"):
entity.upsert(data=data, mode="batch", match="prevent_create") # type: ignore
with pytest.raises(DataverseError, match=r".*match.*only supported for individual mode.*"):
entity.upsert(data=data, mode="batch", match="prevent_update") # type: ignore
def test_entity_upsert_pandas_dataframe(
entity: DataverseEntity, mocked_responses: responses.RequestsMock, primary_id: str
):
# Setup
df = pd.DataFrame([{primary_id: str(uuid4()), "data": i} for i in range(3)])
data = convert_dataframe_to_dict(df)
for row in data:
id = row[primary_id]
payload = {k: v for k, v in row.items() if k != primary_id}
mocked_responses.patch(
url=f"{entity._endpoint}{entity.entity_set_name}({id})",
match=[json_params_matcher(payload)],
status=204,
)
resp = entity.upsert(df, mode="individual")
for row in resp:
assert row.status_code == 204
def test_entity_upsert_polars_dataframe(
entity: DataverseEntity, mocked_responses: responses.RequestsMock, primary_id: str
):
# Setup
df = pl.DataFrame([{primary_id: str(uuid4()), "data": i} for i in range(3)])
data = convert_dataframe_to_dict(df)
for row in data:
id = row[primary_id]
payload = {k: v for k, v in row.items() if k != primary_id}
mocked_responses.patch(
url=f"{entity._endpoint}{entity.entity_set_name}({id})",
match=[json_params_matcher(payload)],
status=204,
)
resp = entity.upsert(df, mode="individual")
for row in resp:
assert row.status_code == 204
def test_entity_upsert_dataframe_with_none(
entity: DataverseEntity, mocked_responses: responses.RequestsMock, primary_id: str
):
# Setup
df = pd.DataFrame([{primary_id: str(uuid4()), "data": i, "more_data": i + 1} for i in range(3)])
df.loc[1, "more_data"] = None # Introduce a None value
data = convert_dataframe_to_dict(df)
for row in data:
id = row[primary_id]
payload = {k: v for k, v in row.items() if k != primary_id and is_not_none(v)}
mocked_responses.patch(
url=f"{entity._endpoint}{entity.entity_set_name}({id})",
match=[json_params_matcher(payload)],
status=204,
)
resp = entity.upsert(df, mode="individual")
for row in resp:
assert row.status_code == 204