Locust框架单次任务执行优化方案咨询及功能提案意向

一、现有终止实例方案的潜在问题 #

• 强制终止实例可能导致测试数据不完整（如请求日志、统计指标未正常落地）
• 分布式测试场景下，实例终止易引发集群状态不一致，后续重启测试需额外清理集群残留进程

二、更高效的替代实现方式 #

1. 基于Locust内置API的单次执行控制 #

无需强制终止实例，直接利用Locust提供的测试停止API，在任务完成后优雅终止测试：

from locust import HttpUser, task, between

class SmokeTestUser(HttpUser):
    wait_time = between(0.1, 0.2)
    task_count = 0
    max_single_run = 1  # 单实例单次执行的任务次数

    @task
    def health_check(self):
        self.client.get("/health")
        self.task_count += 1
        if self.task_count >= self.max_single_run:
            # 停止当前实例的测试任务
            self.environment.runner.stop()
            # 若需全局终止所有实例，改用quit()
            # self.environment.runner.quit()

2. 事件钩子驱动的全局任务控制 #

通过监听Locust的任务完成事件，设置全局任务阈值，达到后统一终止测试：

from locust import events

global_task_threshold = 5  # 全局总任务完成阈值
completed_tasks = 0

@events.task_complete.add_listener
def trigger_global_stop(**kwargs):
    global completed_tasks
    completed_tasks += 1
    if completed_tasks >= global_task_threshold:
        kwargs["environment"].runner.quit()

三、关于向Locust提交PR的可行性建议 #

• 先排查社区已有需求：在Locust的GitHub Issues中搜索smoke test、single run等关键词，确认是否已有正在开发的类似功能，避免重复工作
• 拟实现的包装器建议采用配置优先的设计：
  • 支持在locustfile.py中通过类属性配置（如class SmokeTestUser(HttpUser): single_run = True）
  • 支持命令行参数触发（如locust -f locustfile.py --single-run）
• 尽量采用扩展而非修改核心代码的方式实现，比如新增装饰器或继承扩展User类，降低代码合并的复杂度

四、补充调研方向 #

• 查阅Locust官方文档中Test Stopping章节，确认是否有未被利用的内置控制逻辑
• 参考locust-plugins等社区插件的实现，是否已提供开箱即用的单次执行功能

内容的提问来源于stack exchange，提问作者Ronny