Merge pull request #363 from lunij/marc/ios-support

Fix iOS support and add iOS specific testing

Author: Ignacio Bonafonte

.github/workflows/BuildAndTest.yml

@@ -17,3 +17,9 @@ jobs:
         chmod +x codecov
         xcrun llvm-cov export -ignore-filename-regex="pb\.swift|grpc\.swift" -format="lcov" .build/debug/opentelemetry-swiftPackageTests.xctest/Contents/MacOS/opentelemetry-swiftPackageTests -instr-profile .build/debug/codecov/default.profdata > .build/debug/codecov/coverage_report.lcov
         ./codecov -f .build/debug/codecov/coverage_report.lcov
+    - name: Install Homebrew kegs
+      run: make setup_brew
+    - name: Build for iOS
+      run: make build_for_testing_ios
+    - name: Test for iOS
+      run: make test_without_building_ios

Examples/Datadog Sample/main.swift

@@ -7,7 +7,7 @@ import DatadogExporter
 import Foundation
 import OpenTelemetryApi
 import OpenTelemetrySdk
-#if targetEnvironment(macCatalyst)
+#if !os(macOS)
 import UIKit
 #endif
 
@@ -26,10 +26,10 @@ var instrumentationScopeInfo = InstrumentationScopeInfo(name: instrumentationSco
 var tracer: TracerSdk
 tracer = OpenTelemetrySDK.instance.tracerProvider.get(instrumentationName: instrumentationScopeName, instrumentationVersion: instrumentationScopeVersion) as! TracerSdk
 
-#if targetEnvironment(macCatalyst)
-let hostName = UIDevice.current.name
-#else
+#if os(macOS)
 let hostName = Host.current().localizedName
+#else
+let hostName = UIDevice.current.name
 #endif
 
 let exporterConfiguration = ExporterConfiguration(

Examples/Simple Exporter/main.swift

@@ -54,7 +54,7 @@ let spanExporter = MultiSpanExporter(spanExporters: [jaegerExporter, stdoutExpor
 let spanProcessor = SimpleSpanProcessor(spanExporter: spanExporter)
 OpenTelemetrySDK.instance.tracerProvider.addSpanProcessor(spanProcessor)
 
-if #available(macOS 10.14, *) {
+if #available(iOS 12.0, macOS 10.14, *) {
     OpenTelemetrySDK.instance.tracerProvider.addSpanProcessor(SignPostIntegration())
 }
 

Makefile

@@ -0,0 +1,27 @@
+PROJECT_NAME="opentelemetry-swift-Package"
+
+XCODEBUILD_OPTIONS_IOS=\
+	-configuration Debug \
+	-destination platform='iOS Simulator,name=iPhone 14,OS=latest' \
+	-scheme $(PROJECT_NAME) \
+	-workspace .
+
+.PHONY: setup_brew
+setup_brew:
+	brew update && brew install xcbeautify
+
+.PHONY: build_ios
+build_ios:
+	set -o pipefail && xcodebuild $(XCODEBUILD_OPTIONS_IOS) build | xcbeautify
+
+.PHONY: build_for_testing_ios
+build_for_testing_ios:
+	set -o pipefail && xcodebuild $(XCODEBUILD_OPTIONS_IOS) build-for-testing | xcbeautify
+
+.PHONY: test_ios
+test_ios:
+	set -o pipefail && xcodebuild $(XCODEBUILD_OPTIONS_IOS) test | xcbeautify
+
+.PHONY: test_without_building_ios
+test_without_building_ios:
+	set -o pipefail && xcodebuild $(XCODEBUILD_OPTIONS_IOS) test-without-building | xcbeautify

Package.resolved

@@ -36,6 +36,7 @@ let package = Package(
         .package(name: "swift-nio", url: "https://github.com/apple/swift-nio.git", from: "2.0.0"),
         .package(name: "grpc-swift", url: "https://github.com/grpc/grpc-swift.git", from: "1.0.0"),
         .package(name: "swift-metrics", url: "https://github.com/apple/swift-metrics.git", from: "2.1.1"),
+        .package(name: "Reachability.swift", url: "https://github.com/ashleymills/Reachability.swift", from: "5.1.0")
     ],
     targets: [
         .target(name: "OpenTelemetryApi",
@@ -98,7 +99,7 @@ let package = Package(
                 dependencies: ["OpenTelemetrySdk"],
                 path: "Sources/Exporters/Persistence"),
         .testTarget(name: "NetworkStatusTests",
-                    dependencies: ["NetworkStatus"],
+                    dependencies: ["NetworkStatus", .product(name: "Reachability", package: "Reachability.swift")],
                     path: "Tests/InstrumentationTests/NetworkStatusTests"),
         .testTarget(name: "OpenTelemetryApiTests",
                     dependencies: ["OpenTelemetryApi"],

Package.swift

@@ -17,16 +17,29 @@ class UIDeviceMock: UIDevice {
     init(
         model: String = .mockAny(),
         systemName: String = .mockAny(),
-        systemVersion: String = .mockAny()
+        systemVersion: String = .mockAny(),
+        isBatteryMonitoringEnabled: Bool = .mockAny(),
+        batteryState: UIDevice.BatteryState = .unknown,
+        batteryLevel: Float = 0
     ) {
         self._model = model
         self._systemName = systemName
         self._systemVersion = systemVersion
+        self._isBatteryMonitoringEnabled = isBatteryMonitoringEnabled
+        self._batteryState = batteryState
+        self._batteryLevel = batteryLevel
     }
 
     override var model: String { _model }
     override var systemName: String { _systemName }
     override var systemVersion: String { "mock system version" }
+    override var batteryState: UIDevice.BatteryState { _batteryState }
+    override var batteryLevel: Float { _batteryLevel }
+
+    override var isBatteryMonitoringEnabled: Bool {
+        get { _isBatteryMonitoringEnabled }
+        set { _isBatteryMonitoringEnabled = newValue }
+    }
 }
 
 #endif

Tests/ExportersTests/DatadogExporter/Helpers/DeviceMock.swift

@@ -5,7 +5,7 @@
 
 import XCTest
 
-#if !os(macOS)
+#if os(iOS)
 import UIKit
 #else
 import Foundation
@@ -19,9 +19,9 @@ class DeviceTests: XCTestCase {
         XCTAssertNotNil(Device.current)
     }
 
-    #if !os(macOS) && !targetEnvironment(macCatalyst)
+    #if os(iOS) && !targetEnvironment(macCatalyst)
     func testWhenRunningOnMobile_itUsesUIDeviceInfo() {
-        let uiDevice = DeviceMock(
+        let uiDevice = UIDeviceMock(
             model: "model mock",
             systemName: "system name mock",
             systemVersion: "system version mock"
@@ -32,5 +32,7 @@ class DeviceTests: XCTestCase {
         XCTAssertEqual(device.osName, uiDevice.systemName)
         XCTAssertEqual(device.osVersion, uiDevice.systemVersion)
     }
-    #endif // os(iOS) && !targetEnvironment(macCatalyst)
+
+    class ProcessInfoMock: ProcessInfo {}
+    #endif
 }