Step30: unittest for comment app

Author: yangxg

.idea/HelloDjango-blog-tutorial.iml

@@ -150,6 +150,7 @@ tutorial 分支为项目的主分支，每一篇教程的代码都和历史提
 27. [Django 博客实现简单的全文搜索](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/85/)
 28. [Django Haystack 全文检索与关键词高亮](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/86/)
 29. [单元测试：测试 blog 应用](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/87/)
+30. [单元测试：测试评论应用](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/88/)
 
 ## 公众号
 <p align="center">

README.md

@@ -0,0 +1,17 @@
+from django.apps import apps
+from django.contrib.auth.models import User
+from django.test import TestCase
+
+from blog.models import Category, Post
+
+
+class CommentDataTestCase(TestCase):
+    def setUp(self):
+        apps.get_app_config("haystack").signal_processor.teardown()
+        self.user = User.objects.create_superuser(
+            username="admin", email="[email protected]", password="admin"
+        )
+        self.cate = Category.objects.create(name="测试")
+        self.post = Post.objects.create(
+            title="测试标题", body="测试内容", category=self.cate, author=self.user,
+        )

comments/tests.py

@@ -0,0 +1,13 @@
+from .base import CommentDataTestCase
+from ..models import Comment
+
+
+class CommentModelTestCase(CommentDataTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+        self.comment = Comment.objects.create(
+            name="评论者", email="[email protected]", text="评论内容", post=self.post,
+        )
+
+    def test_str_representation(self):
+        self.assertEqual(self.comment.__str__(), "评论者: 评论内容")

comments/tests/__init__.py

@@ -0,0 +1,83 @@
+from datetime import timedelta
+
+from django.apps import apps
+from django.contrib.auth.models import User
+from django.template import Context, Template
+from django.utils import timezone
+
+from blog.models import Category, Post
+from .base import CommentDataTestCase
+from ..forms import CommentForm
+from ..models import Comment
+from ..templatetags.comments_extras import show_comment_form, show_comments
+
+
+class CommentExtraTestCase(CommentDataTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+        self.ctx = Context()
+
+    def test_show_comment_form_with_empty_form(self):
+        template = Template("{% load comments_extras %}" "{% show_comment_form post %}")
+        form = CommentForm()
+        context = Context(show_comment_form(self.ctx, self.post))
+        expected_html = template.render(context)
+        for field in form:
+            label = '<label for="{}">{}：</label>'.format(
+                field.id_for_label, field.label
+            )
+            self.assertInHTML(label, expected_html)
+            self.assertInHTML(str(field), expected_html)
+
+    def test_show_comment_form_with_invalid_bound_form(self):
+        template = Template(
+            "{% load comments_extras %}" "{% show_comment_form post form %}"
+        )
+        invalid_data = {
+            "email": "invalid_email",
+        }
+        form = CommentForm(data=invalid_data)
+        self.assertFalse(form.is_valid())
+        context = Context(show_comment_form(self.ctx, self.post, form=form))
+        expected_html = template.render(context)
+        for field in form:
+            label = '<label for="{}">{}：</label>'.format(
+                field.id_for_label, field.label
+            )
+            self.assertInHTML(label, expected_html)
+            self.assertInHTML(str(field), expected_html)
+            self.assertInHTML(str(field.errors), expected_html)
+
+    def test_show_comments_without_any_comment(self):
+        template = Template("{% load comments_extras %}" "{% show_comments post %}")
+        ctx_dict = show_comments(self.ctx, self.post)
+        ctx_dict["post"] = self.post
+        context = Context(ctx_dict)
+        expected_html = template.render(context)
+        self.assertInHTML("<h3>评论列表，共 <span>0</span> 条评论</h3>", expected_html)
+        self.assertInHTML("暂无评论", expected_html)
+
+    def test_show_comments_with_comments(self):
+        comment1 = Comment.objects.create(
+            name="评论者1", email="[email protected]", text="评论内容1", post=self.post,
+        )
+        comment2 = Comment.objects.create(
+            name="评论者2",
+            email="[email protected]",
+            text="评论内容2",
+            post=self.post,
+            created_time=timezone.now() - timedelta(days=1),
+        )
+        template = Template("{% load comments_extras %}" "{% show_comments post %}")
+        ctx_dict = show_comments(self.ctx, self.post)
+        ctx_dict["post"] = self.post
+        context = Context(ctx_dict)
+        expected_html = template.render(context)
+        self.assertInHTML("<h3>评论列表，共 <span>2</span> 条评论</h3>", expected_html)
+        self.assertInHTML(comment1.name, expected_html)
+        self.assertInHTML(comment1.text, expected_html)
+        self.assertInHTML(comment2.name, expected_html)
+        self.assertInHTML(comment2.text, expected_html)
+        self.assertQuerysetEqual(
+            ctx_dict["comment_list"], [repr(c) for c in [comment1, comment2]]
+        )

comments/tests/base.py

@@ -0,0 +1,47 @@
+from django.apps import apps
+from django.contrib.auth.models import User
+from django.urls import reverse
+
+from blog.models import Category, Post
+
+from ..models import Comment
+from .base import CommentDataTestCase
+
+
+class CommentViewTestCase(CommentDataTestCase):
+    def setUp(self) -> None:
+        super().setUp()
+        self.url = reverse("comments:comment", kwargs={"post_pk": self.post.pk})
+
+    def test_comment_a_nonexistent_post(self):
+        url = reverse("comments:comment", kwargs={"post_pk": 100})
+        response = self.client.post(url, {})
+        self.assertEqual(response.status_code, 404)
+
+    def test_invalid_comment_data(self):
+        invalid_data = {
+            "email": "invalid_email",
+        }
+        response = self.client.post(self.url, invalid_data)
+        self.assertTemplateUsed(response, "comments/preview.html")
+        self.assertIn("post", response.context)
+        self.assertIn("form", response.context)
+        form = response.context["form"]
+        for field_name, errors in form.errors.items():
+            for err in errors:
+                self.assertContains(response, err)
+        self.assertContains(response, "评论发表失败！请修改表单中的错误后重新提交。")
+
+    def test_valid_comment_data(self):
+        valid_data = {
+            "name": "评论者",
+            "email": "[email protected]",
+            "text": "评论内容",
+        }
+        response = self.client.post(self.url, valid_data, follow=True)
+        self.assertRedirects(response, self.post.get_absolute_url())
+        self.assertContains(response, "评论发表成功！")
+        self.assertEqual(Comment.objects.count(), 1)
+        comment = Comment.objects.first()
+        self.assertEqual(comment.name, valid_data["name"])
+        self.assertEqual(comment.text, valid_data["text"])