Use alternative approach to XCTUnwrap for stubRemoteResponse

Author: mokagio

WordPressKitTests/RemoteTestCase.swift

@@ -54,16 +54,20 @@ extension RemoteTestCase {
         contentType: ResponseContentType,
         status: Int32 = 200
     ) {
-        // This doesn't follow the XCTUnwrap pattern (yet?) because the method is used many times and it was too time consuming to update every call site at the time
-        let stubPath = OHPathForFile(filename, type(of: self))
+        // There are hundreds of usages of the various `stubRemoteResponse` overloads.
+        // The pattern here should be to XCTUnwrap and throw.
+        // In the interest of moving along with the work, let's fail the tests at this level if the file is not found.
+        guard let stubPath = OHPathForFile(filename, type(of: self)) else {
+            return XCTFail("Could not find file at path '\(filename)'.")
+        }
+
         stub(condition: condition) { _ in
             var headers: [NSObject: AnyObject]?
 
             if contentType != .NoContentType {
                 headers = ["Content-Type" as NSObject: contentType.rawValue as AnyObject]
             }
-            // This is force-unwrapped at call site, despite it making more sense at declaration site, so it can be found when grepping for force unwraps.
-            return OHHTTPStubs.fixture(filePath: stubPath!, status: status, headers: headers)
+            return OHHTTPStubs.fixture(filePath: stubPath, status: status, headers: headers)
         }
     }
 
@@ -76,8 +80,13 @@ extension RemoteTestCase {
     ///     - status: The status code to use for the response. Defaults to 200.
     ///
     func stubRemoteResponse(_ endpoint: String, filename: String, contentType: ResponseContentType, status: Int32 = 200) {
-        // This doesn't follow the XCTUnwrap pattern (yet?) because the method is used many times and it was too time consuming to update every call site at the time
-        let stubPath = OHPathForFile(filename, type(of: self))
+        // There are hundreds of usages of the various `stubRemoteResponse` overloads.
+        // The pattern here should be to XCTUnwrap and throw.
+        // In the interest of moving along with the work, let's fail the tests at this level if the file is not found.
+        guard let stubPath = OHPathForFile(filename, type(of: self)) else {
+            return XCTFail("Could not find file at path '\(filename)'.")
+        }
+
         stub(condition: { request in
             return request.url?.absoluteString.range(of: endpoint) != nil
         }) { _ in
@@ -86,8 +95,7 @@ extension RemoteTestCase {
             if contentType != .NoContentType {
                 headers = ["Content-Type" as NSObject: contentType.rawValue as AnyObject]
             }
-            // This is force-unwrapped at call site, despite it making more sense at declaration site, so it can be found when grepping for force unwraps.
-            return fixture(filePath: stubPath!, status: status, headers: headers)
+            return fixture(filePath: stubPath, status: status, headers: headers)
         }
     }
 
@@ -138,15 +146,20 @@ extension RemoteTestCase {
                 return HTTPStubsResponse(error: notConnectedError)
             }
 
-            let stubPath = OHPathForFile(files[callCounter], type(of: self))
+            guard let stubPath = OHPathForFile(files[callCounter], type(of: self)) else {
+                XCTFail("Could not find file at path '\(files[callCounter])'.")
+                let error = NSError(domain: "RemoteTestCase", code: 0, userInfo: nil)
+                return HTTPStubsResponse(error: error)
+            }
+
             callCounter += 1
 
             var headers: [NSObject: AnyObject]?
             if contentType != .NoContentType {
                 headers = ["Content-Type" as NSObject: contentType.rawValue as AnyObject]
             }
 
-            return fixture(filePath: stubPath!, status: status, headers: headers)
+            return fixture(filePath: stubPath, status: status, headers: headers)
         }
     }