Skip to content

test_dataset_drafts#

pop_nested_ids#

Remove ids from nested dicts, return id to dict mapping.

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def pop_nested_ids(dataset: dict) -> dict:
    """Remove ids from nested dicts, return id to dict mapping."""
    ids = {}

    def _pop(object):
        if isinstance(object, list):
            object = dict(enumerate(object))
        if isinstance(object, dict):
            if "id" in object:
                obj_id = object.pop("id")
                if not "pref_label" in object:  # ignore refdata
                    ids[obj_id] = object
            for key, value in object.items():
                if key != "dataset_versions":  # ignore dataset_versions
                    _pop(value)

    _pop(dataset)
    return ids

test_create_draft#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
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
def test_create_draft(admin_client, dataset_a_json, data_catalog, reference_data):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft?include_nulls=true",
        dataset_a_json,
        content_type="application/json",
    )
    assert res.status_code == 201
    draft = res.json()

    res = admin_client.get(
        f"/v3/datasets/{dataset_id}?include_nulls=true", content_type="application/json"
    )
    assert res.status_code == 200
    original = res.json()

    assert original["state"] == "published"
    assert draft["state"] == "draft"
    assert draft["draft_of"]["id"] == original["id"]
    assert original["next_draft"]["id"] == draft["id"]
    metadata_owner_id = draft["metadata_owner"]["id"]
    assert draft["metadata_owner"] == original["metadata_owner"]

    # Remove fields that should be different
    for field in [
        "id",
        "state",
        "next_draft",
        "draft_of",
        "published_revision",
        "draft_revision",
        "created",
        "modified",
        "persistent_identifier",
    ]:
        original.pop(field)
        draft.pop(field)

    # Nested data should be equal but with different ids (except refdata and dataset_versions)
    original_ids = pop_nested_ids(original)
    draft_ids = pop_nested_ids(draft)
    assert original == draft

    # Check that no nested ids are shared
    original_ids.pop(metadata_owner_id)
    draft_ids.pop(metadata_owner_id)
    assert set(original_ids).intersection(draft_ids) == set()

test_create_draft_from_draft#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def test_create_draft_from_draft(admin_client, dataset_a_json, data_catalog, reference_data):
    dataset_a_json["state"] = "draft"
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 400
    assert res.json()["state"] == "Dataset needs to be published before creating a new draft."

test_create_draft_twice#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def test_create_draft_twice(admin_client, dataset_a_json, data_catalog, reference_data):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 201
    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 400
    assert res.json()["next_draft"] == "Dataset already has a draft."

test_create_draft_by_changing_state#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
123
124
125
126
127
128
129
130
131
132
133
134
def test_create_draft_by_changing_state(
    admin_client, dataset_a_json, data_catalog, reference_data
):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.patch(
        f"/v3/datasets/{dataset_id}", {"state": "draft"}, content_type="application/json"
    )
    assert res.status_code == 400
    assert res.json()["state"] == "Value cannot be changed directly for an existing dataset."

test_merge_draft#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
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
@pytest.mark.usefixtures("data_catalog", "reference_data")
def test_merge_draft(admin_client, dataset_a_json, dataset_maximal_json, dataset_signal_handlers):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    assert res.data["state"] == "published"
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 201
    draft_id = res.data["id"]

    dataset_maximal_json.pop("metadata_owner")
    res = admin_client.patch(
        f"/v3/datasets/{draft_id}?include_nulls=true",
        dataset_maximal_json,
        content_type="application/json",
    )
    assert res.status_code == 200
    draft_data = deepcopy(res.json())

    # Merge draft
    dataset_signal_handlers.reset()
    res = admin_client.post(
        f"/v3/datasets/{draft_id}/publish?include_nulls=true", content_type="application/json"
    )
    assert res.status_code == 200
    merge_data = res.json()  # response should be the updated original dataset
    dataset_signal_handlers.assert_call_counts(created=0, updated=1)
    assert str(dataset_signal_handlers.updated.call_args.kwargs["data"].id) == dataset_id

    # Dataset has been updated
    res = admin_client.get(
        f"/v3/datasets/{dataset_id}?include_nulls=true", content_type="application/json"
    )
    assert res.status_code == 200

    published_data = deepcopy(res.json())
    assert published_data == merge_data

    # Remove fields that should be different for draft and merged version
    for field in [
        "id",
        "state",
        "published_revision",
        "draft_revision",
        "draft_of",
        "next_draft",
        "created",
        "dataset_versions",
    ]:
        draft_data.pop(field)
        published_data.pop(field)
    assert draft_data.pop("persistent_identifier") != published_data.pop("persistent_identifier")

    # Check that data from draft has been moved to published version
    assert_nested_subdict(draft_data, published_data)

    # Draft has been removed
    res = admin_client.get(f"/v3/datasets/{draft_id}", content_type="application/json")
    assert res.status_code == 404

test_delete_draft#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def test_delete_draft(admin_client, dataset_a_json, data_catalog, reference_data):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 201
    draft = res.data
    assert Dataset.all_objects.filter(id=draft["id"]).exists()

    res = admin_client.delete(
        f"/v3/datasets/{draft['id']}", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 204
    assert not Dataset.all_objects.filter(id=draft["id"]).exists()

test_draft_revisions#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
def test_draft_revisions(admin_client, dataset_a_json, data_catalog, reference_data):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 201
    draft = res.data

    res = admin_client.get(
        f"/v3/datasets/{draft['id']}/revisions", content_type="application/json"
    )
    assert res.status_code == 200
    assert isinstance(res.data, list)

    # FIXME:
    # Creating a dataset and each m2m change create a revision.
    # It would be better if revision was only created only
    # once, after all m2m changes have been done.
    assert len(res.data) == 1

test_new_published_revisions#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
244
245
246
247
248
249
250
251
252
253
def test_new_published_revisions(admin_client, dataset_a_json, data_catalog, reference_data):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.get(f"/v3/datasets/{dataset_id}/revisions", content_type="application/json")
    assert res.status_code == 200
    assert isinstance(res.data, list)
    assert len(res.data) == 1
    assert res.data[0]["published_revision"] == 1

test_new_draft_publish_revisions#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
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
@pytest.mark.usefixtures("data_catalog", "reference_data")
def test_new_draft_publish_revisions(admin_client, dataset_a_json, dataset_signal_handlers):
    dataset_signal_handlers.assert_call_counts(created=0, updated=0)
    dataset_a_json["state"] = "draft"
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]
    dataset_signal_handlers.assert_call_counts(created=1, updated=0)
    dataset_signal_handlers.reset()
    res = admin_client.post(f"/v3/datasets/{dataset_id}/publish", content_type="application/json")
    assert res.status_code == 200
    dataset_signal_handlers.assert_call_counts(created=0, updated=1)

    res = admin_client.get(f"/v3/datasets/{dataset_id}/revisions", content_type="application/json")
    assert res.status_code == 200
    assert isinstance(res.data, list)
    assert len(res.data) == 1
    assert res.data[0]["published_revision"] == 1

    res = admin_client.patch(
        f"/v3/datasets/{dataset_id}",
        {"description": {"en": "hello world"}},
        content_type="application/json",
    )
    assert res.status_code == 200

    res = admin_client.get(f"/v3/datasets/{dataset_id}/revisions", content_type="application/json")
    assert res.data[0]["published_revision"] == 2
    assert len(res.data) == 2

test_merge_draft_revisions#

Source code in tests/unit/apps/core/api/dataset/test_dataset_drafts.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
@pytest.mark.usefixtures("data_catalog", "reference_data")
def test_merge_draft_revisions(admin_client, dataset_a_json):
    res = admin_client.post("/v3/datasets", dataset_a_json, content_type="application/json")
    assert res.status_code == 201
    dataset_id = res.data["id"]

    res = admin_client.post(
        f"/v3/datasets/{dataset_id}/create-draft", dataset_a_json, content_type="application/json"
    )
    assert res.status_code == 201
    draft_id = res.data["id"]

    res = admin_client.post(f"/v3/datasets/{draft_id}/publish", content_type="application/json")
    assert res.status_code == 200

    res = admin_client.get(f"/v3/datasets/{dataset_id}/revisions", content_type="application/json")
    assert res.status_code == 200
    assert len(res.data) == 2
    assert res.data[0]["published_revision"] == 2