Skip to content

test_files_bulk#

build_files_json#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def build_files_json(file_kwargs: List[dict], storage=None):
    if storage is None:
        storage = factories.FileStorageFactory(
            csc_project="project_x",
            storage_service="ida",
        )

    factory = factories.FileFactory
    instances = []
    for kwargs in file_kwargs:
        factory_args = {k: v for k, v in kwargs.items() if k not in ["exists", "fields"]}
        if kwargs.get("exists"):
            instances.append(factory.create(storage=storage, **factory_args))
        else:
            instances.append(factory.build(storage=storage, **factory_args))

    files = [FileSerializer(f).data for f in instances]
    for f in files:
        f.pop("record_modified", None)  # Ignored by metax
        if f.get("id") is None:
            # Remove read-only fields from new files
            f.pop("id", None)
            f.pop("record_created", None)
        if fields := kwargs.get("fields"):
            # Remove fields not specified in fields list
            for field in list(f):
                if field not in fields:
                    f.pop(field, None)
    return files

csc_project#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
47
48
49
50
51
52
@pytest.fixture
def csc_project() -> FileStorage:
    return factories.FileStorageFactory(
        csc_project="project_x",
        storage_service="ida",
    )

another_csc_project#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
55
56
57
58
59
60
@pytest.fixture
def another_csc_project() -> FileStorage:
    return factories.FileStorageFactory(
        csc_project="project_abc",
        storage_service="ida",
    )

action_url#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@pytest.fixture(scope="module")
def action_url():
    def _action_url(action: str, ignore_errors=False):
        query = "?ignore_errors=true" if ignore_errors else ""
        if action == "insert":
            return reverse("file-post-many") + query
        elif action == "update":
            return reverse("file-patch-many") + query
        elif action == "upsert":
            return reverse("file-put-many") + query
        elif action == "delete":
            return reverse("file-delete-many") + query

    return _action_url

test_files_insert_many_ok#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def test_files_insert_many_ok(ida_client, action_url):
    files = build_files_json(
        [
            {"id": None, "exists": False},
            {"id": None, "exists": False},
            {"id": None, "exists": False},
        ]
    )
    res = ida_client.post(
        action_url("insert"),
        files,
        content_type="application/json",
    )
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": files[0], "action": "insert"},
            {"object": files[1], "action": "insert"},
            {"object": files[2], "action": "insert"},
        ],
        res.json()["success"],
    )

test_files_insert_many_ok_missing_storage_identifier#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def test_files_insert_many_ok_missing_storage_identifier(ida_client, action_url):
    files = build_files_json(
        [
            {"id": None, "exists": False, "storage_identifier": None},
        ]
    )
    res = ida_client.post(
        action_url("insert"),
        files,
        content_type="application/json",
    )
    assert res.status_code == 400
    assert_nested_subdict(
        [
            {
                "errors": {"storage_identifier": RegexField("Field is required")},
            }
        ],
        res.json()["failed"],
    )

test_files_insert_many_missing_storage_identifier#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def test_files_insert_many_missing_storage_identifier(ida_client, action_url):
    files = build_files_json(
        [
            {"id": None, "exists": False, "storage_identifier": None},
        ]
    )
    res = ida_client.post(
        action_url("insert", ignore_errors=True),
        files,
        content_type="application/json",
    )
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {
                "errors": {"storage_identifier": RegexField("Field is required")},
            }
        ],
        res.json()["failed"],
    )

test_files_insert_many_multiple_storages#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def test_files_insert_many_multiple_storages(
    ida_client, csc_project, another_csc_project, action_url
):
    files = build_files_json([{"id": None}], storage=csc_project)
    files += build_files_json([{"id": None}], storage=another_csc_project)
    res = ida_client.post(action_url("insert"), files, content_type="application/json")
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": files[0], "action": "insert"},
            {"object": files[1], "action": "insert"},
        ],
        res.json()["success"],
    )

test_files_insert_many_missing_required_fields#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_insert_many_missing_required_fields(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": False, "fields": ["csc_project", "storage"]},
        ]
    )
    res = ida_client.post(action_url("insert"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": files[0],
                    "errors": {
                        "pathname": "This field is required.",
                        "modified": "This field is required.",
                        "checksum": "This field is required.",
                    },
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_insert_many_id_not_allowed#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_insert_many_id_not_allowed(ida_client, action_url):
    files = build_files_json([{"exists": False}])
    res = ida_client.post(action_url("insert"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": {"id": files[0]["id"]},
                    "errors": {"id": RegexField("not allowed for inserting")},
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": files[0],
                    "errors": {"id": RegexField("not allowed")},
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_insert_many_file_path_already_exists#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_insert_many_file_path_already_exists(ida_client, csc_project, action_url):
    existing_files = build_files_json(
        [{"exists": True, "pathname": "/data/1.txt"}], storage=csc_project
    )
    files = build_files_json(
        [{"exists": False, "id": None, "pathname": "/data/1.txt"}], storage=csc_project
    )
    res = ida_client.post(
        action_url("insert", ignore_errors=True), files, content_type="application/json"
    )
    assert res.status_code == 200
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": {"pathname": files[0]["pathname"]},
                    "errors": {
                        "pathname": RegexField(f"already exists.*{existing_files[0]['id']}")
                    },
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_insert_many_duplicate_file_path#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
def test_files_insert_many_duplicate_file_path(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": False, "id": None, "pathname": "/data/1.txt"},
            {"exists": False, "id": None, "pathname": "/data/1.txt"},
        ],
    )
    res = ida_client.post(
        action_url("insert", ignore_errors=True), files, content_type="application/json"
    )
    assert res.status_code == 200
    assert_nested_subdict(
        {
            "success": [{"object": files[0]}],
            "failed": [
                {
                    "object": files[1],
                    "errors": {"pathname": RegexField("Duplicate value")},
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_insert_many_invalid_file_storage#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
def test_files_insert_many_invalid_file_storage(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": False, "id": None, "pathname": "/data/1.txt"},
            {"exists": False, "id": None, "pathname": "/data/1.txt"},
        ],
    )
    files[0]["storage_service"] = "doesnotexist"
    res = ida_client.post(action_url("insert"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        [{"errors": {"storage_service": RegexField("not a valid choice")}}],
        res.json()["failed"],
        check_list_length=True,
    )

test_files_insert_many_with_external_id#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
def test_files_insert_many_with_external_id(ida_client, action_url):
    files = build_files_json(
        [
            {"id": None, "storage_identifier": "x"},
            {"id": None, "storage_identifier": "y"},
        ]
    )
    res = ida_client.post(
        action_url("insert"),
        files,
        content_type="application/json",
    )
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": files[0], "action": "insert"},
            {"object": files[1], "action": "insert"},
        ],
        res.json()["success"],
    )

test_files_insert_many_same_external_id_different_storage#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_insert_many_same_external_id_different_storage(ida_client, action_url):
    storage_ida = factories.FileStorageFactory(
        csc_project="project_x",
        storage_service="ida",
    )
    storage_pas = factories.FileStorageFactory(
        csc_project="project_x",
        storage_service="pas",
    )
    files = [
        *build_files_json([{"id": None, "storage_identifier": "x"}], storage=storage_ida),
        *build_files_json([{"id": None, "storage_identifier": "x"}], storage=storage_pas),
    ]
    res = ida_client.post(
        action_url("insert"),
        files,
        content_type="application/json",
    )
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": files[0], "action": "insert"},
            {"object": files[1], "action": "insert"},
        ],
        res.json()["success"],
    )

test_files_update_many_ok#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
def test_files_update_many_ok(ida_client, action_url):
    files = build_files_json(
        [
            {"size": 100, "exists": True},
            {"size": 200, "exists": True},
            {"size": 300, "exists": True},
        ]
    )
    res = ida_client.post(action_url("update"), files, content_type="application/json")
    assert_nested_subdict(
        [
            {"object": files[0], "action": "update"},
            {"object": files[1], "action": "update"},
            {"object": files[2], "action": "update"},
        ],
        res.json()["success"],
    )

test_files_update_many_id_required#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
def test_files_update_many_id_required(ida_client, action_url):
    files = build_files_json([{"exists": False, "id": None}])
    res = ida_client.post(action_url("update"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": files[0],
                    "errors": {"id": "File not found."},
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_update_many_existing_file_required#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
def test_files_update_many_existing_file_required(ida_client, action_url):
    files = build_files_json([{"exists": True}])
    files[0]["id"] = str(uuid.uuid4())
    res = ida_client.post(action_url("update"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": files[0],
                    "errors": {"id": RegexField("id not found")},
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_update_many_read_only_field#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
def test_files_update_many_read_only_field(ida_client, action_url):
    files = build_files_json([{"exists": True}])
    files[0].update(pathname="/a_new_path/file.x")
    res = ida_client.post(action_url("update"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": files[0],
                    "errors": {
                        "pathname": RegexField(
                            "Cannot change value",
                        ),
                    },
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_update_many_change_project_for_existing#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_update_many_change_project_for_existing(ida_client, action_url):
    files = build_files_json([{"exists": True}])
    factories.FileStorageFactory(
        csc_project="another_project",
        storage_service="ida",
    )
    files[0].update(csc_project="another_project")
    res = ida_client.post(action_url("update"), files, content_type="application/json")
    assert res.status_code == 400
    match_readonly = RegexField("Cannot change value")
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {
                    "object": files[0],
                    "errors": {
                        "csc_project": match_readonly,
                    },
                }
            ],
        },
        res.json(),
        check_list_length=True,
    )

test_files_upsert_many_ok#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
def test_files_upsert_many_ok(ida_client, action_url):
    files = build_files_json(
        [
            {"size": 100, "exists": True},
            {"size": 200, "exists": False, "id": None},
            {"size": 300, "exists": False, "id": None},
            {"size": 400, "exists": True},
        ]
    )
    res = ida_client.post(action_url("upsert"), files, content_type="application/json")
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": files[0], "action": "update"},
            {"object": files[1], "action": "insert"},
            {"object": files[2], "action": "insert"},
            {"object": files[3], "action": "update"},
        ],
        res.json()["success"],
    )

test_files_upsert_many_with_external_identifier#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
def test_files_upsert_many_with_external_identifier(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": True, "storage_identifier": "file1"},
            {
                "exists": False,
                "storage_identifier": "file2",
                "id": None,
            },
        ]
    )
    res = ida_client.post(action_url("upsert"), files, content_type="application/json")
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": files[0], "action": "update"},
            {"object": files[1], "action": "insert"},
        ],
        res.json()["success"],
        check_list_length=True,
    )

test_files_upsert_many_with_missing_fields_for_new#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_upsert_many_with_missing_fields_for_new(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": True, "storage_identifier": "file1"},
            {
                "exists": False,
                "storage_identifier": "file2",
                "id": None,
            },
        ]
    )
    del files[1]["pathname"]
    del files[1]["checksum"]
    res = ida_client.post(
        action_url("upsert", ignore_errors=True), files, content_type="application/json"
    )
    assert res.status_code == 200
    assert_nested_subdict(
        {
            "success": [
                {"object": files[0], "action": "update"},
            ],
            "failed": [{"object": files[1]}],
        },
        res.json(),
        check_list_length=True,
    )

test_files_upsert_many_unknown_field#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
def test_files_upsert_many_unknown_field(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": True, "storage_identifier": "file1"},
        ]
    )
    files[0]["thisfielddoesnotexist"] = "something"
    res = ida_client.post(action_url("upsert"), files, content_type="application/json")
    assert res.status_code == 400
    assert_nested_subdict(
        {
            "success": [],
            "failed": [
                {"errors": {"thisfielddoesnotexist": "Unknown field"}, "object": files[0]},
            ],
        },
        res.json(),
        check_list_length=True,
    )

set_removed#

Change file json "removed" timestamp to match any date value.

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
547
548
549
def set_removed(file):
    """Change file json "removed" timestamp to match any date value."""
    return {**file, "removed": DateTimeField()}

test_files_delete_many_ok#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
def test_files_delete_many_ok(ida_client):
    files = build_files_json(
        [
            {"exists": True},
            {"exists": True},
            {"exists": True},
        ]
    )
    res = ida_client.post("/v3/files/delete-many", files, content_type="application/json")
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": set_removed(files[0]), "action": "delete"},
            {"object": set_removed(files[1]), "action": "delete"},
            {"object": set_removed(files[2]), "action": "delete"},
        ],
        res.json()["success"],
    )
    assert File.all_objects.filter(id__in=[f["id"] for f in files], is_removed=True).count() == 3

test_files_delete_many_only_id#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
def test_files_delete_many_only_id(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": True},
        ]
    )
    res = ida_client.post(
        action_url("delete"), [{"id": files[0]["id"]}], content_type="application/json"
    )
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": set_removed(files[0]), "action": "delete"},
        ],
        res.json()["success"],
    )
    assert File.all_objects.filter(id__in=[f["id"] for f in files], is_removed=True).count() == 1

test_files_delete_many_with_external_id#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
def test_files_delete_many_with_external_id(ida_client, action_url):
    files = build_files_json(
        [
            {"exists": True, "storage_identifier": "file1"},
        ]
    )
    file = {
        "storage_identifier": files[0]["storage_identifier"],
        "storage_service": files[0]["storage_service"],
    }
    res = ida_client.post(action_url("delete"), [file], content_type="application/json")
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": set_removed(files[0]), "action": "delete"},
        ],
        res.json()["success"],
    )
    assert File.all_objects.filter(id__in=[f["id"] for f in files], is_removed=True).count() == 1

test_files_delete_many_non_existing#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
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
def test_files_delete_many_non_existing(ida_client):
    files = build_files_json(
        [
            {"exists": True},
            {"exists": False},
            {"exists": False},
        ]
    )
    res = ida_client.post(
        "/v3/files/delete-many?ignore_errors=true", files, content_type="application/json"
    )
    assert res.status_code == 200
    assert_nested_subdict(
        {
            "success": [
                {"object": set_removed(files[0]), "action": "delete"},
            ],
            "failed": [
                {"object": files[1], "errors": {"id": "File with id not found."}},
                {"object": files[2], "errors": {"id": "File with id not found."}},
            ],
        },
        res.json(),
    )
    File.all_objects.filter(id__in=[f["id"] for f in files], is_removed=True).count() == 3

test_files_delete_many_multiple_projects#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
640
641
642
643
644
645
646
647
648
649
650
651
652
653
def test_files_delete_many_multiple_projects(
    ida_client, csc_project, another_csc_project, action_url
):
    files = build_files_json([{"exists": True}], storage=csc_project)
    files += build_files_json([{"exists": True}], storage=another_csc_project)
    res = ida_client.post(action_url("delete"), files, content_type="application/json")
    assert res.status_code == 200
    assert_nested_subdict(
        [
            {"object": set_removed(files[0]), "action": "delete"},
            {"object": set_removed(files[1]), "action": "delete"},
        ],
        res.json()["success"],
    )

test_files_delete_duplicate_id#

Source code in tests/unit/apps/files/api/files/test_files_bulk.py 
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
def test_files_delete_duplicate_id(ida_client, csc_project, another_csc_project, action_url):
    files = build_files_json([{"exists": True}], storage=csc_project)
    files += files
    res = ida_client.post(
        action_url("delete", ignore_errors=True), files, content_type="application/json"
    )
    assert res.status_code == 200
    assert_nested_subdict(
        {
            "success": [
                {"object": set_removed(files[0]), "action": "delete"},
            ],
            "failed": [
                {"object": files[1], "errors": {"id": RegexField("Duplicate file")}},
            ],
        },
        res.json(),
    )