#async-std #mocking #testing #run-time #interval #compatible #stream

async-time-mock-async-std

用于异步运行时的可模拟时间(与 async-std 兼容)

3 个不稳定版本

0.1.1 2024年1月22日
0.1.0 2023年2月19日
0.0.1 2023年1月11日

#1125 in Rust 模式

MIT 许可证

13KB
236

async-time-mock-async-std

基于 async-time-mock-core 的异步-std 兼容 API 的异步时间模拟,灵感来源于 Mocking Time In Async Rust 中描述的方法。

注意:此库仍处于起步阶段,API 可能会发生变化(即改进)。请在 GitHub 上留下您的反馈和建议。

Cargo 特性

  • mock:启用模拟时钟。如果您只在测试中启用此特性,则此库将变为 async-std 时间函数的薄包装。
  • stream:为 Interval 实现 futures_core::stream::Stream

示例

use async_time_mock_async_std::MockableClock;
use std::{
	sync::atomic::{AtomicBool, Ordering},
	time::Duration,
};

static HAS_SLEPT: AtomicBool = AtomicBool::new(false);

async fn sleep(clock: MockableClock) {
	// Sleep is either mocked or a real async_std::task::sleep, depending on which variant of `MockableClock` you pass in.
	let _guard = clock.sleep(Duration::from_secs(3600)).await;
	// Dropping this guard signifies that all the effects of the timer have finished.
	// This allows test code to wait until the condition to assert for has happened.

	println!("Slept for an hour");
	HAS_SLEPT.store(true, Ordering::SeqCst);
}

#[async_std::main]
async fn main() {
	let (clock, controller) = MockableClock::mock(); // In production, you can use MockableClock::Real instead

	async_std::task::spawn(sleep(clock));

	controller.advance_time(Duration::from_secs(600)).await;
	assert!(!HAS_SLEPT.load(Ordering::SeqCst), "Timer won't trigger after just 10 minutes.");

	// advance_time will first trigger the sleep in the task above and then wait until the `_guard` was dropped.
	// This ensures that the task had enough time to actually set `HAS_SLEPT` to `true`.
	controller.advance_time(Duration::from_secs(3000)).await;
	assert!(HAS_SLEPT.load(Ordering::SeqCst), "Timer has triggered after 1 hour.")
}

依赖关系

~4–17MB
~174K SLoC