Skip to content

test_dataset_files_allowed_actions#

do_action#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
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
@pytest.fixture
def do_action(data_catalog, admin_client, deep_file_tree):
    def _do(
        state,
        has_files,
        action=None,
        cumulative_state=Dataset.CumulativeState.NOT_CUMULATIVE,
        patch_fields={},
    ):
        if state == "published" or state == "draft_of":
            dataset = factories.PublishedDatasetFactory(
                data_catalog=data_catalog, cumulative_state=cumulative_state
            )
        elif state == "draft":
            dataset = factories.DatasetFactory(
                data_catalog=data_catalog, cumulative_state=cumulative_state
            )

        if has_files:
            initial_actions = {
                **deep_file_tree["params"],
                "directory_actions": [{"pathname": "/dir1/"}],
            }
            res = admin_client.patch(
                f"/v3/datasets/{dataset.id}",
                {"fileset": initial_actions},
                content_type="application/json",
            )
            assert res.status_code == 200
            dataset.refresh_from_db()

        if state == "draft_of":
            dataset = dataset.create_new_draft()

        if action:
            actions = {
                **deep_file_tree["params"],
                "directory_actions": [
                    {"pathname": "/dir1/", "action": action},
                    {"pathname": "/dir2/", "action": action},
                ],
            }
            res = admin_client.patch(
                f"/v3/datasets/{dataset.id}",
                {"fileset": actions, **patch_fields},
                content_type="application/json",
            )
        else:
            res = admin_client.patch(
                f"/v3/datasets/{dataset.id}",
                patch_fields,
                content_type="application/json",
            )
        return res

    return _do

test_add_files_to_empty_published_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
69
70
71
def test_add_files_to_empty_published_dataset(do_action):
    res = do_action(state="published", has_files=False, action="add")
    assert res.status_code == 200

test_add_files_to_published_dataset_with_files#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
74
75
76
77
78
79
80
def test_add_files_to_published_dataset_with_files(do_action):
    res = do_action(state="published", has_files=True, action="add")
    assert res.status_code == 400
    assert (
        res.json()["fileset"]["action"]
        == "Adding files to a published noncumulative dataset is not allowed."
    )

test_add_files_to_draft_of_empty_published_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
83
84
85
def test_add_files_to_draft_of_empty_published_dataset(do_action):
    res = do_action(state="draft_of", has_files=False, action="add")
    assert res.status_code == 200

test_add_files_to_draft_of_published_dataset_with_files#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
88
89
90
91
92
93
94
def test_add_files_to_draft_of_published_dataset_with_files(do_action):
    res = do_action(state="draft_of", has_files=True, action="add")
    assert res.status_code == 400
    assert (
        res.json()["fileset"]["action"]
        == "Adding files to a published noncumulative dataset is not allowed."
    )

test_add_files_to_cumulative_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
 97
 98
 99
100
101
102
103
104
105
def test_add_files_to_cumulative_dataset(do_action):
    res = do_action(
        state="published",
        has_files=True,
        action="add",
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.ACTIVE

test_add_files_to_cumulative_dataset_and_close#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def test_add_files_to_cumulative_dataset_and_close(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="published",
        has_files=True,
        action="add",
        cumulative_state=Dataset.CumulativeState.ACTIVE,
        patch_fields={"cumulative_state": Dataset.CumulativeState.CLOSED},
    )
    assert res.status_code == 200

    # Check dataset is closed
    res = admin_client.patch(
        f"/v3/datasets/{res.data['id']}",
        {"fileset": {**deep_file_tree["params"], "directory_actions": [{"pathname": "/"}]}},
        content_type="application/json",
    )
    assert res.status_code == 400
    assert (
        res.json()["fileset"]["action"]
        == "Adding files to a published noncumulative dataset is not allowed."
    )

test_change_published_dataset_cumulative#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
131
132
133
134
135
136
137
138
139
140
def test_change_published_dataset_cumulative(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="published",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.NOT_CUMULATIVE,
        patch_fields={"cumulative_state": Dataset.CumulativeState.ACTIVE},
    )
    # Dataset already published, cannot make it cumulative afterwards
    assert res.status_code == 400
    assert res.json()["cumulative_state"] == "Cannot change state to 1."

test_add_files_to_cumulative_dataset_and_exclude_some#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def test_add_files_to_cumulative_dataset_and_exclude_some(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="published",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )

    # Allow "remove" if it excludes files being added and does not remove any existing
    res = admin_client.patch(
        f"/v3/datasets/{res.data['id']}",
        {
            "fileset": {
                **deep_file_tree["params"],
                "directory_actions": [{"pathname": "/dir3/"}],
                "file_actions": [{"pathname": "/dir3/sub1/file.txt", "action": "remove"}],
            }
        },
        content_type="application/json",
    )
    assert res.status_code == 200

test_remove_files_from_draft_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
168
169
170
171
172
173
174
def test_remove_files_from_draft_dataset(do_action):
    res = do_action(
        state="draft",
        has_files=True,
        action="remove",
    )
    assert res.status_code == 200

test_remove_files_from_cumulative_draft_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
177
178
179
180
181
182
183
184
def test_remove_files_from_cumulative_draft_dataset(do_action):
    res = do_action(
        state="draft",
        has_files=True,
        action="remove",
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200

test_remove_files_from_published_dataset_with_files#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
187
188
189
190
191
192
193
194
195
196
197
def test_remove_files_from_published_dataset_with_files(do_action):
    res = do_action(
        state="published",
        has_files=True,
        action="remove",
    )
    assert res.status_code == 400
    assert (
        res.json()["fileset"]["action"]
        == "Removing files from a published dataset is not allowed."
    )

test_remove_files_from_cumulative_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
200
201
202
203
204
205
206
207
208
209
210
211
def test_remove_files_from_cumulative_dataset(do_action):
    res = do_action(
        state="published",
        has_files=True,
        action="remove",
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 400
    assert (
        res.json()["fileset"]["action"]
        == "Removing files from a published dataset is not allowed."
    )

test_merge_file_addition_to_cumulative_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
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
def test_merge_file_addition_to_cumulative_dataset(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="draft_of",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.ACTIVE

    res = admin_client.patch(
        f"/v3/datasets/{res.data['id']}",
        {
            "cumulative_state": Dataset.CumulativeState.CLOSED,
            "fileset": {**deep_file_tree["params"], "directory_actions": [{"pathname": "/"}]},
        },
        content_type="application/json",
    )
    assert res.status_code == 200

    res = admin_client.post(
        f"/v3/datasets/{res.data['id']}/publish?include_nulls=true",
        content_type="application/json",
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.CLOSED
    assert res.data["next_draft"] is None

test_file_addition_original_is_closed#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
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
def test_file_addition_original_is_closed(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="draft_of",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.ACTIVE

    # Close original
    close_res = admin_client.patch(
        f"/v3/datasets/{res.data['draft_of']['id']}",
        {"cumulative_state": Dataset.CumulativeState.CLOSED},
        content_type="application/json",
    )
    assert close_res.status_code == 200

    # Closed original should prevent adding files to draft
    res = admin_client.patch(
        f"/v3/datasets/{res.data['id']}",
        {
            "cumulative_state": Dataset.CumulativeState.CLOSED,
            "fileset": {**deep_file_tree["params"], "directory_actions": [{"pathname": "/"}]},
        },
        content_type="application/json",
    )
    assert res.status_code == 400
    assert (
        res.json()["fileset"]["action"]
        == "Adding files to a published noncumulative dataset is not allowed."
    )

test_merge_file_addition_to_closed_dataset#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
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
def test_merge_file_addition_to_closed_dataset(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="draft_of",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.ACTIVE

    # Add files while original is not yet closed
    res = admin_client.patch(
        f"/v3/datasets/{res.data['id']}",
        {
            "fileset": {**deep_file_tree["params"], "directory_actions": [{"pathname": "/"}]},
        },
        content_type="application/json",
    )
    assert res.status_code == 200

    # Close original
    close_res = admin_client.patch(
        f"/v3/datasets/{res.data['draft_of']['id']}",
        {"cumulative_state": Dataset.CumulativeState.CLOSED},
        content_type="application/json",
    )
    assert close_res.status_code == 200

    # Incompatible draft, merge should be prevented
    res = admin_client.post(
        f"/v3/datasets/{res.data['id']}/publish",
        content_type="application/json",
    )
    assert res.status_code == 400
    assert res.json()["fileset"] == "Merging changes would add files, which is not allowed."

test_merge_file_removal#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
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
def test_merge_file_removal(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="draft_of",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.ACTIVE

    # Add files to original
    orig_res = admin_client.patch(
        f"/v3/datasets/{res.data['draft_of']['id']}",
        {
            "cumulative_state": Dataset.CumulativeState.CLOSED,
            "fileset": {**deep_file_tree["params"], "directory_actions": [{"pathname": "/"}]},
        },
        content_type="application/json",
    )
    assert orig_res.status_code == 200

    # Files added to original are missing from draft, so merge would remove them
    res = admin_client.post(
        f"/v3/datasets/{res.data['id']}/publish",
        content_type="application/json",
    )
    assert res.status_code == 400
    assert res.json()["fileset"] == "Merging changes would remove files, which is not allowed."

test_merge_close#

Source code in tests/unit/apps/core/api/dataset_files/test_dataset_files_allowed_actions.py 
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
def test_merge_close(do_action, admin_client, deep_file_tree):
    res = do_action(
        state="draft_of",
        has_files=True,
        cumulative_state=Dataset.CumulativeState.ACTIVE,
    )
    assert res.status_code == 200
    assert res.data["cumulative_state"] == Dataset.CumulativeState.ACTIVE
    assert res.data["fileset"] != None

    # Set draft to close cumulation
    orig_res = admin_client.patch(
        f"/v3/datasets/{res.data['id']}",
        {
            "cumulative_state": Dataset.CumulativeState.CLOSED,
        },
        content_type="application/json",
    )
    assert orig_res.status_code == 200
    assert res.data["fileset"] != None

    res = admin_client.post(
        f"/v3/datasets/{res.data['id']}/publish",
        content_type="application/json",
    )
    assert res.status_code == 200
    assert res.data["fileset"] != None