Move PackageSigningTests to async/await and remove all usages of temp_await

Add async alternatives to PackageSigningEntityStorage
Mark non-async methods noasync
Improve the fixture method to return the result of the body

Author: AndrewHoos

Sources/PackageSigning/SigningEntity/PackageSigningEntityStorage.swift

@@ -20,6 +20,7 @@ import struct TSCUtility.Version
 
 public protocol PackageSigningEntityStorage {
     /// For a given package, return the signing entities and the package versions that each of them signed.
+    @available(*, noasync, message: "Use the async alternative")
     func get(
         package: PackageIdentity,
         observabilityScope: ObservabilityScope,
@@ -31,6 +32,7 @@ public protocol PackageSigningEntityStorage {
     ///
     /// This throws `PackageSigningEntityStorageError.conflict` if `signingEntity`
     /// of the package version is different from that in storage.
+    @available(*, noasync, message: "Use the async alternative")
     func put(
         package: PackageIdentity,
         version: Version,
@@ -46,6 +48,7 @@ public protocol PackageSigningEntityStorage {
     /// If the package version already has other `SigningEntity`s in storage, this
     /// API **adds** `signingEntity` to the package version's signers rather than
     /// throwing an error.
+    @available(*, noasync, message: "Use the async alternative")
     func add(
         package: PackageIdentity,
         version: Version,
@@ -57,6 +60,7 @@ public protocol PackageSigningEntityStorage {
     )
 
     /// Make `signingEntity` the package's expected signer starting from the given version.
+    @available(*, noasync, message: "Use the async alternative")
     func changeSigningEntityFromVersion(
         package: PackageIdentity,
         version: Version,
@@ -71,6 +75,7 @@ public protocol PackageSigningEntityStorage {
     ///
     /// This API deletes all other existing signers from storage, therefore making
     /// `signingEntity` the package's sole signer.
+    @available(*, noasync, message: "Use the async alternative")
     func changeSigningEntityForAllVersions(
         package: PackageIdentity,
         version: Version,
@@ -82,6 +87,107 @@ public protocol PackageSigningEntityStorage {
     )
 }
 
+public extension PackageSigningEntityStorage {
+    func get(
+        package: PackageIdentity,
+        observabilityScope: ObservabilityScope,
+        callbackQueue: DispatchQueue
+    ) async throws -> PackageSigners {
+        try await safe_async {
+            self.get(
+                package: package,
+                observabilityScope: observabilityScope, 
+                callbackQueue: callbackQueue,
+                callback: $0
+            )
+        }
+    }
+
+    func put(
+        package: PackageIdentity,
+        version: Version,
+        signingEntity: SigningEntity,
+        origin: SigningEntity.Origin,
+        observabilityScope: ObservabilityScope,
+        callbackQueue: DispatchQueue
+    ) async throws {
+        try await safe_async {
+            self.put(
+                package: package,
+                version: version,
+                signingEntity: signingEntity,
+                origin: origin,
+                observabilityScope: observabilityScope,
+                callbackQueue: callbackQueue,
+                callback: $0
+            )
+        }
+    }
+
+    func add(
+        package: PackageIdentity,
+        version: Version,
+        signingEntity: SigningEntity,
+        origin: SigningEntity.Origin,
+        observabilityScope: ObservabilityScope,
+        callbackQueue: DispatchQueue
+    ) async throws {
+        try await safe_async {
+            self.add(
+                package: package,
+                version: version,
+                signingEntity: signingEntity,
+                origin: origin,
+                observabilityScope: observabilityScope,
+                callbackQueue: callbackQueue,
+                callback: $0
+            )
+        }
+    }
+
+    func changeSigningEntityFromVersion(
+        package: PackageIdentity,
+        version: Version,
+        signingEntity: SigningEntity,
+        origin: SigningEntity.Origin,
+        observabilityScope: ObservabilityScope,
+        callbackQueue: DispatchQueue
+    ) async throws {
+        try await safe_async {
+            self.changeSigningEntityFromVersion(
+                package: package,
+                version: version,
+                signingEntity: signingEntity,
+                origin: origin,
+                observabilityScope: observabilityScope,
+                callbackQueue: callbackQueue,
+                callback: $0
+            )
+        }
+    }
+
+    func changeSigningEntityForAllVersions(
+        package: PackageIdentity,
+        version: Version,
+        signingEntity: SigningEntity,
+        origin: SigningEntity.Origin,
+        observabilityScope: ObservabilityScope,
+        callbackQueue: DispatchQueue
+    ) async throws {
+        try await safe_async {
+            self.changeSigningEntityForAllVersions(
+                package: package,
+                version: version,
+                signingEntity: signingEntity,
+                origin: origin,
+                observabilityScope: observabilityScope,
+                callbackQueue: callbackQueue,
+                callback: $0
+            )
+        }
+    }
+}
+
 // MARK: - Models
 
 extension SigningEntity {

Sources/SPMTestSupport/misc.swift

@@ -73,20 +73,20 @@ public func testWithTemporaryDirectory(
 /// The temporary copy is deleted after the block returns.  The fixture name may
 /// contain `/` characters, which are treated as path separators, exactly as if
 /// the name were a relative path.
-public func fixture(
+public func fixture<T>(
     name: String,
     createGitRepo: Bool = true,
     file: StaticString = #file,
     line: UInt = #line,
-    body: (AbsolutePath) throws -> Void
-) throws {
+    body: (AbsolutePath) throws -> T
+) throws -> T {
     do {
         // Make a suitable test directory name from the fixture subpath.
         let fixtureSubpath = try RelativePath(validating: name)
         let copyName = fixtureSubpath.components.joined(separator: "_")
 
         // Create a temporary directory for the duration of the block.
-        try withTemporaryDirectory(prefix: copyName) { tmpDirPath in
+        return try withTemporaryDirectory(prefix: copyName) { tmpDirPath in
 
             defer {
                 // Unblock and remove the tmp dir on deinit.
@@ -102,7 +102,7 @@ public func fixture(
             // Check that the fixture is really there.
             guard localFileSystem.isDirectory(fixtureDir) else {
                 XCTFail("No such fixture: \(fixtureDir)", file: file, line: line)
-                return
+                throw SwiftPMError.packagePathNotFound
             }
 
             // The fixture contains either a checkout or just a Git directory.
@@ -116,7 +116,7 @@ public func fixture(
 #endif
 
                 // Invoke the block, passing it the path of the copied fixture.
-                try body(dstDir)
+                return try body(dstDir)
             } else {
                 // Copy each of the package directories and construct a git repo in it.
                 for fileName in try localFileSystem.getDirectoryContents(fixtureDir).sorted() {
@@ -134,7 +134,7 @@ public func fixture(
                 }
 
                 // Invoke the block, passing it the path of the copied fixture.
-                try body(tmpDirPath)
+                return try body(tmpDirPath)
             }
         }
     } catch SwiftPMError.executionFailure(let error, let output, let stderr) {

Tests/CommandsTests/PackageToolTests.swift

@@ -944,7 +944,7 @@ final class PackageToolTests: CommandsTestCase {
     }
 
     func testPinning() throws {
-        try fixture(name: "Miscellaneous/PackageEdit") { fixturePath in
+        let _: Void = try fixture(name: "Miscellaneous/PackageEdit") { fixturePath in
             let fooPath = fixturePath.appending("foo")
             func build() throws -> String {
                 return try SwiftPM.Build.execute(packagePath: fooPath).stdout

Tests/FunctionalTests/DependencyResolutionTests.swift

@@ -29,7 +29,7 @@ class DependencyResolutionTests: XCTestCase {
     }
 
     func testInternalExecAsDep() throws {
-        try fixture(name: "DependencyResolution/Internal/InternalExecutableAsDependency") { fixturePath in
+        _ = try fixture(name: "DependencyResolution/Internal/InternalExecutableAsDependency") { fixturePath in
             XCTAssertBuildFails(fixturePath)
         }
     }
@@ -139,7 +139,7 @@ class DependencyResolutionTests: XCTestCase {
     }
 
     func testPackageLookupCaseInsensitive() throws {
-        try fixture(name: "DependencyResolution/External/PackageLookupCaseInsensitive") { fixturePath in
+        _ = try fixture(name: "DependencyResolution/External/PackageLookupCaseInsensitive") { fixturePath in
             try SwiftPM.Package.execute(["update"], packagePath: fixturePath.appending("pkg"))
         }
     }