Newer
Older
import django_filters
from funkwhale_api.common import serializers
from funkwhale_api.users import models
class TestActionFilterSet(django_filters.FilterSet):
class Meta:
model = models.User
class TestSerializer(serializers.ActionSerializer):
actions = [serializers.Action("test", allow_all=True)]
filterset_class = TestActionFilterSet
def handle_test(self, objects):
Eliot Berriot
committed
class TestDangerousSerializer(serializers.ActionSerializer):
actions = [
serializers.Action("test", allow_all=True),
serializers.Action("test_dangerous"),
]
Eliot Berriot
committed
def handle_test(self, objects):
pass
def handle_test_dangerous(self, objects):
pass
class TestDeleteOnlyInactiveSerializer(serializers.ActionSerializer):
actions = [
serializers.Action(
"test", allow_all=True, qs_filter=lambda qs: qs.filter(is_active=False)
)
]
filterset_class = TestActionFilterSet
def handle_test(self, objects):
pass
def test_action_serializer_validates_action():
serializer = TestSerializer(data, queryset=models.User.objects.none())
assert serializer.is_valid() is False
def test_action_serializer_validates_objects():
serializer = TestSerializer(data, queryset=models.User.objects.none())
assert serializer.is_valid() is False
def test_action_serializers_objects_clean_ids(factories):
serializer = TestSerializer(data, queryset=models.User.objects.all())
assert serializer.is_valid(raise_exception=True) is True
assert list(serializer.validated_data["objects"]) == [user1]
def test_action_serializers_objects_clean_all(factories):
user1 = factories["users.User"]()
user2 = factories["users.User"]()
serializer = TestSerializer(data, queryset=models.User.objects.all())
assert serializer.is_valid(raise_exception=True) is True
assert list(serializer.validated_data["objects"]) == [user1, user2]
def test_action_serializers_save(factories, mocker):
factories["users.User"]()
factories["users.User"]()
serializer = TestSerializer(data, queryset=models.User.objects.all())
assert serializer.is_valid(raise_exception=True) is True
assert result == {"updated": 2, "action": "test", "result": {"hello": "world"}}
handler.assert_called_once()
def test_action_serializers_filterset(factories):
factories["users.User"](is_active=False)
user2 = factories["users.User"](is_active=True)
data = {"objects": "all", "action": "test", "filters": {"is_active": True}}
serializer = TestSerializer(data, queryset=models.User.objects.all())
assert serializer.is_valid(raise_exception=True) is True
assert list(serializer.validated_data["objects"]) == [user2]
def test_action_serializers_validates_at_least_one_object():
serializer = TestSerializer(data, queryset=models.User.objects.none())
assert serializer.is_valid() is False
Eliot Berriot
committed
def test_dangerous_actions_refuses_all(factories):
factories["users.User"]()
data = {"objects": "all", "action": "test_dangerous"}
serializer = TestDangerousSerializer(data, queryset=models.User.objects.all())
Eliot Berriot
committed
assert serializer.is_valid() is False
Eliot Berriot
committed
def test_action_serializers_can_require_filter(factories):
user1 = factories["users.User"](is_active=False)
factories["users.User"](is_active=True)
serializer = TestDeleteOnlyInactiveSerializer(
data, queryset=models.User.objects.all()
)
Eliot Berriot
committed
assert serializer.is_valid(raise_exception=True) is True
assert list(serializer.validated_data["objects"]) == [user1]
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
def test_track_fields_for_update(mocker):
@serializers.track_fields_for_update("field1", "field2")
class S(serializers.serializers.Serializer):
field1 = serializers.serializers.CharField()
field2 = serializers.serializers.CharField()
def update(self, obj, validated_data):
for key, value in validated_data.items():
setattr(obj, key, value)
return obj
on_updated_fields = mocker.stub()
class Obj(object):
field1 = "value1"
field2 = "value2"
obj = Obj()
serializer = S(obj, data={"field1": "newvalue1", "field2": "newvalue2"})
assert serializer.is_valid(raise_exception=True)
serializer.save()
serializer.on_updated_fields.assert_called_once_with(
obj,
{"field1": "value1", "field2": "value2"},
{"field1": "newvalue1", "field2": "newvalue2"},
)