Isolate cloud mock storage per test

Author: fatbobman

Sources/ObservableDefaults/NSUbiquitousKeyValueStore/MockUbiquitousKeyValueStore.swift

@@ -25,6 +25,10 @@ import Foundation
             userDefaults = UserDefaults(suiteName: Self.suiteName)!
         }
 
+        init(suiteName: String) {
+            userDefaults = UserDefaults(suiteName: suiteName)!
+        }
+
         // MARK: - Object methods
 
         func object(forKey aKey: String) -> Any? {

Sources/ObservableDefaults/NSUbiquitousKeyValueStore/NSUbiquitousKeyValueStoreWrapper.swift

@@ -27,13 +27,22 @@ public struct NSUbiquitousKeyValueStoreWrapper: Sendable {
         /// A TaskLocal variable to determine if the current environment is a test environment.
         @TaskLocal
         static var isTestEnvironment: Bool = false
+
+        /// A TaskLocal suite override used to isolate mock cloud storage per test.
+        @TaskLocal
+        static var testSuiteName: String?
     #endif
 
     /// A private property to store the cloud store.
     private var store: ObservableDefaultsCloudStoreProtocol {
         #if DEBUG
-            return Self.isTestEnvironment ? MockUbiquitousKeyValueStore
-                .default : NSUbiquitousKeyValueStore.default
+            if Self.isTestEnvironment {
+                if let testSuiteName = Self.testSuiteName {
+                    return MockUbiquitousKeyValueStore(suiteName: testSuiteName)
+                }
+                return MockUbiquitousKeyValueStore.default
+            }
+            return NSUbiquitousKeyValueStore.default
         #else
             return NSUbiquitousKeyValueStore.default
         #endif

Tests/ObservableDefaultsTests/Utils/TestTrait.swift

@@ -18,9 +18,13 @@ import Testing
             testCase: Test.Case?,
             performing function: @Sendable () async throws -> Void) async throws
         {
+            let suiteName = "ObservableDefaults.TestMode.\(UUID().uuidString)"
             try await NSUbiquitousKeyValueStoreWrapper.$isTestEnvironment
                 .withValue(value) {
-                    try await function()
+                    try await NSUbiquitousKeyValueStoreWrapper.$testSuiteName
+                        .withValue(suiteName) {
+                            try await function()
+                        }
                 }
         }
     }

Tests/ObservableDefaultsTests/Utils/UserDefaults.swift

@@ -24,13 +24,16 @@ extension UserDefaults {
 }
 
 extension UserDefaults {
+    private static var currentMockSuiteName: String {
+        NSUbiquitousKeyValueStoreWrapper.testSuiteName ?? MockUbiquitousKeyValueStore.suiteName
+    }
+
     static var mock: UserDefaults {
-        UserDefaults(suiteName: MockUbiquitousKeyValueStore.suiteName)!
+        UserDefaults(suiteName: currentMockSuiteName)!
     }
 
     static func clearMock() {
-        mock.removePersistentDomain(forName: MockUbiquitousKeyValueStore.suiteName)
+        mock.removePersistentDomain(forName: currentMockSuiteName)
         mock.synchronize()
     }
 }
-