SMock - यूनिट-परीक्षणों के लिए स्विफ्ट मॉकिंग फ्रेमवर्क (विचारों के लिए धन्यवाद gMock)

मुसीबत

ओबीजीसी / सी ++ से स्विफ्ट की दुनिया में कदम रखते हुए, मैं इकाई परीक्षण लिखते समय एक समस्या में भाग गया: जॉक ऑब्जेक्ट बनाने के लिए उपकरणों की कमी।

विघटित कोड लिखते समय, हम अक्सर इंटरफेस (प्रोटोकॉल) के पीछे कार्यान्वयन विवरण छिपाते हैं। मोकामी के साथ इसके घटक भागों की जगह, दूसरों से अलग से किसी वस्तु की कार्यक्षमता की जांच करना भी बहुत सुविधाजनक है।

Googling, मुझे गितुब पर कई स्विफ्ट मॉकिंग फ्रेमवर्क मिले। लेकिन उनमें से कोई भी मुझे स्पष्ट और स्पष्ट रूप से उपयोग में नहीं आया (एक या कई कारणों से):

• निर्भरता का एक बादल है
• कोई सहज वाक्यविन्यास नहीं
• बड़ी मात्रा में सहायक कोड की कोड पीढ़ी / मैनुअल लेखन की आवश्यकता होती है
• XCTest के साथ एकीकृत नहीं है (गीला की अनुमति देता है, लेकिन परीक्षण नहीं किया गया है)
• कई सुविधाओं को एक ढांचे के एक समूह में डंप किया गया है (क्या और क्यों का भ्रम)
• पूर्वनिर्धारित / अंतर्निहित प्रकारों की सीमित संख्या के साथ उपयोग किया जाना चाहिए

यह स्थिति मेरे लिए अप्रिय थी, और लगभग एक साल तक मैंने वर्कआर्स और स्व-निर्मित मोक का उपयोग किया।
स्व-लिखित नकली वस्तुएं सरल हैं, लेकिन वे

• हर बार अलग (पहिया को सुदृढ़ करें)
• या हर बार (कॉपी-पेस्ट)
• उपयोग करने के लिए स्पष्ट नहीं है

फेसला

C ++ gTest / gMock ( Google).
Mock- . , «» ( ) .

gMock, sMock (Swift Mock) gMock.
https://github.com/Alkenso/sMock

sMock:

• mock /
• expectations
• - mock-
• XCTest.framework
• zero-dependency
• pure Swift

()

sMock

• Mock , ( )
• Mock methodCall. "" .

Mocking synchronous method

:

import XCTest
import sMock

//    ,   
protocol HTTPClient {
    func sendRequestSync(_ request: String) -> String
}

//  Mock 
class MockHTTPClient: HTTPClient {
    //   call's mock entity.
    let sendRequestSyncCall = MockMethod<String, String>()

    func sendRequestSync(_ request: String) -> String {
        //  1.    Mock-
        //  2.  non-void   "default"    'Unexpected call' (..     ,   ).
        sendRequestSyncCall.call(request) ?? ""
    }
}

//  ,    
struct Client {
    let httpClient: HTTPClient

    //  ,  HTTP ,    .
    func retrieveRecordsSync() -> [String] {
        let response = httpClient.sendRequestSync("{ action: 'retrieve_records' }")
        return response.split(separator: ";").map(String.init)
    }
}

class ExampleTests: XCTestCase {
    func test_Example() {
        let mock = MockHTTPClient()
        let client = Client(httpClient: mock)

        //     expectation,    'sendRequestSync'  HTTPClient     'request'  "{ action: 'retrieve_records' }".
        //   ,      1     "r1;r2;r3".
        mock.sendRequestSyncCall
            //    expectation (      );
            .expect("Request sent.")
            //  ,   expectation    ,      match
            .match("{ action: 'retrieve_records' }")
            //    ,        (   match)
            .willOnce(
                //  ,    .
                .return("r1;r2;r3"))

        //   expectations,   Client-    .
        let records = client.retrieveRecordsSync()
        XCTAssertEqual(records, ["r1", "r2", "r3"])
    }
}

Mocking synchronous method + mocking asynchonous callback

Mock callback'a, .

//    ,   
protocol HTTPClient {
    func sendRequestSync(_ request: String) -> String
}

//  Mock 
class MockHTTPClient: HTTPClient {
    //   call's mock entity.
    let sendRequestSyncCall = MockMethod<String, String>()

    func sendRequestSync(_ request: String) -> String {
        //  1.    Mock-
        //  2.  non-void   "default"    'Unexpected call' (..     ,   ).
        sendRequestSyncCall.call(request) ?? ""
    }
}

//  ,    
struct Client {
    let httpClient: HTTPClient

    //  ,  HTTP ,    .   
    func retrieveRecordsAsync(completion: @escaping ([String]) -> Void) {
        let response = httpClient.sendRequestSync("{ action: 'retrieve_records' }")
        completion(response.split(separator: ";").map(String.init))
    }
}

class ExampleTests: XCTestCase {
    func test_Example() {
        let mock = MockHTTPClient()
        let client = Client(httpClient: mock)

        //     expectation,    'sendRequestSync'  HTTPClient     'request'  "{ action: 'retrieve_records' }".
        //   ,      1     "r1;r2;r3".
        mock.sendRequestSyncCall
            //    expectation (      );
            .expect("Request sent.")
            //  ,   expectation    ,      match
            .match("{ action: 'retrieve_records' }")
            //    ,        (   match)
            .willOnce(
                //  ,    .
                .return("r1;r2;r3"))

        //    expectation    ( ). 
        //     ,     -  :  'MockClosure' mock entity.
        //     expectation,      1    ( ) ["r1", "r2", "r3"].
        let completionCall = MockClosure<[String], Void>()
        completionCall
            //    expectation (      );
            .expect("Records retrieved.")
            //  ,   expectation    ,      match
            .match(["r1", "r2", "r3"])
            //    ,        (   match).
            //   return value   Void, .return   .
            .willOnce()

        //   expectations,   Client-.
        client.retrieveRecordsAsync(completion: completionCall.asClosure())

        //      expectations (  " "    ).
        sMock.waitForExpectations()
    }
}

Matchers, Actions, Argument capture

sMock (. ):

• Matchers — , .match: .any ( )
• Actions: expectation match'e .return, .
• : expectation .
• : , unexpectedCall

.
.
: , . .

, Swift .
, sMock . .
"testing with Swift"!

Try sMock on github (with SwiftPackageManager)