Crate safina_async_test

A macro for running async fn tests.

It is part of safina, a safe async runtime.

Runs tests with safina_executor::block_on.

Features

• forbid(unsafe_code)
• Straightforward implementation

Limitations

• Building on stable requires the feature once_cell. This uses once_cell crate which contains some unsafe code. This is necessary until std::lazy::OnceCell is stable.
• You must add a dev-dependency on safina-executor.

Examples

use safina_async_test::async_test;
#[async_test]
async fn test1() {
    an_async_fn().await.unwrap();
}

use safina_async_test::async_test;
#[async_test]
async fn test2() {
    // Make your test an `async fn` and await in it.
    assert_eq!(42, do_request().await.unwrap());

    // The macro creates an Executor and runs the test through it.
    // You can spawn async tasks on it:
    safina_executor::spawn(background_task());

    // You can schedule blocking jobs to run on the Executor:
    let result = safina_executor::schedule_blocking(|| blocking_work());
    assert_eq!(3, result.await.unwrap());

    // The macro also starts the timer thread, so this works:
    safina_timer::sleep_for(Duration::from_millis(10)).await;
}

Documentation

https://docs.rs/safina-async-test

Alternatives

• async_std::test
• futures_await_test::async_test
• tokio::test

Changelog

• v0.1.8
  • Support stable with rust 1.51 and once_cell.
  • Start an Executor for each test
• v0.1.7 - Update to safina-executor v0.1.4
• v0.1.6 - Start safina-timer thread
• v0.1.5 - Use safina-executor v0.1.3 API
• v0.1.4 - Upgrade to new safina-executor version which removes need for Box::pin.
• v0.1.3 - Rename safina package to safina-executor.
• v0.1.2 - Update docs
• v0.1.1 - First published version

TO DO

• DONE - Implement as declarative macro. UX is bad.
• DONE - Implement as procedural macro.
• DONE - Report errors nicely
• DONE - Publish on crates.io
• Let users depend only on safina-async-test:
  1. Move proc macro to its own crate.
  2. Make safina_async_test re-export the macro and safina_executor::block_on.
  3. Change the macro to call safina_async_test::block_on.
• Automatically start a worker thread and timer thread.

Release Process

1. Edit Cargo.toml and bump version number.
2. Run ./release.sh

Attribute Macros

async_test