Модульное тестирование Python: автоматический запуск отладчика при сбое теста

Question

Есть ли способ автоматически запустить отладчик в тот момент, когда не проходит тест юнитов?

Прямо сейчас я просто использую 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()

Answer 1

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.

Answer 2

Я думаю, что вы ищете, это нос. Это работает как тестовый бегун для unittest.

Вы можете попасть в отладчик при ошибках с помощью следующей команды:

nosetests --pdb

Answer 3

Усовершенствования сторонней среды тестирования обычно включают в себя функцию (nose а также nose2уже упоминались в других ответах). Еще немного:

pytest поддерживает это.

pytest --pdb

Или, если вы используете ABSL-ру"sabsltest вместо того unittest модуль:

name_of_test.py --pdb_post_mortem

Answer 4

Простой вариант - просто запустить тесты без сбора результатов и позволить первому исключению разбиться в стеке (для произвольной посмертной обработки), например:

unittest.findTestCases(__main__).debug()

---

Другой вариант: переопределить unittest.TextTestResult"s addError а также addFailure в отладочном тесте для немедленной отладки post_mortem (до tearDown()) - или для сбора и обработки ошибок и трассировок расширенным способом.

(Не требует дополнительных каркасов или дополнительного декоратора для методов тестирования)

Основной пример:

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()

Answer 5

Чтобы применить ответ @cmcginty к носителю преемника 2 ( рекомендуется по носу, доступному в системах на основе Debian через apt-get install nose2), вы можете попасть в отладчик при сбоях и ошибках, вызвав

nose2

в вашем тестовом каталоге.

Для этого вам нужно иметь подходящий .unittest.cfg в вашем домашнем каталоге или unittest.cfg в каталоге проекта; это должно содержать строки

[debugger]
always-on = True
errors-only = False

Answer 6

Чтобы ответить на комментарий в вашем коде «В документации unittest.TestCase имеет метод отладки (), но я не понимаю, как его использовать», вы можете сделать что-то вроде этого:

      suite = unittest.defaultTestLoader.loadTestsFromModule(sys.modules[__name__])
suite.debug()

Отдельные тестовые случаи создаются как:testCase = tests('test_trigger_pdb')(гдеtestsявляется подклассомTestCaseпо вашему примеру). И тогда вы можете сделатьtestCase.debug()для отладки одного случая.

Answer 7

Создайте модуль с декоратором, который отправляет сообщения об ошибках всех типов, кроме AssertionError . Декоратор может быть вызван корневым уровнем ведения журнала .

      #!/usr/bin/env python3
'''
Decorator for getting post mortem on errors of a unittest TestCase
'''
import sys
import pdb
import functools
import traceback
import logging
import unittest

logging.basicConfig(format='%(asctime)s %(message)s', level=logging.DEBUG)

def debug_on(log_level):
    '''
    Function decorator for post mortem debugging unittest functions.

    Args:
      log_level (int): logging levels coesponding to logging stl module

    Usecase:

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

    def decorator(f):

        @functools.wraps(f)
        def wrapper(*args, **kwargs):
            try:
                return f(*args, **kwargs)
            except BaseException as err:
                info = sys.exc_info()
                traceback.print_exception(*info)

                if log_level < logging.INFO and type(err) != AssertionError:
                    pdb.post_mortem(info[2])

        return wrapper

    return decorator


class Debug_onTester(unittest.TestCase):

    @debug_on(logging.root.level)
    def test_trigger_pdb(self):
        assert 1 == 0


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

Answer 8

Некоторое вышеприведенное решение изменяет бизнес-логику:

      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(...):
 ...

Answer 9

Вот встроенное, без дополнительных модулей, решение:

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 и он остановится. В противном случае это не так.