-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathtest_experiments.py
More file actions
2131 lines (1834 loc) · 90.7 KB
/
test_experiments.py
File metadata and controls
2131 lines (1834 loc) · 90.7 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
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
# ruff: noqa: E402
import re
from copy import deepcopy
from datetime import date
from unittest.mock import patch
import jsonschema
import pytest
import requests
import requests_mock
arq = pytest.importorskip("arq")
cdot = pytest.importorskip("cdot")
fastapi = pytest.importorskip("fastapi")
from mavedb.lib.exceptions import NonexistentOrcidUserError
from mavedb.lib.validation.urn_re import MAVEDB_TMP_URN_RE
from mavedb.models.experiment import Experiment as ExperimentDbModel
from mavedb.models.experiment_set import ExperimentSet as ExperimentSetDbModel
from mavedb.models.score_set import ScoreSet as ScoreSetDbModel
from mavedb.view_models.experiment import Experiment, ExperimentCreate
from mavedb.view_models.orcid import OrcidUser
from tests.helpers.constants import (
EXTRA_USER,
TEST_BIORXIV_IDENTIFIER,
TEST_CROSSREF_IDENTIFIER,
TEST_EXPERIMENT_WITH_KEYWORD,
TEST_EXPERIMENT_WITH_KEYWORD_HAS_DUPLICATE_OTHERS_RESPONSE,
TEST_EXPERIMENT_WITH_KEYWORD_RESPONSE,
TEST_EXPERIMENT_WITH_UPDATE_KEYWORD_RESPONSE,
TEST_MEDRXIV_IDENTIFIER,
TEST_MINIMAL_EXPERIMENT,
TEST_MINIMAL_EXPERIMENT_RESPONSE,
TEST_MINIMAL_SEQ_SCORESET,
TEST_ORCID_ID,
TEST_PUBMED_IDENTIFIER,
TEST_PUBMED_URL_IDENTIFIER,
TEST_USER,
TEST_USER2,
)
from tests.helpers.dependency_overrider import DependencyOverrider
from tests.helpers.util.contributor import add_contributor
from tests.helpers.util.experiment import create_experiment
from tests.helpers.util.score_set import create_seq_score_set, create_seq_score_set_with_variants, publish_score_set
from tests.helpers.util.user import change_ownership
from tests.helpers.util.variant import mock_worker_variant_insertion
def test_test_minimal_experiment_is_valid():
jsonschema.validate(instance=TEST_MINIMAL_EXPERIMENT, schema=ExperimentCreate.model_json_schema())
def test_create_minimal_experiment(client, setup_router_db):
response = client.post("/api/v1/experiments/", json=TEST_MINIMAL_EXPERIMENT)
assert response.status_code == 200
response_data = response.json()
jsonschema.validate(instance=response_data, schema=Experiment.model_json_schema())
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["urn"]), re.Match)
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["experimentSetUrn"]), re.Match)
expected_response = deepcopy(TEST_MINIMAL_EXPERIMENT_RESPONSE)
expected_response.update({"urn": response_data["urn"], "experimentSetUrn": response_data["experimentSetUrn"]})
assert sorted(expected_response.keys()) == sorted(response_data.keys())
for key in expected_response:
assert (key, expected_response[key]) == (key, response_data[key])
def test_create_experiment_with_contributor(client, setup_router_db):
experiment = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment.update({"contributors": [{"orcid_id": TEST_ORCID_ID}]})
with patch(
"mavedb.lib.orcid.fetch_orcid_user",
lambda orcid_id: OrcidUser(orcid_id=orcid_id, given_name="ORCID", family_name="User"),
):
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 200
response_data = response.json()
jsonschema.validate(instance=response_data, schema=Experiment.model_json_schema())
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["urn"]), re.Match)
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["experimentSetUrn"]), re.Match)
expected_response = deepcopy(TEST_MINIMAL_EXPERIMENT_RESPONSE)
expected_response.update({"urn": response_data["urn"], "experimentSetUrn": response_data["experimentSetUrn"]})
expected_response["contributors"] = [
{
"recordType": "Contributor",
"orcidId": TEST_ORCID_ID,
"givenName": "ORCID",
"familyName": "User",
}
]
assert sorted(expected_response.keys()) == sorted(response_data.keys())
for key in expected_response:
assert (key, expected_response[key]) == (key, response_data[key])
def test_cannot_create_experiment_with_nonexistent_contributor(client, setup_router_db):
experiment = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment.update({"contributors": [{"orcid_id": TEST_ORCID_ID}]})
with patch(
"mavedb.lib.orcid.fetch_orcid_user",
side_effect=NonexistentOrcidUserError(f"No ORCID user was found for ORCID ID {TEST_ORCID_ID}."),
):
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 404
response_data = response.json()
assert "No ORCID user was found for ORCID ID 1111-1111-1111-1111." in response_data["detail"]
def test_create_experiment_with_keywords(session, client, setup_router_db):
response = client.post("/api/v1/experiments/", json=TEST_EXPERIMENT_WITH_KEYWORD)
assert response.status_code == 200
response_data = response.json()
jsonschema.validate(instance=response_data, schema=Experiment.model_json_schema())
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["urn"]), re.Match)
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["experimentSetUrn"]), re.Match)
expected_response = deepcopy(TEST_EXPERIMENT_WITH_KEYWORD_RESPONSE)
expected_response.update({"urn": response_data["urn"], "experimentSetUrn": response_data["experimentSetUrn"]})
assert sorted(expected_response.keys()) == sorted(response_data.keys())
for key in expected_response:
assert (key, expected_response[key]) == (key, response_data[key])
def test_cannot_create_experiment_without_email(client, setup_router_db):
client.put("api/v1/users/me", json={"email": None})
response = client.post("/api/v1/experiments/", json=TEST_MINIMAL_EXPERIMENT)
assert response.status_code == 403
response_data = response.json()
assert response_data["detail"] == "There must be an email address associated with your account to use this feature."
def test_cannot_create_experiment_that_keyword_does_not_match_db_keyword(client, setup_router_db):
# Database does not have this keyword.
invalid_keyword = {
"keywords": [
{
"keyword": {
"key": "Invalid key",
"label": "Invalid label",
},
}
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **invalid_keyword}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert response_data["detail"] == "Invalid keyword Invalid key or Invalid label"
def test_cannot_create_experiment_that_keywords_has_wrong_combination1(client, setup_router_db):
# Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
wrong_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Endogenous locus library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "In Vitro Construct Library Method System",
"label": "Oligo-directed mutagenic PCR",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **wrong_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"]
== "If 'Variant Library Creation Method' is 'Endogenous locus library method', both 'Endogenous Locus "
"Library Method System' and 'Endogenous Locus Library Method Mechanism' must be present."
)
def test_cannot_create_experiment_that_keywords_has_wrong_combination2(client, setup_router_db):
# Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
wrong_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "Endogenous Locus Library Method System",
"label": "SaCas9",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **wrong_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"]
== "If 'Variant Library Creation Method' is 'In vitro construct library method', both 'In Vitro Construct "
"Library Method System' and 'In Vitro Construct Library Method Mechanism' must be present."
)
def test_cannot_create_experiment_that_keywords_has_wrong_combination3(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
If choose Other in Variant Library Creation Method, should not have Endogenous
"""
wrong_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Other",
"special": False,
"description": "Description",
},
"description": "Description",
},
{
"keyword": {
"key": "Endogenous Locus Library Method System",
"label": "SaCas9",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **wrong_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"]
== "If 'Variant Library Creation Method' is 'Other', none of 'Endogenous Locus Library Method System', "
"'Endogenous Locus Library Method Mechanism', 'In Vitro Construct Library Method System', or 'In Vitro "
"Construct Library Method Mechanism' should be present."
)
def test_cannot_create_experiment_that_keywords_has_wrong_combination4(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
If choose Other in Variant Library Creation Method, should not have in vitro
"""
wrong_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Other",
"special": False,
"description": "Description",
},
"description": "Description",
},
{
"keyword": {
"key": "In Vitro Construct Library Method System",
"label": "Error-prone PCR",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **wrong_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"]
== "If 'Variant Library Creation Method' is 'Other', none of 'Endogenous Locus Library Method System', "
"'Endogenous Locus Library Method Mechanism', 'In Vitro Construct Library Method System', or 'In Vitro "
"Construct Library Method Mechanism' should be present."
)
# Test the validator of Endogenous locus keywords
def test_create_experiment_that_keywords_has_endogenous(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
if users choose endogenous locus library method in Variant Library Creation Method
"""
keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Endogenous locus library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "Endogenous Locus Library Method System",
"label": "SaCas9",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "Endogenous Locus Library Method Mechanism",
"label": "Base editor",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 200
def test_cannot_create_experiment_that_keywords_has_endogenous_without_method_mechanism(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
Choose endogenous locus library method in Variant Library Creation Method,
but miss the endogenous locus library method mechanism
"""
incomplete_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Endogenous locus library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "Endogenous Locus Library Method System",
"label": "SaCas9",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **incomplete_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"] == "If 'Variant Library Creation Method' is 'Endogenous locus library method', "
"both 'Endogenous Locus Library Method System' and 'Endogenous Locus Library Method Mechanism' "
"must be present."
)
def test_cannot_create_experiment_that_keywords_has_endogenous_without_method_system(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
Choose endogenous locus library method in Variant Library Creation Method,
but miss the endogenous locus library method system
"""
incomplete_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Endogenous locus library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "Endogenous Locus Library Method Mechanism",
"label": "Base editor",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **incomplete_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"] == "If 'Variant Library Creation Method' is 'Endogenous locus library method', "
"both 'Endogenous Locus Library Method System' and 'Endogenous Locus Library Method Mechanism' "
"must be present."
)
# Test the validator of in vitro keywords
def test_create_experiment_that_keywords_has_in_vitro(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
if users choose in vitro construct library method in Variant Library Creation Method
"""
keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "In Vitro Construct Library Method System",
"label": "Oligo-directed mutagenic PCR",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "In Vitro Construct Library Method Mechanism",
"label": "Native locus replacement",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 200
def test_cannot_create_experiment_that_keywords_has_in_vitro_without_method_system(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
Choose in vitro construct library method in Variant Library Creation Method,
but miss the in vitro construct library method system
"""
incomplete_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "In Vitro Construct Library Method Mechanism",
"label": "Native locus replacement",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **incomplete_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"] == "If 'Variant Library Creation Method' is 'In vitro construct library method', "
"both 'In Vitro Construct Library Method System' and 'In Vitro Construct Library Method Mechanism' "
"must be present."
)
def test_cannot_create_experiment_that_keywords_has_in_vitro_without_method_mechanism(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_keyword_keys function
Choose in vitro construct library method in Variant Library Creation Method,
but miss the in vitro construct library method mechanism
"""
incomplete_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "In Vitro Construct Library Method System",
"label": "Oligo-directed mutagenic PCR",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **incomplete_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert (
response_data["detail"] == "If 'Variant Library Creation Method' is 'In vitro construct library method', "
"both 'In Vitro Construct Library Method System' and 'In Vitro Construct Library Method Mechanism' "
"must be present."
)
def test_create_experiment_that_keyword_gene_ontology_has_valid_code(client, setup_router_db):
valid_keyword = {
"keywords": [
{
"keyword": {
"key": "Phenotypic Assay Mechanism",
"label": "Label",
"code": "GO:1234567",
"special": False,
"description": "Description",
},
},
],
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **valid_keyword}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 200
response_data = response.json()
assert response_data["keywords"][0]["keyword"]["key"] == "Phenotypic Assay Mechanism"
assert response_data["keywords"][0]["keyword"]["label"] == "Label"
assert response_data["keywords"][0]["keyword"]["code"] == "GO:1234567"
def test_create_experiment_that_keyword_gene_ontology_is_other_without_code(client, setup_router_db):
valid_keyword = {
"keywords": [
{
"keyword": {
"key": "Phenotypic Assay Mechanism",
"label": "Other",
"code": None,
"description": "Description",
},
"description": "Description",
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **valid_keyword}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 200
response_data = response.json()
assert response_data["keywords"][0]["keyword"]["key"] == "Phenotypic Assay Mechanism"
assert response_data["keywords"][0]["keyword"]["label"] == "Other"
# TODO(#511) Re-enable the Gene Ontology code requirement.
# def test_cannot_create_experiment_that_keyword_has_an_invalid_code(client, setup_router_db):
# invalid_keyword = {
# "keywords": [
# {
# "keyword": {
# "key": "Phenotypic Assay Mechanism",
# "label": "Label",
# "code": "invalid",
# "description": "Description",
# },
# },
# ]
# }
# experiment = {**TEST_MINIMAL_EXPERIMENT, **invalid_keyword}
# response = client.post("/api/v1/experiments/", json=experiment)
# assert response.status_code == 422
# response_data = response.json()
# assert "Invalid Gene Ontology accession." in response_data["detail"][0]["msg"]
def test_cannot_create_experiment_that_keyword_label_is_other_without_description(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_description function
If choose other, description should not be null.
"""
invalid_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Other",
"special": False,
"description": "Description",
},
"description": None,
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **invalid_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert "Other option does not allow empty description." in response_data["detail"][0]["msg"]
def test_cannot_create_experiment_that_keywords_have_duplicate_keys(client, setup_router_db):
# Test src/mavedb/lib/validation/keywords.validate_duplicates function
invalid_keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Other",
"special": False,
"description": "Description",
},
"description": "Description",
},
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **invalid_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert response_data["detail"] == "Duplicate keys found in keywords."
def test_cannot_create_experiment_that_keywords_have_duplicate_labels(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_duplicates function
Keyword labels are not allowed duplicates except Other.
"""
invalid_keywords = {
"keywords": [
{
"keyword": {
"key": "Delivery Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "In vitro construct library method",
"special": False,
"description": "Description",
},
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **invalid_keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 422
response_data = response.json()
assert response_data["detail"] == "Duplicate labels found in keywords."
def test_create_experiment_that_keywords_have_duplicate_others(client, setup_router_db):
"""
Test src/mavedb/lib/validation/keywords.validate_duplicates function
Keyword labels are not allowed duplicates except Other.
"""
keywords = {
"keywords": [
{
"keyword": {
"key": "Variant Library Creation Method",
"label": "Other",
"special": False,
"description": "Description",
},
"description": "Description",
},
{
"keyword": {"key": "Delivery Method", "label": "Other", "special": False, "description": "Description"},
"description": "Description",
},
]
}
experiment = {**TEST_MINIMAL_EXPERIMENT, **keywords}
response = client.post("/api/v1/experiments/", json=experiment)
assert response.status_code == 200
response_data = response.json()
jsonschema.validate(instance=response_data, schema=Experiment.model_json_schema())
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["urn"]), re.Match)
assert isinstance(MAVEDB_TMP_URN_RE.fullmatch(response_data["experimentSetUrn"]), re.Match)
expected_response = deepcopy(TEST_EXPERIMENT_WITH_KEYWORD_HAS_DUPLICATE_OTHERS_RESPONSE)
expected_response.update({"urn": response_data["urn"], "experimentSetUrn": response_data["experimentSetUrn"]})
assert sorted(expected_response.keys()) == sorted(response_data.keys())
for key in expected_response:
assert (key, expected_response[key]) == (key, response_data[key])
def test_update_experiment_keywords(session, client, setup_router_db):
response = client.post("/api/v1/experiments/", json=TEST_EXPERIMENT_WITH_KEYWORD)
assert response.status_code == 200
experiment = response.json()
experiment_post_payload = experiment.copy()
experiment_post_payload.update(
{
"keywords": [
{
"keyword": {
"key": "Phenotypic Assay Profiling Strategy",
"label": "Shotgun sequencing",
"special": False,
"description": "Description",
},
"description": "Details of phenotypic assay profiling strategy",
},
]
}
)
updated_response = client.put(f"/api/v1/experiments/{experiment['urn']}", json=experiment_post_payload)
assert updated_response.status_code == 200
updated_experiment = updated_response.json()
updated_expected_response = deepcopy(TEST_EXPERIMENT_WITH_UPDATE_KEYWORD_RESPONSE)
updated_expected_response.update(
{"urn": updated_experiment["urn"], "experimentSetUrn": updated_experiment["experimentSetUrn"]}
)
assert sorted(updated_expected_response.keys()) == sorted(updated_experiment.keys())
for key in updated_experiment:
assert (key, updated_expected_response[key]) == (key, updated_experiment[key])
for kw in updated_experiment["keywords"]:
assert "Delivery Method" not in kw["keyword"]["key"]
def test_update_experiment_keywords_case_insensitive(session, client, setup_router_db):
experiment = create_experiment(client)
experiment_post_payload = experiment.copy()
# Test database has Delivery Method. The updating keyword's key is delivery method.
experiment_post_payload.update(
{
"keywords": [
{
"keyword": {
"key": "delivery method",
"label": "Other",
"special": False,
"description": "Description",
},
"description": "Details of delivery method",
},
]
}
)
response = client.put(f"/api/v1/experiments/{experiment['urn']}", json=experiment_post_payload)
response_data = response.json()
expected_response = deepcopy(TEST_EXPERIMENT_WITH_KEYWORD_RESPONSE)
expected_response.update({"urn": response_data["urn"], "experimentSetUrn": response_data["experimentSetUrn"]})
assert sorted(expected_response.keys()) == sorted(response_data.keys())
for key in expected_response:
assert (key, expected_response[key]) == (key, response_data[key])
def test_can_delete_experiment(client, setup_router_db):
experiment = create_experiment(client)
response = client.delete(f"api/v1/experiments/{experiment['urn']}")
assert response.status_code == 200
get_response = client.get(f"api/v1/experiments/{experiment['urn']}")
assert get_response.status_code == 404
@pytest.mark.parametrize(
"test_field,test_value",
[
("urn", "tmp:33df10c9-78b3-4e04-bafb-2446078573d7"),
("numScoreSets", 2),
("createdBy", {"firstName": "Sneaky", "lastName": "User", "orcidId": "0000-9999-9999-0000"}),
("modifiedBy", {"firstName": "Sneaky", "lastName": "User", "orcidId": "0000-9999-9999-0000"}),
("creationDate", date(2020, 4, 1).isoformat()),
("modificationDate", date(2020, 4, 1).isoformat()),
("publishedDate", date(2020, 4, 1).isoformat()),
],
)
def test_cannot_create_special_fields(client, setup_router_db, test_field, test_value):
response_data = create_experiment(client, {test_field: test_value})
if test_field in response_data:
assert (test_field, response_data[test_field]) != (test_field, test_value)
@pytest.mark.parametrize(
"test_field,test_value",
[
("createdBy", {"firstName": "Sneaky", "lastName": "User", "orcidId": "0000-9999-9999-0000"}),
("modifiedBy", {"firstName": "Sneaky", "lastName": "User", "orcidId": "0000-9999-9999-0000"}),
("creationDate", date(2020, 4, 1).isoformat()),
("modificationDate", date(2020, 4, 1).isoformat()),
("publishedDate", date(2020, 4, 1).isoformat()),
],
)
def test_cannot_edit_special_fields(client, setup_router_db, test_field, test_value):
experiment = create_experiment(client)
response_data = create_experiment(client, {test_field: test_value, "urn": experiment["urn"]})
if test_field in response_data:
assert (test_field, response_data[test_field]) != (test_field, test_value)
def test_cannot_assign_to_missing_experiment_set(client, setup_router_db):
experiment_set_urn = "tmp:33df10c9-78b3-4e04-bafb-2446078573d7"
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": experiment_set_urn})
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 404
response_data = response.json()
assert f"experiment set with URN '{experiment_set_urn}' not found" in response_data["detail"]
def test_can_update_own_private_experiment_set(session, client, setup_router_db):
experiment = create_experiment(client)
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": experiment["experimentSetUrn"], "title": "Second Experiment"})
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 200
assert response.json()["experimentSetUrn"] == experiment["experimentSetUrn"]
assert response.json()["title"] == "Second Experiment"
def test_cannot_update_other_users_private_experiment_set(session, client, setup_router_db):
experiment = create_experiment(client)
change_ownership(session, experiment["urn"], ExperimentDbModel)
change_ownership(session, experiment["experimentSetUrn"], ExperimentSetDbModel)
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": experiment["experimentSetUrn"]})
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 404
response_data = response.json()
assert f"experiment set with URN '{experiment['experimentSetUrn']}' not found" in response_data["detail"]
def test_anonymous_cannot_update_other_users_private_experiment_set(
session, client, anonymous_app_overrides, setup_router_db
):
experiment = create_experiment(client)
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": experiment["experimentSetUrn"]})
with DependencyOverrider(anonymous_app_overrides):
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 401
response_data = response.json()
assert "Could not validate credentials" in response_data["detail"]
def test_admin_can_update_other_users_private_experiment_set(session, client, admin_app_overrides, setup_router_db):
experiment = create_experiment(client)
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": experiment["experimentSetUrn"], "title": "Second Experiment"})
with DependencyOverrider(admin_app_overrides):
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 200
assert response.json()["experimentSetUrn"] == experiment["experimentSetUrn"]
assert response.json()["title"] == "Second Experiment"
def test_can_update_own_public_experiment_set(session, data_provider, client, setup_router_db, data_files):
experiment = create_experiment(client)
unpublished_score_set = create_seq_score_set(client, experiment["urn"])
unpublished_score_set = mock_worker_variant_insertion(
client, session, data_provider, unpublished_score_set, data_files / "scores.csv"
)
with patch.object(arq.ArqRedis, "enqueue_job", return_value=None) as worker_queue:
published_score_set = publish_score_set(client, unpublished_score_set["urn"])
worker_queue.assert_called_once()
response_data = create_experiment(
client,
{"experimentSetUrn": published_score_set["experiment"]["experimentSetUrn"], "title": "Second Experiment"},
)
assert response_data["experimentSetUrn"] == published_score_set["experiment"]["experimentSetUrn"]
assert response_data["title"] == "Second Experiment"
def test_cannot_update_other_users_public_experiment_set(session, data_provider, client, setup_router_db, data_files):
experiment = create_experiment(client)
unpublished_score_set = create_seq_score_set(client, experiment["urn"])
unpublished_score_set = mock_worker_variant_insertion(
client, session, data_provider, unpublished_score_set, data_files / "scores.csv"
)
with patch.object(arq.ArqRedis, "enqueue_job", return_value=None) as worker_queue:
published_score_set = publish_score_set(client, unpublished_score_set["urn"])
worker_queue.assert_called_once()
published_experiment_set_urn = published_score_set["experiment"]["experimentSetUrn"]
change_ownership(session, published_experiment_set_urn, ExperimentSetDbModel)
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": published_experiment_set_urn, "title": "Second Experiment"})
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 403
response_data = response.json()
assert (
f"insufficient permissions on experiment set with URN '{published_experiment_set_urn}'"
in response_data["detail"]
)
def test_anonymous_cannot_update_others_user_public_experiment_set(
session, data_provider, client, anonymous_app_overrides, setup_router_db, data_files
):
experiment = create_experiment(client)
unpublished_score_set = create_seq_score_set(client, experiment["urn"])
unpublished_score_set = mock_worker_variant_insertion(
client, session, data_provider, unpublished_score_set, data_files / "scores.csv"
)
with patch.object(arq.ArqRedis, "enqueue_job", return_value=None) as worker_queue:
published_score_set = publish_score_set(client, unpublished_score_set["urn"])
worker_queue.assert_called_once()
published_experiment_set_urn = published_score_set["experiment"]["experimentSetUrn"]
experiment_post_payload = deepcopy(TEST_MINIMAL_EXPERIMENT)
experiment_post_payload.update({"experimentSetUrn": published_experiment_set_urn, "title": "Second Experiment"})
with DependencyOverrider(anonymous_app_overrides):
response = client.post("/api/v1/experiments/", json=experiment_post_payload)
assert response.status_code == 401
response_data = response.json()
assert "Could not validate credentials" in response_data["detail"]
def test_admin_can_update_other_users_public_experiment_set(
session, data_provider, client, admin_app_overrides, setup_router_db, data_files
):
experiment = create_experiment(client)
unpublished_score_set = create_seq_score_set(client, experiment["urn"])
unpublished_score_set = mock_worker_variant_insertion(
client, session, data_provider, unpublished_score_set, data_files / "scores.csv"
)
with patch.object(arq.ArqRedis, "enqueue_job", return_value=None) as worker_queue:
published_score_set = publish_score_set(client, unpublished_score_set["urn"])
worker_queue.assert_called_once()
with DependencyOverrider(admin_app_overrides):
response_data = create_experiment(
client,
{"experimentSetUrn": published_score_set["experiment"]["experimentSetUrn"], "title": "Second Experiment"},
)
assert response_data["experimentSetUrn"] == published_score_set["experiment"]["experimentSetUrn"]
assert response_data["title"] == "Second Experiment"
def test_edit_preserves_optional_metadata(client, setup_router_db):
pass
@pytest.mark.parametrize(
"test_field,test_value",
[
("title", "Edited Title"),
("shortDescription", "Edited Short Description"),
("abstractText", "Edited Abstract"),
("methodText", "Edited Methods"),
],
)
def test_can_edit_private_experiment(client, setup_router_db, test_field, test_value):
experiment = create_experiment(client)
experiment_post_payload = experiment.copy()
experiment_post_payload.update({test_field: test_value, "urn": experiment["urn"]})
response = client.put(f"/api/v1/experiments/{experiment['urn']}", json=experiment_post_payload)
assert response.status_code == 200
response_data = response.json()
jsonschema.validate(instance=response_data, schema=Experiment.model_json_schema())
assert (test_field, response_data[test_field]) == (test_field, test_value)
def test_can_add_contributor_to_own_private_experiment(client, setup_router_db):
experiment = create_experiment(client)
experiment_post_payload = experiment.copy()
experiment_post_payload.update({"contributors": [{"orcid_id": TEST_ORCID_ID}]})
with patch(
"mavedb.lib.orcid.fetch_orcid_user",
lambda orcid_id: OrcidUser(orcid_id=orcid_id, given_name="ORCID", family_name="User"),
):
response = client.put(f"/api/v1/experiments/{experiment['urn']}", json=experiment_post_payload)