Locust性能测试

一、Locust简介

Locust是使用Python开发的支持分布式的一款开源压力测试工具，Locust在测试时，会产生大量的用户对系统进行访问，每个用户的行为是通过Python代码控制的，并且整个测试过程可以在Web的UI界面实时观察测试数据。

二、Locust优势

服务端性能测试工具最核心的部分是压力发生器，而压力发生器的核心要点有两个，一是真实模拟用户操作，二是模拟有效并发。从这两方面看locust是非常不错的。

首先是模拟用户操作，也就是测试脚本描述方面。Locust采用Pure Python脚本描述，并且HTTP请求完全基于Requests库。
另外一点就是并发机制了。Locust的并发机制摒弃了进程和线程，采用协程（gevent）的机制。采用多线程来模拟多用户时，线程数会随着并发数的增加而增加，而线程之间的切换是需要占用资源的，IO的阻塞和线程的sleep会不可避免的导致并发效率下降；正因如此，LoadRunner和Jmeter这类采用进程和线程的测试工具，都很难在单机上模拟出较高的并发压力。而协程和线程的区别在于，协程避免了系统级资源调度，由此大幅提高了性能。正常情况下，单台普通配置的测试机可以生产数千并发压力，这是LoadRunner和Jmeter都无法实现的。

三、编写一个locust脚本locustfile.py模板

# -*-coding: utf8 -*-

import random

from locust import HttpLocust, TaskSet, task

class UserBehavior(TaskSet):
    def __init__(self, *args, **kwargs):#初始化函数，继承父类参数
        super(UserBehavior, self).__init__(*args, **kwargs)
        self.headers = {
            'Content-Type': 'application/json',
            'Authorization': ''
        }

    def on_start(self):
       
        response = self.client.post(
            ' https://xxx.com/login#需要登录的接口地址 ',
            data={
                'username': '',#登录的用户名
                'password': ''#登录密码
            },
            headers=self.headers
        )
        if response.status_code == 200:
            self.headers['Authorization'] = f'Bearer {response.json()["Authorization"]}'

    @task
    def get_overview(self):
        self.client.get(
            'https://xxx.com/#需要测试的接口地址',
            headers=self.headers
        )

class WebsiteUser(HttpLocust):
    host = 'https://xxx.com'
    task_set = UserBehavior
    wait_time = lambda self: random.expovariate(1)*1000

在这个示例中，针对https://xxx.com网站，首先获取登录接口地址的token，模拟用户登录，然后随机地访问/根目录，在测试过程中，两次请求的间隔时间为随机值wait_time。get_overview方法表示一个用户行为，使用@task修饰该方法是一个事务，client.get()用于指定请求路径。
从脚本中可以看出，脚本主要包含两个类，一个是WebsiteUser（继承自HttpLocust，而HttpLocust继承自Locust），另一个是UserBehavior（继承自TaskSet）。事实上，在Locust的测试脚本中，所有业务测试场景都是在Locust和TaskSet两个类的继承子类中进行描述的。

四、执行测试

单进程运行

no_web

locust -H https://xxx.com -f locustfile.py --no-web -c1 -r2

如果采用no_web形式，则需使用--no-web参数，并会用到-c,-r参数。
-c, --clients：指定并发用户数；
-r, --hatch-rate：指定并发加压速率，默认值位1。

web

locust -H https://xxx.com -f locustfile.py

如果采用web形式，，则通常情况下无需指定其它额外参数，Locust默认采用8089端口启动web；如果要使用其它端口，就可以使用如下参数进行指定。
-P, --port：指定web端口，默认为8089.

多进程分布式运行

启动master时，需要使用--master参数；同样的，如果要使用8089以外的端口，还需要使用-P, --port参数。

locust -H https://debugtalk.com -f demo.py --master --port=8088

master启动后，还需要启动slave才能执行测试任务。

启动slave时需要使用--slave参数；在slave中，就不需要再指定端口了。

locust -H https://debugtalk.com -f demo.py --slave

如果slave与master不在同一台机器上，还需要通过--master-host参数再指定master的IP地址。

locust -H https://debugtalk.com -f demo.py --slave --master-host=<locust_machine_ip>

master和slave都启动完毕后，就可以在浏览器中通过http://locust_machine_ip:8089进入Locust的Web管理页面了。使用方式跟单进程web形式完全相同，只是此时是通过多进程负载来生成并发压力，在web管理界面中也能看到实际的slave数量。

五、测试结果展示

浏览器访问http://localhost:8089

image.png

number of user to simulate：设置模拟的用户数
hatch rate ：每秒产生的虚拟用户数
输入用户数100，每秒产生10

Locust在执行测试的过程中，我们可以在web界面中实时地看到结果运行情况。
相比于LoadRunner，Locust的结果展示十分简单，主要就四个指标：并发数、RPS、响应时间、异常率。但对于大多数场景来说，这几个指标已经足够了。