如何在目录中运行所有Python单元测试?

时间:2009-11-13 23:01:40

标签: python unit-testing testing python-unittest

我有一个包含我的Python单元测试的目录。每个单元测试模块的格式为 test _ * .py 。我正在尝试创建一个名为 all_test.py 的文件,您猜对了,运行上述测试表单中的所有文件并返回结果。到目前为止,我尝试了两种方法;都失败了。我将展示这两种方法,我希望那里的人知道如何正确地做到这一点。

对于我的第一次勇敢尝试,我想“如果我只是在文件中导入我的所有测试模块,然后调用这个unittest.main() doodad,它会起作用,对吧?”好吧,事实证明我错了。

import glob
import unittest

testSuite = unittest.TestSuite()
test_file_strings = glob.glob('test_*.py')
module_strings = [str[0:len(str)-3] for str in test_file_strings]

if __name__ == "__main__":
     unittest.main()

这不起作用,我得到的结果是:

$ python all_test.py 

----------------------------------------------------------------------
Ran 0 tests in 0.000s

OK

对于我的第二次尝试,我可以,好吧,也许我会尝试以更“手动”的方式进行整个测试。所以我试着在下面这样做:

import glob
import unittest

testSuite = unittest.TestSuite()
test_file_strings = glob.glob('test_*.py')
module_strings = [str[0:len(str)-3] for str in test_file_strings]
[__import__(str) for str in module_strings]
suites = [unittest.TestLoader().loadTestsFromName(str) for str in module_strings]
[testSuite.addTest(suite) for suite in suites]
print testSuite 

result = unittest.TestResult()
testSuite.run(result)
print result

#Ok, at this point I have a result
#How do I display it as the normal unit test command line output?
if __name__ == "__main__":
    unittest.main()

这也行不通,但似乎太近了!

$ python all_test.py 
<unittest.TestSuite tests=[<unittest.TestSuite tests=[<unittest.TestSuite tests=[<test_main.TestMain testMethod=test_respondes_to_get>]>]>]>
<unittest.TestResult run=1 errors=0 failures=0>

----------------------------------------------------------------------
Ran 0 tests in 0.000s

OK

我似乎有某种套件,我可以执行结果。我有点担心它说我只有run=1,看起来应该是run=2,但这是进步。但是如何将结果传递给main?或者我如何基本上使它工作,所以我可以运行这个文件,并在这样做,运行此目录中的所有单元测试?

16 个答案:

答案 0 :(得分:377)

使用Python 2.7及更高版本,您不必编写新代码或使用第三方工具来执行此操作;通过命令行执行递归测试是内置的。

python -m unittest discover <test_directory>
# or
python -m unittest discover -s <directory> -p '*_test.py'

您可以在python 2.7中阅读更多内容 或python 3.x unittest documentation。

答案 1 :(得分:97)

您可以使用可以为您执行此操作的测试运行器。 nose非常好。例如。运行时,它将在当前树中找到测试并运行它们。

更新:

这是我前鼻子时代的一些代码。您可能不希望显式的模块名称列表,但其余部分可能对您有用。

testmodules = [
    'cogapp.test_makefiles',
    'cogapp.test_whiteutils',
    'cogapp.test_cogapp',
    ]

suite = unittest.TestSuite()

for t in testmodules:
    try:
        # If the module defines a suite() function, call it to get the suite.
        mod = __import__(t, globals(), locals(), ['suite'])
        suitefn = getattr(mod, 'suite')
        suite.addTest(suitefn())
    except (ImportError, AttributeError):
        # else, just load all the test cases from the module.
        suite.addTest(unittest.defaultTestLoader.loadTestsFromName(t))

unittest.TextTestRunner().run(suite)

答案 2 :(得分:47)

现在可以直接从unittest:unittest.TestLoader.discover

import unittest
loader = unittest.TestLoader()
start_dir = 'path/to/your/test/files'
suite = loader.discover(start_dir)

runner = unittest.TextTestRunner()
runner.run(suite)

答案 3 :(得分:36)

在python 3中,如果你正在使用unittest.TestCase

  • 您的__init__.py目录中必须有一个空(或其他)test文件(必须命名为test/
  • test/内的测试文件与模式test_*.py匹配。它们可以位于test/下的子目录中,这些子目录可以命名为任何内容。

然后,您可以使用以下命令运行所有测试:

python -m unittest

完成!解决方案少于100行。希望另一个python初学者通过找到它来节省时间。

答案 4 :(得分:30)

通过研究上面的代码(特别是使用TextTestRunnerdefaultTestLoader),我能够非常接近。最后我通过将所有测试套件传递给单个套件构造函数来修复我的代码,而不是“手动”添加它们,这解决了我的其他问题。所以这是我的解决方案。

import glob
import unittest

test_files = glob.glob('test_*.py')
module_strings = [test_file[0:len(test_file)-3] for test_file in test_files]
suites = [unittest.defaultTestLoader.loadTestsFromName(test_file) for test_file in module_strings]
test_suite = unittest.TestSuite(suites)
test_runner = unittest.TextTestRunner().run(test_suite)

是的,使用鼻子可能比做这个更容易,但这是重点。

答案 5 :(得分:23)

如果您想从各种测试用例类中运行所有测试,并且您很乐意明确指定它们,那么您可以这样做:

from unittest import TestLoader, TextTestRunner, TestSuite
from uclid.test.test_symbols import TestSymbols
from uclid.test.test_patterns import TestPatterns

if __name__ == "__main__":

    loader = TestLoader()
    tests = [
        loader.loadTestsFromTestCase(test)
        for test in (TestSymbols, TestPatterns)
    ]
    suite = TestSuite(tests)

    runner = TextTestRunner(verbosity=2)
    runner.run(suite)

其中uclid是我的项目,TestSymbolsTestPatternsTestCase的子类。

答案 6 :(得分:13)

我已使用discover方法和load_tests的重载来实现此结果(我认为最少)数字代码行:

def load_tests(loader, tests, pattern):
''' Discover and load all unit tests in all files named ``*_test.py`` in ``./src/``
'''
    suite = TestSuite()
    for all_test_suite in unittest.defaultTestLoader.discover('src', pattern='*_tests.py'):
        for test_suite in all_test_suite:
            suite.addTests(test_suite)
    return suite

if __name__ == '__main__':
    unittest.main()

执行类似

的五行
Ran 27 tests in 0.187s
OK

答案 7 :(得分:7)

我尝试了各种各样的方法,但都看起来有缺陷,或者我不得不化妆一些代码,这很烦人。但是在linux下有一种方便的方法,就是通过某种模式找到每个测试,然后逐个调用它们。

find . -name 'Test*py' -exec python '{}' \;

最重要的是,它确实有效。

答案 8 :(得分:6)

如果是打包的库或应用程序,您不希望这样做。 setuptools will do it for you

  

要使用此命令,项目的测试必须通过函数,TestCase类或方法或包含unittest类的模块或包裹包装在TestCase测试套件中。如果命名套件是一个模块,并且模块具有additional_tests()函数,则调用它并将结果(必须是unittest.TestSuite)添加到要运行的测试中。如果命名套件是一个包,则将任何子模块和子包以递归方式添加到整个测试套件

告诉它根测试包的位置,例如:

setup(
    # ...
    test_suite = 'somepkg.test'
)

并运行python setup.py test

基于文件的发现在Python 3中可能存在问题,除非您在测试套件中避免相对导入,因为discover使用文件导入。即使它支持可选的top_level_dir,但我有一些无限的递归错误。因此,对于非打包代码的简单解决方案是将以下内容放在测试包的__init__.py中(请参阅load_tests Protocol)。

import unittest

from . import foo, bar


def load_tests(loader, tests, pattern):
    suite = unittest.TestSuite()
    suite.addTests(loader.loadTestsFromModule(foo))
    suite.addTests(loader.loadTestsFromModule(bar))

    return suite

答案 9 :(得分:4)

我使用PyDev / LiClipse并没有真正弄清楚如何从GUI一次运行所有测试。 (编辑:右键单击根测试文件夹并选择Run as -> Python unit-test

这是我目前的解决方法:

import unittest

def load_tests(loader, tests, pattern):
    return loader.discover('.')

if __name__ == '__main__':
    unittest.main()

我将此代码放在我的测试目录中名为all的模块中。如果我从LiClipse运行此模块作为单元测试,则运行所有测试。如果我要求只重复特定或失败的测试,那么只运行那些测试。它也不会干扰我的命令行测试运行器(nosetests) - 它被忽略了。

您可能需要根据项目设置将参数更改为discover

答案 10 :(得分:2)

根据Stephen Cagle的答案,我添加了对嵌套测试模块的支持。

import fnmatch
import os
import unittest

def all_test_modules(root_dir, pattern):
    test_file_names = all_files_in(root_dir, pattern)
    return [path_to_module(str) for str in test_file_names]

def all_files_in(root_dir, pattern):
    matches = []

    for root, dirnames, filenames in os.walk(root_dir):
        for filename in fnmatch.filter(filenames, pattern):
            matches.append(os.path.join(root, filename))

    return matches

def path_to_module(py_file):
    return strip_leading_dots( \
        replace_slash_by_dot(  \
            strip_extension(py_file)))

def strip_extension(py_file):
    return py_file[0:len(py_file) - len('.py')]

def replace_slash_by_dot(str):
    return str.replace('\\', '.').replace('/', '.')

def strip_leading_dots(str):
    while str.startswith('.'):
       str = str[1:len(str)]
    return str

module_names = all_test_modules('.', '*Tests.py')
suites = [unittest.defaultTestLoader.loadTestsFromName(mname) for mname 
    in module_names]

testSuite = unittest.TestSuite(suites)
runner = unittest.TextTestRunner(verbosity=1)
runner.run(testSuite)

代码搜索.的所有子目录,查找随后加载的*Tests.py个文件。它希望每个*Tests.py包含一个类*Tests(unittest.TestCase),它依次加载并一个接一个地执行。

这适用于目录/模块的任意深度嵌套,但其间的每个目录至少需要包含一个空的__init__.py文件。这允许测试通过用点替换斜杠(或反斜杠)来加载嵌套模块(参见replace_slash_by_dot)。

答案 11 :(得分:1)

无论您位于哪个工作目录中,此BASH脚本都将从文件系统中的任何位置执行python unittest测试目录:其工作目录始终位于test目录中。

所有测试,独立的$ PWD

unittest Python模块对当前目录敏感,除非您告诉它当前位置(使用discover -s选项)。

当留在./src./example工作目录中并且需要快速的整体单元测试时,这很有用:

#!/bin/bash
this_program="$0"
dirname="`dirname $this_program`"
readlink="`readlink -e $dirname`"

python -m unittest discover -s "$readlink"/test -v

选定的测试,独立的$ PWD

我将此实用程序文件命名为runone.py,并按以下方式使用它:

runone.py <test-python-filename-minus-dot-py-fileextension>
#!/bin/bash
this_program="$0"
dirname="`dirname $this_program`"
readlink="`readlink -e $dirname`"

(cd "$dirname"/test; python -m unittest $1)

在生产过程中,无需test/__init__.py文件就可以负担您的包/内存开销。

答案 12 :(得分:1)

这是一个老问题,但是现在(2019年)对我有用的是:

python -m unittest *_test.py

我所有的测试文件都与源文件位于同一文件夹中,并以_test结尾。

答案 13 :(得分:0)

因为测试发现似乎是一个完整的主题,所以有一些专门的框架来测试发现:

更多阅读:https://wiki.python.org/moin/PythonTestingToolsTaxonomy

答案 14 :(得分:0)

我刚刚在基本测试目录中创建了一个discover.py文件,并为子目录中的所有内容添加了import语句。然后Discover可以通过在discover.py

上运行在这些目录中找到我所有的测试。
python -m unittest discover ./test -p '*.py'
# /test/discover.py
import unittest

from test.package1.mod1 import XYZTest
from test.package1.package2.mod2 import ABCTest
...

if __name__ == "__main__"
    unittest.main()

答案 15 :(得分:-2)

这是我的方法,创建a wrapper以从命令行运行测试:

#!/usr/bin/env python3
import os, sys, unittest, argparse, inspect, logging

if __name__ == '__main__':
    # Parse arguments.
    parser = argparse.ArgumentParser(add_help=False)
    parser.add_argument("-?", "--help",     action="help",                        help="show this help message and exit" )
    parser.add_argument("-v", "--verbose",  action="store_true", dest="verbose",  help="increase output verbosity" )
    parser.add_argument("-d", "--debug",    action="store_true", dest="debug",    help="show debug messages" )
    parser.add_argument("-h", "--host",     action="store",      dest="host",     help="Destination host" )
    parser.add_argument("-b", "--browser",  action="store",      dest="browser",  help="Browser driver.", choices=["Firefox", "Chrome", "IE", "Opera", "PhantomJS"] )
    parser.add_argument("-r", "--reports-dir", action="store",   dest="dir",      help="Directory to save screenshots.", default="reports")
    parser.add_argument('files', nargs='*')
    args = parser.parse_args()

    # Load files from the arguments.
    for filename in args.files:
        exec(open(filename).read())

    # See: http://codereview.stackexchange.com/q/88655/15346
    def make_suite(tc_class):
        testloader = unittest.TestLoader()
        testnames = testloader.getTestCaseNames(tc_class)
        suite = unittest.TestSuite()
        for name in testnames:
            suite.addTest(tc_class(name, cargs=args))
        return suite

    # Add all tests.
    alltests = unittest.TestSuite()
    for name, obj in inspect.getmembers(sys.modules[__name__]):
        if inspect.isclass(obj) and name.startswith("FooTest"):
            alltests.addTest(make_suite(obj))

    # Set-up logger
    verbose = bool(os.environ.get('VERBOSE', args.verbose))
    debug   = bool(os.environ.get('DEBUG', args.debug))
    if verbose or debug:
        logging.basicConfig( stream=sys.stdout )
        root = logging.getLogger()
        root.setLevel(logging.INFO if verbose else logging.DEBUG)
        ch = logging.StreamHandler(sys.stdout)
        ch.setLevel(logging.INFO if verbose else logging.DEBUG)
        ch.setFormatter(logging.Formatter('%(asctime)s %(levelname)s: %(name)s: %(message)s'))
        root.addHandler(ch)
    else:
        logging.basicConfig(stream=sys.stderr)

    # Run tests.
    result = unittest.TextTestRunner(verbosity=2).run(alltests)
    sys.exit(not result.wasSuccessful())

为简单起见,请原谅我的非PEP8编码标准。

然后,您可以为所有测试创建公共组件的BaseTest类,因此您的每个测试都将如下所示:

from BaseTest import BaseTest
class FooTestPagesBasic(BaseTest):
    def test_foo(self):
        driver = self.driver
        driver.get(self.base_url + "/")

要运行,只需将测试指定为命令行参数的一部分,例如:

./run_tests.py -h http://example.com/ tests/**/*.py