使用Tornado.testing中的LogTrapTestCase()轻松测试日志输出

Tornado.testing库提供了一个方便的工具类LogTrapTestCase()，用于测试Tornado应用程序中的日志输出。这个工具类可以捕获和断言应用程序中生成的日志消息，以便进行测试。

下面是一个例子，演示如何使用LogTrapTestCase()测试一个简单的Tornado应用程序中的日志输出。

import logging
import tornado.web
import tornado.testing

from tornado.log import LogFormatter, app_log


class HelloWorldHandler(tornado.web.RequestHandler):
    def get(self):
        self.write("Hello, World!")


class TestHelloWorldHandler(tornado.testing.LogTrapTestCase):
    def get_app(self):
        handlers = [
            (r"/", HelloWorldHandler),
        ]
        return tornado.web.Application(handlers)

    def test_logger_output(self):
        logger = logging.getLogger("tornado.application")
        logger.setLevel(logging.INFO)
        stream = tornado.log.LogFormatter().stream
        handler = logging.StreamHandler(stream)
        handler.setFormatter(LogFormatter())
        logger.addHandler(handler)

        expected_msg = "RequestHandler: [GET /] 200"
        with self.log_trap() as logs:
            self.fetch("/")
            self.assertIn(expected_msg, logs)

            # 使用Tornado内置的app_log来记录日志
            app_log.info("Another log message")
            self.assertIn("Another log message", logs)


if __name__ == '__main__':
    tornado.testing.main()

在上面的示例中，首先定义了一个简单的Tornado请求处理程序HelloWorldHandler，该处理程序用于处理根路径的GET请求。然后创建了一个TestHelloWorldHandler测试类，该类继承自tornado.testing.LogTrapTestCase。

在TestHelloWorldHandler类中，我们首先实现了get_app()方法，该方法返回我们要测试的Tornado应用程序对象。在这个例子中，我们只有一个HelloWorldHandler处理程序。

然后，在test_logger_output()方法中，我们配置了日志记录，将日志级别设置为INFO，并将日志记录到stream中。使用LogFormatter对日志进行格式化，然后添加到logger中。

接下来，我们使用self.log_trap()方法捕获日志，并使用self.fetch()方法发起一个GET请求。然后，我们断言日志输出中是否包含了我们预期的日志消息"RequestHandler: [GET /] 200"。

最后，我们使用Tornado内置的app_log来记录一个额外的日志消息"Another log message"，然后断言日志输出中是否包含了这个消息。

通过运行这个例子，我们可以轻松地测试Tornado应用程序中的日志输出。LogTrapTestCase工具类提供了方便的日志捕获和断言机制，使得日志测试变得简单而直观。