Locust性能测试框架

---

一、简介

1.定义

• Locust是一款易于使用的分布式负载测试工具，完全基于事件，即一个locust节点也可以在一个进程中支持数千并发用户，不使用回调，使用轻量级过程（即在自己的进程内运行）。

2.特点

• ①、不需要编写笨重的UI或者臃肿的XML代码，基于协程而不是回调，脚本编写简单易读；
• ②、有一个基于we简洁的HTML+JS的UI用户界面，可以实时显示相关的测试结果；
• ③、支持分布式测试，用户界面基于网络，因此具有跨平台且易于扩展的特点；
• ④、所有繁琐的I / O和协同程序都被委托给gevent，替代其他工具的局限性；

3.比较

工具	区别
jmeter	需要在UI界面上通过选择组件来“编写”脚本，模拟的负载是线程绑定的，意味着模拟的每个用户，都需要一个单独的线程。单台负载机可模拟的负载数有限
locust	通过编写简单易读的代码完成测试脚本，基于事件，同样配置下，单台负载机可模拟的负载数远超jmeter

ps：但locust的局限性在于，目前其本身对测试过程的监控和测试结果展示，不如jmeter全面和详细，需要进行二次开发才能满足需求越来越复杂的性能测试需要

二、安装

• 1.网上都有支持python的版本：2.7、3.4、3.5、3.6、3.7（ps:本机为3.7）
• 2.windows/linux/系统安装（ps:本机为windows10）
  • ①、安装命令

    >通过pip安装
    >pip install locust
    

  • ②、通过为pyzmq、gevent和greenlet安装预先构建的二进制包，然后在这里找到非官方的预制包，下载.whl文件后，使用 pip install name-of-file.whl 命令安装；
  • ③、通过命令查看安装是否成功

    >pip show locust
    >locust  -help 查看帮助
    

三. 实例运行编写

ps:安装的python3.7 版本 import 的变为了HttpUser 不是之前的 ’HttpLocust‘

ps:由于本地接口需要传入token

from locust import HttpUser, TaskSet, task
class WebsiteTasks(TaskSet):
    def on_start(self):
        self.client.post("/chaoxingqiu/account/login_by_password_v_5_1_0/",
                         {"phoneNumber": "13663644714", "password": "123456"})
        # self.client.get("/login?key=00d91e8e0cca2b76f515926a36db68f5&phone=13594347817&passwd=123456")
    # @task(2)
    # def videoCategory(self):
    #     self.client.post("/chaoxingqiu/goods/ali_verify_v_5_0_1/", {}, {"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblVzZXJJZCI6ImIyZmFiYzMwNTI1MzM1NTM5MGY3Nzk0NmYwMmJlYTJhIiwidGltZSI6IjE2MDM2OTg5OTAifQ.uBBTCyLC1OMuAGGoEzTZsCKTly4lUFJTQNnByUKx9tE"})

    # @task(1)
    def videoRecommend(self):
        self.client.post("/chaoxingqiu/version/check_version_update_v_5_0_1/", json={"type":0,"versionCode":"1.6.8"}, headers={"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblVzZXJJZCI6ImIyZmFiYzMwNTI1MzM1NTM5MGY3Nzk0NmYwMmJlYTJhIiwidGltZSI6IjE2MDM2OTg5OTAifQ.uBBTCyLC1OMuAGGoEzTZsCKTly4lUFJTQNnByUKx9tE"})
    #
    # def todayVideo(self):
    #     self.client.post("/chaoxingqiu/discover/user_online_status_v_5_1_0/", {"type":1},{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblVzZXJJZCI6ImIyZmFiYzMwNTI1MzM1NTM5MGY3Nzk0NmYwMmJlYTJhIiwidGltZSI6IjE2MDM2OTg5OTAifQ.uBBTCyLC1OMuAGGoEzTZsCKTly4lUFJTQNnByUKx9tE"})
    #
    # def getJoke(self):
    #     self.client.post("/chaoxingqiu/personal_center/unread_message_display_v_5_0_1/",{"type":5},{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblVzZXJJZCI6ImIyZmFiYzMwNTI1MzM1NTM5MGY3Nzk0NmYwMmJlYTJhIiwidGltZSI6IjE2MDM2OTg5OTAifQ.uBBTCyLC1OMuAGGoEzTZsCKTly4lUFJTQNnByUKx9tE"})
    #
    # def novelSearchApi(self):
    #     self.client.post("/chaoxingqiu/personal_center/personal_homepage_display_v_5_1_1/", {},{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblVzZXJJZCI6ImIyZmFiYzMwNTI1MzM1NTM5MGY3Nzk0NmYwMmJlYTJhIiwidGltZSI6IjE2MDM2OTg5OTAifQ.uBBTCyLC1OMuAGGoEzTZsCKTly4lUFJTQNnByUKx9tE"})
    #
    # tasks = {videoCategory: 2, videoRecommend: 1, todayVideo: 2, getJoke: 3, novelSearchApi: 2}  # 与装饰器效果一致
    tasks = {videoRecommend: 1}  # 与装饰器效果一致

class WebsiteUser(HttpUser):
    # https://blog.csdn.net/c__chao/article/details/78573737
    # task_set = WebsiteTasks  # Usage of User.task_set is deprecated since version 1.0. Set the tasks attribute instead (tasks = [WebsiteTasks])
    tasks = [WebsiteTasks]
    host = "https://api.apiopen.top"
    min_wait = 1000
    max_wait = 5000

脚本说明

新建一个类WebsiteTasks(TaskSet)，继承TaskSet，该类下面写需要请求的接口以及相关信息；
self.client调用get和post方法，和requests一样；
@task装饰该方法表示为用户行为，括号里面参数表示该行为的执行权重：数值越大，执行频率越高，不设置默认是1；
WebsiteUser()类用于设置生成负载的基本属性：

属性	说明
min_wait	模拟负载的任务之间执行时的最小等待时间，单位为毫秒
max_wait	模拟负载的任务之间执行时的最大等待时间，单位为毫秒

PS：默认情况下，时间是在min_wait和max_wait之间随机选择，但是可以通过将wait_function设置为任意函数来使用任何用户定义的时间分布。

四、启动locust

1.在文件里面直接执行

locust -H http://192.168.1.107:8000 -f demo.py

2、如果Locust文件位于子目录下且名称不是locustfile.py，可以使用-f命令启动上面的示例locust文件：

 locust -f demo.py --host=http://192.168.1.107:8000

3、如果要运行分布在多个进程中的Locust，通过指定-master以下内容来启动主进程

 locust -f demo.py --master --host=http://192.168.1.107:8000

4、如果要启动任意数量的从属进程，可以通过-salve命令来启动locust文件：

 locust -f demo.py --salve --host=http://192.168.1.107:8000

5、如果要运行分布式Locust，必须在启动从机时指定主机（运行分布在单台机器上的Locust时不需要这样做，因为主机默认为127.0.0.1）：

 locust -f demo.py --slave --master-host=192.168.0.100 --host=https://cnblogs.com 

6、启动locust文件成功后，编译器控制台会显示如下信息：

[2020-12-10 15:20:41,362] BF-201806010758/INFO/locust.main: Starting web interface at http://0.0.0.0:8089 (accepting connections from all network interfaces)
[2020-12-10 15:20:41,371] BF-201806010758/INFO/locust.main: Starting Locust 1.4.1

五、locust的UI界面

1、启动界面

image.png

ps:Number of users to simulate：设置模拟的用户总数
Hatch rate (users spawned/second)：每秒启动的虚拟用户数
Start swarming：执行locust脚本

2、测试结果页面

image.png

Type：请求类型，即接口的请求方法；
Name：请求路径；
requests：当前已完成的请求数量；
fails：当前失败的数量；
Median：响应时间的中间值，即50%的响应时间在这个数值范围内，单位为毫秒；
Average：平均响应时间，单位为毫秒；
Min：最小响应时间，单位为毫秒；
Max：最大响应时间，单位为毫秒；
Content Size：所有请求的数据量，单位为字节；
reqs/sec：每秒钟处理请求的数量，即QPS；

3、模块说明

image.png

①、Statistics：类似于jmeter中Listen的聚合报告；

②、

image.png

Charts：测试结果变化趋势的曲线展示图，分别为每秒完成的请求数（RPS）、响应时间、不同时间的虚拟用户数；

③、

image.png

Failures：失败请求的展示界面；
④、

image.png

Exceptions：异常请求的展示界面；

⑤、

image.png

Download Data：测试数据下载模块， 提供三种类型的CSV格式的下载，分别是：Statistics、responsetime、exceptions；