ネットワークリクエストをテストする

1. 始める前に

前の Codelab では、Retrofit を使用してネットワークリクエストを行う方法を学習しました。この Codelab では、ネットワークコードの単体テストを作成する方法を学習します。

前提条件

Android Studio でテストディレクトリを作成している
Android Studio で単体テストとインストルメンテーションテストを作成している
Android プロジェクトに Gradle の依存関係を追加している

学習内容

テスト用のリソースを保存する方法
テスト用の API レスポンスをモックする方法
Retrofit API サービスをテストする方法

必要なもの

Android Studio がインストールされているパソコン
Mars Photos アプリの解答コード

この Codelab のスターターコードをダウンロードする

この Codelab では、Mars Photos アプリの解答コードにインストルメンテーションテストを追加します。

この Codelab のコードを取得して Android Studio で開く手順は以下のとおりです。

コードを取得する

指定された URL をクリックします。プロジェクトの GitHub ページがブラウザで開きます。
プロジェクトの GitHub ページで、[Code] ボタンをクリックすると、ダイアログが表示されます。

ダイアログで、[Download ZIP] をクリックして、プロジェクトをパソコンに保存します。ダウンロードが完了するまで待ってください。
パソコンに保存したファイルを見つけます（[ダウンロード] フォルダなど）。
ZIP ファイルをダブルクリックして展開します。プロジェクトファイルが入った新しいフォルダが作成されます。

Android Studio でプロジェクトを開く

Android Studio を起動します。
[Welcome to Android Studio] ウィンドウで [Open an existing Android Studio project] をクリックします。

注: Android Studio がすでに開いている場合は、メニューから [File] > [New] > [Import Project] を選択します。

[Import Project] ダイアログで、展開したプロジェクトフォルダがある場所（[ダウンロード] フォルダなど）に移動します。
そのプロジェクトフォルダをダブルクリックします。
Android Studio でプロジェクトが開くまで待ちます。
実行ボタンをクリックし、アプリをビルドして実行します。正常にビルドされたことを確認します。
[Project] ツールウィンドウでプロジェクトファイルを見て、アプリがどのように設定されているかを確認します。

2. スターターアプリの概要

Mars Photos アプリは、ネットワークリクエストを使用して取得した写真のリストを表示する単一の画面で構成されています。

このスターターコードには、テストに関する微妙な違いが付加されています。この Codelab の範囲外のため詳しくは説明しませんが、この点は重要です。

アプリが API からデータを取得するプロセスをテストする際には、データがどのように表示されるかを確認できるように、常に独自のデータを提供することをおすすめします。API からのデータが変更された場合、テストが中断され、不必要に失敗することがあります。また、実際のネットワーク呼び出しに依存していると、ネットワーク接続やネットワーク速度が原因で障害が生じ、テストの整合性が損なわれる可能性があります。そのため、テストでデータを生成し、test/res ディレクトリに JSON ファイルとして保存します。これはリソースディレクトリで、メインアプリのコードのリソースディレクトリに似ていますが、テストリソースが test/res に格納される点が異なります。

test/res ディレクトリを追加します。プロジェクトビューで src ディレクトリを右クリックし、プルダウンから [New] -> [Directory] を選択します。

表示されたポップアップで下にスクロールして、test/res を選択します。

プロジェクトビューで test/res ディレクトリを右クリックし、[New] -> [File] を選択します。

ファイル名を mars_photos.json とします。

次のコードを mars_photos.json ファイルにコピーします。

[
 {
   "id":"424905",
   "img_src":"http://mars.jpl.nasa.gov/msl-raw-images/msss/01000/mcam/1000MR0044631300503690E01_DXXX.jpg"
 },
 {
   "id":"424906",
   "img_src":"http://mars.jpl.nasa.gov/msl-raw-images/msss/01000/mcam/1000ML0044631300305227E03_DXXX.jpg"
 }
]

このリソースディレクトリのファイルにアクセスするには、ビルドファイルでテストリソースディレクトリを「ソース」ディレクトリとして明示的に指定する必要があります。それには次の行を追加します。

`app/build.gradle`

android {
    ...
    sourceSets {
       test.resources.srcDirs += 'src/test/res'
    }
}

これにより、テストでアクセスするたびにファイルへのフルパスをコードに入力することなく、リソースファイルにアクセスできるようになります。ファイルパスはマシンとオペレーティングシステムの間で変更される可能性があるため、テストでフルパスを入力することはおすすめしません。

同じファイルに次の依存関係を追加し、Gradle を同期します。

`app/build.gradle`

dependencies {
    ...
    testImplementation 'junit:junit:4.12'
    testImplementation "androidx.arch.core:core-testing:2.1.0"
    testImplementation "com.squareup.okhttp3:mockwebserver:4.9.1"
}

通常のテストディレクトリを作成します。

テストディレクトリで、新しいパッケージ com.example.android.marsphotos を作成します。
パッケージ内で、BaseTest.kt という名前の新しい Kotlin ファイルを作成します。

次のコードをコピーして BaseTest.kt ファイルに貼り付けます。このようなコードは見たことがないかもしれませんが、問題ありません。以下のコードでは「Mock」という用語が繰り返し使用されていますが、これについてはこの Codelab で説明します。このクラスの enqueue() 関数は、作成した mars_photos.json ファイルのデータを解析して、後で作成するテストで使用できるようにします。

`BaseTest.kt`

import okhttp3.mockwebserver.MockResponse
import okhttp3.mockwebserver.MockWebServer
import okio.buffer
import okio.source

open class BaseTest {

   val mockWebServer = MockWebServer()

   fun enqueue(fileName: String) {
       val inputStream = javaClass.classLoader!!.getResourceAsStream(fileName)
       val buffer = inputStream.source().buffer()

       mockWebServer.enqueue(
           MockResponse()
               .setResponseCode(200)
               .setBody(buffer.readString(Charsets.UTF_8))
       )
   }
}

3.データのモック

この Codelab では、データのモックに大きく依存します。テストにおけるモックとは、コードの戻り値をシミュレートすることを意味します。前の Codelab では、クラスをモックしました。また、関数をモックして指定した値を返したり、API をモックして指定したデータを返したりすることもできます。モックすることでテスト対象のコードを分離できるため、テストに役立ちます。この Codelab では、API レスポンスのモックに焦点を当てます。関数のモックについては別の Codelab で説明します。

4. 単体テストクラスを作成する

このテストでは API サービスをテストします。まず、MarsApiServiceTests.kt という名前の新しいクラスを作成します。

5. 依存関係

この Codelab のスターターコードには必要な依存関係が含まれていますが、まだ説明していない重要な依存関係が存在します。

testImplementation "com.squareup.okhttp3:mockwebserver:4.9.1"

この依存関係により、モックサーバーを作成できます。基本的に、モックサーバーはネットワークリクエストをインターセプトし、定義したモックデータを返すようにルートを変更します。モックの意味については、この Codelab の後半で説明します。

6. おすすめの方法

このテストは、オブジェクト指向のプログラミング言語である Kotlin で記述します。つまり、テスト用のオブジェクト指向コードを記述できます。このテスト用に記述するコード量はそれほど多くないため、本来はオブジェクト指向の手法を使用する必要はありませんが、ここではコンセプトを説明するために実装します。

スターターコードにすでに単体テストディレクトリが含まれており、その中に BaseTest というクラスがあることにお気づきでしょうか。複数のテストに使用するコードがある場合は、open class を作成してテストクラスに継承させることができます。この BaseTest クラスには enqueue() というメソッドが 1 つしかないため、この Codelab では 1 つのテストクラスのみを作成します。独自のテストを作成するときは、オブジェクト指向プログラミングを使用できることを忘れないでください。ただし、必要のない場合に使いすぎないことが重要です。

7. ネットワークリクエストのテストを作成する

まず、テストクラスが BaseTest から継承していることを確認します。

MarsApiService を直接テストするため、そのインスタンスが必要です。アプリコードの場合と同じように設定しますが、この新しいサービスの URL は異なります。

テストクラスで、MarsApiService の lateinit 変数を作成します。

private lateinit var service: MarsApiService

次に、すべてのテストの前に service 変数を定義する関数が必要です。

setup() という関数を作成し、@Before アノテーションを付けます。

@Before
fun setup() {}

このテストでは、ネットワークリクエストに URL を使用しません。そこで役立つのが MockWebServer です。

データのモック

BaseTest クラスには、MockWebServer オブジェクトのインスタンスである mockWebServer, というプロパティがあります。このオブジェクトはネットワークリクエストをインターセプトしますが、まず、インターセプトする URL にネットワークリクエストをルーティングする必要があります。

MockWebServer には、インターセプトする URL を指定する url() という関数があります。ここでは実際のネットワークリクエストは作成しません。テスト自体で制御するデータを使ってネットワークコードをテストできるように、擬似的にネットワークリクエストを作成します。url() 関数はその疑似 URL を表す文字列を受け取り、HttpUrl オブジェクトを返します。setup() 関数に、次の行を記述します。

val url = mockWebServer.url("/")

インターセプトする URL エンドポイントを設定し、返された HttpUrl オブジェクトを取得しました。

この関数内で、MarsApiService と MarsApiClass の場合と同じ方法で（lazy 変数を除く）MarsApiService のインスタンスを作成します。ベース URL はまだ含めないでください。コードは次のようになります。

service = Retrofit.Builder()
   .addConverterFactory(MoshiConverterFactory.create(
       Moshi.Builder()
           .add(KotlinJsonAdapterFactory())
           .build()
   ))
   .build()
   .create(MarsApiService::class.java)

次に、ベース URL を設定します。Retrofit.Builder() の関数チェーンに次のコードを追加します。

.baseUrl(url)

これにより、リクエストを MockWebServer にルーティングすることを API サービスに示します。

service = Retrofit.Builder()
   .baseUrl(url)
   .addConverterFactory(MoshiConverterFactory.create(
       Moshi.Builder()
           .add(KotlinJsonAdapterFactory())
           .build()
   ))
   .build()
   .create(MarsApiService::class.java)

ここでも、MockWebServer のポイントは、実際の API に対して実際のネットワークリクエストを行わないようにすることです。基本的な考え方は、実際のネットワークリクエストが行われて API が失敗した場合、テストが不合格になるということです。実際の API を使用する場合、API 自体をテストすることになりますが、ここでの目的はあくまで、Android プロジェクトでコードをテストすることです。

MockWebServer は、作成したデータを返す疑似 API と考えることができます。そのため、リクエストを行う前に、何を返すべきかを MockWebServer に明示的に指定する必要があります。そこで出てくるのが、BaseTest の enqueue() 関数です。この関数のコードはこの Codelab の範囲外ですので、心配する必要はありません。この関数が、テストリソースからファイルを取得して、疑似 API レスポンスに変換することだけを理解しておいてください。

api_service() というテスト関数を作成します。テスト関数で、次のように enqueue メソッドを呼び出します。

enqueue("mars_photos.json")

次に、MarsApiService から直接 getPhotos() 関数を呼び出します。getPhotos() は suspend 関数であり、コルーチンスコープから呼び出す必要があることにご注意ください。そのためには、次のように、runBlocking のメソッドの呼び出しをラップします。

runBlocking {
    val apiResponse = service.getPhotos()
}

ここで、getPhotos() レスポンスが null でないことを確認します。apiResponse を runBlocking 内で定義したため、runBlocking 内でもアクセスする必要があります。

runBlocking {
    val apiResponse = service.getPhotos()
    assertNotNull(apiResponse)
}

getPhotos() は MarsPhoto オブジェクトを含むリストを返すため、リストが期待どおりのサイズであることを確認します。

test/res の mars_photos.json ファイルを調べます。リストが空でないことを確認するために、別のアサーションを作成します。また、データの一部が正しいことを確認するためのアサーションも作成します。test/res/mars_photos.json に移動し、いずれかの ID をコピーします。この ID の値が、対応するリストアイテムの ID の値と等しいことのアサーションを行います。

runBlocking {
   val apiResponse = service.getPhotos()

   assertNotNull(apiResponse)
   assertTrue("The list was empty", apiResponse.isNotEmpty())
   assertEquals("The IDs did not match", "424905", apiResponse[0].id)
}

テストコードは次のようになります。

8. 解答コード

9. 完了

ネットワークリクエストのテストは非常に複雑になる場合があり、この Codelab で学習した内容はほんの一部にすぎません。アプリがデータを取得する API ごとに、固有のネットワークテストを作成する必要があります。API の操作に慣れてきたら、テストを拡張してネットワーク障害やさまざまな API レスポンスをシミュレートできます。これはテストの中でも非常に難しい領域ですが、エキスパートになるには試行錯誤が必要です。ぜひ練習を続けてください。

この Codelab では次のことを学びました。

オブジェクト指向プログラミングをテストに適用する方法
テストディレクトリにリソースを格納する方法
テストで suspend 関数を呼び出す方法
テストで API レスポンスをモックする方法

ネットワーク リクエストをテストする

1. 始める前に

前提条件

学習内容

必要なもの

この Codelab のスターター コードをダウンロードする

コードを取得する

Android Studio でプロジェクトを開く

2. スターター アプリの概要

app/build.gradle

app/build.gradle

BaseTest.kt

3.データのモック

4. 単体テストクラスを作成する

5. 依存関係

6. おすすめの方法

7. ネットワーク リクエストのテストを作成する

データのモック

8. 解答コード

9. 完了

ネットワークリクエストをテストする

この Codelab のスターターコードをダウンロードする

2. スターターアプリの概要

`app/build.gradle`

`app/build.gradle`

`BaseTest.kt`

7. ネットワークリクエストのテストを作成する