ヘルスコネクト テスト ライブラリを使用して単体テストを作成する

ヘルスコネクト テスト ライブラリ（androidx.health.connect:connect-testing） 自動テストの作成を簡素化できます。このライブラリを使用すると、アプリの動作を確認したり、手動でテストするのが難しいまれなケースにアプリが正しく応答することを検証したりできます。

このライブラリを使用して、ローカル単体テストを作成できます。通常、このテストは、 ヘルスコネクトとやり取りするアプリ内のクラスの動作 できます。

ライブラリの使用を開始するには、テストの依存関係としてライブラリを追加します。

 testImplementation("androidx.health.connect:connect-testing:1.0.0-alpha01")

ライブラリへのエントリ ポイントは FakeHealthConnectClient クラスです。このクラスは、テストで HealthConnectClient の代わりに使用します。FakeHealthConnectClient には次の機能があります。

  • レコードのインメモリ表現。挿入、削除、削除、 読む
  • 変更トークンの生成と変更のトラッキング
  • レコードと変更のページ分け
  • 集計レスポンスはスタブでサポートされています
  • 任意の関数が例外をスローできるようにする
  • 権限チェックのエミュレートに使用できる FakePermissionController

テストの依存関係を置き換える方法について詳しくは、以下をご覧ください。 Android での依存関係インジェクション。フェイクについて詳しくは、 Android でテストダブルを使用する。

たとえば、クライアントとやり取りするクラスの名前が HealthConnectManager であり、依存関係として HealthConnectClient を受け取ると、 次のようになります。

class HealthConnectManager(
    private val healthConnectClient: HealthConnectClient,
    ...
) { }

テストでは、代わりにテスト対象のクラスにフェイクを渡すことができます。

import androidx.health.connect.client.testing.ExperimentalTestingApi
import androidx.health.connect.client.testing.FakeHealthConnectClient
import kotlinx.coroutines.test.runTest

@OptIn(ExperimentalTestingApi::class)
class HealthConnectManagerTest {

    @Test
    fun readRecords_filterByActivity() = runTest {
        // Create a Fake with 2 running records.
        val fake = FakeHealthConnectClient()
        fake.insertRecords(listOf(fakeRunRecord1, fakeBikeRecord1))

        // Create a manager that depends on the fake.
        val manager = HealthConnectManager(fake)

        // Read running records only.
        val runningRecords = manager.fetchReport(activity = Running)

        // Verify that the records were filtered correctly.
        assertTrue(runningRecords.size == 1)
    }
}

このテストでは、架空の fetchReport 関数が HealthConnectManager で、アクティビティを基準にレコードが適切にフィルタされるようになりました。

例外の検証

HealthConnectClient の呼び出しのほとんどで例外がスローされる可能性があります。たとえば、insertRecords のドキュメントには、次の例外が記載されています。

  • @throws android.os.RemoteException（IPC 転送エラーの場合）。
  • @throws SecurityException: 許可されていないアクセスのリクエスト。
  • @throws java.io.IOException（ディスク I/O の問題の場合）。

この例外は、接続が不安定であったり、スペースが残っていない場合や、 ダウンロードしますこれらのランタイムの問題はいつでも発生する可能性があるため、アプリはこれらの問題に適切に対応する必要があります。

import androidx.health.connect.client.testing.stubs.stub

@Test
fun addRecords_throwsRemoteException_errorIsExposed() {
    // Create Fake that throws a RemoteException
    // when insertRecords is called.
    val fake = FakeHealthConnectClient()
    fake.overrides.insertRecords = stub { throw RemoteException() }

    // Create a manager that depends on the fake.
    val manager = HealthConnectManager(fake)

    // Insert a record.
    manager.addRecords(fakeRunRecord1)

    // Verify that the manager is exposing an error.
    assertTrue(manager.errors.size == 1)
}

集計

集約呼び出しに偽の実装はありません。代わりに、集計関数を使用して スタブを使用して、特定の動作をするようにプログラムできます。こちらの スタブに FakeHealthConnectClient の overrides プロパティを使用。

たとえば、特定の結果を返すように集計関数をプログラムできます。

import androidx.health.connect.client.testing.AggregationResult
import androidx.health.connect.client.records.HeartRateRecord
import androidx.health.connect.client.records.ExerciseSessionRecord
import java.time.Duration

@Test
fun aggregate() {
    // Create a fake result.
    val result =
        AggregationResult(metrics =
            buildMap {
                put(HeartRateRecord.BPM_AVG, 74.0)
                put(
                    ExerciseSessionRecord.EXERCISE_DURATION_TOTAL,
                    Duration.ofMinutes(30)
                )
            }
        )

    // Create a fake that always returns the fake
    // result when aggregate() is called.
    val fake = FakeHealthConnectClient()
    fake.overrides.aggregate = stub(result)

次に、テスト対象のクラス（この場合は HealthConnectManager）が結果を正しく処理したことを確認できます。

// Create a manager that depends on the fake.
val manager = HealthConnectManager(fake)
// Call the function that in turn calls aggregate on the client.
val report = manager.getHeartRateReport()

// Verify that the manager is exposing an error.
assertThat(report.bpmAverage).isEqualTo(74.0)

権限

テスト ライブラリには FakePermissionController が含まれており、これは FakeHealthConnectClient への依存関係として指定します。

テスト対象は、PermissionController—through HealthConnectClient インターフェースの permissionController プロパティ。 ご確認ください。通常、これはクライアントへの呼び出しの前に行う必要があります。

この機能をテストするには、FakePermissionController を使用して使用可能な権限を設定します。

import androidx.health.connect.client.testing.FakePermissionController

@Test
fun newRecords_noPermissions_errorIsExposed() {
    // Create a permission controller with no permissions.
    val permissionController = FakePermissionController(grantAll = false)

    // Create a fake client with the permission controller.
    val fake = FakeHealthConnectClient(permissionController = permissionController)

    // Create a manager that depends on the fake.
    val manager = HealthConnectManager(fake)

    // Call addRecords so that the permission check is made.
    manager.addRecords(fakeRunRecord1)

    // Verify that the manager is exposing an error.
    assertThat(manager.errors).hasSize(1)
}

ページ分け

ページネーションはバグの非常に一般的な原因であるため、FakeHealthConnectClient には、レコードと変更のページネーション実装が正しく動作することを確認するためのメカニズムが用意されています。

テスト対象（この例では HealthConnectManager）は、 ReadRecordsRequest のページサイズ:

fun fetchRecordsReport(pageSize: Int = 1000) }
    val pagedRequest =
        ReadRecordsRequest(
            timeRangeFilter = ...,
            recordType = ...,
            pageToken = page1.pageToken,
            pageSize = pageSize,
        )
    val page = client.readRecords(pagedRequest)
    ...

ページサイズを 2 などの小さい値に設定すると、ページネーションを簡単にテストできます。たとえば、5 つのレコードを挿入して、readRecords が 3 つの異なるページを返すようにします。

@Test
fun readRecords_multiplePages() = runTest {

    // Create a Fake with 2 running records.
    val fake = FakeHealthConnectClient()
    fake.insertRecords(generateRunningRecords(5))

    // Create a manager that depends on the fake.
    val manager = HealthConnectManager(fake)

    // Read records with a page size of 2.
    val report = manager.generateReport(pageSize = 2)

    // Verify that all the pages were processed correctly.
    assertTrue(report.records.size == 5)
}

テストデータ

このライブラリには、偽のデータを生成するための API はまだ含まれていませんが、Android Code Search でライブラリで使用されているデータと生成ツールを使用できます。

スタブ

FakeHealthConnectClient の overrides プロパティを使用すると、呼び出されたときに例外をスローするように関数をプログラム（またはスタブアウト）できます。集計呼び出しでは任意のデータを返すこともでき、 複数回答が返されます詳細については、Stub と MutableStub をご覧ください。

エッジケースの概要

  • クライアントが例外をスローしたときに、アプリが想定どおりに動作することを確認します。各関数のドキュメントで、チェックする必要がある例外を確認します。
  • クライアントに対して行うすべての呼び出しの前に、必ず適切な 許可チェックを行います。
  • ページネーションの実装を確認します。
  • 複数のページを取得したときに 1 つの有効期限が切れている場合 あります。