python3使用ESL和sipp自动多轮压测FreeSWITCH

沈祖晃

环境：CentOS 7.6_x64  FreeSWITCH版本 ：1.10.9  sipp版本：3.6.1  python版本：3.9.12日常工作中，有时会遇到批量自动压测FreeSWITCH的需求，sipp是一个非常好的VoIP压测工具，python是个很好用的脚本语言，今天记录下CentOS 7环境下python3如何借助ESL使用sipp自动压测FreeSWITCH服务器。一、背景描述

sipp的灵活性很好，可根据实际的业务场景定制不同的压测模型，这里选取的压测模型比较简单，整体结构如下：

 
 说明：
1）python脚本通过ESL模块和FreeSWITCH通信，用于控制呼叫和接受数据；  2）FreeSWITCH在这里的角色类似网关，负责将两台UAS的通话连接起来；  3）两台UAS都可自动接收呼叫，并自动播放音频数据，其中有一台需要具备主动发Bye请求挂断电话的功能，用于结束通话。二、具体实现

1、准备sipp配置文件

这里使用的sipp测试模型是UAS模型，该部分我会列举下关键点，sipp软件的安装使用，可参考这篇文章：https://www.cnblogs.com/MikeZhang/p/sippPcapTest.html 1.1 实现循环播放pcap文件实现思路如下：1）通过 assign 进行赋值；2）通过 add 进行计数器累加；3）通过 test 进行判断；4）通过 next 进行逻辑控制； 参考文档：https://sipp.readthedocs.io/en/latest/scenarios/actions.html

 循环播放pcap文件，示例如下：

1.   <nop>
2.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
3.   <assign assign_to="4" variable="5" /><action>
4.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
5.   <assign assign_to="4" variable="5" />  <assign assign_to="audio" value="0"/>
6.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
7.   <assign assign_to="4" variable="5" /></action>
8.   </nop>
9.   <label id="speak"/>
10.   <nop>
11.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
12.   <assign assign_to="4" variable="5" /><action>
13.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
14.   <assign assign_to="4" variable="5" />  <exec play_pcap_audio="pcap/g711a.pcap"/>
15.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
16.   <assign assign_to="4" variable="5" />  <add assign_to="audio" value="1"/>
17.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
18.   <assign assign_to="4" variable="5" />  <test assign_to="result" variable="audio" compare="less_than" value="6" />
19.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
20.   <assign assign_to="4" variable="5" /></action>
21.   </nop>
22.   <pause milliseconds="10000" />
23.   <nop next="speak" test="result"/>

复制代码

1.2 实现UAS主动发Bye请求sipp内置的场景里面，UAS是不主动发Bye请求的，如果需要UAS发Bye请求，可通过如下配置实现：

1. <send  retrans="500">
2.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
3.   <assign assign_to="4" variable="5" /><![CDATA[
5.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
6.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
7.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
8.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
9.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
10.   <assign assign_to="4" variable="5" />  From[$4]
11.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
12.   <assign assign_to="4" variable="5" />  To[$3]
13.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
14.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
15.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
16.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
17.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
18.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
19.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
20.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
21.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
22.   <assign assign_to="4" variable="5" />  Content-Length: 0
24.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
25.   <assign assign_to="4" variable="5" /> ]]>
26.   </send>

复制代码

其中，$3 $4 $5 是变量，通过以下语法获取：

1.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
2.   <assign assign_to="4" variable="5" />

复制代码

1.3 场景配置文件1）UAS1的配置

 2）UAS2的配置

完整代码可从如下渠道获取：
关注微信公众号（聊聊博文，文末可扫码）后回复 20230730 获取。2、准备python测试脚本

实现思路如下：1）设置压测参数；2）使用ESL连接FreeSWITCH，使用hupall清理呼叫，发送外呼命令，同时呼叫UAS1、UAS2；3）等待UAS2执行挂机操作，避免hupall引起的并发过高；4）根据设置的循环次数进入下一轮压测；
其中，python3.9.12版本的ESL编译及使用，可参考这篇文章：https://www.cnblogs.com/MikeZhang/p/py39esl-20230424.html
示例代码如下：

 完整代码可从如下渠道获取：
关注微信公众号（聊聊博文，文末可扫码）后回复 20230730 获取。
三、运行效果

1、UAS2循环播放音频及发送BYE的效果

编写拨号方案：

1. <send  retrans="500">
2.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
3.   <assign assign_to="4" variable="5" /><![CDATA[
5.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
6.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
7.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
8.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
9.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
10.   <assign assign_to="4" variable="5" />  From[$4]
11.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
12.   <assign assign_to="4" variable="5" />  To[$3]
13.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
14.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
15.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
16.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
17.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
18.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
19.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
20.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
21.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
22.   <assign assign_to="4" variable="5" />  Content-Length: 0
24.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
25.   <assign assign_to="4" variable="5" /> ]]>
26.   </send> <send  retrans="500">
27.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
28.   <assign assign_to="4" variable="5" /><![CDATA[
30.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
31.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
32.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
33.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
34.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
35.   <assign assign_to="4" variable="5" />  From[$4]
36.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
37.   <assign assign_to="4" variable="5" />  To[$3]
38.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
39.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
40.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
41.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
42.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
43.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
44.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
45.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
46.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
47.   <assign assign_to="4" variable="5" />  Content-Length: 0
49.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
50.   <assign assign_to="4" variable="5" /> ]]>
51.   </send> <send  retrans="500">
52.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
53.   <assign assign_to="4" variable="5" /><![CDATA[
55.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
56.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
57.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
58.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
59.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
60.   <assign assign_to="4" variable="5" />  From[$4]
61.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
62.   <assign assign_to="4" variable="5" />  To[$3]
63.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
64.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
65.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
66.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
67.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
68.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
69.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
70.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
71.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
72.   <assign assign_to="4" variable="5" />  Content-Length: 0
74.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
75.   <assign assign_to="4" variable="5" /> ]]>
76.   </send> <send  retrans="500">
77.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
78.   <assign assign_to="4" variable="5" /><![CDATA[
80.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
81.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
82.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
83.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
84.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
85.   <assign assign_to="4" variable="5" />  From[$4]
86.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
87.   <assign assign_to="4" variable="5" />  To[$3]
88.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
89.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
90.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
91.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
92.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
93.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
94.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
95.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
96.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
97.   <assign assign_to="4" variable="5" />  Content-Length: 0
99.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
100.   <assign assign_to="4" variable="5" /> ]]>
101.   </send> <send  retrans="500">
102.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
103.   <assign assign_to="4" variable="5" /><![CDATA[
105.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
106.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
107.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
108.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
109.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
110.   <assign assign_to="4" variable="5" />  From[$4]
111.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
112.   <assign assign_to="4" variable="5" />  To[$3]
113.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
114.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
115.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
116.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
117.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
118.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
119.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
120.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
121.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
122.   <assign assign_to="4" variable="5" />  Content-Length: 0
124.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
125.   <assign assign_to="4" variable="5" /> ]]>
126.   </send> <send  retrans="500">
127.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
128.   <assign assign_to="4" variable="5" /><![CDATA[
130.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
131.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
132.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
133.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
134.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
135.   <assign assign_to="4" variable="5" />  From[$4]
136.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
137.   <assign assign_to="4" variable="5" />  To[$3]
138.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
139.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
140.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
141.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
142.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
143.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
144.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
145.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
146.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
147.   <assign assign_to="4" variable="5" />  Content-Length: 0
149.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
150.   <assign assign_to="4" variable="5" /> ]]>
151.   </send> <send  retrans="500">
152.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
153.   <assign assign_to="4" variable="5" /><![CDATA[
155.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
156.   <assign assign_to="4" variable="5" />  BYE sip:[$5] SIP/2.0
157.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
158.   <assign assign_to="4" variable="5" />  Via: SIP/2.0/[transport] [local_ip]:[local_port]
159.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
160.   <assign assign_to="4" variable="5" />  From[$4]
161.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
162.   <assign assign_to="4" variable="5" />  To[$3]
163.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
164.   <assign assign_to="4" variable="5" />  Call-ID: [call_id]
165.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
166.   <assign assign_to="4" variable="5" />  Cseq: [cseq] BYE
167.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
168.   <assign assign_to="4" variable="5" />  Contact: sip:[local_ip]:[local_port]
169.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
170.   <assign assign_to="4" variable="5" />  Max-Forwards: 70
171.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
172.   <assign assign_to="4" variable="5" />  Content-Length: 0
174.   <ereg regexp="sip:(.*)>" search_in="hdr" header="Contact" assign_to="4,5"/>
175.   <assign assign_to="4" variable="5" /> ]]>
176.   </send>

复制代码

启动UAS2，注册分机，拨打 123 即可看到效果：

2、功能验证抓包数据

UAS1 ： 1个并发UAS2 ： 1个并发 

 都有数据发送。
3、python脚本压测效果

为了便于观察效果，这里设置的参数如下：1） UAS1 播放音频时长 30 秒，等待 BYE 请求；2） UAS2 播放音频时长为 35 秒，发送 BYE 请求；3） python脚本的压测循环次数为3，呼叫并发100，循环间隔70秒；
运行效果如下：

运行效果视频可从如下渠道获取：
关注微信公众号（聊聊博文，文末可扫码）后回复 2023073001 获取。四、资源下载

本文涉及文件和示例代码从如下途径获取：关注微信公众号（聊聊博文，文末可扫码）后回复 20230730 获取。

来源:https://www.cnblogs.com/MikeZhang/p/pyESLTest20230731.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！