使用Locust进行压力测试（一）入门

最近一直在使用Locust进行压力测试，因此想总结一下学习和实践的一些成果。Locust官方文档

版本：
python: 3.*
locust: 0.9.0

1. 什么是Locust
Locust的意思是蝗虫，从名字就可以看出它的开发者对其给予的希望——向蝗虫一样攻击网站。根据官方文档解释，Locust是一个易于使用、分布式的、用户负载测试工具，用于对网站（或其它系统）进行负载测试，并弄清楚系统能够处理多少并发用户。Locust是基于事件的，并通过greenlet能够在单机上支持成千上万的并发用户，并且每个用户都是运行在自己的进程当中的。

2.安装
pip install locustio
使用locust -V可查看是否安装成功

3.角色
locust框架（为区分角色的Locust，后用框架代替）中主要有几种角色，理解了每种角色的功能之后，可以帮助实际使用以及更深入学习。

• Locust：如果说框架进行压力测试的方式是用一群蝗虫进行进攻，那么Locust类相当于一个蝗虫模板，而每一个locust实例就相当于其中的一个蝗虫，也就是一个用户、一个线程......。因此当我们使用框架进行压力测试时，至少需要存在一个Locust类，在指定了模拟用户的个数后，框架就会实例化相应多的Locust对象，从而实现对用户的模拟。
• TaskSet：就相当于测试场景，是由一系列的任务组成。我们需要使用一群蝗虫来进攻网站，但是如果蝗虫不知道进攻谁怎么进攻那也是白费力气，因此对蝗虫（模拟用户）我们需要告诉它们执行的任务是什么，也就是需要为每个Locust指定task_set
• task：任务，是TaskSet的一个最小单位
• client：客户端，由于框架主要是用于向website发动进攻，因此我们需要有一个客户端（可以是Http的，也可以是WebSocket等等）。客户端在Locust中被指定，然后会被传递到TaskSet中，因此在TaskSet可以直接使用self.client进行消息的发送和接收。

4.简单使用
官方示例：

from locust import HttpLocust, TaskSet, task

class UserBehavior(TaskSet):
    def on_start(self):
        """ on_start is called when a Locust start before any task is scheduled """
        self.login()

    def on_stop(self):
        """ on_stop is called when the TaskSet is stopping """
        self.logout()

    def login(self):
        self.client.post("/login", {"username":"ellen_key", "password":"education"})

    def logout(self):
        self.client.post("/logout", {"username":"ellen_key", "password":"education"})

    @task(2)
    def index(self):
        self.client.get("/")

    @task(1)
    def profile(self):
        self.client.get("/profile")

class WebsiteUser(HttpLocust):
    task_set = UserBehavior
    min_wait = 5000
    max_wait = 9000

tips:

1. 根据4中说明的角色，我们知道，要通过框架实现压力测试，我们首先需要定义一个TaskSet，即示例中的UserBehavior。
   • 每个带注解@task的方法，都是一个最基本的任务。在每个蝗虫开启进程后，框架会根据任务的权重随机选择下一个执行的任务。
   • on_start方法会在每个任务集开始的时候执行；on_stop方法会在框架的网页上点击了stop时执行
2. 然后我们需要定义一个Locust，示例中的Locust衍生自官方提供的HttpLocust，这样就使得这个蝗虫可以进行http消息的发送。Locust有一系列的属性可以由用户来指定，从而定制化符合需要的模拟用户。
   • task_set：我们必须为每个蝗虫指定任务集，否则在这个蝗虫启动之后，它都不知道应该做什么，因此task_set属性是必须的
   • min_wait、max_wait：每个任务执行后到下一个任务执行前的最小/最大等待时间（注：是每个任务间的等待时间！！！）
   • host：客户端发送消息的主机地址
   • wait_function：一个用于获取任务间等待时长的函数，默认是min_wait和max_wait中的随机值
   • stop_timeout：Locust停止的秒数，如果为None，将不停止一直执行任务
   • weight：当模拟的用户不一样时，设置该值，用于确定每种模拟用户的比重
3. 在官方提供的HttpLocust中，为每个用户提供了一个Http的客户端，这个客户端是衍生自requests.Session的，因此提供的方法与requests相同（get, post, delet, put, head, options, patch, request），不同之处如下：
   • 不需要提供完整的url地址，框架会拼接host和传入的url
   • 每个方法都比原始的requests方法多了两个参数：name和catch_response。
   • 框架会自动根据消息发送是否有返回，返回的status_code是否在400~600之外，由此判断消息发送的成功/失败，实现结果统计

5.调试和运行
框架是通过命令locust运行的，常用参数有：

• -H：指定测试的主机地址（注：会覆盖Locust类指定的主机地址）
• -f：指定测试脚本地址（注：脚本中必须包含一个Locust的衍生类）
• --no-web：不启动web网页，而是直接开始运行测试，需提供属性-c和-r
• -c：并发的用户数，与--no-web一起使用
• -r：每秒启动的用户数，与--no-web一起使用
• -t：运行时间（单位：秒），与--no-web一起使用
• -L：日志级别，默认为INFO
  调试命令：locust -f **.py --no-web -c 1 -t 1
  运行命令：locust -f **.py

6.开始测试
当使用locust命令运行框架后，通过访问localhost:8089即可访问web页面。Number of users to simulate即模拟用户数，也就是并发数；Hatch rate是每秒启动的用户数。通过输入这两个数字，点击Start swarming就开始了测试。

locust启动页面

测试开始后，页面中会对消息请求进行统计，我们据此可获得被测网站的rps、响应时间等等，从而对被测系统进行性能上的分析。在Charts中可以看到图表化的数据趋势；在Failures和Exceptions中，能够看到消息发送失败或执行任务异常的具体信息；在Download Data中可以对统计结果进行下载。

locust运行页面

tips：

• 点击STOP，会停止测试，并调用所有当前执行的TaskSet的on_stop，但不会调用teardown函数
• 点击New test，会开始新的一轮测试，但新测试不会调用setup函数，全局变量也不会再初始化