allure-test-macros

allure-test-macros contains the procedural macros used by the workspace. In most cases you should depend on allure-cargotest instead, because it re-exports these macros together with the runtime integration.

Recommended usage

Add the higher-level crate:

cargo add allure-cargotest --dev

Then use the re-exported macros:

use allure_cargotest::{allure_test, log_asserts, step};

#[step(name = "Open login page")]
fn open_login_page() {}

#[log_asserts]
fn check_login_state() {
    assert!(true);
}

/// Confirms the login check records a page-opening step and assertion evidence.
#[allure_test(name = "Login works", id = "AUTH-1")]
#[test]
fn login_works() {
    open_login_page();
    check_login_state();
}

What the macros do

• #[allure_test] wraps a #[test] function with Allure lifecycle setup and teardown.
• #[step] records a function call as an Allure step.
• #[log_asserts] rewrites standard Rust assertion macros in a helper function so they can be logged according to the runtime assertion-logging configuration.
• Rust doc comments on #[allure_test] functions are used as the default markdown description.
• Use #[allure_test(doc = false)] to disable doc-comment descriptions for a test.
• Optional macro arguments let you override the displayed test or step name, Allure ID, and doc-comment description behavior.

Notes

• #[allure_test] supports synchronous #[test] functions and root async tests that compose with runtime-specific attributes such as #[tokio::test].
• #[allure_test] supports test functions returning () or explicit types that implement std::process::Termination, including Result<(), E>, ExitCode, custom Termination, and opaque impl Termination return values. Result errors and unsuccessful exit codes are reported before the test harness interprets the result.
• For Tokio tests, add Tokio to your test crate and place #[allure_test] above #[tokio::test].
• Allure context is available in the root async test body and awaited helpers, but independently spawned tasks do not implicitly inherit it.
• Test results are written through allure-rust-commons, which honors ALLURE_RESULTS_DIR when set and otherwise uses target/allure-results.
• #[allure_test], #[step], and #[log_asserts] can rewrite bare standard assertion macros. Assertion step emission is enabled by default and can be disabled with ALLURE_LOG_ASSERTS=false or [package.metadata.allure] log_asserts = false.
• This crate is intended as an implementation crate for proc macros.