Как запустить модульное обнаружение из теста python setup.py?

Если вы используете py27+ или py32+, решение довольно простое:

test_suite="tests",

Из раздела Создание и распространение пакетов с помощью Setuptools (выделено мной):

тестирование

Строка с именем подкласса 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)

Модуль стандартной библиотеки Python unittest поддерживает обнаружение (в 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 является единственным потребителем и вызывает ее в указанным способом.