#async #mock

async-time-mock-async-std

Mockable time for use in async runtimes (async-std compatibility)

3 unstable releases

0.1.1 Jan 22, 2024
0.1.0 Feb 19, 2023
0.0.1 Jan 11, 2023

#2 in #infancy

Download history 3/week @ 2023-11-12 3/week @ 2023-11-19 8/week @ 2023-11-26 5/week @ 2023-12-03 3/week @ 2023-12-10 7/week @ 2023-12-17 6/week @ 2023-12-24 7/week @ 2023-12-31 7/week @ 2024-01-07 32/week @ 2024-01-21 13/week @ 2024-01-28 1/week @ 2024-02-04 16/week @ 2024-02-11 92/week @ 2024-02-18

123 downloads per month

MIT license

13KB
236 lines

async-time-mock-async-std

Asynchronous time mocking with an async-std compatible API based on async-time-mock-core, inspired by the approach described in Mocking Time In Async Rust.

NOTE: This library is still in it's infancy, the API is still likely to change (read: improve). Please leave your feedback and suggestions on GitHub.

Cargo features

  • mock: Enable the mock clock. If you only enable this in tests, this library turns into a thin wrapper around async-std's time functions.
  • stream: Implement futures_core::stream::Stream for Interval

Example

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.")
}

Dependencies

~5–15MB
~177K SLoC