feat: Publish releases on Swift Package Registry

.gitignore

@@ -37,6 +37,7 @@ SmokeTests/
 # VS Code config files
 .vscode/
 
-# Allow the AWSSDKSwiftCLI Package.resolved
+# Allow the AWSSDKSwiftCLI & SPRCLI Package.resolved
 # while excluding all other Package.resolved files
 !/AWSSDKSwiftCLI/Package.resolved
+!/SPRCLI/Package.resolved

.swiftlint.yml

@@ -1,10 +1,10 @@
 included:
-  - Sources/Core/AWSClientRuntime/Sources
-  - Sources/Core/AWSSDKChecksums/Sources
-  - Sources/Core/AWSSDKCommon/Sources
-  - Sources/Core/AWSSDKEventStreamsAuth/Sources
-  - Sources/Core/AWSSDKHTTPAuth/Sources
-  - Sources/Core/AWSSDKIdentity/Sources
+  - Sources/Core/aws-sdk-swift.AWSClientRuntime/Sources
+  - Sources/Core/aws-sdk-swift.AWSSDKChecksums/Sources
+  - Sources/Core/aws-sdk-swift.AWSSDKCommon/Sources
+  - Sources/Core/aws-sdk-swift.AWSSDKEventStreamsAuth/Sources
+  - Sources/Core/aws-sdk-swift.AWSSDKHTTPAuth/Sources
+  - Sources/Core/aws-sdk-swift.AWSSDKIdentity/Sources
 
 analyzer_rules:
   - unused_import

AWSSDKSwiftCLI/Sources/AWSCLIUtils/Process+Utils.swift

@@ -42,6 +42,9 @@ public func _run(_ process: Process) throws {
     #if DEBUG
     if let testRunner = ProcessRunner.testRunner {
         try testRunner.run(process)
+        if let pipe = process.standardOutput as? Pipe {
+            try pipe.fileHandleForWriting.close()
+        }
         return
     }
     #endif

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Commands/AWSSDKSwiftCLI/Subcommands/GenerateDocIndex.swift

@@ -70,7 +70,9 @@ struct GenerateDocIndexCommand: ParsableCommand {
         log("Resolving services...")
         let resolvedServices: [String]
         log("Using list of services that exist within Sources/Services")
-        resolvedServices = try FileManager.default.enabledServices()
+        resolvedServices = try FileManager.default
+            .enabledServices()
+            .map { "\($0.trimmingPrefix("aws-sdk-swift."))" }
         log("Resolved list of services: \(resolvedServices.count)")
         return resolvedServices
     }

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

@@ -38,6 +38,7 @@ struct GeneratePackageManifestCommand: ParsableCommand {
     func run() throws {
         let generatePackageManifest = GeneratePackageManifest.standard(
             repoPath: repoPath,
+            packageScope: nil,
             packageFileName: packageFileName,
             clientRuntimeVersion: clientRuntimeVersion,
             crtVersion: crtVersion,
@@ -54,6 +55,8 @@ struct GeneratePackageManifestCommand: ParsableCommand {
 struct GeneratePackageManifest {
     /// The path to the package repository
     let repoPath: String
+    /// The package scope.  Used for Swift Package Registry.
+    let packageScope: String?
     /// The name of the package manifest file, usually `Package.swift`
     let packageFileName: String
     /// The version to set for the ClientRuntime dependency
@@ -69,6 +72,7 @@ struct GeneratePackageManifest {
     let excludeRuntimeTests: Bool
 
     typealias BuildPackageManifest = (
+        _ packageScope: String,
         _ clientRuntimeVersion: Version,
         _ crtVersion: Version,
         _ services: [PackageManifestBuilder.Service]
@@ -90,10 +94,11 @@ struct GeneratePackageManifest {
     ///
     /// - Returns: The contents of the generated package manifest.
     func generatePackageManifestContents() throws -> String {
+        let packageScope = try resolvePackageScope()
         let versions = try resolveVersions()
-        let services = try resolveServices().map { PackageManifestBuilder.Service(name: $0) }
+        let services = try resolveServices(packageScope: packageScope).map { PackageManifestBuilder.Service(name: $0) }
         log("Creating package manifest contents...")
-        let contents = try buildPackageManifest(versions.clientRuntime, versions.crt, services)
+        let contents = try buildPackageManifest(packageScope, versions.clientRuntime, versions.crt, services)
         log("Successfully created package manifest contents")
         return contents
     }
@@ -112,6 +117,21 @@ struct GeneratePackageManifest {
         log("Successfully saved package manifest to \(packageFileName)")
     }
 
+    func resolvePackageScope() throws -> String {
+        log("Resolving package scope...")
+        if let packageScope {
+            log("Using package scope provided: \(packageScope)")
+            return packageScope
+        }
+        let filename = "Package.scope"
+        let data = try FileManager.default.loadContents(atPath: filename)
+        guard let scope = String(data: data, encoding: .utf8) else {
+            throw Error("Package scope in file \(filename) is not valid UTF-8")
+        }
+        log("Using package scope loaded from file \(filename): \(scope)")
+        return scope
+    }
+
     /// Returns the versions for ClientRuntime and CRT.
     /// If explcit versions are provided by the command, then this returns the specified versions.
     /// Otherwise, this returns the versions defined in `packageDependencies.plist`.
@@ -163,7 +183,7 @@ struct GeneratePackageManifest {
     /// Otherwise, this returns the list of services that exist within `Sources/Services`
     ///
     /// - Returns: The list of services to include in the package manifest
-    func resolveServices() throws -> [String] {
+    func resolveServices(packageScope: String) throws -> [String] {
         log("Resolving services...")
         let resolvedServices: [String]
         if let services = self.services {
@@ -174,7 +194,7 @@ struct GeneratePackageManifest {
             resolvedServices = try FileManager.default.enabledServices()
         }
         log("Resolved list of services: \(resolvedServices.count)")
-        return resolvedServices
+        return resolvedServices.map { $0.trimmingPrefix("\(packageScope).") }.map(String.init)
     }
 }
 
@@ -194,6 +214,7 @@ extension GeneratePackageManifest {
     /// - Returns: the standard package manifest generator
     static func standard(
         repoPath: String,
+        packageScope: String? = nil,
         packageFileName: String,
         clientRuntimeVersion: Version? = nil,
         crtVersion: Version? = nil,
@@ -203,13 +224,15 @@ extension GeneratePackageManifest {
     ) -> Self {
         GeneratePackageManifest(
             repoPath: repoPath,
+            packageScope: packageScope,
             packageFileName: packageFileName,
             clientRuntimeVersion: clientRuntimeVersion,
             crtVersion: crtVersion,
             services: services,
             excludeRuntimeTests: excludeRuntimeTests
-        ) { _clientRuntimeVersion, _crtVersion, _services in
+        ) { _packageScope, _clientRuntimeVersion, _crtVersion, _services in
             let builder = PackageManifestBuilder(
+                packageScope: _packageScope,
                 clientRuntimeVersion: _clientRuntimeVersion,
                 crtVersion: _crtVersion,
                 services: _services,

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Models/PackageManifestBuilder.swift

@@ -14,21 +14,24 @@ struct PackageManifestBuilder {
         let name: String
     }
 
+    let packageScope: String
     let clientRuntimeVersion: Version
     let crtVersion: Version
     let services: [Service]
     let excludeRuntimeTests: Bool
     let prefixContents: () throws -> String
     let basePackageContents: () throws -> String
-    
+
     init(
+        packageScope: String,
         clientRuntimeVersion: Version,
         crtVersion: Version,
         services: [Service],
         excludeRuntimeTests: Bool,
         prefixContents: @escaping () throws -> String,
         basePackageContents: @escaping () throws -> String
     ) {
+        self.packageScope = packageScope
         self.clientRuntimeVersion = clientRuntimeVersion
         self.crtVersion = crtVersion
         self.services = services
@@ -38,12 +41,14 @@ struct PackageManifestBuilder {
     }
 
     init(
+        packageScope: String,
         clientRuntimeVersion: Version,
         crtVersion: Version,
         services: [Service],
         excludeRuntimeTests: Bool
     ) {
         self.init(
+            packageScope: packageScope,
             clientRuntimeVersion: clientRuntimeVersion,
             crtVersion: crtVersion,
             services: services,
@@ -93,6 +98,9 @@ struct PackageManifestBuilder {
             // Add the generated content that defines the dependencies' versions
             buildDependencies(),
             "",
+            // Add the package scope
+            buildPackageScope(),
+            "",
             // Remove the runtime tests if needed
             buildRuntimeTests(),
             "",
@@ -119,6 +127,10 @@ struct PackageManifestBuilder {
         """
     }
 
+    private func buildPackageScope() -> String {
+        "let packageScope = \(packageScope.wrappedInQuotes())"
+    }
+
     private func buildRuntimeTests() -> String {
         "let excludeRuntimeUnitTests = \(excludeRuntimeTests)"
     }

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

@@ -105,35 +105,35 @@ private var runtimeTargets: [Target] {
                 .awsSDKHTTPAuth,
                 .awsSDKIdentity
             ],
-            path: "Sources/Core/AWSClientRuntime/Sources/AWSClientRuntime",
+            path: "Sources/Core/\("AWSClientRuntime".withScope)/Sources/AWSClientRuntime",
             resources: [
                 .process("Resources"),
             ]
         ),
         .target(
             name: "AWSSDKCommon",
             dependencies: [.crt],
-            path: "Sources/Core/AWSSDKCommon/Sources"
+            path: "Sources/Core/\("AWSSDKCommon".withScope)/Sources"
         ),
         .target(
             name: "AWSSDKEventStreamsAuth",
             dependencies: [.smithyEventStreamsAPI, .smithyEventStreamsAuthAPI, .smithyEventStreams, .crt, .clientRuntime, "AWSSDKHTTPAuth"],
-            path: "Sources/Core/AWSSDKEventStreamsAuth/Sources"
+            path: "Sources/Core/\("AWSSDKEventStreamsAuth".withScope)/Sources"
         ),
         .target(
             name: "AWSSDKHTTPAuth",
             dependencies: [.crt, .smithy, .clientRuntime, .smithyHTTPAuth, "AWSSDKIdentity", "AWSSDKChecksums"],
-            path: "Sources/Core/AWSSDKHTTPAuth/Sources"
+            path: "Sources/Core/\("AWSSDKHTTPAuth".withScope)/Sources"
         ),
         .target(
             name: "AWSSDKIdentity",
             dependencies: [.crt, .smithy, .clientRuntime, .smithyIdentity, .smithyIdentityAPI, .smithyHTTPAPI, .awsSDKCommon],
-            path: "Sources/Core/AWSSDKIdentity/Sources"
+            path: "Sources/Core/\("AWSSDKIdentity".withScope)/Sources"
         ),
         .target(
             name: "AWSSDKChecksums",
             dependencies: [.crt, .smithy, .clientRuntime, .smithyChecksumsAPI, .smithyChecksums, .smithyHTTPAPI],
-            path: "Sources/Core/AWSSDKChecksums/Sources"
+            path: "Sources/Core/\("AWSSDKChecksums".withScope)/Sources"
         )
     ]
 }
@@ -144,23 +144,23 @@ private var runtimeTestTargets: [Target] {
         .testTarget(
             name: "AWSClientRuntimeTests",
             dependencies: [.awsClientRuntime, .clientRuntime, .smithyTestUtils, .awsSDKCommon],
-            path: "Sources/Core/AWSClientRuntime/Tests/AWSClientRuntimeTests",
+            path: "Sources/Core/\("AWSClientRuntime".withScope)/Tests/AWSClientRuntimeTests",
             resources: [.process("Resources")]
         ),
         .testTarget(
             name: "AWSSDKEventStreamsAuthTests",
             dependencies: ["AWSClientRuntime", "AWSSDKEventStreamsAuth", .smithyStreams, .smithyTestUtils],
-            path: "Sources/Core/AWSSDKEventStreamsAuth/Tests/AWSSDKEventStreamsAuthTests"
+            path: "Sources/Core/\("AWSSDKEventStreamsAuth".withScope)/Tests/AWSSDKEventStreamsAuthTests"
         ),
         .testTarget(
             name: "AWSSDKHTTPAuthTests",
             dependencies: ["AWSSDKHTTPAuth", "AWSClientRuntime", "AWSSDKEventStreamsAuth", .crt, .clientRuntime, .smithyTestUtils],
-            path: "Sources/Core/AWSSDKHTTPAuth/Tests/AWSSDKHTTPAuthTests"
+            path: "Sources/Core/\("AWSSDKHTTPAuth".withScope)/Tests/AWSSDKHTTPAuthTests"
         ),
         .testTarget(
             name: "AWSSDKIdentityTests",
             dependencies: [.smithy, .smithyIdentity, "AWSSDKIdentity", .awsClientRuntime],
-            path: "Sources/Core/AWSSDKIdentity/Tests/AWSSDKIdentityTests",
+            path: "Sources/Core/\("AWSSDKIdentity".withScope)/Tests/AWSSDKIdentityTests",
             resources: [.process("Resources")]
         ),
     ]
@@ -189,7 +189,7 @@ private func target(_ service: String) -> Target {
             .awsSDKEventStreamsAuth,
             .awsSDKChecksums,
         ],
-        path: "Sources/Services/\(service)/Sources/\(service)"
+        path: "Sources/Services/\(service.withScope)/Sources/\(service)"
     )
 }
 
@@ -198,6 +198,14 @@ private func unitTestTarget(_ service: String) -> Target {
     return .testTarget(
         name: "\(testName)",
         dependencies: [.clientRuntime, .awsClientRuntime, .byName(name: service), .smithyTestUtils],
-        path: "Sources/Services/\(service)/Tests/\(testName)"
+        path: "Sources/Services/\(service.withScope)/Tests/\(testName)"
     )
 }
+
+private extension String {
+
+    var withScope: String {
+        guard !packageScope.isEmpty else { return self }
+        return "\(packageScope).\(self)"
+    }
+}

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Commands/GeneratePackageManifestTests.swift

@@ -42,6 +42,7 @@ class GeneratePackageManifestTests: CLITestCase {
     // MARK: Golden Path
 
     func testGoldenPath() throws {
+        let packageScope = "abc-def-ghi"
         let clientRuntimeVersion = "1.2.3"
         let crtVersion = "3.2.1"
         let services = ["EC2", "S3"]
@@ -51,12 +52,12 @@ class GeneratePackageManifestTests: CLITestCase {
         )
         createServiceFolders(services)
 
-        let subject = GeneratePackageManifest.mock(buildPackageManifest: { _clientRuntimeVersion, _crtVersion, services in
-            "\(_clientRuntimeVersion)-\(_crtVersion)-\(services.map(\.name).joined(separator: "-"))"
+        let subject = GeneratePackageManifest.mock(packageScope: packageScope, buildPackageManifest: { _packageScope, _clientRuntimeVersion, _crtVersion, services in
+            "\(_packageScope)-\(_clientRuntimeVersion)-\(_crtVersion)-\(services.map(\.name).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, "abc-def-ghi-1.2.3-3.2.1-EC2-S3")
     }
 
     // MARK: resolveVersions()
@@ -89,18 +90,20 @@ class GeneratePackageManifestTests: CLITestCase {
     // MARK: resolveServices()
 
     func testResolveServicesRetrievesServicesFromDisk() {
+        let packageScope = ""
         let services = ["EC2", "S3"]
         createServiceFolders(services)
 
         let subject = GeneratePackageManifest.mock()
-        let result = try! subject.resolveServices()
+        let result = try! subject.resolveServices(packageScope: packageScope)
         XCTAssertEqual(result, services)
     }
 
     func testResolveServicesWithExplicitServices() {
+        let packageScope = ""
         let services = ["One", "Two", "Three"]
         let subject = GeneratePackageManifest.mock(services: services)
-        let result = try! subject.resolveServices()
+        let result = try! subject.resolveServices(packageScope: packageScope)
         XCTAssertEqual(result, services)
     }
 }
@@ -110,15 +113,16 @@ class GeneratePackageManifestTests: CLITestCase {
 extension GeneratePackageManifest {
     static func mock(
         repoPath: String = ".",
+        packageScope: String = "",
         packageFileName: String = "Package.swift",
         clientRuntimeVersion: Version? = nil,
         crtVersion: Version? = nil,
         services: [String]? = nil,
         excludeRuntimeTests: Bool = false,
-        buildPackageManifest: @escaping BuildPackageManifest = { (_,_,_) throws -> String in "" }
+        buildPackageManifest: @escaping BuildPackageManifest = { (_,_,_,_) throws -> String in "" }
     ) -> GeneratePackageManifest {
         GeneratePackageManifest(
-            repoPath: repoPath,
+            repoPath: repoPath, packageScope: packageScope,
             packageFileName: packageFileName,
             clientRuntimeVersion: clientRuntimeVersion,
             crtVersion: crtVersion,

AWSSDKSwiftCLI/Tests/AWSSDKSwiftCLITests/Models/PackageManifestBuilderTests.swift

@@ -17,6 +17,8 @@ class PackageManifestBuilderTests: XCTestCase {
 let clientRuntimeVersion: Version = "1.2.3"
 let crtVersion: Version = "4.5.6"
 
+let packageScope = "abc-def-ghi"
+
 let excludeRuntimeUnitTests = false
 
 let serviceTargets: [String] = [
@@ -32,6 +34,7 @@ let serviceTargets: [String] = [
 
     func testBuild() throws {
         let subject = try PackageManifestBuilder(
+            packageScope: "abc-def-ghi",
             clientRuntimeVersion: .init("1.2.3"),
             crtVersion: .init("4.5.6"),
             services: ["A","B","C","D","E"].map { PackageManifestBuilder.Service(name: $0) },

Package.scope

@@ -0,0 +1 @@
+aws-sdk-swift