python中的HTML记录器

Question

我正在使用 python logging module 记录到控制台和文本文件。我正在使用HTMLTestRunner 登录 html 文件。我想我正在使用 HTMLTestRunner 0.8.0

但是问题是HTMLTestRunner 只打印print 语句，而日志模块不打印打印语句。有什么办法可以在 html 文件中获取日志语句

下面是htmlrunner代码

runner = HTMLTestRunner.HTMLTestRunner(
                stream=outfile,
                title='Test Report',
                description='Regression Test Suite',
                verbosity=3
                )
result = runner.run(suite)

已编辑：我使用的是import unittest，而对于日志记录我使用的是import logging。对于 HTML 运行器，我使用的是 import HTMLTestRunner

为了在控制台上打印语句，我使用logging.info 和logging.debug。如果我使用 python print 使用打印语句，那么我既不会在控制台中也不会在日志中获得此输出。但是对于 HTML 日志记录，我只有 print 语句和 stderr。

我的查询：HTMLTestRunner.HTMLTestRunner 是否会有使用logging.debug 和logging.info 在控制台上打印的语句

Answer 1

您当前使用的HTMLTestRunner 模块已经使用了大约 6 年，并且严重过时。有更好的选择 - 从 html-testRunner 开始，或者甚至更好的选择 - pytest 启用 HTML reporting plugin。

但是，如果您准备修补/更改 HTMLTestRunner 实现，我们需要执行以下操作以使日志记录正常工作并在报告中显示消息（这只是一种方法）：

• 向HTMLTestRunner 类构造函数添加一个新的logger 参数并将一个新的处理程序附加到记录器：

  class HTMLTestRunner(Template_mixin):
      def __init__(self, stream=sys.stdout, verbosity=1, title=None, description=None, logger=None):  # CHANGE HERE
          # ...
  
          # CHANGE BELOW
          self.log_capture = None
          if logger:
              self.log_capture = StringIO.StringIO()
  
              ch = logging.StreamHandler(self.log_capture)
              ch.setLevel(logging.DEBUG)
  
              formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
              ch.setFormatter(formatter)
  
              logger.addHandler(ch)
  

• 编辑HEADING_TMPL 模板并为日志消息添加一个占位符：

  HEADING_TMPL = """<div class='heading'>
  <h1>%(title)s</h1>
  %(parameters)s
  <p class='description'>%(description)s</p>
  Logging output:
  <p class='logs'>%(logs)s</p>
  </div>
  """ # variables: (title, parameters, description)
  

• 更改_generate_heading()方法并填写logs占位符：

  heading = self.HEADING_TMPL % dict(
      title = saxutils.escape(self.title),
      parameters = ''.join(a_lines),
      description = saxutils.escape(self.description),
      logs='<br>'.join(self.log_capture.getvalue().split("\n")) if self.log_capture else ""
  )
  

• 别忘了import logging

现在，例如，如果您有这种测试，其中 logger 实例在测试中写入日志消息，您可以将记录器传递到 HTMLTestRunner，然后将日志消息转储到报告中：

import logging
import unittest

import HTMLTestRunner

logger = logging.getLogger()
logger.setLevel(logging.DEBUG)


class BasicTestCase(unittest.TestCase):
    def test_one(self):
        logger.info('Test message 1!')
        self.assertEqual(1, 1)

    def test_two(self):
        """Extended description"""
        logger.error('Test message 1!')
        self.assertEqual(2, 2)


if __name__ == '__main__':
    import sys
    logging.basicConfig(stream=sys.stderr)

    with open('report.html', 'w') as report_file:
        runner = HTMLTestRunner.HTMLTestRunner(
            stream=report_file,
            title='Test Report',
            description='Regression Test Suite',
            verbosity=3,
            logger=logger
        )

        suite = unittest.TestLoader().loadTestsFromTestCase(BasicTestCase)

        result = runner.run(suite)
        print(result)

运行测试后report.html的内容：