Skip to content

test_serializers#

test_nested_serializer_bulk_upsert#

Test that lazily saved nested model instances are upserted in bulk.

Source code in tests/unit/apps/common/serializers/test_serializers.py 
 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
@pytest.mark.django_db
def test_nested_serializer_bulk_upsert(admin_user, location_reference_data, mocker):
    """Test that lazily saved nested model instances are upserted in bulk."""
    logging.disable(logging.NOTSET)
    dataset = DatasetFactory()

    # Normally Spatial list serializer does not support id data and only creates new spatials.
    # Make a dataset serializer class that accepts id for Spatial so we can verify that
    # bulk updating in deserialization works
    class SpatialModelSerializer2(SpatialModelSerializer):
        class Meta(SpatialModelSerializer.Meta):
            fields = SpatialModelSerializer.Meta.fields + ["id"]
            extra_kwargs = {"id": {"read_only": False, "required": False}}

    class DatasetSerializer2(DatasetSerializer):
        spatial = SpatialModelSerializer2(required=False, many=True, lazy=True)

    spatials = [
        {
            "geographic_name": "Alppikylä",
            "reference": {"url": "http://www.yso.fi/onto/onto/yso/c_9908ce39"},
        },
    ]

    create = mocker.spy(Spatial.objects, "create")
    bulk_create = mocker.spy(Spatial.objects, "bulk_create")

    class MockRequest:  # Mock required serializer context
        user = admin_user
        method = "PATCH"

        class View:
            query_params = {}

    # Updating dataset should create one spatial
    serializer = DatasetSerializer2(
        instance=dataset,
        data={"spatial": spatials},
        context={"request": MockRequest, "view": MockRequest.View},
        patch=True,
    )
    serializer.is_valid(raise_exception=True)
    with transaction.atomic():
        dataset = serializer.save()

    assert Spatial.all_objects.count() == 1
    assert create.call_count == 0
    assert bulk_create.call_count == 1
    assert len(bulk_create.mock_calls[0].args[0]) == 1
    mocker.resetall()

    # Update the existing spatial name, add another spatial
    spatial_id = dataset.spatial.first().id
    spatials[0].update(
        {
            "id": spatial_id,
            "geographic_name": "Alppikylä is now Tapiola",
            "reference": {"url": "http://www.yso.fi/onto/yso/p105747"},
        }
    )
    spatials.append(
        {
            "geographic_name": "Koitajoki",
            "reference": {"url": "http://www.yso.fi/onto/yso/p105080"},
        }
    )

    # Updating dataset should update one spatial and create one spatial
    serializer = DatasetSerializer2(
        instance=dataset,
        data={"spatial": spatials},
        context={"request": MockRequest, "view": MockRequest.View},
        patch=True,
    )
    serializer.is_valid(raise_exception=True)
    with transaction.atomic():
        dataset = serializer.save()
    dataset.refresh_from_db()  # Make sure we check dataset state in DB

    assert Spatial.all_objects.count() == 2
    assert create.call_count == 0
    assert bulk_create.call_count == 1  # Spatials were created/updated in one query
    assert len(bulk_create.mock_calls[0].args[0]) == 2
    spatial_1, spatial_2 = dataset.spatial.all()
    assert spatial_1.id == spatial_id  # Existing object was updated
    assert spatial_1.geographic_name == "Alppikylä is now Tapiola"
    assert spatial_1.reference.pref_label["fi"] == "Tapiola (Espoo)"
    assert spatial_2.geographic_name == "Koitajoki"
    assert spatial_2.reference.pref_label["fi"] == "Koitajoki"

test_nested_serializer_lazy_transaction_warning#

Test that lazily saved nested model instances are upserted in bulk.

Source code in tests/unit/apps/common/serializers/test_serializers.py 
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
@pytest.mark.django_db(transaction=True)
def test_nested_serializer_lazy_transaction_warning(
    caplog, admin_user, location_reference_data, mocker
):
    """Test that lazily saved nested model instances are upserted in bulk."""
    logging.disable(logging.NOTSET)
    dataset = DatasetFactory()

    class MockRequest:  # Mock required serializer context
        user = admin_user
        method = "PATCH"

        class View:
            query_params = {}

    # Updating dataset should create one spatial
    serializer = DatasetSerializer(
        instance=dataset,
        data={},
        context={"request": MockRequest, "view": MockRequest.View},
        patch=True,
    )
    serializer.is_valid(raise_exception=True)

    with transaction.atomic():
        serializer.save()
    assert caplog.messages == []

    serializer.save()
    assert caplog.messages == [
        "DatasetSerializer has lazy serializer fields (provenance, spatial, temporal) and should update in a transaction."
    ]