Rust / 系统课时

在 tokio 中编写异步测试

在 tokio 中编写异步测试

异步测试的关键不是把同步测试简单加一个宏,而是让测试本身运行在 Tokio runtime 中,并对异步任务的完成、超时和失败进行明确验证。

学习目标

  • 掌握 #[tokio::test] 的基本用法
  • 能使用超时约束异步测试,避免测试无限等待
  • 能正确处理异步任务返回的错误与 panic

使用异步测试宏

Tokio 提供的 #[tokio::test] 会为测试函数准备异步运行时,因此测试函数可以直接声明为 async fn,并使用 .await。它适合测试依赖 Tokio 异步 API 的服务、任务和定时逻辑。

rust
#[cfg(test)]
mod tests {
    #[tokio::test]
    async fn waits_for_async_result() {
        let value = async { 21 + 21 }.await;
        assert_eq!(value, 42);
    }
}

预期结果

text
running 1 test
test tests::waits_for_async_result ... ok

测试函数本身可以直接等待异步操作,但不要把“异步执行了”误认为“业务已经完成”。对于真实任务,还需要验证任务的结果、错误以及完成时间。

给异步测试设置超时

异步测试最常见的危险是等待条件永远不会成立,例如 channel 没有消息、任务没有结束或重试逻辑陷入等待。可以用 tokio::time::timeout 给测试建立明确的时间边界。

rust
#[cfg(test)]
mod tests {
    use std::time::Duration;
    use tokio::time::{sleep, timeout};

    #[tokio::test]
    async fn completes_before_timeout() {
        let result = timeout(Duration::from_millis(100), async {
            sleep(Duration::from_millis(10)).await;
            42
        })
        .await
        .expect("operation timed out");

        assert_eq!(result, 42);
    }
}

预期结果

text
running 1 test
test tests::completes_before_timeout ... ok

超时不是让测试“更快结束”这么简单,而是把异步测试的完成条件显式化。超时时间应明显大于正常执行时间,但不能大到掩盖死锁或错误等待。

处理任务失败

使用 tokio::spawn 后得到的是 JoinHandle。调用 .await 时既要考虑任务自身返回的 Result,也要考虑任务是否被取消或 panic。测试中直接 unwrap 可以快速失败,但对复杂任务最好分别检查业务错误和任务失败。

rust
#[cfg(test)]
mod tests {
    use tokio::task::JoinHandle;

    async fn run_job() -> Result<u32, &'static str> {
        Ok(7)
    }

    #[tokio::test]
    async fn checks_spawned_task_result() {
        let handle: JoinHandle<Result<u32, &'static str>> = tokio::spawn(run_job());
        let value = handle.await.expect("task panicked").expect("job failed");
        assert_eq!(value, 7);
    }
}

预期结果

text
running 1 test
test tests::checks_spawned_task_result ... ok

这里有两层结果:JoinHandle::await 用于判断任务执行是否正常结束,内部 Result 用于判断业务是否成功。把两层混在一起,往往会让失败原因变得难以定位。

什么时候直接 await,什么时候 spawn

测试单个异步函数时,优先直接 .await,因为调用链简单、失败位置清晰。只有需要验证并发任务、后台任务、channel 协作或任务生命周期时,才使用 tokio::spawn。

异步测试真正需要验证的是“业务完成条件”,而不是某个 sleep 是否执行过。优先等待可观察的事件、返回值或状态变化;sleep 只能作为确实需要模拟时间经过时的辅助手段。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

在 tokio 中编写异步测试

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通