Fix pCloud swapped move tuple, harden integration test setUp for eventual consistency

Author: tobihagemann

Sources/CryptomatorCloudAccess/PCloud/PCloudCloudProvider.swift

@@ -404,8 +404,8 @@ public class PCloudCloudProvider: CloudProvider {
 	private func resolveForMove(from sourceCloudPath: CloudPath, to targetCloudPath: CloudPath) -> Promise<(PCloudItem, PCloudItem)> {
 		return resolveParentPath(forItemAt: targetCloudPath).then { targetParentItem -> Promise<(PCloudItem, PCloudItem)> in
 			return all(
-				self.checkForNameCollision(targetCloudPath.lastPathComponent, inFolder: targetParentItem).then { targetParentItem },
-				self.resolvePath(forItemAt: sourceCloudPath)
+				self.resolvePath(forItemAt: sourceCloudPath),
+				self.checkForNameCollision(targetCloudPath.lastPathComponent, inFolder: targetParentItem).then { targetParentItem }
 			)
 		}
 	}

Tests/CryptomatorCloudAccessIntegrationTests/CloudAccessIntegrationTest.swift

@@ -60,7 +60,8 @@ class CloudAccessIntegrationTest: XCTestCase {
 	}
 
 	override class func tearDown() {
-		_ = setUpProvider.deleteFolder(at: integrationTestRootCloudPath).then {
+		guard let provider = setUpProvider else { return }
+		_ = provider.deleteFolder(at: integrationTestRootCloudPath).then {
 			setUpProvider = nil
 		}
 		_ = waitForPromises(timeout: 60.0)
@@ -224,9 +225,9 @@ class CloudAccessIntegrationTest: XCTestCase {
 					FileManager.default.fileExists(atPath: fileURL.path, isDirectory: &isDirectory)
 					let cloudPath = integrationTestRootCloudPath.appendingPathComponent(nextObject)
 					if isDirectory.boolValue {
-						try awaitPromise(provider.createFolder(at: cloudPath))
+						try retryOnEventualConsistencyError { try awaitPromise(provider.createFolder(at: cloudPath)) }
 					} else {
-						_ = try awaitPromise(provider.uploadFile(from: fileURL, to: cloudPath, replaceExisting: false))
+						try retryOnEventualConsistencyError { _ = try awaitPromise(provider.uploadFile(from: fileURL, to: cloudPath, replaceExisting: false)) }
 					}
 				}
 				fulfill(())
@@ -236,6 +237,41 @@ class CloudAccessIntegrationTest: XCTestCase {
 		}
 	}
 
+	/// Retries an operation that fails due to eventual consistency (e.g. S3).
+	/// During setUp, `parentFolderDoesNotExist` and `itemNotFound` indicate that a just-created parent
+	/// folder or its directory metadata hasn't propagated yet.
+	private static func retryOnEventualConsistencyError(maxAttempts: Int = 10, operation: () throws -> Void) throws {
+		var lastError: Error = CloudProviderError.parentFolderDoesNotExist
+		for attempt in 0 ..< maxAttempts {
+			do {
+				try operation()
+				return
+			} catch CloudProviderError.parentFolderDoesNotExist, CloudProviderError.itemNotFound {
+				lastError = CloudProviderError.parentFolderDoesNotExist
+				if attempt == maxAttempts - 1 {
+					throw lastError
+				}
+				Thread.sleep(forTimeInterval: 1.0)
+			}
+		}
+	}
+
+	/// Polls `fetchItemList` until the expected number of items is visible, retrying up to 10 times with a 1-second delay.
+	/// Used after setUp uploads test fixtures to wait for eventual consistency (e.g. S3, pCloud).
+	static func waitForConsistency(provider: CloudProvider, folderPath: CloudPath, expectedItemCount: Int, attempt: Int = 0) -> Promise<Void> {
+		return provider.fetchItemList(forFolderAt: folderPath, withPageToken: nil).then { itemList -> Promise<Void> in
+			if itemList.items.count >= expectedItemCount {
+				return Promise(())
+			}
+			if attempt >= 10 {
+				return Promise(IntegrationTestError.consistencyTimeout)
+			}
+			return Promise(()).delay(1.0).then {
+				return waitForConsistency(provider: provider, folderPath: folderPath, expectedItemCount: expectedItemCount, attempt: attempt + 1)
+			}
+		}
+	}
+
 	// MARK: - fetchItemMetadata Tests
 
 	func testFetchItemMetadataForFile() {

Tests/CryptomatorCloudAccessIntegrationTests/CryptoDecorator/VaultFormat6/VaultFormat6PCloudIntegrationTests.swift

@@ -42,6 +42,14 @@ class VaultFormat6PCloudIntegrationTests: CloudAccessIntegrationTest {
 			return
 		}
 		super.setUp()
+		guard classSetUpError == nil else { return }
+		// Wait for pCloud's eventual consistency to catch up after setUp uploaded all test fixtures.
+		let expectedItemCount = 6 // 5 files (test 0-4.txt) + 1 folder (testFolder)
+		_ = waitForConsistency(provider: setUpProvider, folderPath: integrationTestRootCloudPath, expectedItemCount: expectedItemCount)
+		guard waitForPromises(timeout: 60.0) else {
+			classSetUpError = IntegrationTestError.oneTimeSetUpTimeout
+			return
+		}
 	}
 
 	override func setUpWithError() throws {

Tests/CryptomatorCloudAccessIntegrationTests/CryptoDecorator/VaultFormat6/VaultFormat6S3IntegrationTests.swift

@@ -41,7 +41,35 @@ class VaultFormat6S3IntegrationTests: CloudAccessIntegrationTest {
 			classSetUpError = error
 			return
 		}
+		// Wait for Scaleway S3's eventual consistency to catch up after vault creation.
+		_ = waitForVaultReadiness(provider: setUpProvider)
+		guard waitForPromises(timeout: 60.0) else {
+			classSetUpError = IntegrationTestError.oneTimeSetUpTimeout
+			return
+		}
 		super.setUp()
+		guard classSetUpError == nil else { return }
+		// Wait for Scaleway S3's eventual consistency to catch up after setUp uploaded all test fixtures.
+		let expectedItemCount = 6 // 5 files (test 0-4.txt) + 1 folder (testFolder)
+		_ = waitForConsistency(provider: setUpProvider, folderPath: integrationTestRootCloudPath, expectedItemCount: expectedItemCount)
+		guard waitForPromises(timeout: 60.0) else {
+			classSetUpError = IntegrationTestError.oneTimeSetUpTimeout
+			return
+		}
+	}
+
+	private static func waitForVaultReadiness(provider: CloudProvider, attempt: Int = 0) -> Promise<Void> {
+		let probePath = CloudPath("/.s3-consistency-probe")
+		return provider.createFolderIfMissing(at: probePath).then {
+			return provider.deleteFolderIfExisting(at: probePath)
+		}.recover { error -> Promise<Void> in
+			if attempt >= 10 {
+				return Promise(error)
+			}
+			return Promise(()).delay(2.0).then {
+				return waitForVaultReadiness(provider: provider, attempt: attempt + 1)
+			}
+		}
 	}
 
 	override func setUpWithError() throws {

Tests/CryptomatorCloudAccessIntegrationTests/CryptoDecorator/VaultFormat7/VaultFormat7PCloudIntegrationTests.swift

@@ -43,6 +43,14 @@ class VaultFormat7PCloudIntegrationTests: CloudAccessIntegrationTest {
 			return
 		}
 		super.setUp()
+		guard classSetUpError == nil else { return }
+		// Wait for pCloud's eventual consistency to catch up after setUp uploaded all test fixtures.
+		let expectedItemCount = 6 // 5 files (test 0-4.txt) + 1 folder (testFolder)
+		_ = waitForConsistency(provider: setUpProvider, folderPath: integrationTestRootCloudPath, expectedItemCount: expectedItemCount)
+		guard waitForPromises(timeout: 60.0) else {
+			classSetUpError = IntegrationTestError.oneTimeSetUpTimeout
+			return
+		}
 	}
 
 	override func setUpWithError() throws {

Tests/CryptomatorCloudAccessIntegrationTests/CryptoDecorator/VaultFormat7/VaultFormat7S3IntegrationTests.swift

@@ -41,7 +41,35 @@ class VaultFormat7S3IntegrationTests: CloudAccessIntegrationTest {
 			classSetUpError = error
 			return
 		}
+		// Wait for Scaleway S3's eventual consistency to catch up after vault creation.
+		_ = waitForVaultReadiness(provider: setUpProvider)
+		guard waitForPromises(timeout: 60.0) else {
+			classSetUpError = IntegrationTestError.oneTimeSetUpTimeout
+			return
+		}
 		super.setUp()
+		guard classSetUpError == nil else { return }
+		// Wait for Scaleway S3's eventual consistency to catch up after setUp uploaded all test fixtures.
+		let expectedItemCount = 6 // 5 files (test 0-4.txt) + 1 folder (testFolder)
+		_ = waitForConsistency(provider: setUpProvider, folderPath: integrationTestRootCloudPath, expectedItemCount: expectedItemCount)
+		guard waitForPromises(timeout: 60.0) else {
+			classSetUpError = IntegrationTestError.oneTimeSetUpTimeout
+			return
+		}
+	}
+
+	private static func waitForVaultReadiness(provider: CloudProvider, attempt: Int = 0) -> Promise<Void> {
+		let probePath = CloudPath("/.s3-consistency-probe")
+		return provider.createFolderIfMissing(at: probePath).then {
+			return provider.deleteFolderIfExisting(at: probePath)
+		}.recover { error -> Promise<Void> in
+			if attempt >= 10 {
+				return Promise(error)
+			}
+			return Promise(()).delay(2.0).then {
+				return waitForVaultReadiness(provider: provider, attempt: attempt + 1)
+			}
+		}
 	}
 
 	override func setUpWithError() throws {

Tests/CryptomatorCloudAccessIntegrationTests/IntegrationTestError.swift

@@ -11,6 +11,7 @@ import Foundation
 enum IntegrationTestError: Error {
 	case cloudProviderInitError
 	case missingDirectoryEnumerator
+	case consistencyTimeout
 	case oneTimeSetUpTimeout
 	case setUpTimeout
 }