Share
Embed
Activity/Fragment単位でVisual Regression Testingを実行する
MAO YUFENG
July 14, 2020
Transcript
57 slides
-
CL AndroidでやっているVRTの流れ Screenshot Firebase Test Lab Instrumented Test REG SUIT
Cloud Storage VRT Github Report -
CL AndroidでやっているVRTの流れ Screenshot Firebase Test Lab Instrumented Test REG SUIT
Cloud Storage VRT Github Report どうスクリーンショットを 撮っているかを話す -
View層はテスト対象 Activity/ Fragment Layout(XML) ViewModel Repository LiveData View層 どれを選べばいいでしょう •
Layout(XML) • Activity/Fragment -
Layoutをテスト対象に UIの状態をいじるコードのメンテーが大変そう • テスト分 • Activity/Fragment分 DataBindingうまく使えば、⬆統一できそう が、結構チャレンジ Activity/ Fragment
Layout(XML) ViewModel Repository LiveData -
例:Activity class MyActivity : AppCompatActivity() { // Extension fun from
activity-ktx private val viewModel by viewModels<MyViewModel>() override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.my_layout) viewModel.itemsLiveData.observe(this) { // Bind data to UI } } } MyActivity.kt -
ActivityScenarioでスクリーンショットを撮る @Test fun screenshot() { // TODO: 撮りたいUI状態を作る ActivityScenario.launch(MyActivity::class.java) //
Screenshotのライブラリを使う // Dialogなど撮れるFalconおすすめ https://github.com/jraska/Falcon takeScreenshot("MyActivity") } MyActivityScreenshot.kt -
例:ViewModel class MyViewModel( private val repository: Repository ) : ViewModel()
{ // UIの状態を持つ val itemsLiveData = MutableLiveData<List<Item>>() fun loadItems() { itemsLiveData.value = repository.getItems() } } MyViewModel.kt -
Activity内ViewModelをインスタンス化 MyActivity.kt class MyActivity : AppCompatActivity() { private val viewModel
by viewModels<MyViewModel>() override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // ... } } -
ViewModelFactoryをDIする MyActivity.kt class MyActivity : AppCompatActivity() { private val viewModel
by viewModels<MyViewModel> { myViewModelFactory } @Inject lateinit var myViewModelFactory: ViewModelProvider.Factory override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // DaggerでMemberInjectionする DaggerMyComponent.builder() .build() .inject(this) } } ActivityにInjectする ViewModelFactoryをモックしたもの に差し替えできれば、適切なUI状態が 作れる -
MemberInjectionの問題 MemberInjectionを使っていると、普通に Daggerで構成されたGraphで依存解決され て、モックされたではない依存がinjectされ てテストが実行されてしまう (DaggerHilt, Koinなどを使うとこの問題無いかも) override fun onCreate(savedInstanceState:
Bundle?) { super.onCreate(savedInstanceState) DaggerMyComponent.builder() .build() .inject(this) } -
MemberInjectionの問題 テストの時自由に ViewModelFactoryを Injectしたい! override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState)
if (screenshotTest) { // モックをInjectする } else { DaggerMyComponent.builder() .build() .inject(this) } } -
MemberInjectionの解決案:InjectorWrapper class InjectorWrapper<T : Any>( private val defaultInjector: (T) ->
Unit // DaggerのInjector ) { fun inject(target: T) { defaultInjector.invoke(target) } } -
InjectorWrapper class InjectorWrapper<T : Any>( private val targetClass: Class<T>, private
val defaultInjector: (T) -> Unit // DaggerのInjector ) { fun inject(target: T) { val injector = injectorDelegateMap[targetClass] ?: defaultInjector injector.invoke(target) } companion object { private val injectorDelegateMap = mutableMapOf<Class<*>, (Any) -> Unit>() // Test用のInjector @VisibleForTesting fun <T> setDelegate(targetClass: Class<T>, injector: (T) -> Unit) { @Suppress("UNCHECKED_CAST") injectorDelegateMap[targetClass] = { injector.invoke(it as T) } } } } -
InjectorWrapper class InjectorWrapper<T : Any>( private val targetClass: Class<T>, private
val defaultInjector: (T) -> Unit // DaggerのInjector ) { fun inject(target: T) { val injector = injectorDelegateMap[targetClass] ?: defaultInjector injector.invoke(target) } companion object { private val injectorDelegateMap = mutableMapOf<Class<*>, (Any) -> Unit>() // Test用のInjector @VisibleForTesting fun <T> setDelegate(targetClass: Class<T>, injector: (T) -> Unit) { @Suppress("UNCHECKED_CAST") injectorDelegateMap[targetClass] = { injector.invoke(it as T) } } } } テスト用InjectorをMapに保存する -
InjectorWrapper class InjectorWrapper<T : Any>( private val targetClass: Class<T>, private
val defaultInjector: (T) -> Unit // DaggerのInjector ) { fun inject(target: T) { val injector = injectorDelegateMap[targetClass] ?: defaultInjector injector.invoke(target) } companion object { private val injectorDelegateMap = mutableMapOf<Class<*>, (Any) -> Unit>() // Test用のInjector @VisibleForTesting fun <T> setDelegate(targetClass: Class<T>, injector: (T) -> Unit) { @Suppress("UNCHECKED_CAST") injectorDelegateMap[targetClass] = { injector.invoke(it as T) } } } } テストInjectorあれば使う、無いならデフォルトの使う -
ActivityでInjectorWrapperを使う override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) val component =
DaggerMyComponent.builder() .build() // MyActivityをkeyに、DaggerのInjectorをデフォルトのInjectorに InjectorWrapper(MyActivity::class.java, component::inject) .inject(this) } After -
テスト依存をInjectorWrapperに設定する After @Test fun screenshot() { // 撮りたいUI状態持つViewModelFactoryをInjectorWrapperに設定する InjectorWrapper.setDelegate(MyActivity::class.java) {
activity -> activity.myViewModelFactory = mockMyViewModelFactory() } ActivityScenario.launch(MyActivity::class.java) takeScreenshot("MyActivity") } -
適切な状態持つViewModelを作る // MockKを例に https://mockk.io/ fun mockMyViewModelFactory( items: List<Item> = emptyList()
): ViewModelProvider.Factory { val viewModel = MyViewModel(mockk()) // spyが必要で、後説明する val spyViewModel = spyk(viewModel) { every { itemsLiveData } returns MutableLiveData(items) every { loadItems() } just runs } return object : ViewModelProvider.Factory { override fun <T : ViewModel?> create(modelClass: Class<T>): T { @Suppress("UNCHECKED_CAST") return spyViewModel as T } } } -
適切な状態持つViewModelを作る // MockKを例に https://mockk.io/ fun mockMyViewModelFactory( items: List<Item> = emptyList()
): ViewModelProvider.Factory { val viewModel = MyViewModel(mockk()) // spyが必要で、後説明する val spyViewModel = spyk(viewModel) { every { itemsLiveData } returns MutableLiveData(items) every { loadItems() } just runs } return object : ViewModelProvider.Factory { override fun <T : ViewModel?> create(modelClass: Class<T>): T { @Suppress("UNCHECKED_CAST") return spyViewModel as T } } } -
モック作る時の注意点 • モックライブラリのmockはジェネリックスと相性悪い、spyを使う • API 27以下のInstrumented Testで、モックライブラリはfinal class が対応できない、allopenプラグインを使う //
androidx.lifecycle.ViewModel <T> T setTagIfAbsent(String key, T newValue) https://github.com/mockk/mockk/blob/master/ANDROID.md https://kotlinlang.org/docs/reference/compiler-plugins.html plugins { id "org.jetbrains.kotlin.plugin.allopen" version "1.3.72" } -
EspressoによるUI操作 takeScreenshot("MyActivity-1") Espresso.onView(ViewMatchers.withId(R.id.recycler_view)) .perform( RecyclerViewActions .scrollToPosition<RecyclerView.ViewHolder>(3) ) takeScreenshot("MyActivity-2") Espresso.onView(ViewMatchers.withId(R.id.recycler_view)) .perform(
RecyclerViewActions .scrollToPosition<RecyclerView.ViewHolder>(6) ) takeScreenshot("MyActivity-3") -
EspressoによるUI操作 takeScreenshot("MyActivity-1") Espresso.onView(ViewMatchers.withId(R.id.recycler_view)) .perform( RecyclerViewActions .scrollToPosition<RecyclerView.ViewHolder>(3) ) takeScreenshot("MyActivity-2") Espresso.onView(ViewMatchers.withId(R.id.recycler_view)) .perform(
RecyclerViewActions .scrollToPosition<RecyclerView.ViewHolder>(6) ) takeScreenshot("MyActivity-3") 面倒だ!楽にしたい! -
ViewTreeを探索して自動操作する AppBarLayout CoordinatorLayout ViewPager RecyclerView 1 RecyclerView 2 CoordinatorLayout •
スクリーンショット • AppBarLayoutへ • ViewPagerへ -
ViewTreeを探索して自動操作する AppBarLayout CoordinatorLayout ViewPager RecyclerView 1 RecyclerView 2 ViewPager •
RecyclerView 1へ • RecyclerView 2へ -
自動操作を実装する fun startAutomaticTakeScreenshot(scenario: ActivityScenario) { var rootView: View? = null
// ActivityScenarioからルートViewを取得して走査を始める scenario.onActivity { activity -> rootView = activity.findViewById(android.R.id.content) } dfs(rootView!!) } -
探索関数 fun dfs(view: View) { // Viewのタイプに応じてハンドリングする when (view) {
is AppBarLayout -> handleAppBarLayout(view) is ViewPager -> handleViewPager(view) is RecyclerView -> handleRecyclerView(view) ... } } -
特殊なViewをハンドリングする fun handleViewPager(view: ViewPager) { val startPosition = view.currentItem //
Espressoで各Pageにスクロールする view.forEachIndexed { index, child -> if (index != startPosition) { performAction(view, ViewPagerActions.scrollToPage(index)) } // 現在のページを更に探索する dfs(child) } } ViewPagerの例 -
対象Viewを操作してスクリーンショットを撮る private fun performAction(view: View, viewAction: ViewAction) { // 同じIdもつViewがあり得るので、ユーニークのTagを作る
val tagValue = "view-tree-operator-value-${tagCnt++}" view.setTag(R.id.view_tree_operator_target_tag_key, tagValue) val viewMatcher = ViewMatchers.withTagKey( R.id.view_tree_operator_target_tag_key, CoreMatchers.equalTo(tagValue) ) Espresso.onView(viewMatcher).perform(viewAction) takeScreenshot() } -
テストで自動操作 @Test fun screenshot() { InjectorWrapper.setDelegate(MyActivity::class.java) { activity -> activity.myViewModelFactory
= mockMyViewModelFactory() } ActivityScenario.launch(MyActivity::class.java) takeScreenshot("MyActivity") } Before -
テストで自動操作 @Test fun screenshot() { InjectorWrapper.setDelegate(MyActivity::class.java) { activity -> activity.myViewModelFactory
= mockMyViewModelFactory() } val scenario = ActivityScenario.launch(MyActivity::class.java) startAutomaticTakeScreenshot(scenario) } After -
非同期処理の完成を待つ • CoroutineDispatcher (Executor) をテスト用のものに変える https://qiita.com/takahirom/items/ebf3ae5e38b733904801 • DataBindingのバイディング処理を待つ https://github.com/android/architecture-components-samples/blob/1d7a759f742e8bdaf1eb4531e38ea9270301c577/GithubBrow serSample/app/src/androidTest/java/com/android/example/github/util/DataBindingIdlingResource.kt
• Glideの画像ローディングを待つ https://lcdsmao.dev/synchronize-glide-loading-in-test-with-idlingresource/ -
まとめ VRTに使えるスクリーンショットを撮るために • UI状態作りやすいActivity/Fragmentにした • 適切なUI状態持つViewModelをInjectできるようにInjectorWrapperを 作った • 煩雑なUI操作を避けるためにUI操作とスクリーンショットの自動化を実現し た
• スクリーンショットを安定化するためアニメーション禁止と非同期処理の待 つをした