Device farm Setup

.github/workflows/ci.yml

@@ -61,6 +61,123 @@ jobs:
           chmod a+x builder
           ./builder build -p ${{ env.PACKAGE_NAME }}
 
+  ios-integration-test:
+    runs-on: macos-14
+    permissions:
+      id-token: write # This is required for requesting the JWT
+      contents: read # This is required for actions/checkout
+    env:
+      DEVELOPER_DIR: /Applications/Xcode.app
+      XCODE_DESTINATION: 'OS X'
+      NSUnbufferedIO: YES
+      BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.MOBILEPROVISION_BASE64 }}
+      KEYCHAIN_PASSWORD: ${{ secrets.TEST_KEYCHAIN_PASSWORD }}
+    steps:
+      - name: Build ${{ env.PACKAGE_NAME }} + consumers
+        run: |
+          python3 -c "from urllib.request import urlretrieve; urlretrieve('${{ env.BUILDER_HOST }}/${{ env.BUILDER_SOURCE }}/${{ env.BUILDER_VERSION }}/builder.pyz?run=${{ env.RUN }}', 'builder')"
+          chmod a+x builder
+          ./builder build -p ${{ env.PACKAGE_NAME }}
+      - name: Install the Apple certificate and provisioning profile
+        run: |
+          CERTIFICATE_PATH=$RUNNER_TEMP/build_certificate.p12
+          PP_PATH=$RUNNER_TEMP/mqttclient.mobileprovision
+          KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
+          aws s3 cp s3://aws-crt-test-stuff/iosTestApp.p12 $CERTIFICATE_PATH
+          aws s3 cp s3://aws-crt-test-stuff/aws-common-runtime.MqttClient.mobileprovision $PP_PATH
+          pkcs12_identity_pw=$(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/ios/pkcs12_identity_password" --query "SecretString" | cut -f2 -d":" | cut -f2 -d\")
+          # create temporary keychain
+          security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
+          security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
+          security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
+          # import certificate to keychain
+          security import $CERTIFICATE_PATH -P "$pkcs12_identity_pw" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
+          security list-keychain -d user -s $KEYCHAIN_PATH
+          # apply provisioning profile
+          mkdir -p ~/Library/MobileDevice/Provisioning\ Profiles
+          cp $PP_PATH ~/Library/MobileDevice/Provisioning\ Profiles
+      - name : Setup iOS App Credentials
+        run : |
+          cd aws-crt-swift/Test/IntegrationTests/MqttClient/MqttClient
+          ENDPOINT=$(aws secretsmanager get-secret-value --region us-east-1 --secret-id "unit-test/endpoint" --query "SecretString" | cut -f2 -d":" | cut -f2 -d\")
+          cert=$(aws secretsmanager get-secret-value --region us-east-1 --secret-id "unit-test/certificate" --query "SecretString" | cut -f2 -d":" | cut -f2 -d\") && echo -e "$cert" > ./cert.pem
+          key=$(aws secretsmanager get-secret-value --region us-east-1 --secret-id "unit-test/privatekey" --query "SecretString" | cut -f2 -d":" | cut -f2 -d\") && echo -e "$key" > ./privatekey.pem
+          sed -i '' "s/<endpoint>/${ENDPOINT}/g" ContentView.swift
+      - name: Build Test App
+        run: |
+          xcode-select --print-path
+          pwd
+          cd aws-crt-swift/Test/IntegrationTests/MqttClient
+          pwd
+          xcodebuild -resolvePackageDependencies
+          echo "start build app"
+          xcodebuild -scheme "MqttClient" \
+          -archivePath $RUNNER_TEMP/MqttClient.xcarchive \
+          -configuration Release \
+          -destination generic/platform=iOS \
+          clean archive -allowProvisioningUpdates
+      - name: Export ipa
+        run: |
+          cd aws-crt-swift/Test/IntegrationTests/MqttClient
+          aws s3 cp s3://aws-crt-test-stuff/ExportOptions.plist ExportOptions.plist
+          xcodebuild -exportArchive -archivePath $RUNNER_TEMP/MqttClient.xcarchive -exportOptionsPlist ExportOptions.plist -exportPath output
+          cd output
+          ls
+      - name: Setup Device Farm test file and environment
+      # Device Farm Instructions: https://docs.aws.amazon.com/devicefarm/latest/developerguide/test-types-appium.html
+        run: |
+          cd aws-crt-swift/Test/IntegrationTests/MqttClient
+          pwd
+          pip install virtualenv
+          virtualenv --help
+          virtualenv workspace
+          cd workspace
+          source bin/activate
+          pip install -r ../DeviceFarmScript/requirements.txt
+          # Create a test bundle folder for upload
+          mkdir tests
+          cp ../DeviceFarmScript/mqtt_ios_test.py tests/
+          find tests/
+          py.test --collect-only tests/
+          cd tests/
+          find . -name '__pycache__' -type d -exec rm -r {} +
+          find . -name '*.pyc' -exec rm -f {} +
+          find . -name '*.pyo' -exec rm -f {} +
+          find . -name '*~' -exec rm -f {} +
+          cd ..
+          pip freeze > requirements.txt
+          zip -r test_bundle.zip tests/ requirements.txt
+      - name: configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-region: us-west-2 # Device Farm only available on us-west-2
+      - name: Execute device farm iOS Highly Available
+        run: |
+          cd aws-crt-swift/Test/IntegrationTests/MqttClient
+          pip install -r ./DeviceFarmScript/requirements.txt
+          ls
+          python ./DeviceFarmScript/run_ios_ci.py \
+          --run_id ${{ github.run_id }} \
+          --run_attempt ${{ github.run_attempt }} \
+          --project_arn $(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/DeviceFarm/iOSProjectArn" --query "SecretString" | cut -f2 -d\") \
+          --device_pool_arn $(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/DeviceFarm/iOSHighlyAvailablePool" --query "SecretString" | cut -f2 -d\") \
+          --app_file_path ./output/MqttClient.ipa \
+          --test_file_path ./workspace/test_bundle.zip \
+          --test_spec_file_path ./DeviceFarmScript/test_spec.yml
+      - name: Execute device farm iOS 13
+        run: |
+          cd aws-crt-swift/Test/IntegrationTests/MqttClient
+          pip install -r ./DeviceFarmScript/requirements.txt
+          ls
+          python ./DeviceFarmScript/run_ios_ci.py \
+          --run_id ${{ github.run_id }} \
+          --run_attempt ${{ github.run_attempt }} \
+          --project_arn $(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/DeviceFarm/iOSProjectArn" --query "SecretString" | cut -f2 -d\") \
+          --device_pool_arn $(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/DeviceFarm/iOS13PoolArn" --query "SecretString" | cut -f2 -d\") \
+          --app_file_path ./output/MqttClient.ipa \
+          --test_file_path ./workspace/test_bundle.zip \
+          --test_spec_file_path ./DeviceFarmScript/test_spec.yml
+
   devices:
     runs-on: ${{ matrix.runner }}
     env:
@@ -70,7 +187,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # This matrix runs tests on iOS, tvOS & watchOS, on oldest & newest supported Xcodes
+        # This matrix runs tests on iOS and tvOS on oldest & newest supported Xcodes
         runner:
           - macos-12 # x64
           - macos-13 # x64
@@ -81,9 +198,7 @@ jobs:
           [{ os: ios, destination: 'iOS Simulator,OS=16.1,name=iPhone 14'},
            { os: ios, destination: 'iOS Simulator,OS=17.2,name=iPhone 15'},
            { os: tvos, destination: 'tvOS Simulator,OS=16.1,name=Apple TV 4K (3rd generation) (at 1080p)'},
-           { os: tvos, destination: 'tvOS Simulator,OS=17.2,name=Apple TV 4K (3rd generation) (at 1080p)'},
-           { os: watchos, destination: 'watchOS Simulator,OS=10.2,name=Apple Watch SE (40mm) (2nd generation)'},
-           { os: watchos, destination: 'watchOS Simulator,OS=9.1,name=Apple Watch Series 5 (40mm)'}]
+           { os: tvos, destination: 'tvOS Simulator,OS=17.2,name=Apple TV 4K (3rd generation) (at 1080p)'}]
         xcode:
           - Xcode_14.1
           - Xcode_15.2
@@ -110,10 +225,6 @@ jobs:
             xcode: Xcode_14.1
           - target: { os: ios, destination: 'iOS Simulator,OS=17.2,name=iPhone 15'}
             xcode: Xcode_14.1
-          - target: { os: watchos, destination: 'watchOS Simulator,OS=10.2,name=Apple Watch SE (40mm) (2nd generation)'}
-            xcode: Xcode_14.1
-          - target: { os: watchos, destination: 'watchOS Simulator,OS=9.1,name=Apple Watch Series 5 (40mm)'}
-            xcode: Xcode_15.2
     steps:
       - name: Build ${{ env.PACKAGE_NAME }} + consumers
         run: |

Package.swift

@@ -22,6 +22,9 @@ let cSettings: [CSetting] = [
     .define("AWS_APPSTORE_SAFE"),
 ]
 
+/// Store any defines that will be used by Swift Tests in swiftTestSettings
+var swiftTestSettings: [SwiftSetting] = []
+
 //////////////////////////////////////////////////////////////////////
 /// Configure C targets.
 /// Note: We can not use unsafe flags because SwiftPM makes the target ineligible for use by other packages.
@@ -124,14 +127,26 @@ awsCIoPlatformExcludes.append("source/posix")
 awsCIoPlatformExcludes.append("source/linux")
 awsCIoPlatformExcludes.append("source/s2n")
 awsCIoPlatformExcludes.append("source/darwin")
+cSettingsIO.append(.define("AWS_ENABLE_IO_COMPLETION_PORTS"))
+swiftTestSettings.append(.define("AWS_ENABLE_IO_COMPLETION_PORTS"))
 #elseif os(Linux)
 awsCIoPlatformExcludes.append("source/windows")
 awsCIoPlatformExcludes.append("source/bsd")
 awsCIoPlatformExcludes.append("source/darwin")
+cSettingsIO.append(.define("AWS_ENABLE_EPOLL"))
+swiftTestSettings.append(.define("AWS_ENABLE_EPOLL"))
 #else  // macOS, iOS, watchOS, tvOS
 awsCIoPlatformExcludes.append("source/windows")
 awsCIoPlatformExcludes.append("source/linux")
 awsCIoPlatformExcludes.append("source/s2n")
+cSettingsIO.append(.define("__APPLE__"))
+cSettingsIO.append(.define("AWS_ENABLE_DISPATCH_QUEUE", .when(platforms: [.iOS, .tvOS, .macOS])))
+cSettingsIO.append(.define("AWS_USE_SECITEM", .when(platforms: [.iOS, .tvOS])))
+cSettingsIO.append(.define("AWS_ENABLE_KQUEUE", .when(platforms: [.macOS])))
+swiftTestSettings.append(.define("__APPLE__"))
+swiftTestSettings.append(.define("AWS_ENABLE_DISPATCH_QUEUE", .when(platforms: [.iOS, .tvOS, .macOS])))
+swiftTestSettings.append(.define("AWS_USE_SECITEM", .when(platforms: [.macOS, .iOS, .tvOS])))
+swiftTestSettings.append(.define("AWS_ENABLE_KQUEUE", .when(platforms: [.macOS])))
 #endif
 
 //////////////////////////////////////////////////////////////////////
@@ -304,7 +319,8 @@ packageTargets.append(contentsOf: [
         path: "Test/AwsCommonRuntimeKitTests",
         resources: [
             .process("Resources")
-        ]
+        ],
+        swiftSettings: swiftTestSettings
     ),
     .executableTarget(
         name: "Elasticurl",

Source/AwsCommonRuntimeKit/io/HostResolver.swift

@@ -40,10 +40,7 @@ public class HostResolver: HostResolverProtocol {
             shutdownCallback: shutdownCallback)
     }
 
-    init(eventLoopGroup: EventLoopGroup,
-         maxHosts: Int,
-         maxTTL: Int,
-         shutdownCallback: ShutdownCallback? = nil) throws {
+    public init(eventLoopGroup: EventLoopGroup, maxHosts: Int, maxTTL: Int, shutdownCallback: ShutdownCallback? = nil) throws {
         let shutdownCallbackCore = ShutdownCallbackCore(shutdownCallback)
         let getRawValue: () -> UnsafeMutablePointer<aws_host_resolver>? = {
             withUnsafePointer(to: shutdownCallbackCore.getRetainedShutdownOptions()) { shutdownCallbackCorePointer in

Source/AwsCommonRuntimeKit/io/TLSContextOptions.swift

@@ -37,7 +37,7 @@ public class TLSContextOptions: CStruct {
     public static func makeMTLS(
         certificateData: Data,
         privateKeyData: Data) throws -> TLSContextOptions {
-        #if os(tvOS) || os(iOS) || os(watchOS)
+        #if os(watchOS)
         throw CommonRunTimeError.crtError(CRTError(code: AWS_ERROR_PLATFORM_NOT_SUPPORTED.rawValue))
         #endif
         return try TLSContextOptions(certificateData: certificateData, privateKeyData: privateKeyData)
@@ -55,7 +55,7 @@ public class TLSContextOptions: CStruct {
     public static func makeMTLS(
         certificatePath: String,
         privateKeyPath: String) throws -> TLSContextOptions {
-        #if os(tvOS) || os(iOS) || os(watchOS)
+        #if os(watchOS)
         throw CommonRunTimeError.crtError(CRTError(code: AWS_ERROR_PLATFORM_NOT_SUPPORTED.rawValue))
         #endif
         return try TLSContextOptions(certificatePath: certificatePath, privateKeyPath: privateKeyPath)
@@ -126,6 +126,22 @@ public class TLSContextOptions: CStruct {
     public func setMinimumTLSVersion(_ tlsVersion: TLSVersion) {
         aws_tls_ctx_options_set_minimum_tls_version(rawValue, aws_tls_versions(rawValue: tlsVersion.rawValue))
     }
+
+    /// Updates TLSContextOptions to use specified options when importing certificate and key into keychain.
+    ///
+    /// NOTE: This only works on Apple devices using Apple keychain via Secitem.. The library is currently only tested on iOS.
+    ///
+    /// - Parameters:
+    ///     - certLabel: Human readable label to apply to certificate being imported into keychain.
+    ///     - keyLabel: Human readable label to apply to key being imported into keychain.
+    /// - Throws: CommonRuntimeError.crtError
+    public func setSecitemLabels(certLabel: String? = nil, keyLabel: String? = nil) throws {
+        let secitemOptions = TLSSecitemOptions(certLabel: certLabel, keyLabel: keyLabel)
+
+        if aws_tls_ctx_options_set_secitem_options(rawValue, secitemOptions.rawValue) != AWS_OP_SUCCESS {
+            throw CommonRunTimeError.crtError(CRTError.makeFromLastError())
+        }
+    }
 
     typealias RawType = aws_tls_ctx_options
     func withCStruct<Result>(_ body: (aws_tls_ctx_options) -> Result) -> Result {

Source/AwsCommonRuntimeKit/io/TLSSecitemOptions.swift

@@ -0,0 +1,37 @@
+//  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//  SPDX-License-Identifier: Apache-2.0.
+
+import AwsCIo
+
+public class TLSSecitemOptions: CStruct {
+    var rawValue: UnsafeMutablePointer<aws_secitem_options>
+
+    public init(
+        certLabel: String? = nil,
+        keyLabel: String? = nil) {
+
+            self.rawValue = allocator.allocate(capacity: 1)
+
+            self.rawValue.pointee.cert_label = certLabel?.withByteCursorPointer { certLabelCursorPointer in
+                aws_string_new_from_cursor(
+                    allocator.rawValue,
+                    certLabelCursorPointer)
+            }
+
+            self.rawValue.pointee.key_label = keyLabel?.withByteCursorPointer { keyLabelCursorPointer in
+                aws_string_new_from_cursor(
+                    allocator.rawValue,
+                    keyLabelCursorPointer)
+            }
+    }
+
+    typealias RawType = aws_secitem_options
+    func withCStruct<Result>(_ body: (aws_secitem_options) -> Result) -> Result {
+        return body(rawValue.pointee)
+    }
+
+    deinit {
+        aws_tls_secitem_options_clean_up(rawValue)
+        allocator.release(rawValue)
+    }
+}

Test/AwsCommonRuntimeKitTests/io/TLSContextTests.swift

@@ -39,4 +39,20 @@ class TLSContextTests: XCBaseTestCase {
         _ = TLSConnectionOptions(context: context)
     }
 #endif
+
+#if AWS_USE_SECITEM
+    func testCreateTlsContextWithSecitemOptions() throws {
+        let certPath = try getEnvironmentVarOrSkipTest(environmentVarName: "AWS_TEST_MQTT311_IOT_CORE_X509_CERT")
+        let privateKeyPath = try getEnvironmentVarOrSkipTest(environmentVarName: "AWS_TEST_MQTT311_IOT_CORE_X509_KEY")
+
+        let certificateData = try Data(contentsOf: URL(fileURLWithPath: certPath))
+        let privateKeyData = try Data(contentsOf: URL(fileURLWithPath: privateKeyPath))
+
+        let options = try TLSContextOptions.makeMTLS(certificateData: certificateData, privateKeyData: privateKeyData)
+        try options.setSecitemLabels(certLabel: "TEST_CERT_LABEL", keyLabel: "TEST_KEY_LABEL")
+
+        let context = try TLSContext(options:options, mode: .client)
+        _ = TLSConnectionOptions(context: context)
+    }
+#endif
 }

Test/IntegrationTests/MqttClient/DeviceFarmScript/mqtt_ios_test.py

@@ -0,0 +1,56 @@
+"""
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0.
+"""
+import pytest
+from time import sleep
+
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+from appium.webdriver.common.appiumby import AppiumBy
+from selenium.common.exceptions import NoSuchElementException
+
+capabilities = dict(
+    platformName='ios',
+    automationName='xcuitest',
+    deviceName='iPhone',
+    bundleId='aws-common-runtime.MqttClient',
+    language='en',
+    locale='US',
+)
+
+appium_server_url = 'http://0.0.0.0:4723/wd/hub'
+
+class TestMqttIOS:
+    def setup_method(self):
+        self.driver = webdriver.Remote(appium_server_url, options=XCUITestOptions().load_capabilities(capabilities))
+        self.driver.implicitly_wait(10)
+
+    def teardown_method(self):
+        if self.driver:
+            self.driver.quit()
+
+    @pytest.mark.parametrize("event_loop_tests", [
+        "Background Process"
+    ])
+
+    def test_mqtt(self, event_loop_tests):
+        sleep(3)
+        self.perform_click_element('Setup Client and Start')
+        # Sleep to make sure the connection is finished
+        sleep(10)
+        # put the application in background
+        self.driver.background_app(-1)
+        # Wait to see if the connection is interrupted
+        sleep(15)
+
+    def perform_click_element(self, element_id):
+        try:
+            element = self.driver.find_element(by=AppiumBy.ID, value=element_id)
+            element.click()
+            sleep(2)
+        except NoSuchElementException:
+            pytest.skip(f"Element with ID '{element_id}' not found. Skipped the test")
+
+if __name__ == '__main__':
+    TestMqttIOS.test_mqtt()

Test/IntegrationTests/MqttClient/DeviceFarmScript/requirements.txt

@@ -0,0 +1,12 @@
+packaging==24.0
+Appium-Python-Client==2.11.0
+pytest==7.4.3
+boto3==1.28.1
+urllib3==1.26.18
+requests==2.28.0
+PyYAML==6.0.1
+pytest-metadata==3.0.0
+pytest-html==3.2.0
+selenium==4.9.0
+pluggy==1.2.0
+trio==0.22.2