chore: Opt-in service client tests

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

@@ -10,6 +10,7 @@ on:
 
 env:
   AWS_SWIFT_SDK_USE_LOCAL_DEPS: 1
+  AWS_SWIFT_SDK_ENABLE_SERVICE_TESTS: 1
 
 jobs:
   codegen-build-test:

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

@@ -96,10 +96,43 @@ struct GeneratePackageManifest {
     ///
     /// - Returns: The contents of the generated package manifest.
     func generatePackageManifestContents() throws -> String {
+
+        struct ServiceClientInfo: Decodable {
+            let modelPath: String
+            let dependencies: [String]
+        }
+
         let versions = try resolveVersions()
-        let services = try resolveServices().map { PackageManifestBuilder.Service(name: $0) }
+        let serviceNames = try resolveServices()
+        let services = serviceNames.map { name in
+            let fileURL = URL(fileURLWithPath: "Sources/Services/\(name)/Dependencies.json")
+            let data = try! Data(contentsOf: fileURL)
+            let info = try! JSONDecoder().decode(ServiceClientInfo.self, from: data)
+            let modelFileName = URL(fileURLWithPath: info.modelPath).lastPathComponent
+            return PackageManifestBuilder.Service(
+                moduleName: name,
+                codegenName: modelFileName,
+                dependencies: info.dependencies,
+                isInternal: false
+            )
+        }
+
+        let internalServiceNames = ["AWSSTS", "AWSSSO", "AWSSSOOIDC", "AWSCognitoIdentity", "AWSSignin"]
+        let internalServices = internalServiceNames.map { name in
+            let fileURL = URL(fileURLWithPath: "Sources/Core/AWSSDKIdentity/InternalClients/Internal\(name)/Dependencies.json")
+            let data = try! Data(contentsOf: fileURL)
+            let info = try! JSONDecoder().decode(ServiceClientInfo.self, from: data)
+            let modelFileName = URL(fileURLWithPath: info.modelPath).lastPathComponent
+            return PackageManifestBuilder.Service(
+                moduleName: "Internal\(name)",
+                codegenName: modelFileName,
+                dependencies: info.dependencies,
+                isInternal: true
+            )
+        }
+
         log("Creating package manifest contents...")
-        let contents = try buildPackageManifest(versions.clientRuntime, versions.crt, services)
+        let contents = try buildPackageManifest(versions.clientRuntime, versions.crt, services + internalServices)
         log("Successfully created package manifest contents")
         return contents
     }

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/PackageManifestBuilder.swift

@@ -10,8 +10,12 @@ import AWSCLIUtils
 
 /// Builds the contents of the package manifest file.
 struct PackageManifestBuilder {
+
     struct Service {
-        let name: String
+        let moduleName: String
+        let codegenName: String
+        let dependencies: [String]
+        let isInternal: Bool
     }
 
     let clientRuntimeVersion: Version
@@ -107,13 +111,6 @@ struct PackageManifestBuilder {
             // Add the generated content that defines the list of services to include
             buildServiceTargets(),
             "",
-            // Add the dependencies for the internal clients
-            buildInternalAWSSTSDependencies(),
-            buildInternalAWSSSODependencies(),
-            buildInternalAWSSSOOIDCDependencies(),
-            buildInternalAWSCognitoIdentityDependencies(),
-            buildInternalAWSSignInDependencies(),
-            "",
         ]
         return contents.joined(separator: .newline)
     }
@@ -147,51 +144,32 @@ struct PackageManifestBuilder {
     /// and calls the `addServiceTarget` for each item.
     private func buildServiceTargets() -> String {
         guard !services.isEmpty else {
-            return "let serviceTargets: [String: [Target.Dependency]] = [:]"
+            return "private let serviceClientData: [ServiceClientData] = []"
         }
         var lines: [String] = []
-        lines += ["let serviceTargets: [String: [Target.Dependency]] = ["]
-        lines += services.map {
-            let jsonFilePath = "Sources/Services/\($0.name)/Dependencies.json"
-            let dependencies = clientDependencies(service: $0, jsonFilePath: jsonFilePath)
-            return "    \($0.name.wrappedInQuotes()): \(dependencies),"
-        }
+        lines += ["private let serviceClientData: [ServiceClientData] = ["]
+        lines += services.map { serviceTargetData(service: $0) }
         lines += ["]"]
         return lines.joined(separator: .newline)
     }
 
-    private func buildInternalAWSSTSDependencies() -> String {
-        buildInternalClientDependencies(name: "AWSSTS")
-    }
-
-    private func buildInternalAWSSSODependencies() -> String {
-        buildInternalClientDependencies(name: "AWSSSO")
-    }
-
-    private func buildInternalAWSSSOOIDCDependencies() -> String {
-        buildInternalClientDependencies(name: "AWSSSOOIDC")
-    }
-
-    private func buildInternalAWSCognitoIdentityDependencies() -> String {
-        buildInternalClientDependencies(name: "AWSCognitoIdentity")
-    }
-
-    private func buildInternalAWSSignInDependencies() -> String {
-        buildInternalClientDependencies(name: "AWSSignin")
-    }
-
-    private func buildInternalClientDependencies(name: String) -> String {
-        let jsonFilePath = "Sources/Core/AWSSDKIdentity/InternalClients/Internal\(name)/Dependencies.json"
-        let service = Service(name: name)
-        let dependencies = clientDependencies(service: service, jsonFilePath: jsonFilePath)
-        return "let internal\(name)Dependencies: [Target.Dependency] = \(dependencies)"
+    private func serviceTargetData(service: Service) -> String {
+        var lines = [String]()
+        lines += ["    .init("]
+        lines += ["        \(service.moduleName.wrappedInQuotes()),"]
+        lines += ["        \(service.codegenName.wrappedInQuotes()),"]
+        if service.isInternal {
+            lines += ["        \(clientDependencies(service: service)),"]
+            lines += ["        .internalUse"]
+        } else {
+            lines += ["        \(clientDependencies(service: service))"]
+        }
+        lines += ["    ),"]
+        return lines.joined(separator: "\n")
     }
 
-    private func clientDependencies(service: Service, jsonFilePath: String) -> String {
-        let jsonFileData = FileManager.default.contents(atPath: jsonFilePath) ?? Data("[]".utf8)
-        let dependencies = try! JSONDecoder().decode([String].self, from: jsonFileData)
-            .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: ", ") + "]"
     }
 }
 

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

@@ -54,14 +54,14 @@ let package = Package(
     ],
     products:
         runtimeProducts +
-        serviceTargets.map(productForService(_:_:)),
+        serviceProducts,
     dependencies:
-        [smithySwiftDependency, crtDependency, doccDependencyOrNil].compactMap { $0 },
+        dependencies,
     targets:
         runtimeTargets +
         runtimeTestTargets +
-        serviceTargets.map(target(_:_:)) +
-        serviceTargets.map(unitTestTarget(_:_:))
+        serviceTargets +
+        serviceTestTargets
 )
 
 // MARK: Products
@@ -78,12 +78,20 @@ private var runtimeProducts: [Product] {
     ].map { .library(name: $0, targets: [$0]) }
 }
 
-private func productForService(_ service: String, _ dependencies: [Target.Dependency]) -> Product {
-    .library(name: service, targets: [service])
+private var serviceProducts: [Product] {
+    serviceClientData.filter { $0.serviceType == .awsServiceClient }.map(productForService(_:))
+}
+
+private func productForService(_ service: ServiceClientData) -> Product {
+    .library(name: service.name, targets: [service.name])
 }
 
 // MARK: Dependencies
 
+private var dependencies: [Package.Dependency] {
+    [smithySwiftDependency, crtDependency, doccDependencyOrNil].compactMap { $0 }
+}
+
 private var smithySwiftDependency: Package.Dependency {
     let previewPath = "./smithy-swift"
     let developmentPath = "../smithy-swift"
@@ -196,31 +204,6 @@ private var runtimeTargets: [Target] {
             ],
             path: "Sources/Core/AWSSDKIdentity/Sources/AWSSDKIdentity"
         ),
-        .target(
-            name: "InternalAWSSTS",
-            dependencies: internalAWSSTSDependencies,
-            path: "Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSSTS/Sources/InternalAWSSTS"
-        ),
-        .target(
-            name: "InternalAWSSSO",
-            dependencies: internalAWSSSODependencies,
-            path: "Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSSSO/Sources/InternalAWSSSO"
-        ),
-        .target(
-            name: "InternalAWSSSOOIDC",
-            dependencies: internalAWSSSOOIDCDependencies,
-            path: "Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSSSOOIDC/Sources/InternalAWSSSOOIDC"
-        ),
-        .target(
-            name: "InternalAWSCognitoIdentity",
-            dependencies: internalAWSCognitoIdentityDependencies,
-            path: "Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSCognitoIdentity/Sources/InternalAWSCognitoIdentity"
-        ),
-        .target(
-            name: "InternalAWSSignin",
-            dependencies: internalAWSSigninDependencies,
-            path: "Sources/Core/AWSSDKIdentity/InternalClients/InternalAWSSignin/Sources/InternalAWSSignin"
-        ),
         .target(
             name: "AWSSDKChecksums",
             dependencies: [
@@ -235,7 +218,11 @@ private var runtimeTargets: [Target] {
             name: "AWSSDKDynamic",
             path: "Sources/Core/AWSSDKDynamic/Sources/AWSSDKDynamic"
         ),
-    ]
+    ] + internalServiceTargets
+}
+
+private var internalServiceTargets: [Target] {
+    serviceClientData.filter { $0.serviceType == .internalUse }.map(target(_:))
 }
 
 private var runtimeTestTargets: [Target] {
@@ -288,24 +275,60 @@ private var runtimeTestTargets: [Target] {
     ]
 }
 
-private func target(_ service: String, _ dependencies: [Target.Dependency]) -> Target {
-    .target(
-        name: service,
-        dependencies: dependencies,
-        path: "Sources/Services/\(service)/Sources/\(service)"
-    )
+private var serviceTargets: [Target] {
+    serviceClientData.filter { $0.serviceType == .awsServiceClient }.map(target(_:))
+}
+
+private func target(_ service: ServiceClientData) -> Target {
+    .target(name: service.name, dependencies: service.dependencies, path: service.sourcePath)
 }
 
-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 [] }
+    return serviceClientData.filter { $0.serviceType == .awsServiceClient }.map(unitTestTarget(_:))
+}
+
+private func unitTestTarget(_ service: ServiceClientData) -> Target {
+    let testName = "\(service.name)Tests"
+    let modelName = URL(fileURLWithPath: service.modelPath).lastPathComponent
     return .testTarget(
         name: "\(testName)",
         dependencies: [
-            .byName(name: service),
+            .byName(name: service.name),
             .ClientRuntime,
             .AWSClientRuntime,
             .SmithyTestUtil,
         ],
-        path: "Sources/Services/\(service)/Tests/\(testName)"
+        path: "codegen/sdk-codegen/build/smithyprojections/sdk-codegen/\(modelName)/swift-codegen/Tests/\(testName)"
     )
 }
+
+// As of Swift 6.2, @unchecked is not needed, but for Swift 6.0 it is
+private struct ServiceClientData: @unchecked Sendable {
+
+    enum ServiceType {
+        case awsServiceClient
+        case internalUse
+    }
+
+    let name: String
+    let modelPath: String
+    let dependencies: [Target.Dependency]
+    let serviceType: ServiceType
+
+    init(_ name: String, _ modelPath: String, _ dependencies: [Target.Dependency], _ serviceType: ServiceType = .awsServiceClient) {
+        self.name = name
+        self.modelPath = modelPath
+        self.dependencies = dependencies
+        self.serviceType = serviceType
+    }
+
+    var sourcePath: String {
+        switch serviceType {
+        case .awsServiceClient:
+            return "Sources/Services/\(name)/Sources/\(name)"
+        case .internalUse:
+            return "Sources/Core/AWSSDKIdentity/InternalClients/\(name)/Sources/\(name)"
+        }
+    }
+}

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Commands/GeneratePackageManifestTests.swift

@@ -26,17 +26,40 @@ class GeneratePackageManifestTests: CLITestCase {
 
     func createServiceFolders(_ services: [String]) {
         services.forEach {
+            let path = "Sources/Services/\($0)"
             try! FileManager.default.createDirectory(
-                atPath: "Sources/Services/\($0)",
+                atPath: path,
                 withIntermediateDirectories: true
             )
+            createDependencyJSON(service: $0, path: path)
         }
+
+        let internalServices = ["AWSSTS", "AWSSSO", "AWSSSOOIDC", "AWSCognitoIdentity", "AWSSignin"]
+        internalServices.forEach {
+            let path = "Sources/Core/AWSSDKIdentity/InternalClients/Internal\($0)"
+            try! FileManager.default.createDirectory(
+                atPath: path,
+                withIntermediateDirectories: true
+            )
+            createDependencyJSON(service: $0, path: path)
+        }
+
         try! FileManager.default.createDirectory(
             atPath: "IntegrationTests/Services",
             withIntermediateDirectories: true
         )
     }
-
+
+    func createDependencyJSON(service: String, path: String) {
+        let json = Data("""
+            {
+              "modelPath": "codegen/sdk-codegen/aws-models/\(service.lowercased()).json",
+              "dependencies": []
+            }
+            """.utf8)
+        FileManager.default.createFile(atPath: "\(path)/Dependencies.json", contents: json)
+    }
+
     // MARK: - Tests
 
     // MARK: Golden Path
@@ -50,13 +73,13 @@ class GeneratePackageManifestTests: CLITestCase {
             clientRuntimeVersion: clientRuntimeVersion
         )
         createServiceFolders(services)
-        
+
         let subject = GeneratePackageManifest.mock(buildPackageManifest: { _clientRuntimeVersion, _crtVersion, services in
-            "\(_clientRuntimeVersion)-\(_crtVersion)-\(services.map(\.name).joined(separator: "-"))"
+            "\(_clientRuntimeVersion)-\(_crtVersion)-\(services.map(\.moduleName).joined(separator: "-"))"
         })
         try! subject.run()
         let result = try! String(contentsOfFile: "Package.swift", encoding: .utf8)
-        XCTAssertEqual(result, "1.2.3-3.2.1-EC2-S3")
+        XCTAssertEqual(result, "1.2.3-3.2.1-EC2-S3-InternalAWSSTS-InternalAWSSSO-InternalAWSSSOOIDC-InternalAWSCognitoIdentity-InternalAWSSignin")
     }
 
     // MARK: resolveVersions()