你如何使用 tornado.testing 来创建 WebSocket 单元测试？

Question

我正在开发一个使用 tornado 的 websocket 功能的项目。我看到了大量关于使用异步代码的文档，但没有关于如何使用它来创建与其 WebSocket 实现一起工作的单元测试。

tornado.testing 是否提供执行此操作的功能？如果是这样，有人可以提供一个简短的例子来说明如何实现吗？

提前致谢。

Answer 1

正如@Vladimir 所说，您仍然可以使用AsyncHTTPTestCase 来创建/管理测试网络服务器实例，但是您可以仍然以与正常 HTTP 请求相同的方式测试 WebSocket - 有只是没有语法糖可以帮助你。

Tornado 也有它自己的 WebSocket 客户端，所以没有必要（据我所知）使用第三方客户端——尽管它可能是最近添加的。所以试试类似的东西：

import tornado

class TestWebSockets(tornado.testing.AsyncHTTPTestCase):
    def get_app(self):
        # Required override for AsyncHTTPTestCase, sets up a dummy
        # webserver for this test.
        app = tornado.web.Application([
            (r'/path/to/websocket', MyWebSocketHandler)
        ])
        return app

    @tornado.testing.gen_test
    def test_websocket(self):
        # self.get_http_port() gives us the port of the running test server.
        ws_url = "ws://localhost:" + str(self.get_http_port()) + "/path/to/websocket"
        # We need ws_url so we can feed it into our WebSocket client.
        # ws_url will read (eg) "ws://localhost:56436/path/to/websocket

        ws_client = yield tornado.websocket.websocket_connect(ws_url)

        # Now we can run a test on the WebSocket.
        ws_client.write_message("Hi, I'm sending a message to the server.")
        response = yield ws_client.read_message()
        self.assertEqual(response, "Hi client! This is a response from the server.")
        # ...etc

希望无论如何这是一个很好的起点。

Answer 2

我尝试在基于tornado.websocket.WebSocketHandler 的处理程序上实现一些单元测试，并得到以下结果：

首先AsyncHTTPTestCase 肯定缺乏网络套接字支持。

不过，至少可以使用它来管理IOLoop 和重要的应用程序。可惜tornado没有提供WebSocket客户端，所以这里进入侧开发库。

这里是 unit test on Web Sockets，使用 Jef Balog 的 tornado websocket client。

Answer 3

This answer（和问题）可能很有趣，我使用 ws4py 作为客户端，使用 Tornado 的 AsyncTestCase 来简化整个事情。