Як запустити unittest Discover за допомогою “python setup.py test”?

Я намагаюся зрозуміти, як python setup.py testзапустити еквівалент python -m unittest discover. Я не хочу використовувати сценарій run_tests.py, і я не хочу використовувати будь-які зовнішні інструменти тестування (наприклад, noseабо py.test). Це нормально, якщо рішення працює лише на python 2.7.

У setup.py, я думаю, мені потрібно щось додати до полів test_suiteта / або test_loaderв конфігурації, але я не можу знайти комбінацію, яка працює правильно:

config = {
    'name': name,
    'version': version,
    'url': url,
    'test_suite': '???',
    'test_loader': '???',
}

Чи можливо це лише за допомогою unittestвбудованого в python 2.7?

FYI, моя структура проекту виглядає так:

project/
  package/
    __init__.py
    module.py
  tests/
    __init__.py
    test_module.py
  run_tests.py <- I want to delete this
  setup.py

Оновлення : це можливо за допомогоюunittest2 але я хочу знайти щось еквівалентне, використовуючи лишеunittest

З https://pypi.python.org/pypi/unittest2

unittest2 включає дуже базовий збирач тестів, сумісний з setuptools. Вкажіть test_suite = 'unittest2.collector' у вашому setup.py. Це запускає тестове виявлення з параметрів за замовчуванням із каталогу, що містить setup.py, тому, мабуть, це найкорисніший приклад (див. Unittest2 / collector.py).

На даний момент я просто використовую скрипт, який називається run_tests.py, але я сподіваюся, що зможу позбутися цього, перейшовши до рішення, яке лише використовує python setup.py test.

Ось те, що run_tests.pyя сподіваюся видалити:

import unittest

if __name__ == '__main__':

    # use the default shared TestLoader instance
    test_loader = unittest.defaultTestLoader

    # use the basic test runner that outputs to sys.stderr
    test_runner = unittest.TextTestRunner()

    # automatically discover all tests in the current dir of the form test*.py
    # NOTE: only works for python 2.7 and later
    test_suite = test_loader.discover('.')

    # run the test suite
    test_runner.run(test_suite)

Якщо ви використовуєте py27 + або py32 +, рішення досить просте:

test_suite="tests",

З побудови та розповсюдження пакетів за допомогою Setuptools (наголос на моєму):

test_suite

Рядок, що називає підклас unittest.TestCase (або пакет або модуль, що містить один або кілька з них, або метод такого підкласу), або називає функцію, яку можна викликати без аргументів, і повертає unittest.TestSuite .

Отже, до setup.pyвас слід додати функцію, яка повертає TestSuite:

import unittest
def my_test_suite():
    test_loader = unittest.TestLoader()
    test_suite = test_loader.discover('tests', pattern='test_*.py')
    return test_suite

Потім ви вказали б команду setupнаступним чином:

setup(
    ...
    test_suite='setup.my_test_suite',
    ...
)

Вам не потрібна конфігурація, щоб це працювало. Існує два основних способи зробити це:

Швидкий шлях

Перейменуйте ваш test_module.pyна module_test.py(в основному додайте _testяк суфікс до тестів для певного модуля), і python знайде його автоматично. Просто не забудьте додати це до setup.py:

from setuptools import setup, find_packages

setup(
    ...
    test_suite = 'tests',
    ...
)

Довгий шлях

Ось як це зробити за вашої поточної структури каталогів:

project/
  package/
    __init__.py
    module.py
  tests/
    __init__.py
    test_module.py
  run_tests.py <- I want to delete this
  setup.py

У розділі tests/__init__.pyви хочете імпортувати unittestскрипт test_moduleі модульний тест , а потім створити функцію для запуску тестів. В tests/__init__.py, введіть у чому - щось на зразок цього:

import unittest
import test_module

def my_module_suite():
    loader = unittest.TestLoader()
    suite = loader.loadTestsFromModule(test_module)
    return suite

TestLoaderКлас має інші функції , крім loadTestsFromModule. Ви можете бігти, dir(unittest.TestLoader)щоб побачити інші, але цей найпростіший у використанні.

Оскільки ваша структура каталогів така, ви, ймовірно, захочете test_moduleмати можливість імпортувати вашmodule сценарій. Можливо, ви вже це зробили, але на випадок, якщо цього не зробили, ви можете включити батьківський шлях, щоб можна було імпортувати packageмодуль та moduleсценарій. У верхній частині test_module.py, введіть:

import os, sys
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))

import unittest
import package.module
...

Тоді нарешті, в setup.py включіть testsмодуль і запустіть створену вами команду my_module_suite:

from setuptools import setup, find_packages

setup(
    ...
    test_suite = 'tests.my_module_suite',
    ...
)

Тоді ти просто біжиш python setup.py test.

Ось зразок, який хтось зробив як посилання.

Одне з можливих рішень - просто розширити testкоманду для distutilsта setuptools/distribute . Це здається загальним клубом і набагато складнішим, ніж я б вважав за краще, але, схоже, правильно виявляю і запускаю всі тести в моєму пакеті після запускуpython setup.py test . Я затримуюсь, вибравши це як відповідь на своє запитання, сподіваючись, що хтось запропонує більш елегантне рішення :)

(Натхненно https://docs.pytest.org/en/latest/goodpractices.html#integrating-with-setuptools-python-setup-py-test-pytest-runner )

Приклад setup.py:

try:
    from setuptools import setup
except ImportError:
    from distutils.core import setup

def discover_and_run_tests():
    import os
    import sys
    import unittest

    # get setup.py directory
    setup_file = sys.modules['__main__'].__file__
    setup_dir = os.path.abspath(os.path.dirname(setup_file))

    # use the default shared TestLoader instance
    test_loader = unittest.defaultTestLoader

    # use the basic test runner that outputs to sys.stderr
    test_runner = unittest.TextTestRunner()

    # automatically discover all tests
    # NOTE: only works for python 2.7 and later
    test_suite = test_loader.discover(setup_dir)

    # run the test suite
    test_runner.run(test_suite)

try:
    from setuptools.command.test import test

    class DiscoverTest(test):

        def finalize_options(self):
            test.finalize_options(self)
            self.test_args = []
            self.test_suite = True

        def run_tests(self):
            discover_and_run_tests()

except ImportError:
    from distutils.core import Command

    class DiscoverTest(Command):
        user_options = []

        def initialize_options(self):
                pass

        def finalize_options(self):
            pass

        def run(self):
            discover_and_run_tests()

config = {
    'name': 'name',
    'version': 'version',
    'url': 'http://example.com',
    'cmdclass': {'test': DiscoverTest},
}

setup(**config)

Ще одне менш ідеальне рішення, злегка натхнене http://hg.python.org/unittest2/file/2b6411b9a838/unittest2/collector.py

Додайте модуль, який повертає TestSuiteвиявлені тести. Потім налаштуйте налаштування для виклику цього модуля.

project/
  package/
    __init__.py
    module.py
  tests/
    __init__.py
    test_module.py
  discover_tests.py
  setup.py

Ось discover_tests.py:

import os
import sys
import unittest

def additional_tests():
    setup_file = sys.modules['__main__'].__file__
    setup_dir = os.path.abspath(os.path.dirname(setup_file))
    return unittest.defaultTestLoader.discover(setup_dir)

І ось setup.py:

try:
    from setuptools import setup
except ImportError:
    from distutils.core import setup

config = {
    'name': 'name',
    'version': 'version',
    'url': 'http://example.com',
    'test_suite': 'discover_tests',
}

setup(**config)

Стандартний бібліотечний unittestмодуль Python підтримує виявлення (у Python 2.7 та пізніших версіях та Python 3.2 та новіших версіях). Якщо ви можете припустити ці мінімальні версії, ви можете просто додати discoverаргумент командного рядка до unittestкоманди.

Потрібна лише невелика настройка, щоб setup.py:

import setuptools.command.test
from setuptools import (find_packages, setup)

class TestCommand(setuptools.command.test.test):
    """ Setuptools test command explicitly using test discovery. """

    def _test_args(self):
        yield 'discover'
        for arg in super(TestCommand, self)._test_args():
            yield arg

setup(
    ...
    cmdclass={
        'test': TestCommand,
    },
)

Це не видалить run_tests.py, але змусить його працювати з setuptools. Додати:

class Loader(unittest.TestLoader):
    def loadTestsFromNames(self, names, _=None):
        return self.discover(names[0])

Потім у setup.py: (припускаю, ви робите щось на зразок setup(**config))

config = {
    ...
    'test_loader': 'run_tests:Loader',
    'test_suite': '.', # your start_dir for discover()
}

Єдиний мінус, який я бачу, - це згинання семантики loadTestsFromNames, але команда тесту setuptools є єдиним споживачем і викликає його вказаним чином .