chore: Opt-in service client tests #2059

jbelkins · 2025-11-17T15:14:30Z

Description of changes

This PR moves service client tests (i.e. endpoint tests) from being committed to the project to being an opt-in feature to be utilized only during development & distribution.

Service client tests are never moved from the Smithy build folder into the Swift service client folder as part of the buildSdk Gradle task. Instead, they are left where Smithy generates them. This is comparable to how we generate & run protocol tests.
The environment variable AWS_SWIFT_SDK_ENABLE_SERVICE_TESTS enables the service client test targets. The package will fail to resolve if service clients have not been locally generated (see step above). This env var is set in CI where unit tests run.
The Package.swift file has been overhauled:
- Individual service clients now have a custom data structure (ServiceClientInfo) to allow for multiple pieces of data per service.
- Public and internal service clients are now grouped together to streamline logic for target creation. A property on ServiceClientInfo distinguishes public from internal clients so they can be separated when needed.
- In AWSSDKSwiftCLI, logic for reading the Dependencies.json file has been moved from the PackageManifestBuilder to the GeneratePackageManifest subcommand. This separates concerns better and facilitates easier testing.
The integration for generating the Dependencies.json file has been moved in from smithy-swift since it is only used by AWS SDK.

The code-generated result of this change will be -290K LOC in the project due to not committing service client tests.

New/existing dependencies impact assessment, if applicable

No new dependencies were added to this change.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

jbelkins · 2025-11-17T15:53:02Z

codegen/sdk-codegen/build.gradle.kts

+                    val fileIsServiceClientTests = details.relativePath.startsWith("Tests")

-                    fileIsSmokeTests || fileIsInternalClientGeneratedTests
+                    fileIsSmokeTests || fileIsServiceClientTests


The logic for copying test files used to omit tests for internal clients, it now omits tests for all clients since tests are run from the directory where they are rendered by Smithy.

jbelkins · 2025-11-17T15:54:12Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

-        serviceTargets.map(target(_:_:)) +
-        serviceTargets.map(unitTestTarget(_:_:))
+        serviceTargets +
+        serviceTestTargets


Some of the logic in the Package initializer above has been extracted to helper methods below.

jbelkins · 2025-11-17T21:38:14Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

    )
 }
+
+struct ServiceClientData {


This type has been created to keep multiple pieces of data per service.

jbelkins · 2025-11-17T21:39:09Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

            .SmithyTestUtil,
        ],
-        path: "Sources/Services/\(service)/Tests/\(testName)"
+        path: "codegen/sdk-codegen/build/smithyprojections/sdk-codegen/\(modelName)/swift-codegen/Tests/\(testName)"


The path for tests now points to the Smithy build folder, where the code generator places them at creation, since they are no longer copied into the project.

jbelkins · 2025-11-17T21:39:43Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

-private func unitTestTarget(_ service: String, _ dependencies: [Target.Dependency]) -> Target {
-    let testName = "\(service)Tests"
+private var serviceTestTargets: [Target] {
+    guard ProcessInfo.processInfo.environment["AWS_SWIFT_SDK_ENABLE_SERVICE_TESTS"] != nil else { return [] }


Service test targets now default to [] if the new env var isn't set.

jbelkins · 2025-11-17T21:41:01Z

codegen/sdk-codegen/build.gradle.kts

                exclude { details ->
+                    // Exclude Package.swift
+                    val fileIsPackageManifest = details.file.name.endsWith("Package.swift")
+


Since smithy-swift now generates a package manifest in all cases, we simply don't copy it over to the package structure. This allows for the removal of the related SwiftSetting.

jbelkins · 2025-11-17T21:41:32Z

codegen/sdk-codegen/build.gradle.kts

-                    // Exclude test files for internal clients
-                    val fileIsInternalClientGeneratedTests = it.internalClient && details.relativePath.startsWith("Tests")
+                    // Exclude service client test files
+                    val fileIsServiceClientTests = details.relativePath.startsWith("Tests")


Tests are now not copied for all clients, not just internal.

jbelkins · 2025-11-17T21:44:04Z

...software/amazon/smithy/aws/swift/codegen/swiftintegrations/PackageManifestJSONIntegration.kt

+import software.amazon.smithy.swift.codegen.integration.SwiftIntegration
+import software.amazon.smithy.swift.codegen.model.expectTrait
+import software.amazon.smithy.swift.codegen.targetName
+


An integration that writes the Dependencies.json file that was previously written by smithy-swift.
Since Dependencies.json is only used by AWS SDK, it is moved here.

Also, this class's codegen test has been eliminated because creating a SDK that compiles successfully verifies that this file is correct.

Its structure has changed slightly to pass multiple pieces of data:

{ "modelPath": "code/sdk-codegen/aws-models/s3.json", "dependencies": [ "AWSClientRuntime", "AWSIdentity", "..." ] }

(Two-space indent has been used to minimize the change to the diff)

jbelkins · 2025-11-18T15:16:07Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/PackageManifestBuilder.swift

+        let codegenName: String
+        let dependencies: [String]
+        let isInternal: Bool
    }


An array of this data structure is passed in, with info about every service client to be included in the manifest.

jbelkins · 2025-11-18T15:17:59Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/PackageManifestBuilder.swift

-            .filter { $0 != "SmithyTestUtil" }  // links to test files only
-        return "[" + dependencies.map { ".\($0)" }.joined(separator: ", ") + "]"
+    private func clientDependencies(service: Service) -> String {
+        return "[" + service.dependencies.map { ".\($0)" }.joined(separator: ", ") + "]"


The code for reading the JSON file has been moved from here back up to the subcommand. Instead, the array of Service that is passed into this type contains the dependency info for each service.

jbelkins · 2025-11-18T15:20:15Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

-            name: "InternalAWSCognitoIdentity",
-            dependencies: internalAWSCognitoIdentityDependencies,
-            path: "Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSCognitoIdentity/Sources/InternalAWSCognitoIdentity"
-        ),


These hard-coded internal client targets are removed, since internal clients are now listed along with the public ones.

Instead, the internal services are filtered from the main list of services, and the targets for them are appended to runtime targets below.

jbelkins · 2025-11-18T15:43:59Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

    )
 }
+
+// As of Swift 6.2, @unchecked is not needed, but for Swift 6.0 it is


In Swift 6.1 or 6.2 (not sure which), Target.Dependency was marked Sendable. No code changes were needed to do so.

We mark ServiceClientData as @unchecked Sendable because in the earlier Swift versions we support, Target.Dependency is not Sendable so compile breaks if we try to mark this type as Sendable and Swift 6 language mode is in use.

It's just to suppress the Swift 6 compile error though, because there is no concurrency in the Package.swift file anyway.

jbelkins · 2025-11-18T17:42:00Z

Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSCognitoIdentity/Dependencies.json

    "SmithyTimestamps"
-]
+  ]
+}


New Dependencies.json structure can be seen here. Since it's now a JSON object with individual keys & values inside, it's more future-proof.

"SmithyTestUtil" is removed from every Dependencies.json because it will never be linked to a service client (we used to filter this in AWSSDKSwiftCLI but better to do it when Dependencies.json is written, to save the space.)

jbelkins · 2025-11-18T17:43:11Z

codegen/protocol-test-codegen-local/build.gradle.kts

 }

-data class CodegenTest(val service: String, val module: String, val extraConfig: String? = null)
+data class CodegenTest(val service: String, val module: String)


Unused extraConfig property is removed

jbelkins · 2025-11-18T17:43:42Z

codegen/protocol-test-codegen-local/build.gradle.kts

-                      "copyrightNotice": "//\n// Copyright Amazon.com Inc. or its affiliates.\n// All Rights Reserved.\n//\n// SPDX-License-Identifier: Apache-2.0\n//\n\n// Code generated by smithy-swift-codegen. DO NOT EDIT!\n\n",
-                      "forProtocolTests": true
-                      ${it.extraConfig ?: ""}
+                      "copyrightNotice": "//\n// Copyright Amazon.com Inc. or its affiliates.\n// All Rights Reserved.\n//\n// SPDX-License-Identifier: Apache-2.0\n//\n\n// Code generated by smithy-swift-codegen. DO NOT EDIT!\n\n"


unused forProtocolTests & extraConfig are removed here.

jbelkins · 2025-11-18T17:44:29Z

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Models/PackageManifestBuilderTests.swift

        let excludeRuntimeUnitTests = false

        let isPreviewBuild = false



Test expectations for the package manifest are changed below.

jbelkins · 2025-11-18T17:45:39Z

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Commands/GeneratePackageManifestTests.swift

    }

    func createServiceFolders(_ services: [String]) {
        services.forEach {


Test setup below is expanded to write Dependencies.json for each of the mocked services, since that file is required on every service to successfully create a manifest.

All the internal clients get mocked similarly as well.

jbelkins · 2025-11-18T23:34:20Z

...CLI/Sources/AWSSDKSwiftCLI/Commands/AWSSDKSwiftCLI/Subcommands/GeneratePackageManifest.swift

+        struct ServiceClientInfo: Decodable {
+            let modelPath: String
+            let dependencies: [String]
+        }


Above is the decodable Swift type used to read the contents of Dependencies.json

Below is code that reads Dependencies.json and uses its contents to construct a PackageManifestBuilder.Service for each published and internal service.

The combined list of services is then passed into the manifest builder for inclusion in the text of the manifest.

jbelkins · 2025-11-18T23:36:22Z

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/PackageManifestBuilder.swift

-            buildInternalAWSSSODependencies(),
-            buildInternalAWSSSOOIDCDependencies(),
-            buildInternalAWSCognitoIdentityDependencies(),
-            "",


Here & below, special code for internal services is removed since they are now handled like all other services and filtered as needed into public/internal at runtime.

jbelkins · 2025-11-18T23:42:02Z

codegen/sdk-codegen/build.gradle.kts

    val visibility: String,
    val internalClient: Boolean,
-    val generatePackageManifest: Boolean,
-    val generateDependencyJSON: Boolean,


These SwiftSettings properties were removed in the companion smithy-swift PR.

jbelkins · 2025-11-18T23:56:50Z

.github/workflows/codegen-build-test.yml


 env:
  AWS_SWIFT_SDK_USE_LOCAL_DEPS: 1
+  AWS_SWIFT_SDK_ENABLE_SERVICE_TESTS: 1


codegen-build-test is where all service tests run in CI.

jbelkins added 2 commits November 17, 2025 09:07

chore: Opt-in service client tests

0586443

Enable service tests on CI

18d5df5

jbelkins commented Nov 17, 2025

View reviewed changes

jbelkins added 2 commits November 17, 2025 15:04

Move dependency JSON in from SDK as a SwiftIntegration

1da879e

Fix ktlint

ecf5a57

jbelkins commented Nov 17, 2025

View reviewed changes

jbelkins added 10 commits November 17, 2025 16:00

Add Dependencies.json for internal clients

d0abf40

Refactor CLI, fix CLI tests

a62423a

Merge branch 'main' into jbe/remove_service_client_tests

01184eb

Don't publish internal modules

395de59

Fix protocol tests

c1be323

Don't test internal clients

63fedc1

Make ServiceClientData Sendable

565b61b

Move package JSON generator to last integration run

f70827e

Fix Swift 6 language mode in manifest

77740b8

Omit SmithyTestUtil from dependencies

ed6e759

jbelkins commented Nov 18, 2025

View reviewed changes

Refactor isInternal bool to an enum

0d653a1

jbelkins commented Nov 18, 2025

View reviewed changes

Fix tests

bc4dbfa

jbelkins commented Nov 18, 2025

View reviewed changes

jbelkins added 2 commits November 18, 2025 18:08

Revert continuous-integration workflow

0358490

Merge branch 'main' into jbe/remove_service_client_tests

bb3b0cb

jbelkins requested review from dayaffe and sichanyoo November 19, 2025 00:10

jbelkins marked this pull request as ready for review November 19, 2025 00:10

		let excludeRuntimeUnitTests = false

		let isPreviewBuild = false

chore: Opt-in service client tests #2059

Are you sure you want to change the base?

chore: Opt-in service client tests #2059

Uh oh!

Conversation

jbelkins commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of changes

New/existing dependencies impact assessment, if applicable

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbelkins Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbelkins Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jbelkins commented Nov 17, 2025 •

edited

Loading

jbelkins Nov 17, 2025 •

edited

Loading

jbelkins Nov 18, 2025 •

edited

Loading