test(util): add a test_dbg! macro (#333)

This was cherry-picked out of PR #332
hawkw · Oct 8, 2022 · dad0e0d · dad0e0d
1 parent 07359bf
commit dad0e0d
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/util/Cargo.toml b/util/Cargo.toml
@@ -27,6 +27,9 @@ tracing = { git = "https://github.com/tokio-rs/tracing", default_features = fals
 [target.'cfg(loom)'.dependencies]
 loom = "0.5.5"
 
+[target.'cfg(loom)'.dev-dependencies]
+tracing_01 = { package = "tracing", version = "0.1.36" }
+
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
diff --git a/util/src/macros.rs b/util/src/macros.rs
@@ -66,3 +66,40 @@ macro_rules! unreachable_unchecked {
         }
     });
 }
+
+#[cfg(test)]
+macro_rules! test_dbg {
+    ($x:expr) => {
+        match $x {
+            x => {
+                test_trace!(
+                    location = %core::panic::Location::caller(),
+                    "{} = {x:?}",
+                    stringify!($x)
+                );
+                x
+            }
+        }
+    };
+}
+
+#[cfg(not(test))]
+macro_rules! test_dbg {
+    ($x:expr) => {
+        $x
+    };
+}
+
+#[cfg(all(test, not(loom)))]
+macro_rules! test_trace {
+    ($($arg:tt)+) => {
+        tracing::trace!($($arg)+);
+    };
+}
+
+#[cfg(all(test, loom))]
+macro_rules! test_trace {
+    ($($arg:tt)+) => {
+        tracing_01::trace!($($arg)+);
+    };
+}