Merge pull request #114 from slashmo/fix/tracing-tests-naming

Rename OTelSpan & JaegerTracer for testing

Author: ktoso

Tests/TracingInstrumentationTests/SpanTests.swift

@@ -18,8 +18,7 @@ import XCTest
 
 final class SpanTests: XCTestCase {
     func testAddingEventCreatesCopy() {
-        // TODO: We should probably replace OTelSpan at some point with a NoOpSpan for testing things like this.
-        let span = OTelSpan(
+        let span = TestSpan(
             operationName: "test",
             startTimestamp: .now(),
             context: BaggageContext(),
@@ -160,15 +159,15 @@ final class SpanTests: XCTestCase {
         var parentContext = BaggageContext()
         parentContext[TestBaggageContextKey.self] = "test"
 
-        let parent = OTelSpan(
+        let parent = TestSpan(
             operationName: "client",
             startTimestamp: .now(),
             context: parentContext,
             kind: .client,
             onEnd: { _ in }
         )
         let childContext = BaggageContext()
-        var child = OTelSpan(
+        var child = TestSpan(
             operationName: "server",
             startTimestamp: .now(),
             context: childContext,

Tests/TracingInstrumentationTests/TracingInstrumentTests.swift

@@ -19,7 +19,7 @@ import XCTest
 
 final class TracingInstrumentTests: XCTestCase {
     func testPlayground() {
-        let httpServer = FakeHTTPServer(instrument: JaegerTracer()) { context, _, client -> FakeHTTPResponse in
+        let httpServer = FakeHTTPServer(instrument: TestTracer()) { context, _, client -> FakeHTTPResponse in
             context.logger.info("Make subsequent HTTP request")
             client.performRequest(context, request: FakeHTTPRequest(path: "/test", headers: []))
             return FakeHTTPResponse(status: 418)
@@ -29,38 +29,38 @@ final class TracingInstrumentTests: XCTestCase {
     }
 
     func testItProvidesAccessToATracingInstrument() {
-        let tracer = JaegerTracer()
+        let tracer = TestTracer()
 
-        XCTAssertNil(InstrumentationSystem.tracingInstrument(of: JaegerTracer.self))
+        XCTAssertNil(InstrumentationSystem.tracingInstrument(of: TestTracer.self))
 
         InstrumentationSystem.bootstrapInternal(tracer)
         XCTAssertFalse(InstrumentationSystem.instrument is MultiplexInstrument)
-        XCTAssert(InstrumentationSystem.instrument(of: JaegerTracer.self) === tracer)
+        XCTAssert(InstrumentationSystem.instrument(of: TestTracer.self) === tracer)
         XCTAssertNil(InstrumentationSystem.instrument(of: NoOpInstrument.self))
 
-        XCTAssert(InstrumentationSystem.tracingInstrument(of: JaegerTracer.self) === tracer)
-        XCTAssert(InstrumentationSystem.tracingInstrument is JaegerTracer)
+        XCTAssert(InstrumentationSystem.tracingInstrument(of: TestTracer.self) === tracer)
+        XCTAssert(InstrumentationSystem.tracingInstrument is TestTracer)
 
         let multiplexInstrument = MultiplexInstrument([tracer])
         InstrumentationSystem.bootstrapInternal(multiplexInstrument)
         XCTAssert(InstrumentationSystem.instrument is MultiplexInstrument)
-        XCTAssert(InstrumentationSystem.instrument(of: JaegerTracer.self) === tracer)
+        XCTAssert(InstrumentationSystem.instrument(of: TestTracer.self) === tracer)
 
-        XCTAssert(InstrumentationSystem.tracingInstrument(of: JaegerTracer.self) === tracer)
-        XCTAssert(InstrumentationSystem.tracingInstrument is JaegerTracer)
+        XCTAssert(InstrumentationSystem.tracingInstrument(of: TestTracer.self) === tracer)
+        XCTAssert(InstrumentationSystem.tracingInstrument is TestTracer)
     }
 }
 
-// MARK: - JaegerTracer
+// MARK: - TestTracer
 
-final class JaegerTracer: TracingInstrument {
+final class TestTracer: TracingInstrument {
     func startSpan(
         named operationName: String,
         context: BaggageContext,
         ofKind kind: SpanKind,
         at timestamp: Timestamp?
     ) -> Span {
-        let span = OTelSpan(
+        let span = TestSpan(
             operationName: operationName,
             startTimestamp: timestamp ?? .now(),
             context: context,
@@ -100,7 +100,7 @@ final class JaegerTracer: TracingInstrument {
     }
 }
 
-extension JaegerTracer {
+extension TestTracer {
     struct TraceParent {
         let traceID: String
         let parentID: String
@@ -111,9 +111,9 @@ extension JaegerTracer {
     }
 }
 
-// MARK: - OTelSpan
+// MARK: - TestSpan
 
-struct OTelSpan: Span {
+struct TestSpan: Span {
     let operationName: String
     let kind: SpanKind
 

UseCases/Sources/InstrumentsAppTracing/OSSignpostTracing.swift

@@ -12,8 +12,8 @@
 //===----------------------------------------------------------------------===//
 
 import Baggage
-import Instrumentation
 import Foundation // string conversion for os_log seems to live here
+import Instrumentation
 
 #if os(macOS) || os(tvOS) || os(iOS) || os(watchOS)
 import os.log
@@ -91,7 +91,7 @@ final class OSSignpostSpan: Span {
     public let startTimestamp: Timestamp
     public var endTimestamp: Timestamp?
 
-    public var status: SpanStatus? = nil
+    public var status: SpanStatus?
     public let kind: SpanKind = .internal
 
     public var baggage: BaggageContext {
@@ -147,7 +147,7 @@ final class OSSignpostSpan: Span {
                 signpostID: self.signpostID,
                 Self.beginFormat,
                 self.signpostID.rawValue,
-                "\(context.signpostTraceParentIDs.map({ "\($0.rawValue)" }).joined(separator: ","))",
+                "\(context.signpostTraceParentIDs.map { "\($0.rawValue)" }.joined(separator: ","))",
                 operationName
             )
         }
@@ -160,16 +160,15 @@ final class OSSignpostSpan: Span {
         defer { self.lock.lock() }
         if self.endTimestamp == nil {
             print("""
-                  warning: 
-                  Span \(self.signpostID) (\(self.operationName)) \
-                  [todo:source location] \
-                  was dropped without end() being called!
-                  """)
+            warning: 
+            Span \(self.signpostID) (\(self.operationName)) \
+            [todo:source location] \
+            was dropped without end() being called!
+            """)
         }
     }
     #endif
 
-
     public func addLink(_ link: SpanLink) {
         guard self.isRecording else { return }
         self.lock.lock()
@@ -203,7 +202,6 @@ final class OSSignpostSpan: Span {
         }
     }
 
-
     public func end(at timestamp: Timestamp) {
         guard self.isRecording else { return }
         self.lock.lock()
@@ -236,6 +234,7 @@ enum OSSignpostTracingKeys {
     enum TraceParentIDs: BaggageContextKey {
         typealias Value = [OSSignpostID]
     }
+
     enum SignpostID: BaggageContextKey {
         typealias Value = OSSignpostID
     }
@@ -254,6 +253,7 @@ extension BaggageContext {
             self[OSSignpostTracingKeys.TraceParentIDs.self] = newValue
         }
     }
+
     var signpostID: OSSignpostTracingKeys.SignpostID.Value? {
         get {
             self[OSSignpostTracingKeys.SignpostID.self]

UseCases/Sources/InstrumentsAppTracing/main.swift

@@ -11,9 +11,9 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Instrumentation
 import Baggage
 import Dispatch
+import Instrumentation
 
 // ==== ----------------------------------------------------------------------------------------------------------------
 // MARK: Setup
@@ -36,7 +36,7 @@ if #available(macOS 10.14, iOS 10.0, *) {
 let tracer = InstrumentationSystem.tracer
 let context = BaggageContext()
 
-for i in 1...5 {
+for i in 1 ... 5 {
     print("Starting operation: op-\(i)")
     var parentSpan = tracer.startSpan(named: "op-\(i)", context: context)
     defer { parentSpan.end() }
@@ -60,4 +60,3 @@ print("done.")
 print("Demo only available on macOS / Apple platforms.")
 
 #endif
-