Migrate Statistics to Compose (#821)

Author: manuelvicnt

app/build.gradle

@@ -77,6 +77,10 @@ android {
         }
     }
 
+    buildFeatures {
+        compose true
+    }
+
     dataBinding {
         enabled = true
         enabledForTests = true
@@ -95,6 +99,10 @@ android {
         exclude 'META-INF/AL2.0'
         exclude 'META-INF/LGPL2.1'
     }
+
+    composeOptions {
+        kotlinCompilerExtensionVersion "$composeVersion"
+    }
 }
 
 /*
@@ -125,6 +133,18 @@ dependencies {
     implementation "androidx.navigation:navigation-fragment-ktx:$navigationVersion"
     implementation "androidx.navigation:navigation-ui-ktx:$navigationVersion"
 
+    // Jetpack Compose
+    implementation "androidx.activity:activity-compose:$activityComposeVersion"
+    implementation "androidx.compose.material:material:$composeVersion"
+    implementation "androidx.compose.animation:animation:$composeVersion"
+    implementation "androidx.compose.ui:ui-tooling-preview:$composeVersion"
+    implementation "androidx.compose.runtime:runtime-livedata:$composeVersion"
+    implementation "androidx.lifecycle:lifecycle-viewmodel-compose:$archLifecycleVersion"
+    implementation "com.google.accompanist:accompanist-appcompat-theme:$accompanistVersion"
+    implementation "com.google.accompanist:accompanist-swiperefresh:$accompanistVersion"
+    debugImplementation "androidx.compose.ui:ui-tooling:$composeVersion"
+    debugImplementation "androidx.compose.ui:ui-test-manifest:$composeVersion"
+
     // Dependencies for local unit tests
     testImplementation "junit:junit:$junitVersion"
     testImplementation "org.hamcrest:hamcrest-all:$hamcrestVersion"
@@ -137,10 +157,12 @@ dependencies {
     testImplementation "androidx.test.espresso:espresso-contrib:$espressoVersion"
     testImplementation "androidx.test.espresso:espresso-intents:$espressoVersion"
     testImplementation "com.google.truth:truth:$truthVersion"
+    testImplementation "androidx.compose.ui:ui-test-junit4:$composeVersion"
 
     // Dependencies for Android unit tests
     androidTestImplementation "junit:junit:$junitVersion"
     androidTestImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutinesVersion"
+    androidTestImplementation "androidx.compose.ui:ui-test-junit4:$composeVersion"
 
     // AndroidX Test - JVM testing
     testImplementation "androidx.test:core-ktx:$androidXTestCoreVersion"

app/src/androidTestMock/java/com/example/android/architecture/blueprints/todoapp/tasks/AppNavigationTest.kt

@@ -16,9 +16,11 @@
 package com.example.android.architecture.blueprints.todoapp.tasks
 
 import android.view.Gravity
+import androidx.compose.ui.test.assertIsDisplayed
+import androidx.compose.ui.test.junit4.createAndroidComposeRule
+import androidx.compose.ui.test.onNodeWithText
 import androidx.drawerlayout.widget.DrawerLayout
 import androidx.navigation.findNavController
-import androidx.test.core.app.ActivityScenario
 import androidx.test.core.app.ApplicationProvider.getApplicationContext
 import androidx.test.espresso.Espresso.onView
 import androidx.test.espresso.Espresso.pressBack
@@ -45,15 +47,13 @@ import com.example.android.architecture.blueprints.todoapp.util.monitorActivity
 import com.example.android.architecture.blueprints.todoapp.util.saveTaskBlocking
 import org.junit.After
 import org.junit.Before
+import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
 
 /**
  * Tests for the [DrawerLayout] layout component in [TasksActivity] which manages
  * navigation within the app.
- *
- * UI tests usually use [ActivityTestRule] but there's no API to perform an action before
- * each test. The workaround is to use `ActivityScenario.launch()` and `ActivityScenario.close()`.
  */
 @RunWith(AndroidJUnit4::class)
 @LargeTest
@@ -64,6 +64,9 @@ class AppNavigationTest {
     // An Idling Resource that waits for Data Binding to have no pending bindings
     private val dataBindingIdlingResource = DataBindingIdlingResource()
 
+    @get:Rule
+    val composeTestRule = createAndroidComposeRule<TasksActivity>()
+
     @Before
     fun init() {
         tasksRepository = ServiceLocator.provideTasksRepository(getApplicationContext())
@@ -96,8 +99,7 @@ class AppNavigationTest {
     @Test
     fun drawerNavigationFromTasksToStatistics() {
         // start up Tasks screen
-        val activityScenario = ActivityScenario.launch(TasksActivity::class.java)
-        dataBindingIdlingResource.monitorActivity(activityScenario)
+        dataBindingIdlingResource.monitorActivity(composeTestRule.activityRule.scenario)
 
         onView(withId(R.id.drawer_layout))
             .check(matches(isClosed(Gravity.START))) // Left Drawer should be closed.
@@ -108,7 +110,7 @@ class AppNavigationTest {
             .perform(navigateTo(R.id.statistics_fragment_dest))
 
         // Check that statistics screen was opened.
-        onView(withId(R.id.statistics_layout)).check(matches(isDisplayed()))
+        composeTestRule.onNodeWithText("You have no tasks.").assertIsDisplayed()
 
         onView(withId(R.id.drawer_layout))
             .check(matches(isClosed(Gravity.START))) // Left Drawer should be closed.
@@ -120,15 +122,12 @@ class AppNavigationTest {
 
         // Check that tasks screen was opened.
         onView(withId(R.id.tasks_container_layout)).check(matches(isDisplayed()))
-        // When using ActivityScenario.launch, always call close()
-        activityScenario.close()
     }
 
     @Test
     fun tasksScreen_clickOnAndroidHomeIcon_OpensNavigation() {
         // start up Tasks screen
-        val activityScenario = ActivityScenario.launch(TasksActivity::class.java)
-        dataBindingIdlingResource.monitorActivity(activityScenario)
+        dataBindingIdlingResource.monitorActivity(composeTestRule.activityRule.scenario)
 
         // Check that left drawer is closed at startup
         onView(withId(R.id.drawer_layout))
@@ -137,26 +136,21 @@ class AppNavigationTest {
         // Open Drawer
         onView(
             withContentDescription(
-                activityScenario
-                    .getToolbarNavigationContentDescription()
+                composeTestRule.activityRule.scenario.getToolbarNavigationContentDescription()
             )
         ).perform(click())
 
         // Check if drawer is open
         onView(withId(R.id.drawer_layout))
             .check(matches(isOpen(Gravity.START))) // Left drawer is open open.
-        // When using ActivityScenario.launch, always call close()
-        activityScenario.close()
     }
 
     @Test
     fun statsScreen_clickOnAndroidHomeIcon_OpensNavigation() {
-        // start up Tasks screen
-        val activityScenario = ActivityScenario.launch(TasksActivity::class.java)
-        dataBindingIdlingResource.monitorActivity(activityScenario)
+        dataBindingIdlingResource.monitorActivity(composeTestRule.activityRule.scenario)
 
         // When the user navigates to the stats screen
-        activityScenario.onActivity {
+        composeTestRule.activityRule.scenario.onActivity {
             it.findNavController(R.id.nav_host_fragment).navigate(R.id.statistics_fragment_dest)
         }
 
@@ -167,26 +161,21 @@ class AppNavigationTest {
         // When the drawer is opened
         onView(
             withContentDescription(
-                activityScenario
-                    .getToolbarNavigationContentDescription()
+                composeTestRule.activityRule.scenario.getToolbarNavigationContentDescription()
             )
         ).perform(click())
 
         // Then check that the drawer is open
         onView(withId(R.id.drawer_layout))
             .check(matches(isOpen(Gravity.START))) // Left drawer is open open.
-        // When using ActivityScenario.launch, always call close()
-        activityScenario.close()
     }
 
     @Test
     fun taskDetailScreen_doubleUIBackButton() {
         val task = Task("UI <- button", "Description")
         tasksRepository.saveTaskBlocking(task)
 
-        // start up Tasks screen
-        val activityScenario = ActivityScenario.launch(TasksActivity::class.java)
-        dataBindingIdlingResource.monitorActivity(activityScenario)
+        dataBindingIdlingResource.monitorActivity(composeTestRule.activityRule.scenario)
 
         // Click on the task on the list
         onView(withText("UI <- button")).perform(click())
@@ -196,32 +185,26 @@ class AppNavigationTest {
         // Confirm that if we click "<-" once, we end up back at the task details page
         onView(
             withContentDescription(
-                activityScenario
-                    .getToolbarNavigationContentDescription()
+                composeTestRule.activityRule.scenario.getToolbarNavigationContentDescription()
             )
         ).perform(click())
         onView(withId(R.id.task_detail_title_text)).check(matches(isDisplayed()))
 
         // Confirm that if we click "<-" a second time, we end up back at the home screen
         onView(
             withContentDescription(
-                activityScenario
-                    .getToolbarNavigationContentDescription()
+                composeTestRule.activityRule.scenario.getToolbarNavigationContentDescription()
             )
         ).perform(click())
         onView(withId(R.id.tasks_container_layout)).check(matches(isDisplayed()))
-        // When using ActivityScenario.launch, always call close()
-        activityScenario.close()
     }
 
     @Test
     fun taskDetailScreen_doubleBackButton() {
         val task = Task("Back button", "Description")
         tasksRepository.saveTaskBlocking(task)
 
-        // start up Tasks screen
-        val activityScenario = ActivityScenario.launch(TasksActivity::class.java)
-        dataBindingIdlingResource.monitorActivity(activityScenario)
+        dataBindingIdlingResource.monitorActivity(composeTestRule.activityRule.scenario)
 
         // Click on the task on the list
         onView(withText("Back button")).perform(click())
@@ -235,7 +218,5 @@ class AppNavigationTest {
         // Confirm that if we click back a second time, we end up back at the home screen
         pressBack()
         onView(withId(R.id.tasks_container_layout)).check(matches(isDisplayed()))
-        // When using ActivityScenario.launch, always call close()
-        activityScenario.close()
     }
 }

app/src/main/java/com/example/android/architecture/blueprints/todoapp/statistics/StatisticsFragment.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 The Android Open Source Project
+ * Copyright (C) 2022 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,39 +19,34 @@ import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
-import androidx.databinding.DataBindingUtil
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.material.Surface
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.ComposeView
+import androidx.compose.ui.platform.ViewCompositionStrategy
 import androidx.fragment.app.Fragment
-import androidx.fragment.app.viewModels
-import com.example.android.architecture.blueprints.todoapp.R
-import com.example.android.architecture.blueprints.todoapp.databinding.StatisticsFragBinding
-import com.example.android.architecture.blueprints.todoapp.util.getViewModelFactory
-import com.example.android.architecture.blueprints.todoapp.util.setupRefreshLayout
+import com.google.accompanist.appcompattheme.AppCompatTheme
 
 /**
  * Main UI for the statistics screen.
  */
 class StatisticsFragment : Fragment() {
 
-    private lateinit var viewDataBinding: StatisticsFragBinding
-
-    private val viewModel by viewModels<StatisticsViewModel> { getViewModelFactory() }
-
     override fun onCreateView(
         inflater: LayoutInflater,
         container: ViewGroup?,
         savedInstanceState: Bundle?
-    ): View? {
-        viewDataBinding = DataBindingUtil.inflate(
-            inflater, R.layout.statistics_frag, container,
-            false
-        )
-        return viewDataBinding.root
-    }
-
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        super.onViewCreated(view, savedInstanceState)
-        viewDataBinding.viewmodel = viewModel
-        viewDataBinding.lifecycleOwner = this.viewLifecycleOwner
-        this.setupRefreshLayout(viewDataBinding.refreshLayout)
+    ): View {
+        return ComposeView(requireContext()).apply {
+            // Dispose of the Composition when the view's LifecycleOwner is destroyed
+            setViewCompositionStrategy(ViewCompositionStrategy.DisposeOnViewTreeLifecycleDestroyed)
+            setContent {
+                AppCompatTheme {
+                    Surface(Modifier.fillMaxSize()) {
+                        StatisticsScreen()
+                    }
+                }
+            }
+        }
     }
 }