Django REST框架:TestCase没有返回正确的查询集

时间:2018-03-31 19:20:46

标签: python django django-rest-framework pytest django-testing

我使用DRF为库存中的产品创建了一个API,可以通过以下端点url(r'products/$', views.InventoryList.as_view(), name='product-list')访问。

通过邮递员发出GET请求时,我会收到正确的查询集,这是11个产品总数:

[
    {
        "id": 1,
        "name": "Biscuits",
        "description": "Papadopoulou Biscuits",
        "price": "2.52",
        "comments": [
            {
                "id": 1,
                "title": "First comments for this",
                "comments": "Very tasty",
                "rating": 8,
                "created_by": "xx"
            }
        ]
    },
    {
        "id": 2,
        "name": "Rice",
        "description": "Agrino Rice",
        "price": "3.45",
        "comments": []
    },
    {
        "id": 3,
        "name": "Spaghetti",
        "description": "Barilla",
        "price": "2.10",
        "comments": []
    },
    {
        "id": 4,
        "name": "Canned Tomatoes",
        "description": "Kyknos",
        "price": "3.40",
        "comments": []
    },
    {
        "id": 5,
        "name": "Bacon",
        "description": "Nikas Bacon",
        "price": "2.85",
        "comments": []
    },
    {
        "id": 6,
        "name": "Croissants",
        "description": "Molto",
        "price": "3.50",
        "comments": []
    },
    {
        "id": 7,
        "name": "Beef",
        "description": "Ground",
        "price": "12.50",
        "comments": []
    },
    {
        "id": 8,
        "name": "Flour",
        "description": "Traditional Flour",
        "price": "3.50",
        "comments": []
    },
    {
        "id": 9,
        "name": "Oregano",
        "description": "Traditional oregano",
        "price": "0.70",
        "comments": []
    },
    {
        "id": 10,
        "name": "Tortellini",
        "description": "Authentic tortellini",
        "price": "4.22",
        "comments": []
    },
    {
        "id": 11,
        "name": "Milk",
        "description": "Delta",
        "price": "1.10",
        "comments": []
    }
]

然后我写了一个测试(使用pytest)来测试这个端点:

import pytest
import pytest_django
from django.urls import reverse
from rest_framework import status
from rest_framework.test import APITestCase

class TestInventoryList(APITestCase):
    @pytest.mark.django_db
    def test_get_product_list(self):
        url = reverse('product-list')
        response = self.client.get(url)
        print(response.json())
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.json()), 11) # <-- TC fails here

但由于response.json()仅返回第一个 9 对象,因此失败:

[{
    'id': 1,
    'name': 'Biscuits',
    'description': 'Papadopoulou Biscuits',
    'comments': [],
    'price': '2.52'
}, {
    'id': 2,
    'name': 'Rice',
    'description': 'Agrino Rice',
    'comments': [],
    'price': '3.45'
}, {
    'id': 3,
    'name': 'Spaghetti',
    'description': 'Barilla',
    'comments': [],
    'price': '2.10'
}, {
    'id': 4,
    'name': 'Canned Tomatoes',
    'description': 'Kyknos',
    'comments': [],
    'price': '3.40'
}, {
    'id': 5,
    'name': 'Bacon',
    'description': 'Nikas Bacon',
    'comments': [],
    'price': '2.85'
}, {
    'id': 6,
    'name': 'Croissants',
    'description': 'Molto',
    'comments': [],
    'price': '3.50'
}, {
    'id': 7,
    'name': 'Beef',
    'description': 'Ground',
    'comments': [],
    'price': '12.50'
}, {
    'id': 8,
    'name': 'Flour',
    'description': 'Traditional Flour',
    'comments': [],
    'price': '3.50'
}, {
    'id': 9,
    'name': 'Oregano',
    'description': 'Traditional oregano',
    'comments': [],
    'price': '0.70'
}]

这里有几点意见:

  1. 我的测试用例中返回的查询集不包含我的第一个产品的评论 - 尽管通过邮递员访问时我可以看到评论。 Comments是一个不同的django模型,可通过此嵌套端点访问:url(r'^products/(?P<product_id>[0-9]+)/comments/$', views.CommentsList.as_view())
  2. 我使用POSTAPI身份验证令牌插入了最后两个产品以及我的第一个产品的注释(后一个查询集中没有返回任何内容)。这是我应该以某种方式包含在我的测试用例中的信息吗?
  3. 修改

    models.py

        from django.db import models
    from django.contrib.auth.models import User
    
    class Product(models.Model):
        name = models.CharField(max_length=255)
        description = models.TextField()
        price = models.DecimalField(decimal_places=2, max_digits=20)
    
    
    class Comments(models.Model):
        product = models.ForeignKey(Product, related_name='comments')
        title = models.CharField(max_length=255)
        comments = models.TextField()
        rating = models.IntegerField()
        created_by = models.ForeignKey(User)
    

    urls.py

    from django.conf.urls import url
    from . import views
    
    urlpatterns = [
        url(r'products/$', views.InventoryList.as_view(), name='product-list'),
        url(r'^products/(?P<product_id>[0-9]+)/$', views.InventoryDetail.as_view()),
        url(r'^products/(?P<product_id>[0-9]+)/comments/$', views.CommentsList.as_view()),
        url(r'^products/(?P<product_id>[0-9]+)/comments/(?P<comment_id>[0-9]+)/$', views.CommentsDetail.as_view()),
    ]
    

    views.py

    from rest_framework import generics
    from rest_framework.permissions import IsAuthenticatedOrReadOnly
    from .models import Product, Comments
    from .serializers import ProductSerializer, CommentSerializer
    from .permissions import IsAdminOrReadOnly, IsOwnerOrReadOnly
    
    
    class InventoryList(generics.ListCreateAPIView):
        queryset = Product.objects.all()
        serializer_class = ProductSerializer
        permission_classes = (IsAdminOrReadOnly, )
        lookup_url_kwarg = 'product_id'
    
    
    class InventoryDetail(generics.RetrieveUpdateAPIView):
        queryset = Product.objects.all()
        serializer_class = ProductSerializer
        permission_classes = (IsAdminOrReadOnly, )
        lookup_url_kwarg = 'product_id'
    
    
    class CommentsList(generics.ListCreateAPIView):
        serializer_class = CommentSerializer
        permission_classes = (IsAuthenticatedOrReadOnly, )
        lookup_url_kwarg = 'product_id'
    
        def perform_create(self, serializer):
            serializer.save(created_by=self.request.user, product_id=self.kwargs['product_id'])
    
        def get_queryset(self):
            product = self.kwargs['product_id']
            return Comments.objects.filter(product__id=product)
    
    
    class CommentsDetail(generics.RetrieveUpdateDestroyAPIView):
        serializer_class = CommentSerializer
        permission_classes = (IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly)
        lookup_url_kwarg = 'comment_id'
    
        def get_queryset(self):
            comment = self.kwargs['comment_id']
            return Comments.objects.filter(id=comment)
    

    permissions.py

    from rest_framework.permissions import BasePermission, SAFE_METHODS
    
    
    class IsAdminOrReadOnly(BasePermission):
        def has_permission(self, request, view):
            if request.method in SAFE_METHODS:
                return True
            else:
                return request.user.is_staff
    
    
    class IsOwnerOrReadOnly(BasePermission):
        def has_object_permission(self, request, view, obj):
            if request.method in SAFE_METHODS:
                return True
    
            return obj.created_by == request.user
    

1 个答案:

答案 0 :(得分:4)

我怀疑,(没有您的产品型号)您没有从产品表中获取所有元素,原因如下:

  • 您手动创建了前9个元素,但未将其注册到特定用户。
  • 之后,您添加了一种身份验证方法(TokenAuthentication)并创建了一些具有访问权限的用户。
  • 由于您添加了身份验证方法,因此您可能已将@permission_classes((IsAuthenticated,)) / permission_classes=(IsAuthenticated,)添加到product-list视图。
    这限制了任何未经身份验证的用户访问product-list。 strong>未经身份验证的匿名用户只会看到您数据库中的匿名元素。
  • 您向其中一个注册用户添加了接下来的2个元素和注释,然后将这些元素注册到用户创建者,因此如果没有经过身份验证的用户,您将无法访问它们。

要从DRF的测试客户端访问需要身份验证的资源,您需要先对用户进行身份验证。
您可以使用force_authenticate方法:

class TestInventoryList(APITestCase):
    def setUp(self):
        self.req_factory = APIRequestFactory()
        self.view =  views.InventoryList.as_view({'get': 'list',})

    @pytest.mark.django_db
    def test_get_product_list(self):
        url = reverse('product-list')
        request = self.client.get(url)
        force_authenticate(request, user=YOUR_USER)
        response = self.view(request)
        print(response.json())
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.json()), 11)

此测试假设您list方法返回Products.objects.all()

正如@cezar指出的那样,针对实际数据测试视图很容易失败(例如,当您添加新元素时,self.assertEqual(len(response.json()), 11)将失败)

您应该考虑模仿您的回答以创建一个孤立的环境。

我倾向于使用factory_boydjango-nose的组合(pytest也可以)。