[SDTEST-3738] Added framework versions (#234)

Author: ypopovych

Sources/DatadogSDKTesting/DDTags.swift

@@ -67,7 +67,7 @@ internal enum DDTestTags {
     static let testSkippedByITR = "test.skipped_by_itr"
     static let testHasFailedAllRetries = "test.has_failed_all_retries"
     static let testFailureSuppressionReason = "test.failure_suppression_reason"
-   
+    static let testFrameworkVersion = "test.framework_version"
 }
 
 internal enum DDHostTags {

Sources/DatadogSDKTesting/DDTest.swift

@@ -143,7 +143,7 @@ extension Test {
                                _ action: @Sendable (Test) async throws -> T) async rethrows -> T
     {
         let testStartTime = start ?? suite.configuration.clock.now
-        return try await DDTestMonitor.tracer.withActiveSpan(name: "\(suite.testFramework).test",
+        return try await DDTestMonitor.tracer.withActiveSpan(name: "\(suite.testFramework.name).test",
                                                              attributes: attributes(test: name, in: suite),
                                                              startTime: testStartTime) { span in
             let test = Self(name: name, suite: suite, span: span)
@@ -159,7 +159,7 @@ extension Test {
                                _ action: (Test) throws -> T) rethrows -> T
     {
         let testStartTime = start ?? suite.configuration.clock.now
-        return try DDTestMonitor.tracer.withActiveSpan(name: "\(suite.testFramework).test",
+        return try DDTestMonitor.tracer.withActiveSpan(name: "\(suite.testFramework.name).test",
                                                        attributes: attributes(test: name, in: suite),
                                                        startTime: testStartTime) { span in
             let test = Self(name: name, suite: suite, span: span)
@@ -178,7 +178,8 @@ extension Test {
             DDTestTags.testName: .string(name),
             DDTestTags.testSuite: .string(suite.name),
             DDTestTags.testModule: .string(suite.module.name),
-            DDTestTags.testFramework: .string(suite.testFramework),
+            DDTestTags.testFramework: .string(suite.testFramework.name),
+            DDTestTags.testFrameworkVersion: .string(suite.testFramework.version),
             DDTestTags.testType: .string(DDTagValues.typeTest),
             DDTestTags.testIsUITest: .string("false"),
             DDTestSuiteVisibilityTags.testSessionId: .string(suite.session.id.hexString),

Sources/DatadogSDKTesting/DDTestModule.swift

@@ -113,7 +113,7 @@ public extension Module {
     ///   - name: name of the suite
     ///   - startTime: Optional, the time where the suite started
     @objc func suiteStart(name: String, startTime: Date? = nil) -> Suite {
-        startSuite(named: name, at: startTime, framework: "SwiftManual") as! Suite
+        startSuite(named: name, at: startTime, framework: .init(name: "SwiftManual", version: "0.0.0")) as! Suite
     }
 
     @objc func suiteStart(name: String) -> Suite {
@@ -159,8 +159,8 @@ extension Module: TestModule {
 }
 
 extension Module: TestSuiteProvider {
-    func startSuite(named name: String, at start: Date?, framework: String) -> any TestRunProvider & TestSuite {
-        addFramework(framework)
+    func startSuite(named name: String, at start: Date?, framework: TestFramework) -> any TestRunProvider & TestSuite {
+        addFramework(framework.name)
         return Suite(name: name, module: self, framework: framework, startTime: start)
     }
 }

Sources/DatadogSDKTesting/DDTestSuite.swift

@@ -18,7 +18,7 @@ public final class Suite: NSObject, Encodable {
 
     public let name: String
     public let startTime: Date
-    public let testFramework: String
+    public let testFramework: TestFramework
     public let localization: String
 
     var duration: UInt64 { _state.value.duration }
@@ -33,7 +33,7 @@ public final class Suite: NSObject, Encodable {
     private let _module: Module
     private let _state: Synced<MutableState>
 
-    init(name: String, module: Module, framework: String, startTime: Date? = nil) {
+    init(name: String, module: Module, framework: TestFramework, startTime: Date? = nil) {
         self.name = name
         self._module = module
         self.testFramework = framework
@@ -51,7 +51,8 @@ public final class Suite: NSObject, Encodable {
         state.meta[DDGenericTags.type] = DDTagValues.typeSuiteEnd
         state.meta[DDTestTags.testSuite] = name
         state.meta[DDTestTags.testModule] = module.name
-        state.meta[DDTestTags.testFramework] = testFramework
+        state.meta[DDTestTags.testFramework] = testFramework.name
+        state.meta[DDTestTags.testFrameworkVersion] = testFramework.version
         state.meta[DDTestSuiteVisibilityTags.testSessionId] = String(module.session.id.rawValue)
         state.meta[DDTestSuiteVisibilityTags.testModuleId] = String(module.id.rawValue)
         state.meta[DDTestSuiteVisibilityTags.testSuiteId] = String(id.rawValue)

Sources/DatadogSDKTesting/Models.swift

@@ -93,11 +93,11 @@ protocol TestSuite: TestContainer {
     var session: any TestSession { get }
     var module: any TestModule { get }
     var localization: String { get }
-    var testFramework: String { get }
+    var testFramework: TestFramework { get }
 }
 
 protocol TestSuiteProvider: Sendable {
-    func startSuite(named: String, at: Date?, framework: String) -> any TestSuite & TestRunProvider
+    func startSuite(named: String, at: Date?, framework: TestFramework) -> any TestSuite & TestRunProvider
 }
 
 protocol TestRunProvider: Sendable {
@@ -299,6 +299,16 @@ struct TestRunParameters: Encodable {
     }
 }
 
+public struct TestFramework: Sendable {
+    public var name: String
+    public var version: String
+    
+    public init(name: String, version: String) {
+        self.name = name
+        self.version = version
+    }
+}
+
 extension TestModel {
     internal var endTime: Date {
         startTime.addingTimeInterval(.fromNanoseconds(Int64(duration)))

Sources/DatadogSDKTesting/SwiftTesting/SwiftTestingContext.swift

@@ -502,33 +502,34 @@ struct SwiftTestingSuiteContext: Sendable {
     let observer: any SwiftTestingObserverType
     let moduleManager: any TestModuleManager
     let testsCount: Int
+    let version: String
 
     init(suite: any TestSuite & TestRunProvider,
-         configuration: SessionConfig,
+         configuration: SessionConfig, version: String,
          info: any SwiftTestingTestInfoType,
          testsCount: Int,
          observer: any SwiftTestingObserverType,
          moduleManager: any TestModuleManager)
     {
-        self.init(suite: suite, configuration: configuration,
+        self.init(suite: suite, configuration: configuration, version: version,
                   testsCount: testsCount, state: .init(tests: []),
                   info: info, observer: observer, moduleManager: moduleManager)
     }
 
     init(suite: any TestSuite & TestRunProvider,
-         configuration: SessionConfig,
+         configuration: SessionConfig, version: String,
          tests: Set<String>,
          info: any SwiftTestingTestInfoType,
          observer: any SwiftTestingObserverType,
          moduleManager: any TestModuleManager)
     {
-        self.init(suite: suite, configuration: configuration,
+        self.init(suite: suite, configuration: configuration, version: version,
                   testsCount: tests.count, state: .init(tests: tests),
                   info: info, observer: observer, moduleManager: moduleManager)
     }
 
     private init(suite: any TestSuite & TestRunProvider,
-                 configuration: SessionConfig,
+                 configuration: SessionConfig, version: String,
                  testsCount: Int, state: State,
                  info: any SwiftTestingTestInfoType,
                  observer: any SwiftTestingObserverType,
@@ -541,6 +542,7 @@ struct SwiftTestingSuiteContext: Sendable {
         self.observer = observer
         self.configuration = configuration
         self.moduleManager = moduleManager
+        self.version = version
     }
 
     func withTestRun<T>(named name: String, _ action: @Sendable (any TestRun) async throws -> T) async rethrows -> T {
@@ -709,19 +711,21 @@ struct SwiftTestingSuiteProvider: SwiftTestingSuiteProviderType {
 
     var registry: any SwiftTestingTestRegistryType { _state.registry }
     var observer: any SwiftTestingObserverType { _state.observer }
+    let version: String
     private let _state: State
 
     init(session: any TestSessionManager, observer: any SwiftTestingObserverType) {
         self._state = .init(session: session, observer: observer, registry: Registry())
+        self.version = PlatformUtils.getSwiftTestingVersion() ?? "unknown"
     }
 
     func with(suite info: some SwiftTestingTestInfoType,
               performing function: @Sendable (borrowing SwiftTestingSuiteContext) async throws -> Void) async throws
     {
         let suite = try await self._state.suite(named: info.suite, in: info.module) { (mod, manager, config) in
             let count = try await self.registry.count(for: info)
-            let suite = mod.startSuite(named: info.suite, at: nil, framework: Self.framework)
-            return .init(suite: suite, configuration: config, info: info,
+            let suite = mod.startSuite(named: info.suite, at: nil, framework: .init(name: Self.framework, version: version))
+            return .init(suite: suite, configuration: config, version: version, info: info,
                          testsCount: count, observer: self.observer, moduleManager: manager)
         }
         if suite.isNew {
@@ -735,8 +739,8 @@ struct SwiftTestingSuiteProvider: SwiftTestingSuiteProviderType {
     {
         let suite = try await self._state.suite(named: test.suite, in: test.module) { (mod, manager, config) in
             let tests = try await self.registry.tests(for: test)
-            let suite = mod.startSuite(named: test.suite, at: nil, framework: Self.framework)
-            return SwiftTestingSuiteContext(suite: suite, configuration: config,
+            let suite = mod.startSuite(named: test.suite, at: nil, framework: .init(name: Self.framework, version: version))
+            return SwiftTestingSuiteContext(suite: suite, configuration: config, version: version,
                                             tests: tests, info: test, observer: self.observer,
                                             moduleManager: manager)
         }
@@ -770,7 +774,7 @@ struct SwiftTestingSuiteProvider: SwiftTestingSuiteProviderType {
 }
 
 extension TestSuite {
-    var isSwiftTesting: Bool { testFramework ==  SwiftTestingSuiteProvider.framework }
+    var isSwiftTesting: Bool { testFramework.name ==  SwiftTestingSuiteProvider.framework }
 }
 
 extension Optional where Wrapped == SwiftTestingTestStatus.Errors {

Sources/DatadogSDKTesting/Utils/PlatformUtils.swift

@@ -83,6 +83,17 @@ struct PlatformUtils {
         return version
     }
 
+    static func getXCTestVersion() -> String? {
+        guard let xcTestClass = NSClassFromString("XCTest") else { return nil }
+        return Bundle(for: xcTestClass).infoDictionary?["CFBundleShortVersionString"] as? String
+    }
+    
+    static func getSwiftTestingVersion() -> String? {
+        Bundle.allFrameworks
+            .first { $0.bundleIdentifier == "com.apple.dt.swift-testing" }
+            .flatMap { $0.infoDictionary?["CFBundleVersion"] as? String }
+    }
+
     static func getRuntimeInfo() -> (String, String) {
         if NSClassFromString("XCTest") != nil {
             return ("Xcode", getXcodeVersion())

Sources/DatadogSDKTesting/XCTest/DDXCTestObserver.swift

@@ -11,11 +11,13 @@ internal import XCTest
 final class DDXCTestObserver: NSObject, XCTestObservation, DDXCTestRetryDelegate {
     private(set) var state: State
     private let log: Logger
+    private let version: String
 
     init(session: any TestSessionManager, log: Logger) {
         XCUIApplication.swizzleMethods
         state = .start(session)
         self.log = log
+        self.version = PlatformUtils.getXCTestVersion() ?? "unknown"
         super.init()
     }
 
@@ -103,7 +105,7 @@ final class DDXCTestObserver: NSObject, XCTestObservation, DDXCTestRetryDelegate
         let wrappedTests = tests.map { DDXCTestRetryGroup(for: $0, observer: self) }
         testSuite.setValue(wrappedTests, forKey: "_mutableTests")
 
-        let suite = module.startSuite(named: testSuite.name, at: nil, framework: "XCTest")
+        let suite = module.startSuite(named: testSuite.name, at: nil, framework: .init(name: "XCTest", version: version))
         DDCrashes.setCurrent(spanData: suite.toCrashData)
         context.features.testSuiteWillStart(suite: suite, testsCount: UInt(wrappedTests.count))
 

Tests/DatadogSDKTesting/DDXCTestObserverTests.swift

@@ -80,6 +80,7 @@ internal class DDXCTestObserverTests: XCTestCase {
         XCTAssertEqual(spanData.attributes[DDTestTags.testName]?.description, testName)
         XCTAssertEqual(spanData.attributes[DDTestTags.testSuite]?.description, testSuite)
         XCTAssertEqual(spanData.attributes[DDTestTags.testFramework]?.description, "XCTest")
+        XCTAssertEqual(spanData.attributes[DDTestTags.testFrameworkVersion]?.description, PlatformUtils.getXCTestVersion())
         XCTAssertEqual(spanData.attributes[DDTestTags.testType]?.description, DDTagValues.typeTest)
         XCTAssertEqual(spanData.attributes[DDHostTags.hostVCPUCount]?.description, String(Double(PlatformUtils.getCpuCount())))
     }

Tests/DatadogSDKTesting/MockTestRunner.swift

@@ -174,7 +174,7 @@ extension Mocks {
         }
 
         func _run(suite name: String, info: TestSuite, module: Module) {
-            let suite = module.startSuite(named: name, at: nil, framework: "MockRunner") as! Mocks.Suite
+            let suite = module.startSuite(named: name, at: nil, framework: .init(name: "MockRunner", version: "1.0.0")) as! Mocks.Suite
             features.testSuiteWillStart(suite: suite, testsCount: UInt(info.tests.count))
             for (test, method) in info.tests {
                 _run(group: test, method: method, suite: suite)