1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
/// Common handling used by all the assertion-related macros
#[cfg(not(feature = "no-antithesis-sdk"))]
#[doc(hidden)]
#[macro_export]
macro_rules! assert_helper {
// The handling of this pattern-arm of assert_helper
// is wrapped in a block {} to avoid name collisions
(condition = $condition:expr, $message:literal, $details:expr, $assert_type:path, $display_type:literal, must_hit = $must_hit:literal) => {{
// Force evaluation of expressions.
let condition = $condition;
let details = $details;
// Define a do-nothing function `'f()'` within the context of
// the function invoking an assertion. Then the ``type_name`` of
// this do-nothing will be something like:
//
// bincrate::binmod::do_stuff::f
//
// After trimming off the last three chars ``::f`` what remains is
// the full path to the name of the function invoking the assertion
//
// Both the untrimmed ``NAME`` and trimmed ``FUN_NAME`` are lazily
// initialized statics so that ``FUN_NAME`` can be available at
// assertion catalog registration time.
use $crate::once_cell::sync::Lazy;
fn f() {}
fn type_name_of<T>(_: T) -> &'static str {
::std::any::type_name::<T>()
}
static NAME: Lazy<&'static str> = Lazy::new(|| type_name_of(f));
static FUN_NAME: Lazy<&'static str> = Lazy::new(|| &NAME[..NAME.len() - 3]);
#[$crate::linkme::distributed_slice($crate::assert::ANTITHESIS_CATALOG)]
#[linkme(crate = $crate::linkme)] // Refer to our re-exported linkme.
static ALWAYS_CATALOG_ITEM: $crate::assert::CatalogInfo = $crate::assert::CatalogInfo {
assert_type: $assert_type,
display_type: $display_type,
condition: false,
message: $message,
class: ::std::module_path!(),
function: &FUN_NAME, /* function: &Lazy<&str> */
file: ::std::file!(),
begin_line: ::std::line!(),
begin_column: ::std::column!(),
must_hit: $must_hit,
id: $message,
};
let ptr_function = Lazy::force(&FUN_NAME);
$crate::assert::assert_impl(
$assert_type, /* assert_type */
$display_type.to_owned(), /* display_type */
condition, /* condition */
$message.to_owned(), /* message */
::std::module_path!().to_owned(), /* class */
String::from(*ptr_function), /* function */
::std::file!().to_owned(), /* file */
::std::line!(), /* line */
::std::column!(), /* column */
true, /* hit */
$must_hit, /* must-hit */
$message.to_owned(), /* id */
details, /* details */
)
}}; // end pattern-arm block
}
#[cfg(feature = "no-antithesis-sdk")]
#[doc(hidden)]
#[macro_export]
macro_rules! assert_helper {
(condition = $condition:expr, $message:literal, $details:expr, $assert_type:path, $display_type:literal, must_hit = $must_hit:literal) => {{
// Force evaluation of expressions, ensuring that
// any side effects of these expressions will always be
// evaluated at runtime - even if the assertion itself
// is supressed by the `no-antithesis-sdk` feature
let condition = $condition;
let details = $details;
}};
}
/// 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 the ``Antithesis SDK: Always`` group of your triage report.
///
/// # Example
///
/// ```
/// use serde_json::{json};
/// use antithesis_sdk::{assert_always, random};
///
/// const MAX_ALLOWED: u64 = 100;
/// let actual = random::get_random() % 100u64;
/// let details = json!({"max_allowed": MAX_ALLOWED, "actual": actual});
/// antithesis_sdk::assert_always!(actual < MAX_ALLOWED, "Value in range", &details);
/// ```
#[macro_export]
macro_rules! assert_always {
($condition:expr, $message:literal, $details:expr) => {
$crate::assert_helper!(
condition = $condition,
$message,
$details,
$crate::assert::AssertType::Always,
"Always",
must_hit = true
)
};
}
/// 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 the ``Antithesis SDK: Always`` group of your triage report.
///
/// # Example
///
/// ```
/// use serde_json::{json};
/// use antithesis_sdk::{assert_always_or_unreachable, random};
///
/// const MAX_ALLOWED: u64 = 100;
/// let actual = random::get_random() % 100u64;
/// let details = json!({"max_allowed": MAX_ALLOWED, "actual": actual});
/// antithesis_sdk::assert_always_or_unreachable!(actual < MAX_ALLOWED, "Value in range", &details);
/// ```
#[macro_export]
macro_rules! assert_always_or_unreachable {
($condition:expr, $message:literal, $details:expr) => {
$crate::assert_helper!(
condition = $condition,
$message,
$details,
$crate::assert::AssertType::Always,
"AlwaysOrUnreachable",
must_hit = false
)
};
}
/// 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 the ``Antithesis SDK: Sometimes`` group.
///
/// # Example
///
/// ```
/// use serde_json::{json};
/// use antithesis_sdk::{assert_sometimes, random};
///
/// const MAX_ALLOWED: u64 = 100;
/// let actual = random::get_random() % 120u64;
/// let details = json!({"max_allowed": MAX_ALLOWED, "actual": actual});
/// antithesis_sdk::assert_sometimes!(actual > MAX_ALLOWED, "Value in range", &details);
/// ```
#[macro_export]
macro_rules! assert_sometimes {
($condition:expr, $message:literal, $details:expr) => {
$crate::assert_helper!(
condition = $condition,
$message,
$details,
$crate::assert::AssertType::Sometimes,
"Sometimes",
must_hit = true
)
};
}
/// 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.
///
/// # Example
///
/// ```
/// use serde_json::{json};
/// use antithesis_sdk::{assert_reachable, random};
///
/// const MAX_ALLOWED: u64 = 100;
/// let actual = random::get_random() % 120u64;
/// let details = json!({"max_allowed": MAX_ALLOWED, "actual": actual});
/// if (actual > MAX_ALLOWED) {
/// antithesis_sdk::assert_reachable!("Value in range", &details);
/// }
/// ```
#[macro_export]
macro_rules! assert_reachable {
($message:literal, $details:expr) => {
$crate::assert_helper!(
condition = true,
$message,
$details,
$crate::assert::AssertType::Reachability,
"Reachable",
must_hit = true
)
};
}
/// 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.
///
/// # Example
///
/// ```
/// use serde_json::{json};
/// use antithesis_sdk::{assert_unreachable, random};
///
/// const MAX_ALLOWED: u64 = 100;
/// let actual = random::get_random() % 120u64;
/// let details = json!({"max_allowed": MAX_ALLOWED, "actual": actual});
/// if (actual > 120u64) {
/// antithesis_sdk::assert_unreachable!("Value is above range", &details);
/// }
/// ```
#[macro_export]
macro_rules! assert_unreachable {
($message:literal, $details:expr) => {
$crate::assert_helper!(
condition = false,
$message,
$details,
$crate::assert::AssertType::Reachability,
"Unreachable",
must_hit = false
)
};
}