Python Graphene中基于graphene.test测试Subscription的方法咨询
graphene-python 中 Subscription 测试的惯用实现方案
graphene.test 模块自带的测试客户端,天生就是为单次返回的 Query/Mutation 设计的——它走的是同步单次执行分支,根本没法适配 Subscription 基于事件流持续推送的长连接特性,直接拿原来测Query的client.execute去跑Subscription查询,最后拿到的只会是个空流,完全没有测试价值。
核心测试思路
Subscription的单元测试不需要启动真实WebSocket服务,直接对齐graphene框架原生的流执行逻辑做断言即可,和真实线上运行的订阅行为1:1匹配:
- 直接调用Schema层面的异步订阅入口
schema.subscribe(),获取可异步迭代的事件流对象,该入口和生产环境的订阅执行逻辑完全解耦传输层,不存在协议层耦合 - 在测试流程中构造触发订阅的场景:可以直接调用对应触发事件的Mutation,也可以手动往订阅的事件通道写入测试数据
- 逐次读取事件流返回的推送内容,校验返回结构、数据值、错误抛出等预期行为,覆盖正常推送、异常场景、流中断等测试分支
典型测试代码示例
以pytest异步测试为例,最小可运行的Subscription测试写法如下:
import pytest from myapp.graphql.schema import schema @pytest.mark.asyncio async def test_new_message_subscription_flow(): # 建立订阅流 subscription_stream = await schema.subscribe( """ subscription OnNewMessage { newMessage { content sender } } """ ) # 校验订阅初始化无语法/权限错误 init_response = await subscription_stream.__anext__() assert not init_response.errors # 触发会推送订阅事件的操作:比如调用发消息的Mutation await schema.execute( """ mutation SendMessage($content: String!) { sendMessage(content: $content) { sendSuccess } } """, variable_values={"content": "测试消息"}, context={"current_user": "test_user_001"} ) # 读取订阅流收到的推送事件,做断言 push_event = await subscription_stream.__anext__() assert not push_event.errors assert push_event.data["newMessage"]["content"] == "测试消息" assert push_event.data["newMessage"]["sender"] == "test_user_001"
常见实践注意事项
- 别费劲硬把Subscription查询塞给
graphene.test的同步客户端了:人家的执行逻辑就是为单请求单响应的场景设计的,传Subscription进去拿不到实际推送的事件,纯做无用功 - 写Subscription单测根本不用启动真实WebSocket服务:graphene的Subscription核心逻辑和传输层是完全分离的,直接调用Schema层的订阅入口,就能覆盖90%以上的业务逻辑测试场景,测试的运行速度和稳定性都远高于启动真实服务的端到端测试
- 传输层相关的逻辑(比如WebSocket鉴权、连接生命周期管理),可以单独写端到端测试覆盖,不需要混在Subscription业务逻辑的单元测试里
内容的提问来源于stack exchange,提问作者Peteris
相关产品推荐
相关产品推荐

