Step14: 单元测试

zmrenwu · zmrenwu · commit 7861f322c224 · 2020-08-24T12:08:05.000+09:00
diff --git a/README.md b/README.md
@@ -202,6 +202,7 @@ $ git clone https://github.com/HelloGitHub-Team/HelloDjango-REST-framework-tutor
 13. [加缓存为接口提速](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/102/))
 14. [API 版本管理](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/103/))
 15. [限制接口访问频率](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/104/))
+16. [单元测试](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/105/))
 
 ## 公众号
 <p align="center">
diff --git a/blog/serializers.py b/blog/serializers.py
@@ -2,14 +2,9 @@
 from rest_framework import serializers
 from rest_framework.fields import CharField
 
-from drf_haystack.serializers import (
-    HaystackSerializer,
-    HaystackSerializerMixin,
-    HighlighterMixin,
-)
+from drf_haystack.serializers import HaystackSerializerMixin
 
 from .models import Category, Post, Tag
-from .search_indexes import PostIndex
 from .utils import Highlighter
 
 
diff --git a/blog/tests/test_api.py b/blog/tests/test_api.py
@@ -0,0 +1,166 @@
+from datetime import datetime
+
+from django.apps import apps
+from django.contrib.auth.models import User
+from django.core.cache import cache
+from django.urls import reverse
+from django.utils.timezone import utc
+from rest_framework import status
+from rest_framework.test import APITestCase
+
+from blog.models import Category, Post, Tag
+from blog.serializers import (
+    CategorySerializer,
+    PostListSerializer,
+    PostRetrieveSerializer,
+    TagSerializer,
+)
+from comments.models import Comment
+from comments.serializers import CommentSerializer
+
+
+class PostViewSetTestCase(APITestCase):
+    def setUp(self):
+        # 断开 haystack 的 signal，测试生成的文章无需生成索引
+        apps.get_app_config("haystack").signal_processor.teardown()
+        # 清除缓存，防止限流
+        cache.clear()
+
+        # 设置博客数据
+        # post3 category2 tag2 2020-08-01 comment2 comment1
+        # post2 category1 tag1 2020-07-31
+        # post1 category1 tag1 2020-07-10
+        user = User.objects.create_superuser(
+            username="admin", email="admin@hellogithub.com", password="admin"
+        )
+        self.cate1 = Category.objects.create(name="category 1")
+        self.cate2 = Category.objects.create(name="category 2")
+        self.tag1 = Tag.objects.create(name="tag1")
+        self.tag2 = Tag.objects.create(name="tag2")
+
+        self.post1 = Post.objects.create(
+            title="title 1",
+            body="post 1",
+            category=self.cate1,
+            author=user,
+            created_time=datetime(year=2020, month=7, day=10).replace(tzinfo=utc),
+        )
+        self.post1.tags.add(self.tag1)
+
+        self.post2 = Post.objects.create(
+            title="title 2",
+            body="post 2",
+            category=self.cate1,
+            author=user,
+            created_time=datetime(year=2020, month=7, day=31).replace(tzinfo=utc),
+        )
+        self.post2.tags.add(self.tag1)
+
+        self.post3 = Post.objects.create(
+            title="title 3",
+            body="post 3",
+            category=self.cate2,
+            author=user,
+            created_time=datetime(year=2020, month=8, day=1).replace(tzinfo=utc),
+        )
+        self.post3.tags.add(self.tag2)
+        self.comment1 = Comment.objects.create(
+            name="u1",
+            email="u1@google.com",
+            text="comment 1",
+            post=self.post3,
+            created_time=datetime(year=2020, month=8, day=2).replace(tzinfo=utc),
+        )
+        self.comment2 = Comment.objects.create(
+            name="u2",
+            email="u1@apple.com",
+            text="comment 2",
+            post=self.post3,
+            created_time=datetime(year=2020, month=8, day=3).replace(tzinfo=utc),
+        )
+
+    def test_list_post(self):
+        url = reverse("v1:post-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = PostListSerializer(
+            instance=[self.post3, self.post2, self.post1], many=True
+        )
+        self.assertEqual(response.data["results"], serializer.data)
+
+    def test_list_post_filter_by_category(self):
+        url = reverse("v1:post-list")
+        response = self.client.get(url, {"category": self.cate1.pk})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = PostListSerializer(instance=[self.post2, self.post1], many=True)
+        self.assertEqual(response.data["results"], serializer.data)
+
+    def test_list_post_filter_by_tag(self):
+        url = reverse("v1:post-list")
+        response = self.client.get(url, {"tags": self.tag1.pk})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = PostListSerializer(instance=[self.post2, self.post1], many=True)
+        self.assertEqual(response.data["results"], serializer.data)
+
+    def test_list_post_filter_by_archive_date(self):
+        url = reverse("v1:post-list")
+        response = self.client.get(url, {"created_year": 2020, "created_month": 7})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = PostListSerializer(instance=[self.post2, self.post1], many=True)
+        self.assertEqual(response.data["results"], serializer.data)
+
+    def test_retrieve_post(self):
+        url = reverse("v1:post-detail", kwargs={"pk": self.post1.pk})
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = PostRetrieveSerializer(instance=self.post1)
+        self.assertEqual(response.data, serializer.data)
+
+    def test_retrieve_nonexistent_post(self):
+        url = reverse("v1:post-detail", kwargs={"pk": 9999})
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+    def test_list_archive_dates(self):
+        url = reverse("v1:post-archive-date")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data, ["2020-08", "2020-07"])
+
+    def test_list_comments(self):
+        url = reverse("v1:post-comment", kwargs={"pk": self.post3.pk})
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = CommentSerializer([self.comment2, self.comment1], many=True)
+        self.assertEqual(response.data["results"], serializer.data)
+
+    def test_list_nonexistent_post_comments(self):
+        url = reverse("v1:post-comment", kwargs={"pk": 9999})
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+
+class CategoryViewSetTestCase(APITestCase):
+    def setUp(self) -> None:
+        self.cate1 = Category.objects.create(name="category 1")
+        self.cate2 = Category.objects.create(name="category 2")
+
+    def test_list_categories(self):
+        url = reverse("v1:category-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = CategorySerializer([self.cate1, self.cate2], many=True)
+        self.assertEqual(response.data, serializer.data)
+
+
+class TagViewSetTestCase(APITestCase):
+    def setUp(self) -> None:
+        self.tag1 = Tag.objects.create(name="tag1")
+        self.tag2 = Tag.objects.create(name="tag2")
+
+    def test_list_tags(self):
+        url = reverse("v1:tag-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        serializer = CategorySerializer([self.tag1, self.tag2], many=True)
+        self.assertEqual(response.data, serializer.data)
diff --git a/blog/tests/test_serializers.py b/blog/tests/test_serializers.py
@@ -0,0 +1,20 @@
+import unittest
+
+from blog.serializers import HighlightedCharField
+from django.test import RequestFactory
+from rest_framework.request import Request
+
+
+class HighlightedCharFieldTestCase(unittest.TestCase):
+    def test_to_representation(self):
+        field = HighlightedCharField()
+        request = RequestFactory().get("/", {"text": "关键词"})
+        drf_request = Request(request=request)
+        setattr(field, "_context", {"request": drf_request})
+        document = "无关文本关键词无关文本，其他别的关键词别的无关的词。"
+        result = field.to_representation(document)
+        expected = (
+            '无关文本<span class="highlighted">关键词</span>无关文本，'
+            '其他别的<span class="highlighted">关键词</span>别的无关的词。'
+        )
+        self.assertEqual(result, expected)
diff --git a/blog/tests/test_utils.py b/blog/tests/test_utils.py
@@ -1,8 +1,12 @@
-from django.test import TestCase
-from ..utils import Highlighter
+import unittest
+from datetime import datetime
 
+from django.core.cache import cache
 
-class HighlighterTestCase(TestCase):
+from ..utils import Highlighter, UpdatedAtKeyBit
+
+
+class HighlighterTestCase(unittest.TestCase):
     def test_highlight(self):
         document = "这是一个比较长的标题，用于测试关键词高亮但不被截断。"
         highlighter = Highlighter("标题")
@@ -20,3 +24,18 @@ def test_highlight(self):
                 '...<span class="highlighted">标题</span>，应该被截断。'
             )
         )
+
+
+class UpdatedAtKeyBitTestCase(unittest.TestCase):
+    def test_get_data(self):
+        # 未缓存的情况
+        key_bit = UpdatedAtKeyBit()
+        data = key_bit.get_data()
+        self.assertEqual(data, str(cache.get(key_bit.key)))
+
+        # 已缓存的情况
+        cache.clear()
+        now = datetime.utcnow()
+        now_str = str(now)
+        cache.set(key_bit.key, now)
+        self.assertEqual(key_bit.get_data(), now_str)
diff --git a/blog/views.py b/blog/views.py
@@ -154,7 +154,7 @@ def retrieve(self, request, *args, **kwargs):
     def list_archive_dates(self, request, *args, **kwargs):
         dates = Post.objects.dates("created_time", "month", order="DESC")
         date_field = DateField()
-        data = [date_field.to_representation(date) for date in dates]
+        data = [date_field.to_representation(date)[:7] for date in dates]
         return Response(data=data, status=status.HTTP_200_OK)
 
     @cache_response(timeout=5 * 60, key_func=CommentListKeyConstructor())
@@ -210,7 +210,7 @@ class PostSearchView(HaystackViewSet):
     throttle_classes = [PostSearchAnonRateThrottle]
 
 
-class ApiVersionTestViewSet(viewsets.ViewSet):
+class ApiVersionTestViewSet(viewsets.ViewSet):  # pragma: no cover
     @action(
         methods=["GET"], detail=False, url_path="test", url_name="test",
     )
diff --git a/comments/tests/test_api.py b/comments/tests/test_api.py
@@ -0,0 +1,49 @@
+from django.apps import apps
+from django.contrib.auth.models import User
+from rest_framework import status
+from rest_framework.reverse import reverse
+from rest_framework.test import APITestCase
+
+from blog.models import Category, Post
+from comments.models import Comment
+
+
+class CommentViewSetTestCase(APITestCase):
+    def setUp(self):
+        self.url = reverse("v1:comment-list")
+        # 断开 haystack 的 signal，测试生成的文章无需生成索引
+        apps.get_app_config("haystack").signal_processor.teardown()
+        user = User.objects.create_superuser(
+            username="admin", email="admin@hellogithub.com", password="admin"
+        )
+        cate = Category.objects.create(name="测试")
+        self.post = Post.objects.create(
+            title="测试标题", body="测试内容", category=cate, author=user,
+        )
+
+    def test_create_valid_comment(self):
+        data = {
+            "name": "user",
+            "email": "user@example.com",
+            "text": "test comment text",
+            "post": self.post.pk,
+        }
+        response = self.client.post(self.url, data)
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+        comment = Comment.objects.first()
+        self.assertEqual(comment.name, data["name"])
+        self.assertEqual(comment.email, data["email"])
+        self.assertEqual(comment.text, data["text"])
+        self.assertEqual(comment.post, self.post)
+
+    def test_create_invalid_comment(self):
+        invalid_data = {
+            "name": "user",
+            "email": "user@example.com",
+            "text": "test comment text",
+            "post": 999,
+        }
+        response = self.client.post(self.url, invalid_data)
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertEqual(Comment.objects.count(), 0)
diff --git a/comments/views.py b/comments/views.py
@@ -55,5 +55,5 @@ def comment(request, post_pk):
 class CommentViewSet(mixins.CreateModelMixin, viewsets.GenericViewSet):
     serializer_class = CommentSerializer
 
-    def get_queryset(self):
+    def get_queryset(self):  # pragma: no cover
         return Comment.objects.all()
