feat: Add integration tests to CI (#1308)

awslabs · Jan 22, 2024 · ce9f5a0 · ce9f5a0
1 parent 36821c2
commit ce9f5a0
Show file tree

Hide file tree

Showing 8 changed files with 202 additions and 3 deletions.
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -0,0 +1,159 @@
+name: Integration Tests
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  AWS_SWIFT_SDK_USE_LOCAL_DEPS: 1
+
+permissions:
+  id-token: write
+
+jobs:
+  apple:
+    runs-on: ${{ matrix.runner }}
+    environment: Integration-Test
+    env:
+      DEVELOPER_DIR: /Applications/${{ matrix.xcode }}.app/Contents/Developer
+    strategy:
+      fail-fast: false
+      matrix:
+        # This matrix runs tests on Mac, on oldest & newest supported Xcodes
+        runner:
+          - macos-12
+          - macos-13
+        xcode:
+          - Xcode_14.0.1
+          - Xcode_15.2
+        exclude:
+          # Don't run old macOS with new Xcode
+          - runner: macos-12
+            xcode: Xcode_15.2
+          # Don't run new macOS with old Xcode
+          - runner: macos-13
+            xcode: Xcode_14.0.1
+    steps:
+      - name: Configure AWS Credentials for Integration Tests
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.INTEGRATION_TEST_ROLE_ARN }}
+          aws-region: us-west-2
+      - name: Checkout aws-sdk-swift
+        uses: actions/checkout@v3
+      - name: Select smithy-swift branch
+        run: |
+          ORIGINAL_REPO_HEAD_REF="$GITHUB_HEAD_REF" \
+          DEPENDENCY_REPO_URL="https://github.com/smithy-lang/smithy-swift.git" \
+          ./scripts/ci_steps/select_dependency_branch.sh
+      - name: Checkout smithy-swift
+        uses: actions/checkout@v3
+        with:
+          repository: smithy-lang/smithy-swift
+          ref: ${{ env.DEPENDENCY_REPO_SHA }}
+          path: smithy-swift
+      - name: Move smithy-swift into place
+        run: mv smithy-swift ..
+      - name: Cache Gradle
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: 1-${{ runner.os }}-gradle-${{ hashFiles('settings.gradle.kts', 'gradle/wrapper/gradle-wrapper.properties') }}
+          restore-keys: |
+            1-${{ runner.os }}-gradle-${{ hashFiles('settings.gradle.kts', 'gradle/wrapper/gradle-wrapper.properties') }}
+            1-${{ runner.os }}-gradle-
+      - name: Cache Swift
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/Library/Caches/org.swift.swiftpm
+            ~/.cache/org.swift.swiftpm
+          key: 1-${{ runner.os }}-${{ matrix.xcode }}-${{ hashFiles('Package.swift', 'AWSSDKSwiftCLI/Package.swift') }}
+          restore-keys: |
+            1-${{ runner.os }}-${{ matrix.xcode }}-${{ hashFiles('Package.swift', 'AWSSDKSwiftCLI/Package.swift') }}
+            1-${{ runner.os }}-${{ matrix.xcode }}-
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: corretto
+          java-version: 17
+      - name: Tools Versions
+        run: ./scripts/ci_steps/log_tool_versions.sh
+      - name: Prepare Integration Tests
+        run: ./scripts/ci_steps/prepare_integration_tests.sh
+      - name: Build Integration Tests
+        run: swift build --build-tests
+      - name: Run Integration Tests
+        run: swift test
+
+  linux:
+    runs-on: ubuntu-latest
+    environment: Integration-Test
+    container: swift:${{ matrix.version }}-${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - focal
+          #- amazonlinux2
+        version:
+          - 5.7
+          - 5.9
+    steps:
+      - name: Configure AWS Credentials for Integration Tests
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.INTEGRATION_TEST_ROLE_ARN }}
+          aws-region: us-west-2
+      - name: Checkout aws-sdk-swift
+        uses: actions/checkout@v3
+      - name: Select smithy-swift branch
+        run: |
+          ORIGINAL_REPO_HEAD_REF="${GITHUB_HEAD_REF:-${GITHUB_REF_NAME:-main}}" \
+          DEPENDENCY_REPO_URL="https://github.com/smithy-lang/smithy-swift.git" \
+          ./scripts/ci_steps/select_dependency_branch.sh
+      - name: Checkout smithy-swift
+        uses: actions/checkout@v3
+        with:
+          repository: smithy-lang/smithy-swift
+          ref: ${{ env.DEPENDENCY_REPO_SHA }}
+          path: smithy-swift
+      - name: Move smithy-swift into place
+        run: mv smithy-swift ..
+      - name: Cache Gradle
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: 1-${{ runner.os }}-gradle-${{ hashFiles('settings.gradle.kts', 'gradle/wrapper/gradle-wrapper.properties') }}
+          restore-keys: |
+            1-${{ runner.os }}-gradle-${{ hashFiles('settings.gradle.kts', 'gradle/wrapper/gradle-wrapper.properties') }}
+            1-${{ runner.os }}-gradle-
+      - name: Cache Swift
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/Library/Caches/org.swift.swiftpm
+            ~/.cache/org.swift.swiftpm
+          key: 1-${{ runner.os }}-swift-${{ matrix.version }}-spm-${{ hashFiles('Package.swift', 'AWSSDKSwiftCLI/Package.swift') }}
+          restore-keys: |
+            1-${{ runner.os }}-swift-${{ matrix.version }}-spm-${{ hashFiles('Package.swift', 'AWSSDKSwiftCLI/Package.swift') }}
+            1-${{ runner.os }}-swift-${{ matrix.version }}-spm-
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: corretto
+          java-version: 17
+      - name: Install OpenSSL (all OS) and which (AL2 only)
+        run: ./scripts/ci_steps/install_native_linux_dependencies.sh
+      - name: Tools Versions
+        run: ./scripts/ci_steps/log_tool_versions.sh
+      - name: Prepare Integration Tests
+        run: ./scripts/ci_steps/prepare_integration_tests.sh
+      - name: Build Integration Tests
+        run: swift build --build-tests
+      - name: Run Integration Tests
+        run: swift test
diff --git a/IntegrationTests/Services/AWSECSIntegrationTests/ECSCredentialsProviderTests.swift b/IntegrationTests/Services/AWSECSIntegrationTests/ECSCredentialsProviderTests.swift
@@ -37,7 +37,8 @@ class ECSCredentialsProviderTests: XCTestCase {
         )
     }
 
-    func test_ecsCredentialsProvider() async throws {
+    // TODO: Re-enable this test once CI is configured to run it. See https://github.com/awslabs/aws-sdk-swift/issues/1310
+    func xtest_ecsCredentialsProvider() async throws {
         let ecsClient = try await ECSClient()
 
         // create cluster

diff --git a/IntegrationTests/Services/AWSS3IntegrationTests/ProcessCredentialsProviderTests.swift b/IntegrationTests/Services/AWSS3IntegrationTests/ProcessCredentialsProviderTests.swift
@@ -31,7 +31,8 @@ class ProcessCredentialProviderTests: XCTestCase {
     }
 
     // This test calls listBuckets() and forces S3Client to use ProcessCredentialsProvider
-    func test_listBuckets() async throws {
+    // TODO: Re-enable this test once CI is configured to run it.  See https://github.com/awslabs/aws-sdk-swift/issues/1309
+    func xtest_listBuckets() async throws {
         _ = try await client.listBuckets(input: ListBucketsInput())
     }
 }
diff --git a/IntegrationTests/Services/AWSS3IntegrationTests/S3URLEncodingTests.swift b/IntegrationTests/Services/AWSS3IntegrationTests/S3URLEncodingTests.swift
@@ -5,6 +5,9 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 import XCTest
 import AWSS3
 

diff --git a/IntegrationTests/Services/AWSS3IntegrationTests/S3XCTestCase.swift b/IntegrationTests/Services/AWSS3IntegrationTests/S3XCTestCase.swift
@@ -5,6 +5,9 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 import XCTest
 import AWSS3
 

diff --git a/IntegrationTests/Services/AWSS3IntegrationTests/SSOCredentialsProviderTests.swift b/IntegrationTests/Services/AWSS3IntegrationTests/SSOCredentialsProviderTests.swift
@@ -54,7 +54,8 @@ class SSOCredentialsProviderTests : XCTestCase {
     }
 
     // The test calls listBuckets() and forces S3Client to use SSOCredentialsProvider
-    func test_listBuckets() async throws {
+    // TODO: Re-enable this test once CI is configured to run it. See https://github.com/awslabs/aws-sdk-swift/issues/1311
+    func xtest_listBuckets() async throws {
         _ = try await client.listBuckets(input: ListBucketsInput())
     }
 

diff --git a/scripts/ci_steps/prepare_integration_tests.sh b/scripts/ci_steps/prepare_integration_tests.sh
@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -e
+
+# Only enable codegen for integration test services
+cp scripts/integration-test-sdk.properties sdk.properties
+
+# Delete all staged, generated code
+rm -rf Sources/Services/*
+rm -rf Tests/Services/*
+
+# Code-generate all enabled AWS services
+./gradlew -p codegen/sdk-codegen build
+./gradlew -p codegen/sdk-codegen stageSdks
+./gradlew --stop
+
+# Merge model files
+./scripts/mergeModels.sh Sources/Services
+
+# Regenerate the SDK Package.swift to run only integration tests
+cd AWSSDKSwiftCLI
+swift run AWSSDKSwiftCLI generate-package-manifest --include-integration-tests --exclude-aws-services --exclude-runtime-tests ..
+cd ..
+
+# Dump the Package.swift contents to the logs
+cat Package.swift
+
+# Run aws-sdk-swift integration tests as a separate step
+# (allows for use of either Xcode or pure Swift toolchains)
diff --git a/scripts/integration-test-sdk.properties b/scripts/integration-test-sdk.properties
@@ -0,0 +1,2 @@
+# Only include services needed for running integration tests
+onlyIncludeModels=kinesis.2013-12-02,s3.2006-03-01,sso-admin.2020-07-20,translate.2017-07-01,sqs.2012-11-05,ec2.2016-11-15,mediaconvert.2017-08-29,ecs.2014-11-13,cloudwatch-logs.2014-03-28,iam.2010-05-08,sts.2011-06-15
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Only include services needed for running integration tests
		onlyIncludeModels=kinesis.2013-12-02,s3.2006-03-01,sso-admin.2020-07-20,translate.2017-07-01,sqs.2012-11-05,ec2.2016-11-15,mediaconvert.2017-08-29,ecs.2014-11-13,cloudwatch-logs.2014-03-28,iam.2010-05-08,sts.2011-06-15