Mocker

MockerはSwiftで書かれたライブラリで、カスタムURLProtocol使用してデータ要求をモックすることができます。

• 特徴
• 要件
• 使用法
  • モッカーをアクティブにします
    • カスタムURLSESSIONS
    • alamofire
  • モックを登録します
    • モックされたデータを作成します
    • JSONリクエスト
    • ファイル拡張子
    • カスタムヘッドと応答を取得します
    • 応答が遅れました
    • 応答をリダイレクトします
    • URLを無視します
    • モックコールバック
  • Unregister Mocks
    • 登録されているすべてのモックをクリアします
• コミュニケーション
• インストール
• ノートをリリースします
• ライセンス

特徴

すべてのデータリクエストユニットテストをオフラインで実行しますか？

• URLに基​​づいてモックされたデータ要求を作成します
• ファイル拡張子に基づいて、モックされたデータ要求を作成します
• カスタムプロトコルクラスを使用してURLSessionで動作します
• Alamofireなどの一般的なフレームワークをサポートしています

使用法

ユニットテストは、 Mocker向けに書かれており、それがどのように機能するかを確認するのに役立ちます。

モッカーをアクティブにします

最初のMockを登録した後、モッカーはURLSession.sharedのようなデフォルトのURLロードシステムに対して自動的にアクティブになります。

カスタムURLSESSIONS

カスタムURLSessionで動作させるには、 MockingURLProtocol登録する必要があります。

 let configuration = URLSessionConfiguration . default
configuration . protocolClasses = [ MockingURLProtocol . self ]
let urlSession = URLSession ( configuration : configuration ) 

alamofire

カスタムURLSessionに登録するのと非常に似ています。

 let configuration = URLSessionConfiguration . af . default
configuration . protocolClasses = [ MockingURLProtocol . self ]
let sessionManager = Alamofire . Session ( configuration : configuration )

モックを登録します

モックされたデータを作成します

モックされたすべてのデータがアクセス可能なクラスを作成することをお勧めします。この例は、このプロジェクトの単体テストにあります。

 public final class MockedData {
    public static let botAvatarImageResponseHead : Data = try ! Data ( contentsOf : Bundle ( for : MockedData . self ) . url ( forResource : " Resources/Responses/bot-avatar-image-head " , withExtension : " data " ) ! )
    public static let botAvatarImageFileUrl : URL = Bundle ( for : MockedData . self ) . url ( forResource : " wetransfer_bot_avater " , withExtension : " png " ) !
    public static let exampleJSON : URL = Bundle ( for : MockedData . self ) . url ( forResource : " Resources/JSON Files/example " , withExtension : " json " ) !
} 

JSONリクエスト

 let originalURL = URL ( string : " https://www.wetransfer.com/example.json " ) !
    
let mock = Mock ( url : originalURL , contentType : . json , statusCode : 200 , data : [
    . get : try ! Data ( contentsOf : MockedData . exampleJSON ) // Data containing the JSON response
] )
mock . register ( )

URLSession . shared . dataTask ( with : originalURL ) { ( data , response , error ) in
    guard let data = data , let jsonDictionary = ( try ? JSONSerialization . jsonObject ( with : data , options : [ ] ) ) as? [ String : Any ] else {
        return
    }
    
    // jsonDictionary contains your JSON sample file data
    // ..
    
} . resume ( ) 

空の応答

 let originalURL = URL ( string : " https://www.wetransfer.com/api/foobar " ) !
var request = URLRequest ( url : originalURL )
request . httpMethod = " PUT "
    
let mock = Mock ( request : request , statusCode : 204 )
mock . register ( )

URLSession . shared . dataTask ( with : originalURL ) { ( data , response , error ) in
    // ....
} . resume ( ) 

クエリを無視します

認証URLのような一部のURLには、クエリにタイムスタンプまたはUUIDが含まれています。これらをock笑するには、特定のURLのクエリを無視できます。

 /// Would transform to "https://www.example.com/api/authentication" for example.
let originalURL = URL ( string : " https://www.example.com/api/authentication?oauth_timestamp=151817037 " ) !
    
let mock = Mock ( url : originalURL , ignoreQuery : true , contentType : . json , statusCode : 200 , data : [
    . get : try ! Data ( contentsOf : MockedData . exampleJSON ) // Data containing the JSON response
] )
mock . register ( )

URLSession . shared . dataTask ( with : originalURL ) { ( data , response , error ) in
    guard let data = data , let jsonDictionary = ( try ? JSONSerialization . jsonObject ( with : data , options : [ ] ) ) as? [ String : Any ] else {
        return
    }
    
    // jsonDictionary contains your JSON sample file data
    // ..
    
} . resume ( ) 

ファイル拡張子

 let imageURL = URL ( string : " https://www.wetransfer.com/sample-image.png " ) !

Mock ( fileExtensions : " png " , contentType : . imagePNG , statusCode : 200 , data : [
    . get : try ! Data ( contentsOf : MockedData . botAvatarImageFileUrl )
] ) . register ( )

URLSession . shared . dataTask ( with : imageURL ) { ( data , response , error ) in
    let botAvatarImage : UIImage = UIImage ( data : data! ) ! // This is the image from your resources.
} . resume ( ) 

カスタムヘッドと応答を取得します

 let exampleURL = URL ( string : " https://www.wetransfer.com/api/endpoint " ) !

Mock ( url : exampleURL , contentType : . json , statusCode : 200 , data : [
    . head : try ! Data ( contentsOf : MockedData . headResponse ) ,
    . get : try ! Data ( contentsOf : MockedData . exampleJSON )
] ) . register ( )

URLSession . shared . dataTask ( with : exampleURL ) { ( data , response , error ) in
	// data is your mocked data
} . resume ( ) 

カスタムデータ型

既に構築された静的DataType実装に加えて、 Content-Typeヘッダーキーの値として使用されるカスタムの実装を作成することができます。

 let xmlURL = URL ( string : " https://www.wetransfer.com/sample-xml.xml " ) !

Mock ( fileExtensions : " png " , contentType : . init ( name : " xml " , headerValue : " text/xml " ) , statusCode : 200 , data : [
    . get : try ! Data ( contentsOf : MockedData . sampleXML )
] ) . register ( )

URLSession . shared . dataTask ( with : xmlURL ) { ( data , response , error ) in
    let sampleXML : Data = data // This is the xml from your resources.
} . resume ( 

応答が遅れました

リクエストのキャンセルが機能しているかどうかをテストしたい場合があります。その場合、mockedリクエストはすぐに終了せず、遅延が必要です。これは簡単に追加できます：

 let exampleURL = URL ( string : " https://www.wetransfer.com/api/endpoint " ) !

var mock = Mock ( url : exampleURL , contentType : . json , statusCode : 200 , data : [
    . head : try ! Data ( contentsOf : MockedData . headResponse ) ,
    . get : try ! Data ( contentsOf : MockedData . exampleJSON )
] )
mock . delay = DispatchTimeInterval . seconds ( 5 )
mock . register ( ) 

応答をリダイレクトします

時々、短いURLまたは他のリダイレクトURLをモックしたい場合があります。これは、応答を保存し、リダイレクトの場所をock笑することで可能です。これは、応答の内部にあります。

 Date: Tue, 10 Oct 2017 07:28:33 GMT
Location: https://wetransfer.com/redirect

短いURLとリダイレクトURLのモックを作成することにより、リダイレクトを模倣してこの動作をテストできます。

 let urlWhichRedirects : URL = URL ( string : " https://we.tl/redirect " ) !
Mock ( url : urlWhichRedirects , contentType : . html , statusCode : 200 , data : [ . get : try ! Data ( contentsOf : MockedData . redirectGET ) ] ) . register ( )
Mock ( url : URL ( string : " https://wetransfer.com/redirect " ) ! , contentType : . json , statusCode : 200 , data : [ . get : try ! Data ( contentsOf : MockedData . exampleJSON ) ] ) . register ( ) 

URLを無視します

モッカーが登録時にデフォルトですべてのURLをキャッチすると、モックされたリクエストが必要ない場合に投げられるfatalErrorになってしまう可能性があります。その場合、URLを無視できます。

 let ignoredURL = URL ( string : " https://www.wetransfer.com " ) !

// Ignore any requests that exactly match the URL
Mocker . ignore ( ignoredURL )

// Ignore any requests that match the URL, with any query parameters
// e.g. https://www.wetransfer.com?foo=bar would be ignored
Mocker . ignore ( ignoredURL , matchType : . ignoreQuery )

// Ignore any requests that begin with the URL
// e.g. https://www.wetransfer.com/api/v1 would be ignored
Mocker . ignore ( ignoredURL , matchType : . prefix )

ただし、モックされたURLのみをキャッチし、他のすべてのURLを無視するためにモッカーが必要な場合は、 mode属性を.optinに設定できます。

 Mocker . mode = . optin

元のモードを元に戻す場合は、 .optoutに設定するだけです。

 Mocker . mode = . optout

模擬エラー

Mockを要求してエラーを返すことができ、エラー処理のテストを可能にします。

 Mock ( url : originalURL , contentType : . json , statusCode : 500 , data : [ . get : Data ( ) ] ,
     requestError : TestExampleError . example ) . register ( )

URLSession . shared . dataTask ( with : originalURL ) { ( data , urlresponse , err ) in
    XCTAssertNil ( data )
    XCTAssertNil ( urlresponse )
    XCTAssertNotNil ( err )
    if let err = err {
        // there's not a particularly elegant way to verify an instance
        // of an error, but this is a convenient workaround for testing
        // purposes
        XCTAssertEqual ( " example " , String ( describing : err ) )
    }

    expectation . fulfill ( )
} . resume ( ) 

モックコールバック

Mockコールバックに登録して、テストを容易にすることができます。

 var mock = Mock ( url : request . url! , contentType : . json , statusCode : 200 , data : [ . post : Data ( ) ] )
mock . onRequestHandler = OnRequestHandler ( httpBodyType : [ [ String : String ] ] . self , callback : { request , postBodyArguments in
    XCTAssertEqual ( request . url , mock . request . url )
    XCTAssertEqual ( expectedParameters , postBodyArguments )
    onRequestExpectation . fulfill ( )
} )
mock . completion = {
    endpointIsCalledExpectation . fulfill ( )
}
mock . register ( ) 

模擬期待

completionとonRequest設定する代わりに、期待を利用することもできます。

 var mock = Mock ( url : url , contentType : . json , statusCode : 200 , data : [ . get : Data ( ) ] )
let requestExpectation = expectationForRequestingMock ( & mock )
let completionExpectation = expectationForCompletingMock ( & mock )
mock . register ( )

URLSession . shared . dataTask ( with : URLRequest ( url : url ) ) . resume ( )

wait ( for : [ requestExpectation , completionExpectation ] , timeout : 2.0 )

Unregister Mocks

登録されているすべてのモックをクリアします

登録されたすべての模擬をクリアできます：

 Mocker . removeAll ( ) 

コミュニケーション

• バグが見つかった場合は、問題を開きます。
• 機能リクエストがある場合は、問題を開きます。
• 貢献したい場合は、プルリクエストを送信してください。

インストール

カルタゴ

Carthageは、依存関係を構築し、バイナリフレームワークを提供する分散型依存関係マネージャーです。

次のコマンドを使用して、HomeBrewでCarthageをインストールできます。

$ brew update
$ brew install carthage

Carthageを使用してモッカーをXcodeプロジェクトに統合するには、 Cartfileで指定します。

 github "WeTransfer/Mocker" ~> 3.0.0

carthage update実行してフレームワークを構築し、構築されたMocker.framework Xcodeプロジェクトにドラッグします。

Swiftパッケージマネージャー

Swift Package Managerは、Swiftコードの配布を管理するためのツールです。 Swiftビルドシステムと統合されて、依存関係のダウンロード、コンパイル、リンクのプロセスを自動化します。

マニフェストファイル

Package.swiftファイルにパッケージとしてモッカーを追加し、使用するターゲットの依存関係として指定します。

import PackageDescription

let package = Package (
    name : " MyProject " ,
    platforms : [
       . macOS ( . v10_15 )
    ] ,
    dependencies : [
        . package ( url : " https://github.com/WeTransfer/Mocker.git " , . upToNextMajor ( from : " 3.0.0 " ) )
    ] ,
    targets : [
        . target (
            name : " MyProject " ,
            dependencies : [ " Mocker " ] ) ,
        . testTarget (
            name : " MyProjectTests " ,
            dependencies : [ " MyProject " ] ) ,
    ]
) 

Xcode

Xcodeプロジェクトへの依存関係としてモッカーを追加するには、 [ファイル]> [Swiftパッケージ]> [パッケージの依存関係の追加]を選択し、リポジトリURLを入力します。

ビルドエラーの解決

次のエラーが発生した場合： Auto-Link Library XCTESTとXCTESTSWIFTSUPPORTが見つからない場合は、NOからYEにビルドオプションの下に次のプロパティを設定します。
enable_testing_search_paths to yes

手動で

前述の依存関係マネージャーを使用したくない場合は、モッカーをプロジェクトに手動で統合できます。

組み込みフレームワーク

• 端末を開き、 cdトップレベルのプロジェクトディレクトリに開き、次のコマンドを実行します。

  $ git init

• 次のコマンドを実行して、gitサブモジュールとしてモッカーを追加します。

  $ git submodule add https://github.com/WeTransfer/Mocker.git

• 新しいMockerフォルダーを開き、 Mocker.xcodeprojアプリケーションのXCodeプロジェクトのプロジェクトナビゲーターにドラッグします。

  アプリケーションのBlue Projectアイコンの下にネストされているように見えます。他のすべてのXcodeグループの上または下にあるかどうかは重要ではありません。

• プロジェクトナビゲーターでMocker.xcodeproj選択し、アプリケーションターゲットの展開ターゲットと一致する展開ターゲットを確認します。

• 次に、Project Navigator（Blue Project Icon）でアプリケーションプロジェクトを選択して、ターゲット構成ウィンドウに移動し、サイドバーの「ターゲット」の下のアプリケーションターゲットを選択します。

• そのウィンドウの上部にあるタブバーで、「一般」パネルを開きます。

• 「埋め込まれたバイナリ」セクションの下の+ボタンをクリックします。

• Mocker.frameworkを選択します。

• そしてそれだけです！

  Mocker.framework 、シミュレーターとデバイスに基づいてビルドするために必要なコピーファイルビルドフェーズに、ターゲット依存性、リンクされたフレームワーク、組み込みフレームワークとして自動的に追加されます。

---

ノートをリリースします

変更のリストについては、changelog.mdを参照してください。

ライセンス

モッカーはMITライセンスの下で利用できます。詳細については、ライセンスファイルを参照してください。