Skip to content

test_dataset_copy#

collect_copy_info#

Determine which fields will be copied or reused when model instance is copied.

Source code in tests/unit/apps/core/models/test_dataset_copy.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
67
68
69
70
71
72
73
74
def collect_copy_info(model, path="", copy_info=None, ignore_fields=None, model_stack=None):
    """Determine which fields will be copied or reused when model instance is copied."""
    if model_stack is None:
        model_stack = []
    if model_stack and model_stack[-1] == model:
        return  # prevent infinite org recursion
    model_stack.append(model)

    if not ignore_fields:
        ignore_fields = set()
    if not copy_info:
        copy_info = {}
    all_fields = model._meta.get_fields()
    forward_relation_fields = [f for f in all_fields if f.is_relation and f.concrete]
    reverse_relation_fields = [f for f in all_fields if f.is_relation and not f.concrete]

    for field in forward_relation_fields:
        if field.name in ignore_fields:
            continue
        if field.name in model.copier.parent_relations:
            continue

        new_path = f"{path}.{field.name}"
        if field.name in model.copier.copied_relations:
            copy_info[new_path] = "copy"
            collect_copy_info(
                field.related_model,
                new_path,
                copy_info=copy_info,
                ignore_fields=ignore_fields,
                model_stack=model_stack,
            )
        else:
            if (
                field.one_to_one
                and model != field.related_model
                and issubclass(model, field.related_model)
            ):
                continue  # hide e.g. actor_ptr of DatasetActor
            copy_info[new_path] = "existing"

    for field in reverse_relation_fields:
        if field.name in ignore_fields:
            continue
        if field.name in model.copier.parent_relations:  # hide parent relations
            continue

        if field.name in model.copier.copied_relations:
            new_path = f"{path}.{field.name}"
            copy_info[new_path] = "copy"
            collect_copy_info(
                field.related_model,
                new_path,
                copy_info=copy_info,
                ignore_fields=ignore_fields,
                model_stack=model_stack,
            )

        if field.name not in model.copier.copied_relations:
            new_path = f"{path}.{field.name}"
            copy_info[new_path] = "omit"

    model_stack.pop()
    return copy_info

test_dataset_copied_fields#

Source code in tests/unit/apps/core/models/test_dataset_copy.py 
 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
def test_dataset_copied_fields():
    copy_info = collect_copy_info(
        Dataset,
        path="dataset",
        ignore_fields={
            "preservation",  # preservation is emptied manually
            "system_creator",  # hide to reduce noise
        },
    )
    copied = {key for key, value in copy_info.items() if value == "copy"}
    existing = {key for key, value in copy_info.items() if value == "existing"}
    omit = {key for key, value in copy_info.items() if value == "omit"}

    # Relations that should use new copies of related objects:
    assert copied == {
        "dataset.access_rights",
        "dataset.access_rights.license",
        "dataset.actors",
        "dataset.actors.organization",
        "dataset.actors.organization.homepage",
        "dataset.actors.organization.parent",
        "dataset.actors.person",
        "dataset.actors.person.homepage",
        "dataset.file_set.directory_metadata",
        "dataset.file_set.file_metadata",
        "dataset.file_set",
        "dataset.other_identifiers",
        "dataset.projects.funding.funder.organization.homepage",
        "dataset.projects.funding.funder.organization.parent",
        "dataset.projects.funding.funder.organization",
        "dataset.projects.funding.funder",
        "dataset.projects.funding",
        "dataset.projects.participating_organizations.homepage",
        "dataset.projects.participating_organizations.parent",
        "dataset.projects.participating_organizations",
        "dataset.projects",
        "dataset.provenance.is_associated_with.organization.homepage",
        "dataset.provenance.is_associated_with.organization.parent",
        "dataset.provenance.is_associated_with.organization",
        "dataset.provenance.is_associated_with.person.homepage",
        "dataset.provenance.is_associated_with.person",
        "dataset.provenance.is_associated_with",
        "dataset.provenance.spatial",
        "dataset.provenance.temporal",
        "dataset.provenance.used_entity",
        "dataset.provenance.variables.concept",
        "dataset.provenance.variables.universe",
        "dataset.provenance.variables",
        "dataset.provenance",
        "dataset.relation.entity",
        "dataset.relation",
        "dataset.remote_resources",
        "dataset.spatial",
        "dataset.temporal",
    }

    # Relations that should reuse the existing objects:
    assert existing == {
        "dataset.access_rights.access_type",
        "dataset.access_rights.license.reference",
        "dataset.access_rights.restriction_grounds",
        "dataset.data_catalog",
        "dataset.dataset_versions",
        "dataset.draft_of",
        "dataset.field_of_science",
        "dataset.file_set.directory_metadata.storage",
        "dataset.file_set.directory_metadata.use_category",
        "dataset.file_set.file_metadata.file_type",
        "dataset.file_set.file_metadata.file",
        "dataset.file_set.file_metadata.use_category",
        "dataset.file_set.files",
        "dataset.file_set.storage",
        "dataset.infrastructure",
        "dataset.language",
        "dataset.last_modified_by",
        "dataset.metadata_owner",
        "dataset.other_identifiers.identifier_type",
        "dataset.permissions",
        "dataset.projects.funding.funder.funder_type",
        "dataset.provenance.event_outcome",
        "dataset.provenance.lifecycle_event",
        "dataset.provenance.preservation_event",
        "dataset.provenance.spatial.reference",
        "dataset.provenance.used_entity.type",
        "dataset.relation.entity.type",
        "dataset.relation.relation_type",
        "dataset.remote_resources.file_type",
        "dataset.remote_resources.use_category",
        "dataset.spatial.reference",
        "dataset.theme",
    }

    # Reverse relations that are not copied:
    # Any parent relations that show up here (e.g. dataset.access_rights.dataset)
    # should be added to corresponding parent_relations list
    # (e.g. AccessRights.copier.parent_relations) to indicate they
    # are intentionally omitted when creating a copy.
    assert omit == {
        "dataset.projects.participating_organizations.children",
        "dataset.legacydataset",
        "dataset.metrics",
        "dataset.provenance.is_associated_with.organization.children",
        "dataset.actors.organization.children",
        "dataset.projects.funding.funder.organization.children",
        "dataset.next_draft",
    }

test_dataset_copy_bulk#

Test that nested objects are copied using bulk_create.

Source code in tests/unit/apps/core/models/test_dataset_copy.py 
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
def test_dataset_copy_bulk():
    """Test that nested objects are copied using bulk_create."""
    orig: Dataset = PublishedDatasetFactory()

    spatials = []
    temporals = []
    provenances = []
    provenance_spatials = []
    for i in range(5):
        spatials.append(Spatial(geographic_name=f"spatial-{i}"))
        temporals.append(Temporal(temporal_coverage=f"time {i}"))

    for i in range(10):
        spatial = Spatial(geographic_name=f"provenance-spatial-{i}")
        provenance_spatials.append(spatial)
        provenances.append(Provenance(title={"en": f"provenance-{i}"}, spatial=spatial))

    Spatial.objects.bulk_create(spatials + provenance_spatials)
    Provenance.objects.bulk_create(provenances)
    Temporal.objects.bulk_create(temporals)
    orig.spatial.set(spatials)
    orig.provenance.set(provenances)
    orig.temporal.set(temporals)

    with count_queries() as count:
        with transaction.atomic():
            copy = orig.create_copy()

    # Copying dataset should copy spatials, provenances and temporals
    # in one insert per model instead of saving instances one-by-one
    assert count["SQLInsertCompiler"]["Spatial"] == 1
    assert count["SQLInsertCompiler"]["Provenance"] == 1
    assert count["SQLInsertCompiler"]["Temporal"] == 1

    # Check that values are actually copied
    assert Spatial.objects.count() == 15 * 2
    assert Provenance.objects.count() == 10 * 2
    assert Temporal.objects.count() == 5 * 2

    assert list(orig.spatial.values("geographic_name")) == list(
        copy.spatial.values("geographic_name")
    )
    orig_spatial_ids = set(orig.spatial.values_list("id", flat=True))
    copy_spatial_ids = set(copy.spatial.values_list("id", flat=True))
    assert orig_spatial_ids.isdisjoint(copy_spatial_ids)

    assert list(orig.provenance.values("title", "spatial__geographic_name")) == list(
        copy.provenance.values("title", "spatial__geographic_name")
    )
    orig_provenance_ids = set(orig.provenance.values_list("id", flat=True))
    copy_provenance_ids = set(copy.provenance.values_list("id", flat=True))
    assert orig_provenance_ids.isdisjoint(copy_provenance_ids)

    orig_provenance_spatial_ids = set(orig.provenance.values_list("spatial_id", flat=True))
    copy_provenance_spatial_ids = set(copy.provenance.values_list("spatial_id", flat=True))
    assert orig_provenance_spatial_ids.isdisjoint(copy_provenance_spatial_ids)

    assert list(orig.temporal.values("temporal_coverage")) == list(
        copy.temporal.values("temporal_coverage")
    )
    orig_temporal_ids = set(orig.temporal.values_list("id", flat=True))
    copy_temporal_ids = set(copy.temporal.values_list("id", flat=True))
    assert orig_temporal_ids.isdisjoint(copy_temporal_ids)