[英]How to perform UPDATE and DELETE operation in Django rest framework
[英]How to write a test for 'delete' operation in Django rest framework
我正在為Django Rest Framework API編寫測試。
我一直在測試“刪除”。
我對“創建”的測試效果很好。
這是我的測試代碼:
import json
from django.urls import reverse
from rest_framework import status
from rest_framework.test import APITestCase
from users.models import CustomUser
from lists.models import List, Item
class ListAPITest(APITestCase):
@classmethod
def setUp(self):
self.data = {'name': 'Test list', 'description':'A description', 'item': [
{'name': 'Item 1 Name', 'description': 'Item 1 description', 'order': 1},
{'name': 'Item 2 Name', 'description': 'Item 2 description', 'order': 2},
{'name': 'Item 3 Name', 'description': 'Item 3 description', 'order': 3},
{'name': 'Item 4 Name', 'description': 'Item 4 description', 'order': 4},
{'name': 'Item 5 Name', 'description': 'Item 5 description', 'order': 5},
{'name': 'Item 6 Name', 'description': 'Item 6 description', 'order': 6},
{'name': 'Item 7 Name', 'description': 'Item 7 description', 'order': 7},
{'name': 'Item 8 Name', 'description': 'Item 8 description', 'order': 8},
{'name': 'Item 9 Name', 'description': 'Item 9 description', 'order': 9},
{'name': 'Item 10 Name', 'description': 'Item 10 description', 'order': 10}
]}
# 'lists' is the app_name set in endpoints.py
# 'Lists' is the base_name set for the list route in endpoints.py
# '-list' seems to be something baked into the api
self.url = reverse('lists:Lists-list')
def test_create_list_authenticated(self):
"""
Ensure we can create a new list object.
"""
user = CustomUser.objects.create(email='person@example.com', username='Test user', email_verified=True)
self.client.force_authenticate(user=user)
response = self.client.post(self.url, self.data, format='json')
list_id = json.loads(response.content)['id']
# the request should succeed
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
# there should now be 1 List in the database
self.assertEqual(List.objects.count(), 1)
def test_delete_list_by_owner(self):
"""
delete list should succeed if user created list
"""
user = CustomUser.objects.create(email='person@example.com', username='Test user', email_verified=True)
new_list = List.objects.create(name='Test list', description='A description', created_by=user, created_by_username=user.username)
self.client.force_authenticate(user=user)
response = self.client.delete(self.url + '/' + str(new_list.id))
self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
我看到的不是預期的狀態204,而是:
AssertionError: 405 != 204
405是不允許的方法。
這是我的模型定義:
class List(models.Model):
"""Models for lists
"""
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
created_by = models.ForeignKey(USER, on_delete=models.CASCADE, related_name='list_created_by_id')
created_by_username = models.CharField(max_length=255) # this shold be OK given that the list will be deleted if the created_by_id user is deleted
created_at = models.DateTimeField(auto_now_add=True)
parent_item = models.ForeignKey('Item', on_delete=models.SET_NULL, null=True, related_name='parent_item')
modified_by = models.ForeignKey(USER, on_delete=models.SET_NULL, null=True,
related_name='list_modified_by')
modified_at = models.DateTimeField(auto_now_add=True)
name = models.CharField(max_length=255)
description = models.CharField(max_length=5000, blank=True, default='')
is_public = models.BooleanField(default=False)
def __str__(self):
return self.name
這是我的觀點:
class ListViewSet(FlexFieldsModelViewSet):
"""
ViewSet for lists.
"""
permission_classes = [IsOwnerOrReadOnly, HasVerifiedEmail]
model = List
serializer_class = ListSerializer
permit_list_expands = ['item']
pagination_class = LimitOffsetPagination
def get_queryset(self):
# unauthenticated user can only view public lists
queryset = List.objects.filter(is_public=True)
# authenticated user can view public lists and lists the user created
# listset in query parameters can be additional filter
if self.request.user.is_authenticated:
listset = self.request.query_params.get('listset', None)
if listset == 'my-lists':
queryset = List.objects.filter(created_by=self.request.user)
elif listset == 'public-lists':
queryset = List.objects.filter(is_public=True)
else:
queryset = List.objects.filter(
Q(created_by=self.request.user) |
Q(is_public=True)
)
# allow filter by URL parameter created_by
created_by = self.request.query_params.get('created_by', None)
if created_by is not None:
queryset = queryset.filter(created_by=created_by)
# return only lists that have no parent item
toplevel = self.request.query_params.get('toplevel')
if toplevel is not None:
queryset = queryset.filter(parent_item=None)
return queryset.order_by('name')
我已經閱讀了文檔,但無法找到如何設置刪除請求的方法。
我也嘗試過這個:
kwargs = {'pk': new_list.id}
response = self.client.delete(self.url, **kwargs)
這給我一個錯誤:
AssertionError: Expected view ListViewSet to be called with a URL keyword argument named "pk". Fix your URL conf, or set the `.lookup_field` attribute on the view correctly.
通過我的React前端中的API,在我的應用程序中進行刪除可以正常工作。
我知道我的對象叫做List令人困惑,但是很難想到另一個名字,因為那是事實!
感謝您的任何想法,我在這里缺少什么!
我建議您看看Django-restframework測試文檔。
https://www.django-rest-framework.org/api-guide/testing/
這是我如何為您當前情況編寫測試的示例。
from rest_framework.test import APIRequestFactory, force_authenticate
from django.test import TestCase
class TestsAPIListDetailView(TestCase):
def setUp(self):
self.factory = APIRequestFactory()
# This only matters if you are passing url query params e.g. ?foo=bar
self.baseUrl = "/list/"
def test_delete_with_standard_permission(self):
# Creates mock objects
user = CustomUser.objects.create(email='person@example.com', username='Test user', email_verified=True)
new_list = List.objects.create(name='Test list', description='A description', created_by=user,
created_by_username=user.username)
# Creates a mock delete request.
# The url isn't strictly needed here. Unless you are using query params e.g. ?q=bar
req = self.factory.delete("{}{}/?q=bar".format(self.baseUrl, new_list.pk))
current_list_amount = List.object.count()
# Authenticates the user with the request object.
force_authenticate(req, user=user)
# Returns the response data if you ran the view with request(e.g if you called a delete request).
# Also you can put your url kwargs(For example for /lists/<pk>/) like pk or slug in here. Theses kwargs will be automatically passed to view.
resp = APIListDetailView.as_view()(req, pk=new_list.pk)
# Asserts.
self.assertEqual(204, resp.status_code, "Should delete the list from database.")
self.assertEqual(current_list_amount, List.objects.count() - 1, "Should have delete a list from the database.")
如果您不熟悉測試,可能值得看看工廠男孩來模擬您的Django模型。 https://factoryboy.readthedocs.io/en/latest/
順便說一句,您應該真正避免在模型名稱中使用通用詞,例如“ List”。
問題可能出在您如何制定URL上。 您可以通過以下操作直接撤消刪除的URL:
url = reverse('lists:Lists-detail', kwargs={'pk': new_list.pk})
self.client.delete(url).
使用這種方法,您將不會遇到忘記尾隨斜杠或在不需要時添加斜杠的問題。 該問題也可能出現在您的視圖集中,因為您使用的是自定義ModelViewset,但是您說它可以與JS客戶端一起使用,因此可能不是問題。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.