Add basic tests for SDK Span (#309)

src/sdk/trace/span.rs

@@ -9,7 +9,7 @@
 //! is possible to change its name, set its `Attributes`, and add `Links` and `Events`.
 //! These cannot be changed after the `Span`'s end time has been set.
 use crate::trace::{Event, SpanContext, SpanId, StatusCode, TraceId, TraceState};
-use crate::{exporter, sdk, KeyValue};
+use crate::{exporter::trace::SpanData, sdk, KeyValue};
 use std::sync::{Arc, Mutex};
 use std::time::SystemTime;
 
@@ -23,16 +23,12 @@ pub struct Span {
 /// Inner data, processed and exported on drop
 #[derive(Debug)]
 struct SpanInner {
-    data: Option<Mutex<Option<exporter::trace::SpanData>>>,
+    data: Option<Mutex<Option<SpanData>>>,
     tracer: sdk::trace::Tracer,
 }
 
 impl Span {
-    pub(crate) fn new(
-        id: SpanId,
-        data: Option<exporter::trace::SpanData>,
-        tracer: sdk::trace::Tracer,
-    ) -> Self {
+    pub(crate) fn new(id: SpanId, data: Option<SpanData>, tracer: sdk::trace::Tracer) -> Self {
         Span {
             id,
             inner: Arc::new(SpanInner {
@@ -45,7 +41,7 @@ impl Span {
     /// Operate on reference to span inner
     fn with_data<T, F>(&self, f: F) -> Option<T>
     where
-        F: FnOnce(&exporter::trace::SpanData) -> T,
+        F: FnOnce(&SpanData) -> T,
     {
         self.inner.data.as_ref().and_then(|inner| {
             inner
@@ -58,7 +54,7 @@ impl Span {
     /// Operate on mutable reference to span inner
     fn with_data_mut<T, F>(&self, f: F) -> Option<T>
     where
-        F: FnOnce(&mut exporter::trace::SpanData) -> T,
+        F: FnOnce(&mut SpanData) -> T,
     {
         self.inner.data.as_ref().and_then(|inner| {
             inner
@@ -173,3 +169,232 @@ impl Drop for SpanInner {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::{api, api::core::KeyValue, api::trace::Span as _, api::trace::TracerProvider};
+    use std::time::Duration;
+
+    fn init() -> (sdk::trace::Tracer, SpanData) {
+        let provider = sdk::trace::TracerProvider::default();
+        let config = provider.config();
+        let tracer = provider.get_tracer("opentelemetry", Some(env!("CARGO_PKG_VERSION")));
+        let data = SpanData {
+            span_context: SpanContext::new(
+                TraceId::from_u128(0),
+                SpanId::from_u64(0),
+                api::trace::TRACE_FLAG_NOT_SAMPLED,
+                false,
+                TraceState::default(),
+            ),
+            parent_span_id: SpanId::from_u64(0),
+            span_kind: api::trace::SpanKind::Internal,
+            name: "opentelemetry".to_string(),
+            start_time: SystemTime::now(),
+            end_time: SystemTime::now(),
+            attributes: sdk::trace::EvictedHashMap::new(config.max_attributes_per_span),
+            message_events: sdk::trace::EvictedQueue::new(config.max_events_per_span),
+            links: sdk::trace::EvictedQueue::new(config.max_links_per_span),
+            status_code: StatusCode::OK,
+            status_message: "".to_string(),
+            resource: config.resource.clone(),
+            instrumentation_lib: *tracer.instrumentation_library(),
+        };
+        (tracer, data)
+    }
+
+    fn create_span() -> Span {
+        let (tracer, data) = init();
+        Span::new(SpanId::from_u64(0), Some(data), tracer)
+    }
+
+    #[test]
+    fn create_span_without_data() {
+        let (tracer, _) = init();
+        let span = Span::new(SpanId::from_u64(0), None, tracer);
+        span.with_data(|_data| panic!("there are data"));
+    }
+
+    #[test]
+    fn create_span_with_data() {
+        let (tracer, data) = init();
+        let span = Span::new(SpanId::from_u64(0), Some(data.clone()), tracer);
+        span.with_data(|d| assert_eq!(*d, data));
+    }
+
+    #[test]
+    fn add_event() {
+        let span = create_span();
+        let name = "some_event".to_string();
+        let attributes = vec![KeyValue::new("k", "v")];
+        span.add_event(name.clone(), attributes.clone());
+        span.with_data(|data| {
+            if let Some(event) = data.message_events.iter().next() {
+                assert_eq!(event.name, name);
+                assert_eq!(event.attributes, attributes);
+            } else {
+                panic!("no event");
+            }
+        });
+    }
+
+    #[test]
+    fn add_event_with_timestamp() {
+        let span = create_span();
+        let name = "some_event".to_string();
+        let attributes = vec![KeyValue::new("k", "v")];
+        let timestamp = SystemTime::now();
+        span.add_event_with_timestamp(name.clone(), timestamp, attributes.clone());
+        span.with_data(|data| {
+            if let Some(event) = data.message_events.iter().next() {
+                assert_eq!(event.timestamp, timestamp);
+                assert_eq!(event.name, name);
+                assert_eq!(event.attributes, attributes);
+            } else {
+                panic!("no event");
+            }
+        });
+    }
+
+    #[test]
+    fn record_exception() {
+        let span = create_span();
+        let err = std::io::Error::from(std::io::ErrorKind::Other);
+        span.record_exception(&err);
+        span.with_data(|data| {
+            if let Some(event) = data.message_events.iter().next() {
+                assert_eq!(event.name, "exception");
+                assert_eq!(
+                    event.attributes,
+                    vec![KeyValue::new("exception.message", err.to_string())]
+                );
+            } else {
+                panic!("no event");
+            }
+        });
+    }
+
+    #[test]
+    fn record_exception_with_stacktrace() {
+        let span = create_span();
+        let err = std::io::Error::from(std::io::ErrorKind::Other);
+        let stacktrace = "stacktrace...".to_string();
+        span.record_exception_with_stacktrace(&err, stacktrace.clone());
+        span.with_data(|data| {
+            if let Some(event) = data.message_events.iter().next() {
+                assert_eq!(event.name, "exception");
+                assert_eq!(
+                    event.attributes,
+                    vec![
+                        KeyValue::new("exception.message", err.to_string()),
+                        KeyValue::new("exception.stacktrace", stacktrace),
+                    ]
+                );
+            } else {
+                panic!("no event");
+            }
+        });
+    }
+
+    #[test]
+    fn set_attribute() {
+        let span = create_span();
+        let attributes = KeyValue::new("k", "v");
+        span.set_attribute(attributes.clone());
+        span.with_data(|data| {
+            if let Some(val) = data.attributes.get(&attributes.key) {
+                assert_eq!(*val, attributes.value);
+            } else {
+                panic!("no attribute");
+            }
+        });
+    }
+
+    #[test]
+    fn set_status() {
+        let span = create_span();
+        let status = StatusCode::Unknown;
+        let message = "UNKNOWN".to_string();
+        span.set_status(status.clone(), message.clone());
+        span.with_data(|data| {
+            assert_eq!(data.status_code, status);
+            assert_eq!(data.status_message, message);
+        });
+    }
+
+    #[test]
+    fn update_name() {
+        let span = create_span();
+        let name = "new_name".to_string();
+        span.update_name(name.clone());
+        span.with_data(|data| {
+            assert_eq!(data.name, name);
+        });
+    }
+
+    #[test]
+    fn end() {
+        let span = create_span();
+        span.end();
+    }
+
+    #[test]
+    fn end_with_timestamp() {
+        let span = create_span();
+        let timestamp = SystemTime::now();
+        span.end_with_timestamp(timestamp);
+        span.with_data(|data| assert_eq!(data.end_time, timestamp));
+    }
+
+    #[test]
+    #[ignore = "not yet implemented"]
+    fn end_only_once() {
+        let span = create_span();
+        let timestamp = SystemTime::now();
+        span.end_with_timestamp(timestamp);
+        span.end_with_timestamp(timestamp.checked_add(Duration::from_secs(10)).unwrap());
+        span.with_data(|data| assert_eq!(data.end_time, timestamp));
+    }
+
+    #[test]
+    #[ignore = "not yet implemented"]
+    fn noop_after_end() {
+        let span = create_span();
+        let initial = span.with_data(|data| data.clone()).unwrap();
+        span.end();
+        span.add_event("some_event".to_string(), vec![KeyValue::new("k", "v")]);
+        span.add_event_with_timestamp(
+            "some_event".to_string(),
+            SystemTime::now(),
+            vec![KeyValue::new("k", "v")],
+        );
+        let err = std::io::Error::from(std::io::ErrorKind::Other);
+        span.record_exception(&err);
+        span.record_exception_with_stacktrace(&err, "stacktrace...".to_string());
+        span.set_attribute(KeyValue::new("k", "v"));
+        span.set_status(StatusCode::Unknown, "UNKNOWN".to_string());
+        span.update_name("new_name".to_string());
+        span.with_data(|data| {
+            assert_eq!(data.message_events, initial.message_events);
+            assert_eq!(data.attributes, initial.attributes);
+            assert_eq!(data.status_code, initial.status_code);
+            assert_eq!(data.status_message, initial.status_message);
+            assert_eq!(data.name, initial.name);
+        });
+    }
+
+    #[test]
+    fn is_recording_true_when_not_ended() {
+        let span = create_span();
+        assert!(span.is_recording());
+    }
+
+    #[test]
+    #[ignore = "not yet implemented"]
+    fn is_recording_false_after_end() {
+        let span = create_span();
+        span.end();
+        assert!(!span.is_recording());
+    }
+}