RPC接口测试技术-websocket 自动化测试实践

【摘要】 WebSocket 是一种在单个 TCP 连接上进行全双工通信(Full Duplex 是通讯传输的一个术语。通信允许数据在两个方向上同时传输，它在能力上相当于两个单工通信方式的结合。全双工指可以同时（瞬时）进行信号的双向传输（ A→B 且 B→A ）。指 A→B 的同时 B→A，是瞬时同步的)的协议。WebSocket 通信协议于 2011 年被 IETF 定为标准 RFC 6455，并由...

WebSocket 是一种在单个 TCP 连接上进行全双工通信(Full Duplex 是通讯传输的一个术语。通信允许数据在两个方向上同时传输，它在能力上相当于两个单工通信方式的结合。全双工指可以同时（瞬时）进行信号的双向传输（ A→B 且 B→A ）。指 A→B 的同时 B→A，是瞬时同步的)的协议。

WebSocket 通信协议于 2011 年被 IETF 定为标准 RFC 6455，并由 RFC7936 补充规范。WebSocket API (WebSocket API 是一个使用WebSocket 协议的接口，通过它来建立全双工通道来收发消息) 也被 W3C 定为标准。

而 HTTP 协议就不支持持久连接，虽然在 HTTP1.1 中进行了改进，使得有一个 keep-alive，在一个 HTTP 连接中，可以发送多个 Request，接收多个 Response。

但是在 HTTP 中 Request = Response 永远是成立的，也就是说一个 request 只能有一个response。而且这个response也是被动的，不能主动发起。

websocket 常用于社交/订阅、多玩家游戏、协同办公/编辑、股市基金报价、体育实况播放、音视频聊天/视频会议/在线教育、智能家居与基于位置的应用。

websocket 接口不能使用 requests 直接进行接口的调用，可以依赖第三方库的方式来实现调用，以下内容介绍如何调用第三方库实现 websocket 的接口自动化测试。

实战

使用 python 语言实现 websocket 的接口自动化

环境准备

1.安装 pyhton3 环境下载需要的运行库
2.下载需要的运行库
pip install websocket-client

实战演示

• 连接 websoket 服务器

1. import logging

2. from websocket import create_connection

3. logger = logging.getLogger(__name__)

4. url = 'ws://echo.websocket.org/' #一个在线的回环websocket接口,必须以websocket的方式连接后访问，无法直接在网页端输入该地址访问

5. wss = create_connection(url, timeout=timeout)

• 发送 websocket 消息

1. wss.send('Hello World')

• 接收 websocket 消息

1. res = wss.recv()

2. logger.info(res)

• 关闭 websocket 连接

1. wss.close()

• websocket 第三方库的调用不支持直接发送除字符串外的其他数据类型，所以在发送请求之前需要将 Python 结构化的格式,转换为成为字符串类型或者 json 字符串后，再发起 websocket 的接口请求

1. #待发送的数据体格式为：

2. data= {

3. "a" : "abcd",

4. "b" : 123

5. }

6. # 发送前需要把数据处理成 json 字符串

7. new_data=json.dumps(data,ensure_ascii=False)

8. wss.send(new_data)

• 接收的数据体的处理：如果接口定义为 json 的话，由于数据的传输都是字符串格式的，需要对接收的数据体进行转换操作

1. # 接收的数据体的格式也为字符串

2. logger.info(type(res)) # <class 'str'>

对于响应内容进行格式转换处理：

1. def load_json(base_str):

2. if isinstance(base_str, str):

3. try:

4. res = json.loads(base_str)

5. return load_json(res)

6. except JSONDecodeError:

7. return base_str

8. elif isinstance(base_str, list):

9. res = []

10. for i in base_str:

11. res.append(load_json(i))

12. return res

13. elif isinstance(base_str, dict):

14. for key, value in base_str.items():

15. base_str[key] = load_json(value)

16. return base_str

17. return base_str

• websocket 接口自动化测试，二次封装 demo 展示
  web_socket_util.py 封装 websocket 接口通用操作：

1. import logging

2. import json

3. from websocket import create_connection

4. logger = logging.getLogger(__name__)

5. class WebsocketUtil():

7. def conn(self, uri, timeout=3):

8. '''

9. 连接web服务器

10. :param uri: 服务的url

11. :param timeout: 超时时间

12. :return:

13. '''

14. self.wss = create_connection(uri, timeout=timeout)

16. def send(self, message):

17. '''

18. 发送请求数据体

19. :param message: 待发送的数据信息

20. :return:

21. '''

22. if not isinstance(message, str):

23. message = json.dumps(message)

24. return self.wss.send(message)

26. def load_json(self, base_str):

27. '''

28. 进行数据体的处理

29. :param base_str: 待处理的数据体

30. :return:

31. '''

32. if isinstance(base_str, str):

33. try:

34. res = json.loads(base_str)

35. return self.load_json(res)

36. except JSONDecodeError:

37. return base_str

38. elif isinstance(base_str, list):

39. res = []

40. for i in base_str:

41. res.append(self.load_json(i))

42. return res

43. elif isinstance(base_str, dict):

44. for key, value in base_str.items():

45. base_str[key] = self.load_json(value)

46. return base_str

47. return base_str

49. def recv(self, timeout=3):

50. '''

51. 接收数据体信息，并调用数据体处理方法处理响应体

52. :param timeout: 超时时间

53. :return:

54. '''

55. if isinstance(timeout, dict):

56. timeout = timeout["timeout"]

57. try:

58. self.settimeout(timeout)

59. recv_json = self.wss.recv()

60. all_json_recv = self.load_json(recv_json)

61. self._set_response(all_json_recv)

62. return all_json_recv

63. except WebSocketTimeoutException:

64. logger.error(f"已经超过{timeout}秒没有接收数据啦")

66. def settimeout(self, timeout):

67. '''

68. 设置超时时间

69. :param timeout: 超时时间

70. :return:

71. '''

72. self.wss.settimeout(timeout)

74. def recv_all(self, timeout=3):

75. '''

76. 接收多个数据体信息，并调用数据体处理方法处理响应体

77. :param timeout: 超时时间

78. :return:

79. '''

80. if isinstance(timeout, dict):

81. timeout = timeout["timeout"]

82. recv_list = []

83. while True:

84. try:

85. self.settimeout(timeout)

86. recv_json = self.wss.recv()

87. all_json_recv = self.load_json(recv_json)

88. recv_list.append(all_json_recv)

89. logger.info(f"all::::: {all_json_recv}")

90. except WebSocketTimeoutException:

91. logger.error(f"已经超过{timeout}秒没有接收数据啦")

92. break

93. self._set_response(recv_list)

94. return recv_list

96. def close(self):

97. '''

98. 关闭连接

99. :return:

100. '''

101. return self.wss.close()

103. def _set_response(self, response):

104. self.response = response

106. def _get_response(self) -> list:

107. return self.response

test_case.py websocket 接口自动化测试用例：

1. class TestWsDemo:

3. def setup(self):

4. url = 'ws://echo.websocket.org/'

5. self.wss = WebsocketUtil()

6. self.wss.conn(url)

8. def teardown(self):

9. self.wss.close()

11. def test_demo(self):

12. data = {"a": "hello", "b": "world"}

13. self.wss.send(data)

14. res = self.wss.recv()

15. assert 'hello' == res['a']

WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。

在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取