Failing -> Unimplemented (#1168)

Author: mluisbrown

Examples/CaseStudies/SwiftUICaseStudies/02-Effects-SystemEnvironment.swift

@@ -205,17 +205,11 @@ struct SystemEnvironment<Environment> {
   import XCTestDynamicOverlay
 
   extension SystemEnvironment {
-    static func failing(
-      date: @escaping () -> Date = {
-        XCTFail("date dependency is unimplemented.")
-        return Date()
-      },
+    static func unimplemented(
+      date: @escaping () -> Date = XCTUnimplemented("\(Self.self).date", placeholder: Date()),
       environment: Environment,
-      mainQueue: DateScheduler = FailingScheduler(),
-      uuid: @escaping () -> UUID = {
-        XCTFail("UUID dependency is unimplemented.")
-        return UUID()
-      }
+      mainQueue: DateScheduler = UnimplementedScheduler(),
+      uuid: @escaping () -> UUID = XCTUnimplemented("\(Self.self).uuid", placeholder: UUID())
     ) -> Self {
       Self(
         date: date,

Examples/CaseStudies/SwiftUICaseStudies/FactClient.swift

@@ -28,10 +28,10 @@ extension FactClient {
 
 #if DEBUG
   extension FactClient {
-    // This is the "failing" fact dependency that is useful to plug into tests that you want
+    // This is the "unimplemented" fact dependency that is useful to plug into tests that you want
     // to prove do not need the dependency.
-    static let failing = Self(
-      fetch: { _ in .failing("\(Self.self).fact is unimplemented.") }
+    static let unimplemented = Self(
+      fetch: { _ in .unimplemented("\(Self.self).fact") }
     )
   }
 #endif

Examples/CaseStudies/SwiftUICaseStudiesTests/02-Effects-BasicsTests.swift

@@ -10,7 +10,7 @@ class EffectsBasicsTests: XCTestCase {
       initialState: EffectsBasicsState(),
       reducer: effectsBasicsReducer,
       environment: EffectsBasicsEnvironment(
-        fact: .failing,
+        fact: .unimplemented,
         mainQueue: ImmediateScheduler()
       )
     )
@@ -27,7 +27,7 @@ class EffectsBasicsTests: XCTestCase {
     let store = TestStore(
       initialState: EffectsBasicsState(),
       reducer: effectsBasicsReducer,
-      environment: .failing
+      environment: .unimplemented
     )
 
     store.environment.fact.fetch = { Effect(value: "\($0) is a good number Brent") }
@@ -49,7 +49,7 @@ class EffectsBasicsTests: XCTestCase {
     let store = TestStore(
       initialState: EffectsBasicsState(),
       reducer: effectsBasicsReducer,
-      environment: .failing
+      environment: .unimplemented
     )
 
     store.environment.fact.fetch = { _ in Effect(error: FactClient.Error()) }
@@ -68,8 +68,8 @@ class EffectsBasicsTests: XCTestCase {
 }
 
 extension EffectsBasicsEnvironment {
-  static let failing = Self(
-    fact: .failing,
-    mainQueue: .failing
+  static let unimplemented = Self(
+    fact: .unimplemented,
+    mainQueue: .unimplemented
   )
 }

Examples/CaseStudies/SwiftUICaseStudiesTests/02-Effects-WebSocketTests.swift

@@ -9,7 +9,7 @@ class WebSocketTests: XCTestCase {
     let socketSubject = Signal<WebSocketClient.Action, Never>.pipe()
     let receiveSubject = Signal<WebSocketClient.Message, NSError>.pipe()
 
-    var webSocket = WebSocketClient.failing
+    var webSocket = WebSocketClient.unimplemented
     webSocket.open = { _, _, _ in socketSubject.output.producer }
     webSocket.receive = { _ in receiveSubject.output.producer }
     webSocket.send = { _, _ in Effect(value: nil) }
@@ -58,7 +58,7 @@ class WebSocketTests: XCTestCase {
     let socketSubject = Signal<WebSocketClient.Action, Never>.pipe()
     let receiveSubject = Signal<WebSocketClient.Message, NSError>.pipe()
 
-    var webSocket = WebSocketClient.failing
+    var webSocket = WebSocketClient.unimplemented
     webSocket.open = { _, _, _ in socketSubject.output.producer }
     webSocket.receive = { _ in receiveSubject.output.producer }
     webSocket.send = { _, _ in Effect(value: NSError(domain: "", code: 1)) }
@@ -103,7 +103,7 @@ class WebSocketTests: XCTestCase {
     let socketSubject = Signal<WebSocketClient.Action, Never>.pipe()
     let pingSubject = Signal<NSError?, Never>.pipe()
 
-    var webSocket = WebSocketClient.failing
+    var webSocket = WebSocketClient.unimplemented
     webSocket.open = { _, _, _ in socketSubject.output.producer }
     webSocket.receive = { _ in .none }
     webSocket.sendPing = { _ in pingSubject.output.producer }
@@ -141,7 +141,7 @@ class WebSocketTests: XCTestCase {
   func testWebSocketConnectError() {
     let socketSubject = Signal<WebSocketClient.Action, Never>.pipe()
 
-    var webSocket = WebSocketClient.failing
+    var webSocket = WebSocketClient.unimplemented
     webSocket.cancel = { _, _, _ in .fireAndForget { socketSubject.input.sendCompleted() } }
     webSocket.open = { _, _, _ in socketSubject.output.producer }
     webSocket.receive = { _ in .none }
@@ -168,11 +168,11 @@ class WebSocketTests: XCTestCase {
 }
 
 extension WebSocketClient {
-  static let failing = Self(
-    cancel: { _, _, _ in .failing("WebSocketClient.cancel") },
-    open: { _, _, _ in .failing("WebSocketClient.open") },
-    receive: { _ in .failing("WebSocketClient.receive") },
-    send: { _, _ in .failing("WebSocketClient.send") },
-    sendPing: { _ in .failing("WebSocketClient.sendPing") }
+  static let unimplemented = Self(
+    cancel: { _, _, _ in .unimplemented("\(Self.self).cancel") },
+    open: { _, _, _ in .unimplemented("\(Self.self).open") },
+    receive: { _ in .unimplemented("\(Self.self).receive") },
+    send: { _, _ in .unimplemented("\(Self.self).send") },
+    sendPing: { _ in .unimplemented("\(Self.self).sendPing") }
   )
 }

Examples/CaseStudies/SwiftUICaseStudiesTests/04-HigherOrderReducers-ReusableOfflineDownloadsTests.swift

@@ -18,7 +18,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   let scheduler = TestScheduler()
 
   func testDownloadFlow() {
-    var downloadClient = DownloadClient.failing
+    var downloadClient = DownloadClient.unimplemented
     downloadClient.download = { _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
@@ -54,7 +54,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testDownloadThrottling() {
-    var downloadClient = DownloadClient.failing
+    var downloadClient = DownloadClient.unimplemented
     downloadClient.download = { _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
@@ -94,7 +94,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testCancelDownloadFlow() {
-    var downloadClient = DownloadClient.failing
+    var downloadClient = DownloadClient.unimplemented
     downloadClient.download = { _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
@@ -131,7 +131,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testDownloadFinishesWhileTryingToCancel() {
-    var downloadClient = DownloadClient.failing
+    var downloadClient = DownloadClient.unimplemented
     downloadClient.download = { _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
@@ -170,7 +170,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
   }
 
   func testDeleteDownloadFlow() {
-    var downloadClient = DownloadClient.failing
+    var downloadClient = DownloadClient.unimplemented
     downloadClient.download = { _ in self.downloadSubject.output.producer }
 
     let store = TestStore(
@@ -202,7 +202,7 @@ class ReusableComponentsDownloadComponentTests: XCTestCase {
 }
 
 extension DownloadClient {
-  static let failing = Self(
-    download: { _ in .failing("DownloadClient.download") }
+  static let unimplemented = Self(
+    download: { _ in .unimplemented("\(Self.self).download") }
   )
 }

Examples/Search/Search/WeatherClient.swift

@@ -81,9 +81,9 @@ extension WeatherClient {
 // MARK: - Mock API implementations
 
 extension WeatherClient {
-  static let failing = Self(
-    forecast: { _ in .failing("\(Self.self).forecast") },
-    search: { _ in .failing("\(Self.self).search") }
+  static let unimplemented = Self(
+    forecast: { _ in .unimplemented("\(Self.self).forecast") },
+    search: { _ in .unimplemented("\(Self.self).search") }
   )
 }
 

Examples/Search/SearchTests/SearchTests.swift

@@ -12,7 +12,7 @@ class SearchTests: XCTestCase {
       initialState: SearchState(),
       reducer: searchReducer,
       environment: SearchEnvironment(
-        weatherClient: .failing,
+        weatherClient: .unimplemented,
         mainQueue: self.scheduler
       )
     )
@@ -36,7 +36,7 @@ class SearchTests: XCTestCase {
       initialState: SearchState(),
       reducer: searchReducer,
       environment: SearchEnvironment(
-        weatherClient: .failing,
+        weatherClient: .unimplemented,
         mainQueue: self.scheduler
       )
     )
@@ -50,7 +50,7 @@ class SearchTests: XCTestCase {
   }
 
   func testClearQueryCancelsInFlightSearchRequest() {
-    var weatherClient = WeatherClient.failing
+    var weatherClient = WeatherClient.unimplemented
     weatherClient.search = { _ in Effect(value: .mock) }
 
     let store = TestStore(
@@ -84,7 +84,7 @@ class SearchTests: XCTestCase {
     var results = Search.mock.results
     results.append(specialResult)
 
-    var weatherClient = WeatherClient.failing
+    var weatherClient = WeatherClient.unimplemented
     weatherClient.forecast = { _ in Effect(value: .mock) }
 
     let store = TestStore(
@@ -143,7 +143,7 @@ class SearchTests: XCTestCase {
     var results = Search.mock.results
     results.append(specialResult)
 
-    var weatherClient = WeatherClient.failing
+    var weatherClient = WeatherClient.unimplemented
     weatherClient.forecast = { _ in Effect(value: .mock) }
 
     let store = TestStore(
@@ -194,7 +194,7 @@ class SearchTests: XCTestCase {
   }
 
   func testTapOnLocationFailure() {
-    var weatherClient = WeatherClient.failing
+    var weatherClient = WeatherClient.unimplemented
     weatherClient.forecast = { _ in Effect(error: WeatherClient.Failure()) }
 
     let results = Search.mock.results

Examples/SpeechRecognition/SpeechRecognition/SpeechClient/Failing.swift

@@ -4,10 +4,10 @@ import Speech
 
 #if DEBUG
   extension SpeechClient {
-    static let failing = Self(
-      finishTask: { .failing("SpeechClient.finishTask") },
-      recognitionTask: { _ in .failing("SpeechClient.recognitionTask") },
-      requestAuthorization: { .failing("SpeechClient.requestAuthorization") }
+    static let unimplemented = Self(
+      finishTask: { .unimplemented("\(Self.self).finishTask") },
+      recognitionTask: { _ in .unimplemented("\(Self.self).recognitionTask") },
+      requestAuthorization: { .unimplemented("\(Self.self).requestAuthorization") }
     )
   }
 #endif

Examples/SpeechRecognition/SpeechRecognitionTests/SpeechRecognitionTests.swift

@@ -8,7 +8,7 @@ class SpeechRecognitionTests: XCTestCase {
   let recognitionTaskSubject = Signal<SpeechClient.Action, SpeechClient.Error>.pipe()
 
   func testDenyAuthorization() {
-    var speechClient = SpeechClient.failing
+    var speechClient = SpeechClient.unimplemented
     speechClient.requestAuthorization = { Effect(value: .denied) }
 
     let store = TestStore(
@@ -37,7 +37,7 @@ class SpeechRecognitionTests: XCTestCase {
   }
 
   func testRestrictedAuthorization() {
-    var speechClient = SpeechClient.failing
+    var speechClient = SpeechClient.unimplemented
     speechClient.requestAuthorization = { Effect(value: .restricted) }
 
     let store = TestStore(
@@ -60,7 +60,7 @@ class SpeechRecognitionTests: XCTestCase {
   }
 
   func testAllowAndRecord() {
-    var speechClient = SpeechClient.failing
+    var speechClient = SpeechClient.unimplemented
     speechClient.finishTask = {
       .fireAndForget { self.recognitionTaskSubject.input.sendCompleted() }
     }
@@ -108,7 +108,7 @@ class SpeechRecognitionTests: XCTestCase {
   }
 
   func testAudioSessionFailure() {
-    var speechClient = SpeechClient.failing
+    var speechClient = SpeechClient.unimplemented
     speechClient.recognitionTask = { _ in self.recognitionTaskSubject.output.producer }
     speechClient.requestAuthorization = { Effect(value: .authorized) }
 
@@ -138,7 +138,7 @@ class SpeechRecognitionTests: XCTestCase {
   }
 
   func testAudioEngineFailure() {
-    var speechClient = SpeechClient.failing
+    var speechClient = SpeechClient.unimplemented
     speechClient.recognitionTask = { _ in self.recognitionTaskSubject.output.producer }
     speechClient.requestAuthorization = { Effect(value: .authorized) }
 

Examples/TicTacToe/tic-tac-toe/Sources/AuthenticationClient/AuthenticationClient.swift

@@ -72,9 +72,9 @@ public struct AuthenticationClient {
 
 #if DEBUG
   extension AuthenticationClient {
-    public static let failing = Self(
-      login: { _ in .failing("AuthenticationClient.login") },
-      twoFactor: { _ in .failing("AuthenticationClient.twoFactor") }
+    public static let unimplemented = Self(
+      login: { _ in .unimplemented("\(Self.self).login") },
+      twoFactor: { _ in .unimplemented("\(Self.self).twoFactor") }
     )
   }
 #endif