Làm cách nào để chạy khám phá mới nhất từ ​​“thử nghiệm python setup.py”?

Tôi đang cố gắng tìm ra cách python setup.py testchạy tương đương với python -m unittest discover. Tôi không muốn sử dụng tập lệnh run_tests.py và tôi không muốn sử dụng bất kỳ công cụ kiểm tra bên ngoài nào (như nosehoặc py.test). Sẽ ổn nếu giải pháp chỉ hoạt động trên python 2.7.

Trong setup.py, tôi nghĩ rằng tôi cần thêm một cái gì đó vào các trường test_suitevà / hoặc test_loadertrong cấu hình, nhưng dường như tôi không thể tìm thấy một tổ hợp nào hoạt động chính xác:

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

Điều này có khả thi bằng cách chỉ unittestđược xây dựng trong python 2.7 không?

FYI, cấu trúc dự án của tôi trông như thế này:

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

Cập nhật : Điều này có thể xảy ra với unittest2nhưng tôi muốn tìm thứ gì đó tương đương chỉ bằng cách sử dụngunittest

Từ https://pypi.python.org/pypi/unittest2

unittest2 bao gồm một bộ thu thử nghiệm tương thích với setuptools rất cơ bản. Chỉ định test_suite = 'unittest2.collector' trong setup.py của bạn. Điều này bắt đầu khám phá thử nghiệm với các tham số mặc định từ thư mục chứa setup.py, vì vậy nó có lẽ hữu ích nhất làm ví dụ (xem unittest2 / collector.py).

Hiện tại, tôi chỉ đang sử dụng một tập lệnh có tên run_tests.py, nhưng tôi hy vọng tôi có thể loại bỏ điều này bằng cách chuyển sang một giải pháp chỉ sử dụng python setup.py test.

Đây là những run_tests.pygì tôi hy vọng sẽ xóa:

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)

Nếu bạn sử dụng py27 + hoặc py32 +, giải pháp khá đơn giản:

test_suite="tests",

Từ việc xây dựng và phân phối các gói với Setuptools (tôi nhấn mạnh):

test_suite

Một chuỗi đặt tên cho lớp con unittest.TestCase (hoặc một gói hoặc mô-đun chứa một hoặc nhiều trong số chúng hoặc một phương thức của lớp con đó) hoặc đặt tên cho một hàm có thể được gọi mà không có đối số và trả về một unittest.TestSuite .

Do đó, trong setup.pybạn sẽ thêm một hàm trả về TestSuite:

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

Sau đó, bạn sẽ chỉ định lệnh setupnhư sau:

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

Bạn không cần cấu hình để làm việc này. Về cơ bản có hai cách chính để làm điều đó:

Cách nhanh chóng

Đổi tên của bạn test_module.pythành module_test.py(về cơ bản thêm _testdưới dạng hậu tố cho các bài kiểm tra cho một mô-đun cụ thể) và python sẽ tự động tìm thấy nó. Chỉ cần đảm bảo thêm điều này vào setup.py:

from setuptools import setup, find_packages

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

Con đường dài

Đây là cách thực hiện với cấu trúc thư mục hiện tại của bạn:

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

Bên dưới tests/__init__.py, bạn muốn nhập unittestvà tập lệnh kiểm tra đơn vị của mình test_module, sau đó tạo một hàm để chạy kiểm tra. Trong tests/__init__.py, nhập một cái gì đó như sau:

import unittest
import test_module

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

Ngoài ra, TestLoaderlớp còn có các chức năng khác loadTestsFromModule. Bạn có thể chạy dir(unittest.TestLoader)để xem những cái khác, nhưng cái này là đơn giản nhất để sử dụng.

Vì cấu trúc thư mục của bạn là như vậy, có thể bạn sẽ muốn test_modulecó thể nhập moduletập lệnh của mình . Bạn có thể đã làm điều này, nhưng trong trường hợp chưa làm, bạn có thể bao gồm đường dẫn chính để bạn có thể nhập packagemô-đun và moduletập lệnh. Ở đầu của bạn test_module.py, hãy nhập:

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

import unittest
import package.module
...

Rồi cuối cùng, trong setup.py, bao gồm các testsmô-đun và chạy lệnh mà bạn đã tạo, my_module_suite:

from setuptools import setup, find_packages

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

Sau đó, bạn chỉ cần chạy python setup.py test.

Đây là một mẫu ai đó đã làm để tham khảo.

Một giải pháp khả thi là chỉ cần mở rộng testlệnh for distutilsand setuptools/ distribute. Điều này có vẻ như là một tổng số kluge và phức tạp hơn tôi muốn, nhưng dường như phát hiện và chạy chính xác tất cả các bài kiểm tra trong gói của tôi khi chạy python setup.py test. Tôi đang tiếp tục chọn đây làm câu trả lời cho câu hỏi của mình với hy vọng rằng ai đó sẽ cung cấp một giải pháp thanh lịch hơn :)

(Lấy cảm hứng từ https://docs.pytest.org/en/latest/goodpractices.html#integrating-with-setuptools-python-setup-py-test-pytest-runner )

Ví dụ 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)

Một giải pháp kém lý tưởng khác được lấy cảm hứng từ http://hg.python.org/unittest2/file/2b6411b9a838/unittest2/collector.py

Thêm một mô-đun trả về một TestSuitetrong số các bài kiểm tra đã phát hiện. Sau đó, cấu hình thiết lập để gọi mô-đun đó.

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

Đây là 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)

Và đây là 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)

unittestMô-đun thư viện tiêu chuẩn của Python hỗ trợ khám phá (trong Python 2.7 trở lên và Python 3.2 trở lên). Nếu bạn có thể giả định các phiên bản tối thiểu đó, thì bạn chỉ cần thêm discoverđối số dòng lệnh vào unittestlệnh.

Chỉ cần một chỉnh sửa nhỏ để 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,
    },
)

Thao tác này sẽ không xóa run_tests.py, nhưng sẽ làm cho nó hoạt động với các công cụ thiết lập. Thêm vào:

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

Sau đó, trong setup.py: (Tôi cho rằng bạn đang làm điều gì đó giống như vậy setup(**config))

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

Nhược điểm duy nhất mà tôi thấy là nó làm cong ngữ nghĩa của nó loadTestsFromNames, nhưng lệnh kiểm tra setuptools là người dùng duy nhất và gọi nó theo một cách cụ thể .