如何在 Django 中测试自定义模板标签？

Question

我正在向 Django 应用程序添加一组模板标签，但我不确定如何测试它们。我在我的模板中使用了它们，它们似乎有效，但我一直在寻找更正式的东西。主要逻辑在模型/模型管理器中完成并已经过测试。标签只是检索数据并将其存储在上下文变量中，例如

{% views_for_object widget as views %}
"""
Retrieves the number of views and stores them in a context variable.
"""
# or
{% most_viewed_for_model main.model_name as viewed_models %}
"""
Retrieves the ViewTrackers for the most viewed instances of the given model.
"""

所以我的问题是您通常会测试您的模板标签吗？如果这样做，您会如何做？

Answer 1

这是我的一个测试文件的一小段，其中 self.render_template 是 TestCase 中的一个简单辅助方法：

    rendered = self.render_template(
        '{% load templatequery %}'
        '{% displayquery django_templatequery.KeyValue all() with "list.html" %}'
    )
    self.assertEqual(rendered,"foo=0\nbar=50\nspam=100\negg=200\n")

    self.assertRaises(
        template.TemplateSyntaxError,
        self.render_template,
        '{% load templatequery %}'
        '{% displayquery django_templatequery.KeyValue all() notwith "list.html" %}'
    )

它非常基本，并且使用黑盒测试。它只是将一个字符串作为模板源，渲染它并检查输出是否等于预期的字符串。

render_template 方法非常简单：

from django.template import Context, Template

class MyTest(TestCase):
    def render_template(self, string, context=None):
        context = context or {}
        context = Context(context)
        return Template(string).render(context)

Answer 2

你们让我走上了正轨。可以检查渲染后上下文是否已正确更改：

class TemplateTagsTestCase(unittest.TestCase):        
    def setUp(self):    
        self.obj = TestObject.objects.create(title='Obj a')

    def testViewsForOjbect(self):
        ViewTracker.add_view_for(self.obj)
        t = Template('{% load my_tags %}{% views_for_object obj as views %}')
        c = Context({"obj": self.obj})
        t.render(c)
        self.assertEqual(c['views'], 1)

Answer 3

如何测试模板标签的一个很好的示例平面模板标签测试

Answer 4

字符串可以呈现为模板，因此您可以使用模板标签作为字符串编写一个包含简单“模板”的测试，并确保它在给定特定上下文的情况下正确呈现。

Answer 5

当我测试我的模板标签时，我会让标签本身返回一个包含我正在使用的文本或字典的字符串......有点类似于其他建议。

由于标签可以修改上下文和/或返回要渲染的字符串——我发现仅查看渲染的字符串是最快的。

而不是：

return ''

拥有它：

return str(my_data_that_I_am_testing)

直到你快乐为止。