Skip to content

Commit

Permalink
chore(starknet_sequencer_infra): add tracing test
Browse files Browse the repository at this point in the history
commit-id:76d16e9a
  • Loading branch information
Itay-Tsabary-Starkware committed Dec 2, 2024
1 parent 1c04622 commit 4a77ea6
Show file tree
Hide file tree
Showing 4 changed files with 164 additions and 0 deletions.
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/infra_utils/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ tracing.workspace = true
[dev-dependencies]
rstest.workspace = true
tokio = { workspace = true, features = ["macros", "rt"] }
tracing-subscriber = { workspace = true, features = ["env-filter"] }
3 changes: 3 additions & 0 deletions crates/infra_utils/src/tracing.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
use tracing::{debug, error, info, trace, warn};

#[cfg(test)]
#[path = "tracing_test.rs"]
mod tracing_test;
/// Dynamically set tracing level of a message.
pub struct DynamicLogger {
level: TraceLevel,
Expand Down
159 changes: 159 additions & 0 deletions crates/infra_utils/src/tracing_test.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
use std::fmt::Debug;
use std::sync::{Arc, Mutex};

use tracing::field::{Field, Visit};
use tracing::span::{Attributes, Id, Record};
use tracing::subscriber::with_default;
use tracing::{Event, Metadata, Subscriber};

use crate::tracing::{DynamicLogger, TraceLevel};

#[test]
fn test_dynamic_logger_without_base_message() {
let subscriber = TestSubscriber::new();

with_default(subscriber.clone(), || {
let logger = DynamicLogger::new(TraceLevel::Info, None);
logger.log_message("Test message");
});

let messages = subscriber.messages();
assert_eq!(messages.len(), 1);
assert!(messages[0].contains("Test message"));
assert!(messages[0].contains("INFO"));
}

#[test]
fn test_dynamic_logger_with_base_message() {
let subscriber = TestSubscriber::new();

with_default(subscriber.clone(), || {
let logger = DynamicLogger::new(TraceLevel::Debug, Some("BaseMessage".to_string()));
logger.log_message("Test message");
});

let messages = subscriber.messages();
assert_eq!(messages.len(), 1);
assert!(messages[0].contains("BaseMessage: Test message"));
assert!(messages[0].contains("DEBUG"));
}

#[test]
fn test_all_trace_levels() {
let subscriber = TestSubscriber::new();

let test_cases = [
(TraceLevel::Trace, "TRACE"),
(TraceLevel::Debug, "DEBUG"),
(TraceLevel::Info, "INFO"),
(TraceLevel::Warn, "WARN"),
(TraceLevel::Error, "ERROR"),
];

with_default(subscriber.clone(), || {
for (level, expected_level_str) in test_cases {
subscriber.clear();
let logger = DynamicLogger::new(level, None);
logger.log_message("Test message");

let messages = subscriber.messages();
assert_eq!(messages.len(), 1);
assert!(messages[0].contains(expected_level_str));
assert!(messages[0].contains("Test message"));
}
});
}

#[test]
fn test_message_formatting() {
let subscriber = TestSubscriber::new();

with_default(subscriber.clone(), || {
let base_message = Some("Component".to_string());
let logger = DynamicLogger::new(TraceLevel::Info, base_message);
logger.log_message("Operation completed");
});

let messages = subscriber.messages();
assert_eq!(messages.len(), 1);
assert!(messages[0].contains("Component: Operation completed"));
assert!(messages[0].contains("INFO"));
}

#[test]
fn test_empty_message() {
let subscriber = TestSubscriber::new();

with_default(subscriber.clone(), || {
let logger = DynamicLogger::new(TraceLevel::Warn, None);
logger.log_message("");
});

let messages = subscriber.messages();
assert_eq!(messages.len(), 1);
assert!(messages[0].contains("WARN"));
}

// Custom visitor to capture event fields
struct MessageVisitor<'a> {
message: &'a mut String,
}

impl<'a> Visit for MessageVisitor<'a> {
fn record_debug(&mut self, field: &Field, value: &dyn Debug) {
if field.name() == "message" {
self.message.push_str(&format!("{:?}", value));
}
}
}

// Custom subscriber to capture log output
#[derive(Default, Clone)]
struct TestSubscriber {
messages: Arc<Mutex<Vec<String>>>,
}

impl TestSubscriber {
fn new() -> Self {
Self { messages: Arc::new(Mutex::new(Vec::new())) }
}

fn messages(&self) -> Vec<String> {
self.messages.lock().unwrap().clone()
}

fn clear(&self) {
self.messages.lock().unwrap().clear();
}
}

impl Subscriber for TestSubscriber {
fn enabled(&self, _metadata: &Metadata<'_>) -> bool {
true
}

fn event(&self, event: &Event<'_>) {
let mut message = String::new();
let metadata = event.metadata();

// Add level prefix
message.push_str(&format!("{}: ", metadata.level()));

// Capture the message field
let mut visitor = MessageVisitor { message: &mut message };
event.record(&mut visitor);

self.messages.lock().unwrap().push(message);
}

fn enter(&self, _span: &Id) {}
fn exit(&self, _span: &Id) {}

fn new_span(&self, _span: &Attributes<'_>) -> Id {
Id::from_u64(0)
}

fn record(&self, _span: &Id, _values: &Record<'_>) {}

fn record_follows_from(&self, _span: &Id, _follows: &Id) {}
}

0 comments on commit 4a77ea6

Please sign in to comment.