Add Hilt to the project (#857)

Author: Manuel Vivo

.github/workflows/blueprints.yaml

@@ -35,35 +35,29 @@ jobs:
             ~/.gradle/caches/build-cache-*
           key: gradle-${{ hashFiles('checksum.txt') }}
 
-      - name: Build project Mock and UnitTest
-        run: ./gradlew assembleMockDebug assembleProdDebug compileMockDebugUnitTestKotlin
+      - name: Build project and UnitTest
+        run: ./gradlew assembleDebug compileDebugUnitTestKotlin
 
       - name: Spotless
         run: ./gradlew spotlessCheck
 
-      - name: Robolectric Mock
-        run: ./gradlew testMockDebugUnitTest
-
-      - name: Build project Prod and UnitTest
-        run: ./gradlew assembleMockDebug assembleProdDebug compileProdDebugUnitTestKotlin
-
-      - name: Robolectric Prod
-        run: ./gradlew spotlessCheck assembleMockDebug assembleProdDebug testMockDebugUnitTest testProdDebugUnitTest --stacktrace
+      - name: Robolectric
+        run: ./gradlew testDebugUnitTest
 
       # Needed to accept licenses
       - name: Setup Android SDK
         uses: android-actions/setup-android@v2
 
-      - name: Compile AndroidTests Mock
-        run: ./gradlew compileMockDebugAndroidTestKotlin
+      - name: Compile AndroidTests
+        run: ./gradlew compileDebugAndroidTestKotlin
 
       - name: Run all tests pixel 2 api 30 ATD
         working-directory: .
-        run: ./gradlew -Pandroid.sdk.channel=3 -Pandroid.experimental.androidTest.numManagedDeviceShards=1 -Pandroid.testoptions.manageddevices.emulator.gpu="swiftshader_indirect" pixel2api30atdMockDebugAndroidTest
+        run: ./gradlew -Pandroid.sdk.channel=3 -Pandroid.experimental.androidTest.numManagedDeviceShards=1 -Pandroid.testoptions.manageddevices.emulator.gpu="swiftshader_indirect" pixel2api30atdDebugAndroidTest
 
       - name: Run all tests pixel 2 api 30 non-ATD
         working-directory: .
-        run: ./gradlew -Pandroid.sdk.channel=3 -Pandroid.experimental.androidTest.numManagedDeviceShards=1 -Pandroid.testoptions.manageddevices.emulator.gpu="swiftshader_indirect" pixel2api30MockDebugAndroidTest
+        run: ./gradlew -Pandroid.sdk.channel=3 -Pandroid.experimental.androidTest.numManagedDeviceShards=1 -Pandroid.testoptions.manageddevices.emulator.gpu="swiftshader_indirect" pixel2api30DebugAndroidTest
 
       - name: Upload build reports
         if: always()

README.md

@@ -13,7 +13,7 @@ In this branch you'll find:
 *   A **data layer** with a repository and two data sources (local using Room and a fake remote).
 *   Two **product flavors**, `mock` and `prod`, [to ease development and testing](https://android-developers.googleblog.com/2015/12/leveraging-product-flavors-in-android.html).
 *   A collection of unit, integration and e2e **tests**, including "shared" tests that can be run on emulator/device or Robolectric.
-*   A simple service locator for inversion of control.
+*   Dependency injection using [Hilt](https://developer.android.com/training/dependency-injection/hilt-android).
 
 ## Variations
 
@@ -23,10 +23,11 @@ This project hosts each sample app in separate repository branches. For more inf
 |     Sample     | Description |
 | ------------- | ------------- |
 | [main](https://github.com/googlesamples/android-architecture/tree/main) | This branch |
-| [hilt](https://github.com/googlesamples/android-architecture/tree/hilt) | A simple Hilt setup that removes the two flavors and service locator (not using Compose yet) |
+| [service-locator](https://github.com/googlesamples/android-architecture/tree/service-locator) | A simple setup that removes Hilt in favor of a service locator |
 | [livedata](https://github.com/googlesamples/android-architecture/tree/livedata) | Uses LiveData instead of StateFlow as the data stream solution |
 | [usecases](https://github.com/googlesamples/android-architecture/tree/usecases) | Adds a new domain layer that uses UseCases for business logic (not using Compose yet) |
 | [views](https://github.com/googlesamples/android-architecture/tree/views) | Uses Views instead of Jetpack Compose to render UI elements on the screen |
+| [views-hilt](https://github.com/googlesamples/android-architecture/tree/views-hilt) | Uses Views and Hilt instead together |
 
 ## Why a to-do app?
 

app/build.gradle

@@ -1,6 +1,7 @@
 apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-kapt'
+apply plugin: 'dagger.hilt.android.plugin'
 
 android {
     compileSdkVersion rootProject.compileSdkVersion
@@ -12,7 +13,13 @@ android {
         versionCode 1
         versionName "1.0"
 
-        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
+        testInstrumentationRunner "com.example.android.architecture.blueprints.todoapp.CustomTestRunner"
+
+        javaCompileOptions {
+            annotationProcessorOptions {
+                arguments += ["room.incremental" : "true"]
+            }
+        }
     }
 
     android {
@@ -44,27 +51,6 @@ android {
         }
     }
 
-    flavorDimensions "default"
-
-    // If you need to add more flavors, consider using flavor dimensions.
-    productFlavors {
-        mock {
-            dimension "default"
-            applicationIdSuffix = ".mock"
-        }
-        prod {
-            dimension "default"
-        }
-    }
-
-    // Remove mockRelease as it's not needed.
-    android.variantFilter { variant ->
-        if (variant.buildType.name == 'release'
-                && variant.getFlavors().get(0).name == 'mock') {
-            variant.setIgnore(true)
-        }
-    }
-
     // Always show the result of every unit test, even if it passes.
     testOptions.unitTests {
         includeAndroidResources = true
@@ -149,6 +135,11 @@ dependencies {
     implementation "androidx.lifecycle:lifecycle-runtime-ktx:$archLifecycleVersion"
     implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$archLifecycleVersion"
 
+    // Hilt
+    implementation "com.google.dagger:hilt-android:$hiltVersion"
+    implementation "androidx.hilt:hilt-navigation-compose:$hiltAndroidXVersion"
+    kapt "com.google.dagger:hilt-compiler:$hiltVersion"
+
     // Jetpack Compose
     implementation "androidx.activity:activity-compose:$activityComposeVersion"
     implementation "androidx.compose.material:material:$composeVersion"
@@ -175,6 +166,10 @@ dependencies {
     testImplementation "com.google.truth:truth:$truthVersion"
     testImplementation "androidx.compose.ui:ui-test-junit4:$composeVersion"
 
+    // JVM tests - Hilt
+    testImplementation "com.google.dagger:hilt-android-testing:$hiltVersion"
+    kaptTest "com.google.dagger:hilt-compiler:$hiltVersion"
+
     // Dependencies for Android unit tests
     androidTestImplementation "junit:junit:$junitVersion"
     androidTestImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutinesVersion"
@@ -200,6 +195,10 @@ dependencies {
     androidTestImplementation "org.robolectric:annotations:$robolectricVersion"
     implementation "androidx.test.espresso:espresso-idling-resource:$espressoVersion"
 
+    // AndroidX Test - Hilt testing
+    androidTestImplementation "com.google.dagger:hilt-android-testing:$hiltVersion"
+    kaptAndroidTest "com.google.dagger:hilt-compiler:$hiltVersion"
+
     // Kotlin
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion"
 }

app/src/androidTest/java/com/example/android/architecture/blueprints/todoapp/CustomTestRunner.kt

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.android.architecture.blueprints.todoapp
+
+import android.app.Application
+import android.content.Context
+import androidx.test.runner.AndroidJUnitRunner
+import dagger.hilt.android.testing.HiltTestApplication
+
+class CustomTestRunner : AndroidJUnitRunner() {
+    override fun newApplication(cl: ClassLoader?, name: String?, context: Context?): Application {
+        return super.newApplication(cl, HiltTestApplication::class.java.name, context)
+    }
+}

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

@@ -15,7 +15,6 @@
  */
 package com.example.android.architecture.blueprints.todoapp.tasks
 
-import androidx.activity.ComponentActivity
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
 import androidx.compose.ui.test.assertIsDisplayed
 import androidx.compose.ui.test.assertIsNotDisplayed
@@ -24,59 +23,50 @@ import androidx.compose.ui.test.onAllNodesWithText
 import androidx.compose.ui.test.onNodeWithContentDescription
 import androidx.compose.ui.test.onNodeWithText
 import androidx.compose.ui.test.performClick
-import androidx.test.core.app.ApplicationProvider.getApplicationContext
 import androidx.test.espresso.Espresso.pressBack
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.filters.LargeTest
-import androidx.test.internal.runner.junit4.statement.UiThreadStatement.runOnUiThread
+import com.example.android.architecture.blueprints.todoapp.HiltTestActivity
 import com.example.android.architecture.blueprints.todoapp.R
-import com.example.android.architecture.blueprints.todoapp.ServiceLocator
 import com.example.android.architecture.blueprints.todoapp.TodoNavGraph
 import com.example.android.architecture.blueprints.todoapp.data.Task
 import com.example.android.architecture.blueprints.todoapp.data.source.TasksRepository
 import com.example.android.architecture.blueprints.todoapp.util.saveTaskBlocking
 import com.google.accompanist.appcompattheme.AppCompatTheme
-import kotlinx.coroutines.Dispatchers
-import org.junit.After
+import dagger.hilt.android.testing.HiltAndroidRule
+import dagger.hilt.android.testing.HiltAndroidTest
 import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
+import javax.inject.Inject
 
 /**
  * Tests for scenarios that requires navigating within the app.
  */
 @RunWith(AndroidJUnit4::class)
 @LargeTest
+@HiltAndroidTest
 class AppNavigationTest {
 
-    private lateinit var tasksRepository: TasksRepository
-
-    @get:Rule
-    val composeTestRule = createAndroidComposeRule<ComponentActivity>()
-    private val activity get() = composeTestRule.activity
+    @get:Rule(order = 0)
+    var hiltRule = HiltAndroidRule(this)
 
     // Executes tasks in the Architecture Components in the same thread
-    @get:Rule
+    @get:Rule(order = 1)
     var instantTaskExecutorRule = InstantTaskExecutorRule()
 
+    @get:Rule(order = 2)
+    val composeTestRule = createAndroidComposeRule<HiltTestActivity>()
+    private val activity get() = composeTestRule.activity
+
+    @Inject
+    lateinit var tasksRepository: TasksRepository
+
     @Before
     fun init() {
-        // Run on UI thread to make sure the same instance of the SL is used.
-        runOnUiThread {
-            ServiceLocator.createDataBase(getApplicationContext(), inMemory = true)
-            ServiceLocator.ioDispatcher = Dispatchers.Unconfined
-            tasksRepository = ServiceLocator.provideTasksRepository(getApplicationContext())
-        }
-    }
-
-    @After
-    fun reset() {
-        runOnUiThread {
-            ServiceLocator.resetRepository()
-            ServiceLocator.resetIODispatcher()
-        }
+        hiltRule.inject()
     }
 
     @Test

app/src/androidTestMock/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksScreenTest.kt renamed to app/src/androidTest/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksScreenTest.kt

@@ -16,7 +16,6 @@
 
 package com.example.android.architecture.blueprints.todoapp.tasks
 
-import androidx.activity.ComponentActivity
 import androidx.annotation.StringRes
 import androidx.compose.material.Surface
 import androidx.compose.ui.test.assertIsDisplayed
@@ -28,20 +27,19 @@ import androidx.compose.ui.test.performClick
 import androidx.lifecycle.SavedStateHandle
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.filters.MediumTest
-import androidx.test.internal.runner.junit4.statement.UiThreadStatement.runOnUiThread
+import com.example.android.architecture.blueprints.todoapp.HiltTestActivity
 import com.example.android.architecture.blueprints.todoapp.R
-import com.example.android.architecture.blueprints.todoapp.ServiceLocator
 import com.example.android.architecture.blueprints.todoapp.data.Task
-import com.example.android.architecture.blueprints.todoapp.data.source.FakeRepository
 import com.example.android.architecture.blueprints.todoapp.data.source.TasksRepository
 import com.example.android.architecture.blueprints.todoapp.util.saveTaskBlocking
 import com.google.accompanist.appcompattheme.AppCompatTheme
-import kotlinx.coroutines.ExperimentalCoroutinesApi
-import org.junit.After
+import dagger.hilt.android.testing.HiltAndroidRule
+import dagger.hilt.android.testing.HiltAndroidTest
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
+import javax.inject.Inject
 
 /**
  * Integration test for the Task List screen.
@@ -51,29 +49,22 @@ import org.junit.runner.RunWith
 @MediumTest
 // @LooperMode(LooperMode.Mode.PAUSED)
 // @TextLayoutMode(TextLayoutMode.Mode.REALISTIC)
-@ExperimentalCoroutinesApi
+@HiltAndroidTest
 class TasksScreenTest {
 
-    private lateinit var repository: TasksRepository
+    @get:Rule(order = 0)
+    var hiltRule = HiltAndroidRule(this)
 
-    @get:Rule
-    val composeTestRule = createAndroidComposeRule<ComponentActivity>()
+    @get:Rule(order = 1)
+    val composeTestRule = createAndroidComposeRule<HiltTestActivity>()
     private val activity get() = composeTestRule.activity
 
-    @Before
-    fun initRepository() {
-        // Run on UI thread to make sure the same instance of the SL is used.
-        runOnUiThread {
-            repository = FakeRepository()
-            ServiceLocator.tasksRepository = repository
-        }
-    }
+    @Inject
+    lateinit var repository: TasksRepository
 
-    @After
-    fun cleanupDb() {
-        runOnUiThread {
-            ServiceLocator.resetRepository()
-        }
+    @Before
+    fun init() {
+        hiltRule.inject()
     }
 
     @Test