Skip to content

Rearrange trace integration tests #2628

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Rearrange trace integration tests #2628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
285 changes: 153 additions & 132 deletions opentelemetry-otlp/tests/integration_test/tests/traces.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
#![cfg(unix)]

use std::{fs::File, os::unix::fs::MetadataExt};

use integration_test_runner::trace_asserter::{read_spans_from_json, TraceAsserter};
use opentelemetry::global;
use opentelemetry::trace::TraceError;
use opentelemetry::{
trace::{TraceContextExt, Tracer},
Key, KeyValue,
};
use opentelemetry_otlp::SpanExporter;

use anyhow::Result;
use ctor::dtor;
use integration_test_runner::test_utils;
use opentelemetry_proto::tonic::trace::v1::TracesData;
use opentelemetry_sdk::{trace as sdktrace, Resource};
use std::fs::File;
use std::io::Write;
use std::os::unix::fs::MetadataExt;
use std::time::Duration;
use tokio::time::sleep;

fn init_tracer_provider() -> Result<sdktrace::SdkTracerProvider, TraceError> {
let exporter_builder = SpanExporter::builder();
Expand All @@ -44,46 +35,6 @@ fn init_tracer_provider() -> Result<sdktrace::SdkTracerProvider, TraceError> {
.build())
}

const LEMONS_KEY: Key = Key::from_static_str("lemons");
const ANOTHER_KEY: Key = Key::from_static_str("ex.com/another");

#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
#[cfg(any(feature = "tonic-client", feature = "reqwest-blocking-client"))]
pub async fn traces() -> Result<()> {
test_utils::start_collector_container().await?;

let tracer_provider = init_tracer_provider().expect("Failed to initialize tracer provider.");
global::set_tracer_provider(tracer_provider.clone());

let tracer = global::tracer("ex.com/basic");

tracer.in_span("operation", |cx| {
let span = cx.span();
span.add_event(
"Nice operation!".to_string(),
vec![KeyValue::new("bogons", 100)],
);
span.set_attribute(KeyValue::new(ANOTHER_KEY, "yes"));

tracer.in_span("Sub operation...", |cx| {
let span = cx.span();
span.set_attribute(KeyValue::new(LEMONS_KEY, "five"));

span.add_event("Sub span event", vec![]);
});
});

tracer_provider.shutdown()?;

// Give it a second to flush
sleep(Duration::from_secs(2)).await;

// Validate results
assert_traces_results(test_utils::TRACES_FILE, "./expected/traces.json")?;

Ok(())
}

pub fn assert_traces_results(result: &str, expected: &str) -> Result<()> {
let left = read_spans_from_json(File::open(expected)?)?;
let right = read_spans_from_json(File::open(result)?)?;
Expand All @@ -97,94 +48,164 @@ pub fn assert_traces_results(result: &str, expected: &str) -> Result<()> {
Ok(())
}

#[test]
#[should_panic(expected = "left: \"Sub operation...\"")] // we swap the parent spans with child spans in failed_traces.json
pub fn test_assert_span_eq_failure() {
let left = read_spans_from_json(File::open("./expected/traces.json").unwrap()).unwrap();
let right = read_spans_from_json(File::open("./expected/failed_traces.json").unwrap()).unwrap();

TraceAsserter::new(right, left).assert();
}

#[test]
pub fn test_assert_span_eq() -> Result<()> {
let spans = read_spans_from_json(File::open("./expected/traces.json")?)?;

TraceAsserter::new(spans.clone(), spans).assert();

Ok(())
}

#[test]
pub fn test_serde() -> Result<()> {
let spans = read_spans_from_json(
File::open("./expected/traces.json").expect("Failed to read traces.json"),
)?;
let json = serde_json::to_string_pretty(&TracesData {
resource_spans: spans,
})
.expect("Failed to serialize spans to json");

// Write to file.
let mut file = File::create("./expected/serialized_traces.json").unwrap();
file.write_all(json.as_bytes()).unwrap();

let left = read_spans_from_json(
File::open("./expected/traces.json").expect("Failed to read traces.json"),
)?;
let right = read_spans_from_json(
File::open("./expected/serialized_traces.json")
.expect("Failed to read serialized_traces.json"),
)?;

TraceAsserter::new(left, right).assert();

Ok(())
}

#[ignore = "TODO: [Fix Me] Failing on CI. Needs to be investigated and resolved."]
#[test]
#[cfg(any(feature = "tonic-client", feature = "reqwest-blocking-client"))]
pub fn span_batch_non_tokio_main() -> Result<()> {
// Initialize the tracer provider inside a tokio runtime
// as this allows tonic client to capture the runtime,
// but actual export occurs from the dedicated std::thread
// created by BatchSpanProcessor.

#[cfg(test)]
mod tracetests {
use anyhow::Ok;
let rt = tokio::runtime::Runtime::new()?;
let tracer_provider = rt.block_on(async {
// While we're here setup our collector container too, as this needs tokio to run
let _ = test_utils::start_collector_container().await;
init_tracer_provider()
})?;

let tracer = global::tracer("ex.com/basic");

tracer.in_span("operation", |cx| {
let span = cx.span();
span.add_event(
"Nice operation!".to_string(),
vec![KeyValue::new("bogons", 100)],
);
span.set_attribute(KeyValue::new(ANOTHER_KEY, "yes"));

tracer.in_span("Sub operation...", |cx| {
use anyhow::Result;
use integration_test_runner::test_utils;
use integration_test_runner::trace_asserter::{read_spans_from_json, TraceAsserter};
use opentelemetry::Key;
use opentelemetry::{
global,
trace::{TraceContextExt, Tracer},
KeyValue,
};
use opentelemetry_proto::tonic::trace::v1::TracesData;
use std::fs::File;
use std::io::Write;
use std::time::Duration;
use tokio::time::sleep;

use crate::{assert_traces_results, init_tracer_provider};

const LEMONS_KEY: Key = Key::from_static_str("lemons");
const ANOTHER_KEY: Key = Key::from_static_str("ex.com/another");

#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
#[cfg(any(feature = "tonic-client", feature = "reqwest-blocking-client"))]
pub async fn traces() -> Result<()> {
use opentelemetry::{
global,
trace::{TraceContextExt, Tracer},
KeyValue,
};

use crate::{assert_traces_results, init_tracer_provider};

test_utils::start_collector_container().await?;

let tracer_provider =
init_tracer_provider().expect("Failed to initialize tracer provider.");
global::set_tracer_provider(tracer_provider.clone());

let tracer = global::tracer("ex.com/basic");

tracer.in_span("operation", |cx| {
let span = cx.span();
span.set_attribute(KeyValue::new(LEMONS_KEY, "five"));
span.add_event(
"Nice operation!".to_string(),
vec![KeyValue::new("bogons", 100)],
);
span.set_attribute(KeyValue::new(ANOTHER_KEY, "yes"));

tracer.in_span("Sub operation...", |cx| {
let span = cx.span();
span.set_attribute(KeyValue::new(LEMONS_KEY, "five"));

span.add_event("Sub span event", vec![]);
});
});

span.add_event("Sub span event", vec![]);
tracer_provider.shutdown()?;

// Give it a second to flush
sleep(Duration::from_secs(5)).await;

// Validate results
assert_traces_results(test_utils::TRACES_FILE, "./expected/traces.json")?;

Ok(())
}

#[test]
#[should_panic(expected = "left: \"Sub operation...\"")] // we swap the parent spans with child spans in failed_traces.json
pub fn test_assert_span_eq_failure() {
let left = read_spans_from_json(File::open("./expected/traces.json").unwrap()).unwrap();
let right =
read_spans_from_json(File::open("./expected/failed_traces.json").unwrap()).unwrap();

TraceAsserter::new(right, left).assert();
}

#[test]
pub fn test_assert_span_eq() -> Result<()> {
let spans = read_spans_from_json(File::open("./expected/traces.json")?)?;

TraceAsserter::new(spans.clone(), spans).assert();

Ok(())
}

#[test]
pub fn test_serde() -> Result<()> {
let spans = read_spans_from_json(
File::open("./expected/traces.json").expect("Failed to read traces.json"),
)?;
let json = serde_json::to_string_pretty(&TracesData {
resource_spans: spans,
})
.expect("Failed to serialize spans to json");

// Write to file.
let mut file = File::create("./expected/serialized_traces.json").unwrap();
file.write_all(json.as_bytes()).unwrap();

let left = read_spans_from_json(
File::open("./expected/traces.json").expect("Failed to read traces.json"),
)?;
let right = read_spans_from_json(
File::open("./expected/serialized_traces.json")
.expect("Failed to read serialized_traces.json"),
)?;

TraceAsserter::new(left, right).assert();

Ok(())
}

#[ignore = "TODO: [Fix Me] Failing on CI. Needs to be investigated and resolved."]
#[test]
#[cfg(any(feature = "tonic-client", feature = "reqwest-blocking-client"))]
pub fn span_batch_non_tokio_main() -> Result<()> {
// Initialize the tracer provider inside a tokio runtime
// as this allows tonic client to capture the runtime,
// but actual export occurs from the dedicated std::thread
// created by BatchSpanProcessor.

let rt = tokio::runtime::Runtime::new()?;
let tracer_provider = rt.block_on(async {
// While we're here setup our collector container too, as this needs tokio to run
let _ = test_utils::start_collector_container().await;
init_tracer_provider()
})?;

let tracer = global::tracer("ex.com/basic");

tracer.in_span("operation", |cx| {
let span = cx.span();
span.add_event(
"Nice operation!".to_string(),
vec![KeyValue::new("bogons", 100)],
);
span.set_attribute(KeyValue::new(ANOTHER_KEY, "yes"));

tracer.in_span("Sub operation...", |cx| {
let span = cx.span();
span.set_attribute(KeyValue::new(LEMONS_KEY, "five"));

span.add_event("Sub span event", vec![]);
});
});
});

tracer_provider.shutdown()?;
tracer_provider.shutdown()?;

// Give it a second to flush
std::thread::sleep(Duration::from_secs(2));
// Give it a second to flush
std::thread::sleep(Duration::from_secs(5));

// Validate results
assert_traces_results(test_utils::TRACES_FILE, "./expected/traces.json")?;
Ok(())
// Validate results
assert_traces_results(test_utils::TRACES_FILE, "./expected/traces.json")?;
Ok(())
}
}

///
Expand Down