Consequently use injected @ApplicationContext in Android tests; fix Hilt rules

Author: rfc2822

app/src/androidTest/kotlin/at/bitfire/davdroid/db/CollectionTest.kt

@@ -4,13 +4,14 @@
 
 package at.bitfire.davdroid.db
 
+import android.content.Context
 import android.security.NetworkSecurityPolicy
 import androidx.test.filters.SmallTest
-import androidx.test.platform.app.InstrumentationRegistry
 import at.bitfire.dav4jvm.DavResource
 import at.bitfire.dav4jvm.property.webdav.ResourceType
 import at.bitfire.davdroid.network.HttpClient
 import at.bitfire.davdroid.settings.SettingsManager
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import okhttp3.HttpUrl.Companion.toHttpUrl
@@ -34,25 +35,25 @@ class CollectionTest {
     val hiltRule = HiltAndroidRule(this)
 
     @Inject
-    lateinit var settingsManager: SettingsManager
-
-    @Before
-    fun inject() {
-        hiltRule.inject()
-    }
+    @ApplicationContext
+    lateinit var context: Context
 
+    @Inject
+    lateinit var settingsManager: SettingsManager
 
     private lateinit var httpClient: HttpClient
     private val server = MockWebServer()
 
     @Before
-    fun setUp() {
-        httpClient = HttpClient.Builder(InstrumentationRegistry.getInstrumentation().targetContext).build()
+    fun setup() {
+        hiltRule.inject()
+
+        httpClient = HttpClient.Builder(context).build()
         Assume.assumeTrue(NetworkSecurityPolicy.getInstance().isCleartextTrafficPermitted)
     }
 
     @After
-    fun shutDown() {
+    fun teardown() {
         httpClient.close()
     }
 

app/src/androidTest/kotlin/at/bitfire/davdroid/network/ConnectionUtilsTest.kt

@@ -11,7 +11,6 @@ import android.net.NetworkCapabilities.NET_CAPABILITY_INTERNET
 import android.net.NetworkCapabilities.NET_CAPABILITY_NOT_VPN
 import android.net.NetworkCapabilities.NET_CAPABILITY_VALIDATED
 import android.net.NetworkCapabilities.TRANSPORT_WIFI
-import dagger.hilt.android.testing.HiltAndroidTest
 import io.mockk.every
 import io.mockk.junit4.MockKRule
 import io.mockk.mockk
@@ -21,7 +20,6 @@ import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
-@HiltAndroidTest
 class ConnectionUtilsTest {
 
     @get:Rule

app/src/androidTest/kotlin/at/bitfire/davdroid/network/HttpClientTest.kt

@@ -4,8 +4,9 @@
 
 package at.bitfire.davdroid.network
 
+import android.content.Context
 import android.security.NetworkSecurityPolicy
-import androidx.test.platform.app.InstrumentationRegistry
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import okhttp3.Request
@@ -19,6 +20,7 @@ import org.junit.Assume
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import javax.inject.Inject
 
 @HiltAndroidTest
 class HttpClientTest {
@@ -29,11 +31,15 @@ class HttpClientTest {
     @get:Rule
     var hiltRule = HiltAndroidRule(this)
 
+    @Inject
+    @ApplicationContext
+    lateinit var context: Context
+
     @Before
     fun setUp() {
         hiltRule.inject()
 
-        httpClient = HttpClient.Builder(InstrumentationRegistry.getInstrumentation().targetContext).build()
+        httpClient = HttpClient.Builder(context).build()
 
         server = MockWebServer()
         server.start(30000)

app/src/androidTest/kotlin/at/bitfire/davdroid/repository/DavCollectionRepositoryTest.kt

@@ -1,10 +1,11 @@
 package at.bitfire.davdroid.repository
 
-import androidx.test.platform.app.InstrumentationRegistry
+import android.content.Context
 import at.bitfire.davdroid.db.AppDatabase
 import at.bitfire.davdroid.db.Collection
 import at.bitfire.davdroid.db.Service
 import at.bitfire.davdroid.settings.AccountSettings
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import io.mockk.mockk
@@ -27,12 +28,14 @@ class DavCollectionRepositoryTest {
     lateinit var accountSettingsFactory: AccountSettings.Factory
 
     @Inject
-    lateinit var serviceRepository: DavServiceRepository
+    @ApplicationContext
+    lateinit var context: Context
 
     @Inject
     lateinit var db: AppDatabase
 
-    val context = InstrumentationRegistry.getInstrumentation().targetContext
+    @Inject
+    lateinit var serviceRepository: DavServiceRepository
 
     var service: Service? = null
 
@@ -48,6 +51,7 @@ class DavCollectionRepositoryTest {
         serviceRepository.deleteAll()
     }
 
+
     @Test
     fun testOnChangeListener_setForceReadOnly() = runBlocking {
         val collectionId = db.collectionDao().insertOrUpdateByUrl(

app/src/androidTest/kotlin/at/bitfire/davdroid/resource/LocalAddressBookTest.kt

@@ -6,34 +6,37 @@ package at.bitfire.davdroid.resource
 
 import android.accounts.Account
 import android.accounts.AccountManager
-import androidx.arch.core.executor.testing.InstantTaskExecutorRule
-import androidx.test.platform.app.InstrumentationRegistry
+import android.content.Context
 import at.bitfire.davdroid.R
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import org.junit.After
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import javax.inject.Inject
 
 @HiltAndroidTest
 class LocalAddressBookTest {
 
     @get:Rule
     val hiltRule = HiltAndroidRule(this)
 
-    val context = InstrumentationRegistry.getInstrumentation().targetContext
+    @Inject
+    @ApplicationContext
+    lateinit var context: Context
 
-    val mainAccountType = context.getString(R.string.account_type)
-    val mainAccount = Account("main", mainAccountType)
+    private val mainAccountType by lazy { context.getString(R.string.account_type) }
+    private val mainAccount by lazy { Account("main", mainAccountType) }
 
-    val addressBookAccountType = context.getString(R.string.account_type_address_book)
-    val addressBookAccount = Account("sub", addressBookAccountType)
+    private val addressBookAccountType by lazy { context.getString(R.string.account_type_address_book) }
+    private val addressBookAccount by lazy { Account("sub", addressBookAccountType) }
 
-    val accountManager = AccountManager.get(context)
+    private val accountManager by lazy { AccountManager.get(context) }
 
     @Before
-    fun setUp() {
+    fun setup() {
         hiltRule.inject()
 
         // TODO DOES NOT WORK: the account immediately starts to sync, which creates the sync adapter services.
@@ -42,7 +45,7 @@ class LocalAddressBookTest {
     }
 
     @After
-    fun cleanup() {
+    fun teardown() {
         accountManager.removeAccount(addressBookAccount, null, null)
         accountManager.removeAccount(mainAccount, null, null)
     }

app/src/androidTest/kotlin/at/bitfire/davdroid/resource/LocalGroupTest.kt

@@ -8,6 +8,7 @@ import android.Manifest
 import android.content.ContentProviderClient
 import android.content.ContentUris
 import android.content.ContentValues
+import android.content.Context
 import android.provider.ContactsContract
 import android.provider.ContactsContract.CommonDataKinds.GroupMembership
 import androidx.test.platform.app.InstrumentationRegistry
@@ -17,6 +18,7 @@ import at.bitfire.vcard4android.BatchOperation
 import at.bitfire.vcard4android.CachedGroupMembership
 import at.bitfire.vcard4android.Contact
 import at.bitfire.vcard4android.GroupMethod
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import org.junit.AfterClass
@@ -37,8 +39,6 @@ class LocalGroupTest {
 
     companion object {
 
-        val context = InstrumentationRegistry.getInstrumentation().targetContext
-
         @JvmField
         @ClassRule
         val permissionRule = GrantPermissionRule.grant(Manifest.permission.READ_CONTACTS, Manifest.permission.WRITE_CONTACTS)!!
@@ -48,6 +48,7 @@ class LocalGroupTest {
         @BeforeClass
         @JvmStatic
         fun connect() {
+            val context = InstrumentationRegistry.getInstrumentation().targetContext
             provider = context.contentResolver.acquireContentProviderClient(ContactsContract.AUTHORITY)!!
             assertNotNull(provider)
         }
@@ -62,6 +63,10 @@ class LocalGroupTest {
     @get:Rule
     val hiltRule = HiltAndroidRule(this)
 
+    @Inject
+    @ApplicationContext
+    lateinit var context: Context
+
     @Inject
     lateinit var settingsManager: SettingsManager
 

app/src/androidTest/kotlin/at/bitfire/davdroid/resource/contactrow/GroupMembershipBuilderTest.kt

@@ -15,6 +15,7 @@ import androidx.test.rule.GrantPermissionRule
 import at.bitfire.davdroid.resource.LocalTestAddressBook
 import at.bitfire.vcard4android.Contact
 import at.bitfire.vcard4android.GroupMethod
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import org.junit.AfterClass
@@ -24,14 +25,13 @@ import org.junit.BeforeClass
 import org.junit.ClassRule
 import org.junit.Rule
 import org.junit.Test
+import javax.inject.Inject
 
 @HiltAndroidTest
 class GroupMembershipBuilderTest {
 
     companion object {
 
-        val context: Context = InstrumentationRegistry.getInstrumentation().targetContext
-
         @JvmField
         @ClassRule
         val permissionRule = GrantPermissionRule.grant(Manifest.permission.READ_CONTACTS, Manifest.permission.WRITE_CONTACTS)!!
@@ -41,6 +41,7 @@ class GroupMembershipBuilderTest {
         @BeforeClass
         @JvmStatic
         fun connect() {
+            val context: Context = InstrumentationRegistry.getInstrumentation().targetContext
             provider = context.contentResolver.acquireContentProviderClient(ContactsContract.AUTHORITY)!!
         }
 
@@ -55,6 +56,10 @@ class GroupMembershipBuilderTest {
     @get:Rule
     val hiltRule = HiltAndroidRule(this)
 
+    @Inject
+    @ApplicationContext
+    lateinit var context: Context
+
     @Before
     fun inject() {
         hiltRule.inject()

app/src/androidTest/kotlin/at/bitfire/davdroid/servicedetection/CollectionListRefresherTest.kt

@@ -6,7 +6,6 @@ package at.bitfire.davdroid.servicedetection
 
 import android.content.Context
 import android.security.NetworkSecurityPolicy
-import androidx.test.platform.app.InstrumentationRegistry
 import at.bitfire.davdroid.db.AppDatabase
 import at.bitfire.davdroid.db.Collection
 import at.bitfire.davdroid.db.HomeSet
@@ -16,6 +15,7 @@ import at.bitfire.davdroid.log.Logger
 import at.bitfire.davdroid.network.HttpClient
 import at.bitfire.davdroid.settings.Settings
 import at.bitfire.davdroid.settings.SettingsManager
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import io.mockk.every
@@ -36,22 +36,6 @@ import javax.inject.Inject
 
 @HiltAndroidTest
 class CollectionListRefresherTest {
-    
-    @get:Rule
-    var hiltRule = HiltAndroidRule(this)
-
-    val context: Context = InstrumentationRegistry.getInstrumentation().targetContext
-
-    @Inject
-    lateinit var settings: SettingsManager
-
-    @Before
-    fun setUp() {
-        hiltRule.inject()
-    }
-
-    
-    // Test dependencies
 
     companion object {
         private const val PATH_CALDAV = "/caldav"
@@ -66,28 +50,40 @@ class CollectionListRefresherTest {
         private const val SUBPATH_ADDRESSBOOK_INACCESSIBLE = "/addressbooks/inaccessible-contacts"
     }
 
+    @get:Rule
+    var hiltRule = HiltAndroidRule(this)
+
+    @Inject
+    @ApplicationContext
+    lateinit var context: Context
+
     @Inject
     lateinit var db: AppDatabase
 
     @Inject
     lateinit var refresherFactory: CollectionListRefresher.Factory
 
+    @Inject
+    lateinit var settings: SettingsManager
+
     private val mockServer = MockWebServer()
     private lateinit var client: HttpClient
 
     @Before
-    fun mockServerSetup() {
+    fun setup() {
+        hiltRule.inject()
+
         // Start mock web server
         mockServer.dispatcher = TestDispatcher()
         mockServer.start()
 
-        client = HttpClient.Builder(InstrumentationRegistry.getInstrumentation().targetContext).build()
+        client = HttpClient.Builder(context).build()
 
         Assume.assumeTrue(NetworkSecurityPolicy.getInstance().isCleartextTrafficPermitted)
     }
 
     @After
-    fun cleanUp() {
+    fun teardown() {
         mockServer.shutdown()
         db.close()
     }