Paparazziを使って、実機を使わずにスナップショットを取る

Created at Sun, Feb 28, 2021

今回は、Paparazzi の使い方について紹介します。

また、今回の記事のサンプルコードは github/satoshun/paparazzi にあります。

Paparazzi?

square社がメンテしているライブラリです。これを使うことで、実機を使わずにスナップショットを取ることが出来ます。

使い方

トップのbuild.gradleにGradleプラグインをセットします。

buildscript {
  repositories {
    mavenCentral()
    google()
  }
  dependencies {
    classpath 'app.cash.paparazzi:paparazzi-gradle-plugin:0.7.0'
  }
}

ライブラリのbuild.gradleにプラグインを適用します。

apply plugin: 'app.cash.paparazzi'

これで準備は完了です。

次に、サンプルのレイアウトファイルとして、lib_item.xml を準備したので、これをPaparazziを使ってスナップショットを取る例を紹介します。

class LayoutTest {
  @get:Rule
  var paparazzi = Paparazzi(deviceConfig = DeviceConfig.NEXUS_5)

  @Test
  fun sample() {
    val launch = paparazzi.inflate<LinearLayout>(R.layout.lib_item)
    paparazzi.snapshot(view = launch)
  }
}

Paparazziには、Junit4 Ruleが定義されています。引数には、デバイス情報を指定します。今回は、Nexus5を指定しました。

次に、Paparazziクラスに定義されている、inflate、snapshotメソッドをコールします。これでテストを実行すると、次のようなスナップショット(png)が作成されます。

実機を使わずに、スクリーンショットを取ることが出来ました。

まとめ

結構お手軽に使うことが出来ました。まだAPIが安定していない?そうなので、プロダクションに入れるのは時期尚早かもしれませんが、安定してきたら、試してみるのも良さそうです(こなみかん)

android
test