如何让你的 WebSocket 接口测试更高效？拯救你的接口测试工作

目录

引言

WebSocket介绍

HTTP与WebSocket的区别

WebSocket测试方法

使用在线工具

使用Postman

使用Jmeter

使用Python

结语

---

引言

你是否曾经为 WebSocket 接口测试中复杂的协议和难以捕获的数据而感到束手无策WebSocket 协议与传统的 HTTP 协议不同测试方法也需要针对其特殊性进行优化。

本文将向您介绍一些在 WebSocket 接口测试中提高效率的实用方法和技巧希望对您学习WebSocket有所帮助。

WebSocket介绍

WebSocket 是一种基于在单个 TCP 连接上进行全双工通信的协议是从HTML5开始提供的一种浏览器与服务器之间进行全双工通讯的网络技术解决了HTTP协议不适用于实时通信的缺点相较于 HTTP 协议WebSocket 协议实现了持久化网络通信可以实现客户端和服务端的长连接能够进行双向实时通信协议名为"ws"。

HTTP与WebSocket的区别

1. 两者都是基于TCP协议进行数据传输具有可靠的传输能力而且都是应用层协议
2. HTTP是单向的通信只能由客户端向服务端发送请求服务端无法主动向客户端发送消息
3. WebSocket是双向通信客户端和服务端是通过握手建立连接可实现全双工通信双方可以同时主动向对方发送消息
4. WebSocket在建立连接时数据是通过HTTP协议传输的但是建立之后真正传输数据时使用的是更加可靠的TCP协议

二者关系

• WebSocket在建立连接时HTTP通过Upgrade消息头来通知客户端需要采用WebSocket协议来完成这个请求在发送完此响应最后的空行后服务器就会切换到WebSocket协议接口返回状态码为101表示服务器已经理解了客户端的请求需要升级协议

WebSocket测试方法

使用在线工具

在线工具有很多自行百度吧个人习惯用这个工具

使用Postman

Postman支持测试WebSocket协议的接口此文章发布时还处于公测阶段需要登录后才能使用入口如下图所示

操作跟测试HTTP请求类似不过多介绍啦如下图所示

使用Jmeter

使用Jmeter既可以单独测接口也可以进行性能测试但测试WebSocket协议需要安装插件下载插件后放到Jmeter安装路径中的lib/ext目录下重启Jmeter后在【选项】菜单中会出现【Plugins Manager】然后在可用插件Tab页搜索WebSocket进行安装即可如下图所示

安装后新建【线程组】在添加【取样器】中会出现6项WebSocket的组件

• WebSocket Close用于关闭WebSocket连接
• WebSocket Open Connection只建立WebSocket连接不发送数据
• WebSocket Ping/Pong用于心跳检测为了保持长连接防止客户端被服务端判定为不活跃而被断开
• WebSocket Single Read Sampler用于接收一个文本或二进制数据
• WebSocket Single Write Sampler用于发送一个文本或二进制数据
• WebSocket request-response Sampler用于执行基本的请求和响应交换既能发送数据又可以接收数据

若有使用过Jmeter就肯定能明白这些组件的使用方法以WebSocket request-response Sampler为例页面信息介绍如下图所示

使用Python

首先需要安装websocket-client

pip install websocket-client

对于只是测试WebSocket接口发送接收消息是否正常不需要长时间连接可以使用下面的短连接方法在请求结束后会主动断开连接

from websocket import create_connection

user1 = create_connection("ws://localhost:6688/1")	# 用户1打开连接
user2 = create_connection("ws://localhost:6688/2")	# 用户2打开连接

print("获取响应状态码", user1.getstatus()) # 正常应返回101
print("获取响应头", user2.getheaders())

user1.send("你好呀")	 # 用户1向服务端发送消息

res1 = user1.recv()		# 查看服务端推送的消息
res2 = user2.recv()

if res1 == res2:
    print("服务端消息推送成功\n")
else:
    print("消息获取异常\n")
    
print("查看用户1收到的消息",res1,"\n查看用户2收到的消息",res2)

若是要对WebSocket接口做持续监听工作需要长连接但不需要传参只是监听消息使用WebSocketApp类就更合适啦方法如下

import websocket

def on_open(ws):				# 定义用来处理打开连接的方法
    print("打开连接")
    
def on_message(ws, message):	# 定义用来监听服务器返回消息的方法
    print("监听到服务器返回的消息\n", message)

def on_error(ws, error):		# 定义用来处理错误的方法
    print("连接出现异常\n", error)

def on_close(ws):				# 定义用来处理断开连接的方法
    print("关闭连接")

if __name__ == "__main__":
    websocket.enableTrace(True) # 可选择开启跟踪在控制台可以看到详细的信息
    ws = websocket.WebSocketApp("ws://localhost:6688",
                                on_open=on_open,
                                on_message=on_message,
                                on_error=on_error,
                                on_close=on_close)
    ws.run_forever()	# 调用run_forever方法保持长连接

还可以使用Pytest对WebSocket接口实现自动化测试示例如下

import pytest
from websocket import create_connection

class TestDyd():
    url = "ws://localhost:6688"

    @classmethod
    def setup_class(cls):
        cls.ws = create_connection(cls.url)  # 建立连接
        cls.ws.settimeout(5)  # 设置超时时间

    def test_connect(self):
        # 通过状态码判断连接是否正常
        assert self.ws.getstatus() == 101

    def test_send(self):
        params = "你好呀"  			# 定义传参

        self.ws.send(params)			# 发送请求
        result = self.ws.recv()			# 获取响应结果
        print("收到来自服务端的消息", result)	# 打印响应结果
        # 因为该测试项目传参会显示在响应中所以通过判断传参是否在响应结果中进行断言
        assert params in result

if __name__ == '__main__':
    pytest.main(["-vs"])

传参可以使用@pytest.mark.parametrize()装饰器示例如下

import pytest
from websocket import create_connection

class TestDyd():
    
    data = [("/user/2", "今天开直播卖鱼"),("/user/3", "鱼可以买来放生吗"),
            ("/user/4", "那条翻白肚的鱼有死亡证明吗"),("/user/5", "你的鱼会唱歌吗"),
            ("/user/6", "你的鱼上大学了吗"),("/user/7", "你的鱼买回来需要隔离吗")]

    @pytest.mark.parametrize("user, word", data)
    def test_send(self, user, word):
        ws = create_connection("ws://localhost:6688"+user)
        params = word  

        ws.send(params)  # 发送请求
        result = ws.recv()  # 获取响应结果
        print("来自服务端的消息", result)
        assert params in result	# 断言

先简单介绍这些吧关于Python脚本可以参考官方文档里面有示例和常见问题解决方法

结语

这篇贴子到这里就结束了最后希望看这篇帖子的朋友能够有所收获。

 获取方式留言【WebSocket学习】即可

如果你觉得文章还不错请大家 点赞、分享、留言 下因为这将是我持续输出更多优质文章的最强动力