memseek-test 0.20.2

Scenario-based async load testing framework with HTTP helpers, HDR histogram latency reports and graceful shutdown
Documentation
use crate::{error::ScenarioError, runner::TaskIndex};

/// `setup()` 阶段的执行粒度。
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SetupMode {
    /// 每个并发任务执行一次(默认);产出在任务内所有轮次间复用。
    /// 适合登录拿 token、预热客户端等会话级准备。
    Task,
    /// 每轮 `run` 之前执行一次;产出仅本轮有效。
    /// 适合验证码、唯一账号等一次性消耗数据。
    Round,
}

/// 框架按单线程 `block_on` + `join_all` 调度,不 `tokio::spawn`,
/// 因此不要求方法返回的 Future `Send`;若未来需要 spawn,
/// 应改为返回 `impl Future + Send` 的手写形态。
#[allow(async_fn_in_trait)]
pub trait Scenario: Default + Send + Sync + 'static {
    type Ctx: Send + Sync;
    type Error: ScenarioError;
    /// `run` 的成功产出(如 `reqwest::Response`),每轮 run 的局部值,
    /// 仅供本轮 `validate` 借用来做业务校验。
    /// 不需要产出数据时填 `()` 即可(此时 `run` 签名与旧版 `Result<(), Error>` 等价)。
    type Output;
    /// `setup` 产出的数据(如登录会话/预热客户端/本轮业务参数),
    /// 供 `run`/`validate` 借用。不需要时填 `()` 即可(也无需实现 `setup`)。
    type Setup: Default + Send + Sync;

    /// `setup` 执行粒度,默认每个任务一次(`SetupMode::Task`)。
    const SETUP_MODE: SetupMode = SetupMode::Task;

    /// 场景展示名。
    ///
    /// 默认返回完整类型路径(如 `my_mod::HelloScenario`)。
    /// 注意:注册进 registry 的**匹配名**由 `register_scenario!` 生成,
    /// 默认是类型简单名(可用 `name = "..."` 覆盖),两者相互独立。
    fn name() -> &'static str {
        std::any::type_name::<Self>()
    }

    /// 预置阶段,按 [`Self::SETUP_MODE`] 决定执行频率:
    ///
    /// - `SetupMode::Task`:每个并发任务在 run 循环开始前执行**一次**,
    ///   产出注入该任务所有轮次的 `run`/`validate`;
    /// - `SetupMode::Round`:每轮 `run` 之前执行**一次**,
    ///   产出仅本轮有效。
    ///
    /// `task` 与 `run` 收到的为同一任务身份,可用 `task.index`
    /// 做账号等参数化预置(如 `login(format!("loadtest_{}", index))`)。
    /// 返回 `Err` 时该任务直接中止:记一次失败,不再继续。
    /// 默认实现产出 `Default::default()`,`Setup = ()` 的场景无需覆盖。
    async fn setup(_ctx: &Self::Ctx, _task: &TaskIndex) -> Result<Self::Setup, Self::Error> {
        Ok(Default::default())
    }

    /// 执行一次场景业务,返回本轮产出供 `validate` 校验。
    /// `setup` 为该任务/该轮预置阶段的产出,可借用。
    /// `task` 是框架分配的并发任务身份(编号/总数),可用 `task.index`
    /// 做账号等参数化(如 `format!("loadtest_{}", task.index + 1)`)。
    /// 返回 `Err` 时该轮直接记为失败,runner 不会调用 `validate`。
    async fn run(
        ctx: &Self::Ctx,
        task: &TaskIndex,
        setup: &Self::Setup,
    ) -> Result<Self::Output, Self::Error>;

    /// 对 run 的成功产出做业务校验,默认直接通过。
    /// `setup` 与 `task` 与 `run` 收到的为同一任务身份/预置产出。
    /// 返回 `Err` 同样记为一次 validate 失败。
    async fn validate(
        _ctx: &Self::Ctx,
        _task: &TaskIndex,
        _setup: &Self::Setup,
        _output: &Self::Output,
    ) -> Result<bool, Self::Error> {
        Ok(true)
    }
}