veecle_os_test/
lib.rs

1//! Utilities for testing actors.
2//!
3//! [`veecle_os_test::execute!`](crate::execute) can be used in place of [`veecle_os::runtime::execute!`](veecle_os_runtime::execute!)
4//! to write tests for actors.
5//!
6//! [`veecle_os_test::block_on_future`](block_on_future) can be used to block the current thread until the future resolves.
7//!
8//! The following example shows how to implement a test:
9//!
10//! ```
11//! use core::convert::Infallible;
12//!
13//! #[derive(Debug, Default, veecle_os_runtime::Storable)]
14//! pub struct Number(usize);
15//!
16//! #[derive(Debug, Default, veecle_os_runtime::Storable)]
17//! pub struct Total(usize);
18//! #
19//! # use veecle_os_runtime::{InitializedReader, Reader, Writer};
20//!
21//! // `total_actor` reads numbers from a `Number` reader, keeps a running
22//! // total, and writes running totals to a `Total` writer.
23//! #[veecle_os_runtime::actor]
24//! async fn total_actor(
25//!     mut total: Writer<'_, Total>,
26//!     mut numbers: InitializedReader<'_, Number>,
27//! ) -> Infallible {
28//!     let mut sum: usize = 0;
29//!     loop {
30//!         numbers.wait_for_update().await.read(|value| {
31//!             sum += value.0;
32//!         });
33//!
34//!         total.write(Total(sum)).await;
35//!     }
36//! }
37//!
38//! // This test writes 1 and 2 to the `Number` slot and verifies that
39//! // `total_actor` writes 1 and 3 as the running totals.
40//!
41//! veecle_os_test::block_on_future(
42//!     veecle_os_test::execute! {
43//!         store: [Total, Number],
44//!         actors: [TotalActor],
45//!         validation: async |mut total_reader: Reader<'a, Total>, mut numbers_writer: Writer<'a, Number>| {
46//!             numbers_writer.write(Number(0)).await;
47//!             let mut total_reader = total_reader.wait_init().await;
48//!             total_reader.wait_for_update().await.read(|value| {
49//!                 assert_eq!(value.0, 0);
50//!             });
51//!             numbers_writer.write(Number(1)).await;
52//!             total_reader.wait_for_update().await.read(|value| {
53//!                 assert_eq!(value.0, 1);
54//!             });
55//!             numbers_writer.write(Number(2)).await;
56//!             total_reader.wait_for_update().await.read(|value| {
57//!                 assert_eq!(value.0, 3);
58//!             });
59//!         }
60//!     }
61//! );
62//! ```
63
64#![forbid(unsafe_code)]
65
66#[doc(hidden)]
67mod execute;
68
69/// Reexport of [`futures::executor::block_on`] for convenience.
70pub use futures::executor::block_on as block_on_future;
71
72/// Internal exports for `macro_rules!` purposes.
73#[doc(hidden)]
74pub mod __exports {
75    pub use ::veecle_os_runtime;
76    pub use futures;
77}
veecle_os_test/lib.rs

veecle_os_test/
lib.rs
