view.py 中的 Django 文档测试

Question

Django 1.4 测试文档指出：

对于给定的 Django 应用程序，测试运行程序在两个位置查找文档测试：

• models.py 文件。您可以定义模块级文档测试和/或单个模型的文档测试。通常的做法是将应用程序级文档测试放在模块文档字符串中，将模型级文档测试放在模型文档字符串中。

• 应用程序目录（即保存 models.py 的目录）中名为 tests.py 的文件。该文件是您想要编写的任何和所有文档测试的挂钩，这些文档测试不一定与模型相关。

出于好奇，我想知道为什么 Django 的测试运行程序仅限于 models.py 中的文档测试，但更实际的是，我想知道如何扩展测试运行程序的文档测试以包含（例如) 运行manage.py test时的views.py和其他模块。

如果有任何意见，我将不胜感激。

谢谢。

布莱恩

Answer 1

这是我的 tests/__init__.py 实现，基于 Jesse Shieh 回答：

import doctest
import unittest

list_of_doctests = [
    'myapp.views.myview',
    'myapp.forms.myform',
]
list_of_unittests = [
    'sometestshere',  # This file is myapp/tests/sometestshere.py
    'moretestshere',  # This file is myapp/tests/moretestshere.py
    'myapp.tests.othertest',  # Absolute paths also work.
]

def suite():
    suite = unittest.TestSuite()
    for t in list_of_doctests:
        suite.addTest(doctest.DocTestSuite(
            __import__(t, globals(), locals(), fromlist=["*"])
        ))
    for t in list_of_unittests:
        suite.addTest(unittest.TestLoader().loadTestsFromModule(
            __import__(t, globals(), locals(), fromlist=["*"])
        ))
    return suite

基本上，这个解决方案允许向测试套件添加任意“文件”（实际上是模块）。它允许将单元测试拆分为单独的文件，并允许添加任何包含文档测试的模块。只需将模块名称添加到该文件顶部的相应列表中即可。

Answer 2

将nosetests与django插件（django-sane-testing或django-nose）一起使用，并使用 --with-doctest 标志。

Answer 3

我发布了一个 github gist，它允许您在项目中的任何文件或模块中运行测试。
从特定模块和文件运行文档测试

Answer 4

您可以尝试编写自己的 testrunner 并查看是否可以包含其他文件来检查文档测试。

http://docs.djangoproject.com/en /dev/topics/testing/#defining-a-test-runner

Answer 5

Django 的原生测试系统基于 unittest 包。所以它并没有那么强大。

我建议您使用向后兼容的nose unittest< /代码> 类固醇。将其与使用nose的Django测试运行器一起使用。您可以通过多种方式自定义鼻子，包括使用 -m 标志将其指向自定义测试位置。

Answer 6

您可以通过在 tests.py 中添加/编辑 suite() 函数来完成此操作，该函数定义 django 测试运行程序将运行哪些测试。

import unittest
import doctest
from project import views

def suite():
    suite = unittest.TestSuite()
    suite.addTest(doctest.DocTestSuite(views))
    return suite

然后像往常一样运行你的测试，你应该在views.py 中看到你的文档测试运行。

$ python manage.py test project

django 测试文档对此进行了更详细的描述

当您运行测试时，测试实用程序的默认行为是查找 models.py 和 tests.py 中的所有测试用例（即，unittest.TestCase 的子类），并自动从中构建测试套件测试用例，并运行该套件。

还有第二种方法来定义模块的测试套件：如果您在 models.py 或 tests.py 中定义一个名为 suite() 的函数，Django 测试运行程序将使用该函数来构建测试套件那个模块。这遵循建议的单元测试组织。有关如何构建复杂测试套件的更多详细信息，请参阅 Python 文档。

但是，请记住，构建您自己的测试套件意味着 django 测试运行程序不会自动运行您在tests.py 中的任何测试。例如，您必须手动将它们添加到您的套件中

import unittest
import doctest
from project import views

class FooTestCase(unittest.TestCase):
    def testFoo(self):
        self.assertEquals('foo', 'bar')

def suite():
    suite = unittest.TestSuite()
    suite.addTest(doctest.DocTestSuite(views))
    suite.addTest(unittest.TestLoader().loadTestsFromTestCase(FooTestCase))
    return suite

Answer 7

Django 1.6 中发生了变化：

Doctests 将不再被自动发现。整合
doctests 在您的测试套件中，请遵循 Python 中的 建议
文档。

所以我自己要做的就是（在 my_app/tests.py 中）：

import unittest
import doctest
from my_app import views

def load_tests(loader, tests, ignore):
    tests.addTests(doctest.DocTestSuite(views))
    return tests