Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding PartialEq for LogRecord and SpanContext to help unit testing #1944

Merged
merged 6 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions opentelemetry-sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## vNext

- `opentelemetry_sdk::logs::record::LogRecord` and `opentelemetry_sdk::logs::record::TraceContext` derive from `PartialEq` to facilitate Unit Testing.

## v0.24.1

- Add hidden method to support tracing-opentelemetry
Expand Down
68 changes: 66 additions & 2 deletions opentelemetry-sdk/src/logs/record.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use opentelemetry::{
};
use std::{borrow::Cow, time::SystemTime};

#[derive(Debug, Default, Clone)]
#[derive(Debug, Default, Clone, PartialEq)]
#[non_exhaustive]
/// LogRecord represents all data carried by a log record, and
/// is provided to `LogExporter`s as input.
Expand Down Expand Up @@ -99,7 +99,7 @@ impl opentelemetry::logs::LogRecord for LogRecord {

/// TraceContext stores the trace context for logs that have an associated
/// span.
#[derive(Debug, Clone)]
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub struct TraceContext {
/// Trace id
Expand Down Expand Up @@ -198,4 +198,68 @@ mod tests {
Some(vec![(Key::new("key"), AnyValue::String("value".into()))])
);
}

#[test]
fn compare_trace_context() {
let trace_context = TraceContext {
trace_id: TraceId::from_u128(1),
span_id: SpanId::from_u64(1),
trace_flags: Some(TraceFlags::default()),
};

let trace_context_cloned = trace_context.clone();

assert_eq!(trace_context, trace_context_cloned);

let trace_context_different = TraceContext {
trace_id: TraceId::from_u128(2),
span_id: SpanId::from_u64(2),
trace_flags: Some(TraceFlags::default()),
};

assert_ne!(trace_context, trace_context_different);
}

#[test]
fn compare_log_record() {
let log_record = LogRecord {
event_name: Some(Cow::Borrowed("test_event")),
target: Some(Cow::Borrowed("foo::bar")),
timestamp: Some(SystemTime::now()),
observed_timestamp: Some(SystemTime::now()),
severity_text: Some(Cow::Borrowed("ERROR")),
severity_number: Some(Severity::Error),
body: Some(AnyValue::String("Test body".into())),
attributes: Some(vec![(Key::new("key"), AnyValue::String("value".into()))]),
trace_context: Some(TraceContext {
trace_id: TraceId::from_u128(1),
span_id: SpanId::from_u64(1),
trace_flags: Some(TraceFlags::default()),
}),
};

let log_record_cloned = log_record.clone();

assert_eq!(log_record, log_record_cloned);

let mut log_record_different = log_record.clone();
log_record_different.event_name = Some(Cow::Borrowed("different_event"));

assert_ne!(log_record, log_record_different);
}

#[test]
fn compare_log_record_target_borrowed_eq_owned() {
let log_record_borrowed = LogRecord {
event_name: Some(Cow::Borrowed("test_event")),
..Default::default()
};

let log_record_owned = LogRecord {
event_name: Some(Cow::Owned("test_event".to_string())),
..Default::default()
};

assert_eq!(log_record_borrowed, log_record_owned);
}
}
Loading