Misc fixes for v0.2.6

Author: wsx-antithesis

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "antithesis_sdk"
-version = "0.2.5"
+version = "0.2.6"
 edition = "2021"
 rust-version = "1.62.1"
 license = "MIT"

lib/Cargo.toml

@@ -426,7 +426,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_always_greater_than_or_equal_to {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_always, >=, false, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_always, >=, false, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(
@@ -442,7 +442,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_always_less_than {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_always, <, true, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_always, <, true, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(
@@ -458,7 +458,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_always_less_than_or_equal_to {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_always, <=, true, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_always, <=, true, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(
@@ -474,7 +474,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_sometimes_greater_than {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_sometimes, >, true, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_sometimes, >, true, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(
@@ -490,7 +490,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_sometimes_greater_than_or_equal_to {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_sometimes, >=, true, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_sometimes, >=, true, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(
@@ -506,7 +506,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_sometimes_less_than {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_sometimes, <, false, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_sometimes, <, false, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(
@@ -522,7 +522,7 @@ Example usage:
 #[macro_export]
 macro_rules! assert_sometimes_less_than_or_equal_to {
     ($left:expr, $right:expr, $message:literal$(, $details:expr)?) => {
-        $crate::numeric_guidance_helper!($crate::assert_sometimes, <=, false, $left, $right, $message, $details)
+        $crate::numeric_guidance_helper!($crate::assert_sometimes, <=, false, $left, $right, $message$(, $details)?)
     };
     ($($rest:tt)*) => {
         ::std::compile_error!(

lib/src/assert/macros.rs

@@ -5,19 +5,19 @@ use linkme::distributed_slice;
 #[cfg(feature = "full")]
 use once_cell::sync::Lazy;
 use serde::Serialize;
-use serde_json::Value;
 #[cfg(feature = "full")]
 use serde_json::json;
+use serde_json::Value;
 
 #[cfg(feature = "full")]
 use std::collections::HashMap;
 #[cfg(feature = "full")]
 use std::sync::Mutex;
 
-mod macros;
 #[doc(hidden)]
 #[cfg(feature = "full")]
 pub mod guidance;
+mod macros;
 
 /// Catalog of all antithesis assertions provided
 #[doc(hidden)]
@@ -137,7 +137,7 @@ pub struct AssertionCatalogInfo {
 }
 
 #[derive(Serialize, Debug)]
-struct AssertionInfo {
+struct AssertionInfo<'a> {
     assert_type: AssertType,
     display_type: String,
     condition: bool,
@@ -146,10 +146,10 @@ struct AssertionInfo {
     hit: bool,
     must_hit: bool,
     id: String,
-    details: Value,
+    details: &'a Value,
 }
 
-impl AssertionInfo {
+impl<'a> AssertionInfo<'a> {
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         assert_type: AssertType,
@@ -164,7 +164,7 @@ impl AssertionInfo {
         hit: bool,
         must_hit: bool,
         id: String,
-        details: &Value,
+        details: &'a Value,
     ) -> Self {
         let location = AntithesisLocationInfo {
             class,
@@ -183,13 +183,13 @@ impl AssertionInfo {
             hit,
             must_hit,
             id,
-            details: details.clone(),
+            details,
         }
     }
-} 
+}
 
 #[cfg(feature = "full")]
-impl AssertionInfo {
+impl AssertionInfo<'_> {
     // AssertionInfo::track_entry() determines if the assertion should
     // actually be emitted:
     //
@@ -240,13 +240,12 @@ impl AssertionInfo {
 }
 
 #[cfg(not(feature = "full"))]
-impl AssertionInfo {
+impl AssertionInfo<'_> {
     fn track_entry(&self) {
-        return
+        return;
     }
 }
 
-
 /// This is a low-level method designed to be used by third-party frameworks.
 /// Regular users of the assert package should not call it.
 ///
@@ -496,7 +495,7 @@ mod tests {
         assert_eq!(ai.hit, this_hit);
         assert_eq!(ai.must_hit, this_must_hit);
         assert_eq!(ai.id.as_str(), this_id);
-        assert_eq!(ai.details, this_details);
+        assert_eq!(ai.details, &this_details);
     }
 
     #[test]
@@ -544,7 +543,7 @@ mod tests {
         assert_eq!(ai.hit, this_hit);
         assert_eq!(ai.must_hit, this_must_hit);
         assert_eq!(ai.id.as_str(), this_id);
-        assert_eq!(ai.details, this_details);
+        assert_eq!(ai.details, &this_details);
     }
 
     #[test]
@@ -592,7 +591,7 @@ mod tests {
         assert_eq!(ai.hit, this_hit);
         assert_eq!(ai.must_hit, this_must_hit);
         assert_eq!(ai.id.as_str(), this_id);
-        assert_eq!(ai.details, this_details);
+        assert_eq!(ai.details, &this_details);
     }
 
     #[test]

lib/src/assert/mod.rs

@@ -5,10 +5,10 @@
 ///
 /// Each macro/function in this module takes a parameter called ``message``, which is
 /// a string literal identifier used to aggregate assertions.
-/// Antithesis generates one test property per unique ``message`` This test property will be named ``message`` in the [triage report](https://antithesis.com/docs/reports/triage/).
+/// Antithesis generates one test property per unique ``message`` This test property will be named ``message`` in the [triage report](https://antithesis.com/reports/example-triage-report).
 ///
 /// Each macro/function also takes a parameter called ``details``, which is a key-value map of optional additional information provided by the user to add context for assertion failures.
-/// The information that is logged will appear in the ``logs`` section of a [triage report](https://antithesis.com/docs/reports/triage/).
+/// The information that is logged will appear in the ``logs`` section of a [triage report](https://antithesis.com/reports/example-triage-report).
 /// Normally the values in ``details`` are evaluated at runtime.
 pub mod assert;
 

lib/src/lib.rs

@@ -81,6 +81,7 @@ fn assert_demo() {
     assert_unreachable!("Impossible to get here", &details);
 
     assert_always_greater_than!(3, 100, "not right");
+    assert_sometimes_greater_than_or_equal_to!(3, 100, "not right");
 
     assert_sometimes_all!({a: true, b: false}, "not all right");
 }