Module antithesis_sdk::prelude
source · Expand description
Convenience to import all macros and functions
Re-exports§
pub use crate::assert::assert_raw;
pub use crate::assert::AssertType;
pub use crate::antithesis_init;
pub use crate::lifecycle;
pub use crate::random;
Macros§
- Assert that
condition
is true every time this function is called, and that it is called at least once. The corresponding test property will be viewable in theAntithesis SDK: Always
group of your triage report. assert_always_greater_than(x, y, ...)
is mostly equivalent toassert_always!(x > y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.assert_always_greater_than_or_equal_to(x, y, ...)
is mostly equivalent toassert_always!(x >= y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.assert_always_less_than(x, y, ...)
is mostly equivalent toassert_always!(x < y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.assert_always_less_than_or_equal_to(x, y, ...)
is mostly equivalent toassert_always!(x <= y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.- Assert that
condition
is true every time this function is called. The corresponding test property will pass even if the assertion is never encountered. This test property will be viewable in theAntithesis SDK: Always
group of your triage report. assert_always_some({a: x, b: y, ...})
is similar toassert_always(x || y || ...)
, except:- Assert that a line of code is reached at least once. The corresponding test property will pass if this macro is ever called. (If it is never called the test property will therefore fail.) This test property will be viewable in the
Antithesis SDK: Reachablity assertions
group. - Assert that
condition
is true at least one time that this function was called. (If the assertion is never encountered, the test property will therefore fail.) This test property will be viewable in theAntithesis SDK: Sometimes
group. assert_sometimes_all({a: x, b: y, ...})
is similar toassert_sometimes(x && y && ...)
, except:assert_sometimes_greater_than(x, y, ...)
is mostly equivalent toassert_sometimes!(x > y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.assert_sometimes_greater_than_or_equal_to(x, y, ...)
is mostly equivalent toassert_sometimes!(x >= y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.assert_sometimes_less_than(x, y, ...)
is mostly equivalent toassert_sometimes!(x < y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.assert_sometimes_less_than_or_equal_to(x, y, ...)
is mostly equivalent toassert_sometimes!(x <= y, ...)
, except Antithesis has more visibility to the value ofx
andy
, and the assertion details would be merged with{"left": x, "right": y}
.- Assert that a line of code is never reached. The corresponding test property will fail if this macro is ever called. (If it is never called the test property will therefore pass.) This test property will be viewable in the
Antithesis SDK: Reachablity assertions
group.