feat: fully rework logging initialization

Tests are now using `test-log` library. See detailed `zenoh_util::init_logging` documentation.
eclipse-zenoh · Jun 20, 2024 · 7a2b87a · 7a2b87a
1 parent 4a314a6
commit 7a2b87a
Show file tree

Hide file tree

Showing 58 changed files with 2,746 additions and 2,751 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -157,6 +157,7 @@ shellexpand = "3.0.0"
 socket2 = { version = "0.5.1", features = ["all"] }
 stop-token = "0.7.0"
 syn = "2.0"
+test-log = "0.2.16"
 tide = "0.16.0"
 token-cell = { version = "1.4.2", default-features = false }
 tokio = { version = "1.35.1", default-features = false } # Default features are disabled due to some crates' requirements

diff --git a/ci/valgrind-check/Cargo.toml b/ci/valgrind-check/Cargo.toml
@@ -27,7 +27,6 @@ tracing-subscriber = { version = "0.3", features = ["json", "env-filter"] }
 futures = "0.3.25"
 zenoh = { path = "../../zenoh/" }
 zenoh-runtime = { path = "../../commons/zenoh-runtime/" }
-zenoh-util = { path = "../../commons/zenoh-util/", features = ["test"] }
 
 [[bin]]
 name = "pub_sub"

diff --git a/ci/valgrind-check/src/pub_sub/bin/z_pub_sub.rs b/ci/valgrind-check/src/pub_sub/bin/z_pub_sub.rs
@@ -18,7 +18,7 @@ use zenoh::{config::Config, key_expr::KeyExpr, prelude::*};
 #[tokio::main]
 async fn main() {
     let _z = zenoh_runtime::ZRuntimePoolGuard;
-    zenoh_util::init_log_test();
+    zenoh::init_logging();
 
     let pub_key_expr = KeyExpr::try_from("test/valgrind/data").unwrap();
     let sub_key_expr = KeyExpr::try_from("test/valgrind/**").unwrap();

diff --git a/ci/valgrind-check/src/queryable_get/bin/z_queryable_get.rs b/ci/valgrind-check/src/queryable_get/bin/z_queryable_get.rs
@@ -20,7 +20,7 @@ use zenoh::{
 #[tokio::main]
 async fn main() {
     let _z = zenoh_runtime::ZRuntimePoolGuard;
-    zenoh_util::init_log_test();
+    zenoh::init_logging();
 
     let queryable_key_expr = KeyExpr::try_from("test/valgrind/data").unwrap();
     let get_selector = Selector::try_from("test/valgrind/**").unwrap();

diff --git a/commons/zenoh-buffers/src/zbuf.rs b/commons/zenoh-buffers/src/zbuf.rs
@@ -745,6 +745,7 @@ impl ZBuf {
     }
 }
 
+#[cfg(test)]
 mod tests {
     #[test]
     fn zbuf_eq() {

diff --git a/commons/zenoh-codec/Cargo.toml b/commons/zenoh-codec/Cargo.toml
@@ -18,9 +18,9 @@ version = { workspace = true }
 repository = { workspace = true }
 homepage = { workspace = true }
 authors = [
-	"kydos <angelo@icorsaro.net>",
-	"Luca Cominardi <luca.cominardi@zettascale.tech>",
-	"Pierre Avital <pierre.avital@zettascale.tech>",
+  "kydos <angelo@icorsaro.net>",
+  "Luca Cominardi <luca.cominardi@zettascale.tech>",
+  "Pierre Avital <pierre.avital@zettascale.tech>",
 ]
 edition = { workspace = true }
 license = { workspace = true }
@@ -31,20 +31,20 @@ description = "Internal crate for zenoh."
 [features]
 default = ["std"]
 std = [
-    "tracing",
-    "serde/std",
-    "uhlc/std",
-    "zenoh-protocol/std"
+  "tracing",
+  "serde/std",
+  "uhlc/std",
+  "zenoh-protocol/std"
 ]
 shared-memory = [
-    "std",
-    "zenoh-shm",
-    "zenoh-protocol/shared-memory",
-    "zenoh-buffers/shared-memory"
+  "std",
+  "zenoh-shm",
+  "zenoh-protocol/shared-memory",
+  "zenoh-buffers/shared-memory"
 ]
 
 [dependencies]
-tracing = {workspace = true, optional = true }
+tracing = { workspace = true, optional = true }
 serde = { workspace = true, features = ["alloc"] }
 uhlc = { workspace = true }
 zenoh-buffers = { workspace = true, default-features = false }
@@ -54,10 +54,10 @@ zenoh-shm = { workspace = true, optional = true }
 # INFO: May cause problems when testing no_std stuff. Check this tool: https://docs.rs/crate/cargo-no-dev-deps/0.1.0
 [dev-dependencies]
 criterion = { workspace = true }
+test-log = { workspace = true }
 
 rand = { workspace = true, features = ["default"] }
 zenoh-protocol = { workspace = true, features = ["test"] }
-zenoh-util = {workspace = true }
 
 [[bench]]
 name = "codec"

diff --git a/commons/zenoh-codec/src/core/zint.rs b/commons/zenoh-codec/src/core/zint.rs
@@ -320,6 +320,7 @@ zint_impl!(usize);
 //     }
 // }
 
+// #[cfg(test)]
 // mod tests {
 //     #[test]
 //     fn u64_overhead() {

diff --git a/commons/zenoh-codec/tests/codec.rs b/commons/zenoh-codec/tests/codec.rs
@@ -386,10 +386,8 @@ fn codec_shm_info() {
 }
 
 // Common
-#[test]
+#[test_log::test]
 fn codec_extension() {
-    zenoh_util::try_init_log_from_env();
-
     macro_rules! run_extension_single {
         ($ext:ty, $buff:expr) => {
             let codec = Zenoh080::new();

diff --git a/commons/zenoh-crypto/src/cipher.rs b/commons/zenoh-crypto/src/cipher.rs
@@ -68,6 +68,7 @@ impl BlockCipher {
     }
 }
 
+#[cfg(test)]
 mod tests {
     #[test]
     fn cipher() {

diff --git a/commons/zenoh-shm/Cargo.toml b/commons/zenoh-shm/Cargo.toml
@@ -18,9 +18,9 @@ version = { workspace = true }
 repository = { workspace = true }
 homepage = { workspace = true }
 authors = [
-	"kydos <angelo@icorsaro.net>",
-	"Luca Cominardi <luca.cominardi@zettascale.tech>",
-	"Pierre Avital <pierre.avital@zettascale.tech>",
+  "kydos <angelo@icorsaro.net>",
+  "Luca Cominardi <luca.cominardi@zettascale.tech>",
+  "Pierre Avital <pierre.avital@zettascale.tech>",
 ]
 edition = { workspace = true }
 license = { workspace = true }
@@ -35,7 +35,7 @@ test = ["num_cpus"]
 async-trait = { workspace = true }
 bincode = { workspace = true }
 crc = { workspace = true }
-tracing = {workspace = true}
+tracing = { workspace = true }
 serde = { workspace = true, features = ["default"] }
 shared_memory = { workspace = true }
 tokio = { workspace = true }

diff --git a/commons/zenoh-util/Cargo.toml b/commons/zenoh-util/Cargo.toml
@@ -31,9 +31,6 @@ description = "Internal crate for zenoh."
 [badges]
 maintenance = { status = "actively-developed" }
 
-[features]
-test = []
-
 [dependencies]
 async-std = { workspace = true, features = ["default", "unstable"] }
 tokio = { workspace = true, features = ["time", "net"] }