Настроить Django для поиска всех доктестов во всех модулях?

Question

Если я выполню следующую команду:

>python manage.py test

Django просматривает tests.py в моем приложении и запускает любые doctests или модульные тесты в этом файле.Он также просматривает словарь __ test __ для запуска дополнительных тестов.Таким образом, я могу связать doctests из других модулей следующим образом:

#tests.py
from myapp.module1 import _function1, _function2

__test__ = {
    "_function1": _function1,
    "_function2": _function2
}

Если я хочу включить больше доктестов, есть ли более простой способ, чем перечислять их все в этом словаре?В идеале, я просто хочу, чтобы Django нашел все doctests во всех модулях приложения myapp.

Есть ли какой-нибудь способ взлома рефлексии, который привел бы меня туда, где я хочу быть?

Answer 1

Спасибо Алексу и Полу. Это то, что я придумал:

# tests.py
import sys, settings, re, os, doctest, unittest, imp

# import your base Django project
import myapp

# Django already runs these, don't include them again
ALREADY_RUN = ['tests.py', 'models.py']

def find_untested_modules(package):
    """ Gets all modules not already included in Django's test suite """
    files = [re.sub('\.py, '', f) 
             for f in os.listdir(os.path.dirname(package.__file__))
             if f.endswith(".py") 
             and os.path.basename(f) not in ALREADY_RUN]
    return [imp.load_module(file, *imp.find_module(file, package.__path__))
             for file in files]

def modules_callables(module):
    return [m for m in dir(module) if callable(getattr(module, m))]

def has_doctest(docstring):
    return ">>>" in docstring

__test__ = {}
for module in find_untested_modules(myapp.module1):
    for method in modules_callables(module):
        docstring = str(getattr(module, method).__doc__)
        if has_doctest(docstring):

            print "Found doctest(s) " + module.__name__ + "." + method

            # import the method itself, so doctest can find it
            _temp = __import__(module.__name__, globals(), locals(), [method])
            locals()[method] = getattr(_temp, method)

            # Django looks in __test__ for doctests to run
            __test__[method] = getattr(module, method)

Answer 2

Я решил это для себя некоторое время назад:

apps = settings.INSTALLED_APPS

for app in apps:
    try:
        a = app + '.test'
        __import__(a)
        m = sys.modules[a]
    except ImportError: #no test jobs for this module, continue to next one
        continue
    #run your test using the imported module m

Это позволило мне поместить тесты для каждого модуля в их собственный файл test.py, чтобы они не перепутались с остальным кодом моего приложения. Было бы легко изменить это, чтобы просто искать doc-тесты в каждом из ваших модулей и запускать их, если он их нашел.

Answer 3

Используйте django-nose , поскольку Нос автоматически находит все тесты рекурсивно.

Answer 4

Вот ключевые элементы решения:

tests.py:

def find_modules(package):
    """Return list of imported modules from given package"""
    files = [re.sub('\.py$', '', f) for f in os.listdir(os.path.dirname(package.__file__))
             if f.endswith(".py") and os.path.basename(f) not in ('__init__.py', 'test.py')]
    return [imp.load_module(file, *imp.find_module(file, package.__path__)) for file in files]

def suite(package=None):
    """Assemble test suite for Django default test loader"""
    if not package: package = myapp.tests # Default argument required for Django test runner
    return unittest.TestSuite([doctest.DocTestSuite(m) for m in find_modules(package)])

Чтобы добавить рекурсию, используйте os.walk() чтобы обойти дерево модулей и найти пакеты python.

Answer 5

Я не слишком разбираюсь в тестировании Джано, но, насколько я понимаю, он использует автоматические обнаружение unittest , так же как python -m обнаружение модуля и Nose.

Если это так, просто поместите следующий файл туда, где обнаружение обнаружит его (обычно это просто вопрос присвоения ему имени test_doctest.py или аналогичного).

Измените your_package на пакет для тестирования. Все модули (включая подпакеты) будут документированы.

import doctest
import pkgutil

import your_package as root_package


def load_tests(loader, tests, ignore):
    modules = pkgutil.walk_packages(root_package.__path__, root_package.__name__ + '.')
    for _, module_name, _ in modules:
        try:
            suite = doctest.DocTestSuite(module_name)
        except ValueError:
            # Presumably a "no docstrings" error. That's OK.
            pass
        else:
            tests.addTests(suite)
    return tests