50

有没有办法在单元测试失败时自动启动调试器?

现在我只是手动使用 pdb.set_trace() ,但这非常繁琐,因为我每次都需要添加它并在最后取出它。

例如:

import unittest

class tests(unittest.TestCase):

    def setUp(self):
        pass

    def test_trigger_pdb(self):
        #this is the way I do it now
        try:
            assert 1==0
        except AssertionError:
            import pdb
            pdb.set_trace()

    def test_no_trigger(self):
        #this is the way I would like to do it:
        a=1
        b=2
        assert a==b
        #magically, pdb would start here
        #so that I could inspect the values of a and b

if __name__=='__main__':
    #In the documentation the unittest.TestCase has a debug() method
    #but I don't understand how to use it
    #A=tests()
    #A.debug(A)

    unittest.main()
4

7 回答 7

36

我想你要找的是鼻子。它就像unittest的测试运行器一样工作。

您可以使用以下命令进入错误调试器:

nosetests --pdb
于 2011-05-16T00:54:29.817 回答
29
import unittest
import sys
import pdb
import functools
import traceback
def debug_on(*exceptions):
    if not exceptions:
        exceptions = (AssertionError, )
    def decorator(f):
        @functools.wraps(f)
        def wrapper(*args, **kwargs):
            try:
                return f(*args, **kwargs)
            except exceptions:
                info = sys.exc_info()
                traceback.print_exception(*info) 
                pdb.post_mortem(info[2])
        return wrapper
    return decorator

class tests(unittest.TestCase):
    @debug_on()
    def test_trigger_pdb(self):
        assert 1 == 0

我更正了代码以在异常上调用 post_mortem 而不是 set_trace。

于 2010-12-09T14:24:54.217 回答
4

一个简单的选择是只运行测试而不收集结果,并让第一个异常崩溃堆栈(用于任意事后处理),例如

try: unittest.findTestCases(__main__).debug()
except:
    pdb.post_mortem(sys.exc_info()[2])

另一种选择:覆盖unittest.TextTestResult和在调试测试运行器中立即进行事后调试(之前addError)- 或以高级方式收集和处理错误和回溯。addFailuretearDown()

(不需要额外的框架或测试方法的额外装饰器)

基本示例:

import unittest, pdb

class TC(unittest.TestCase):
    def testZeroDiv(self):
        1 / 0

def debugTestRunner(post_mortem=None):
    """unittest runner doing post mortem debugging on failing tests"""
    if post_mortem is None:
        post_mortem = pdb.post_mortem
    class DebugTestResult(unittest.TextTestResult):
        def addError(self, test, err):
            # called before tearDown()
            traceback.print_exception(*err)
            post_mortem(err[2])
            super(DebugTestResult, self).addError(test, err)
        def addFailure(self, test, err):
            traceback.print_exception(*err)
            post_mortem(err[2])
            super(DebugTestResult, self).addFailure(test, err)
    return unittest.TextTestRunner(resultclass=DebugTestResult)

if __name__ == '__main__':
    ##unittest.main()
    unittest.main(testRunner=debugTestRunner())
    ##unittest.main(testRunner=debugTestRunner(pywin.debugger.post_mortem))
    ##unittest.findTestCases(__main__).debug()
于 2016-04-18T18:03:45.923 回答
4

第三方测试框架增强通常似乎包括该功能(nose并且nose2已经在其他答案中提到过)。多一点:

pytest支持它。

pytest --pdb

或者,如果您使用absl-pyabsltest而不是模块unittest

name_of_test.py --pdb_post_mortem
于 2019-08-27T22:31:36.713 回答
1

要将@cmcginty 的答案应用到后续的nose 2(在基于Debian 的系统上通过nose 推荐apt-get install nose2),您可以通过调用进入调试器的失败和错误

nose2

在您的测试目录中。

为此,您需要.unittest.cfg在您的主目录或unittest.cfg项目目录中有一个合适的;它需要包含行

[debugger]
always-on = True
errors-only = False
于 2016-03-18T12:21:29.320 回答
0

上面的一些解决方案修改了业务逻辑:

try:      # <-- new code
 original_code()  # <-- changed (indented)
except Exception as e:  # <-- new code
 pdb.post_mortem(...)   # <-- new code

为了尽量减少对原始代码的更改,我们可以定义一个函数装饰器,并简单地装饰抛出的函数:

def pm(func):
    import functools, pdb

    @functools.wraps(func)
    def func2(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except Exception as e:
            pdb.post_mortem(e.__traceback__)

   raise
    return func2

利用:

@pm
def test_xxx(...):
 ...
于 2022-02-04T08:12:59.023 回答
0

这是一个内置的,没有额外模块的解决方案:

import unittest
import sys
import pdb

####################################
def ppdb(e=None):
    """conditional debugging
       use with:  `if ppdb(): pdb.set_trace()` 
    """
    return ppdb.enabled

ppdb.enabled = False
###################################


class SomeTest(unittest.TestCase):

    def test_success(self):
        try:
            pass
        except Exception, e:
            if ppdb(): pdb.set_trace()
            raise

    def test_fail(self):
        try:
            res = 1/0
            #note:  a `nosetests --pdb` run will stop after any exception
            #even one without try/except and ppdb() does not not modify that.
        except Exception, e:
            if ppdb(): pdb.set_trace()
            raise


if __name__ == '__main__':
    #conditional debugging, but not in nosetests
    if "--pdb" in sys.argv:
        print "pdb requested"
        ppdb.enabled = not sys.argv[0].endswith("nosetests")
        sys.argv.remove("--pdb")

    unittest.main()

调用它,python myunittest.py --pdb它会停止。否则不会。

于 2017-09-05T18:26:07.087 回答