For #9599: Add PinnedSitesStorageTest to increase top-sites test cove…

…rage

components/feature/top-sites/src/androidTest/java/mozilla/components/feature/top/sites/PinnedSitesStorageTest.kt → components/feature/top-sites/src/androidTest/java/mozilla/components/feature/top/sites/OnDevicePinnedSitesStorageTest.kt

@@ -28,7 +28,7 @@ import java.util.concurrent.Executors
 private const val MIGRATION_TEST_DB = "migration-test"
 
 @Suppress("LargeClass")
-class PinnedSitesStorageTest {
+class OnDevicePinnedSitesStorageTest {
     private lateinit var context: Context
     private lateinit var storage: PinnedSiteStorage
     private lateinit var executor: ExecutorService

components/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/PinnedSiteStorage.kt

@@ -5,6 +5,7 @@
 package mozilla.components.feature.top.sites
 
 import android.content.Context
+import androidx.annotation.VisibleForTesting
 import kotlinx.coroutines.Dispatchers.IO
 import kotlinx.coroutines.withContext
 import mozilla.components.feature.top.sites.db.PinnedSiteEntity
@@ -16,6 +17,9 @@ import mozilla.components.feature.top.sites.db.toPinnedSite
  */
 class PinnedSiteStorage(context: Context) {
 
+    @VisibleForTesting
+    internal var currentTimeMillis: () -> Long = { System.currentTimeMillis() }
+    @VisibleForTesting
     internal var database: Lazy<TopSiteDatabase> = lazy { TopSiteDatabase.get(context) }
     private val pinnedSiteDao by lazy { database.value.pinnedSiteDao() }
 
@@ -35,7 +39,7 @@ class PinnedSiteStorage(context: Context) {
                 title = title,
                 url = url,
                 isDefault = isDefault,
-                createdAt = System.currentTimeMillis()
+                createdAt = currentTimeMillis()
             )
         }
         pinnedSiteDao.insertAllPinnedSites(siteEntities)
@@ -55,7 +59,7 @@ class PinnedSiteStorage(context: Context) {
                 title = title,
                 url = url,
                 isDefault = isDefault,
-                createdAt = System.currentTimeMillis()
+                createdAt = currentTimeMillis()
             )
             entity.id = pinnedSiteDao.insertPinnedSite(entity)
         }

components/feature/top-sites/src/test/java/mozilla/components/feature/top/sites/PinnedSitesStorageTest.kt

@@ -0,0 +1,130 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.feature.top.sites
+
+import kotlinx.coroutines.runBlocking
+import mozilla.components.feature.top.sites.db.PinnedSiteDao
+import mozilla.components.feature.top.sites.db.PinnedSiteEntity
+import mozilla.components.feature.top.sites.db.TopSiteDatabase
+import mozilla.components.feature.top.sites.TopSite.Type.DEFAULT
+import mozilla.components.feature.top.sites.TopSite.Type.PINNED
+import mozilla.components.support.test.mock
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
+import org.junit.Test
+import org.mockito.Mockito.verify
+import org.mockito.Mockito.`when`
+
+class PinnedSitesStorageTest {
+
+    @Test
+    fun addAllDefaultSites() = runBlocking {
+        val storage = PinnedSiteStorage(mock())
+        val dao = mockDao(storage)
+
+        storage.currentTimeMillis = { 42 }
+
+        storage.addAllPinnedSites(listOf(
+            Pair("Mozilla", "https://www.mozilla.org"),
+            Pair("Firefox", "https://www.firefox.com"),
+            Pair("Wikipedia", "https://www.wikipedia.com"),
+            Pair("Pocket", "https://www.getpocket.com")
+        ), isDefault = true)
+
+        verify(dao).insertAllPinnedSites(listOf(
+            PinnedSiteEntity(title = "Mozilla", url = "https://www.mozilla.org", isDefault = true, createdAt = 42),
+            PinnedSiteEntity(title = "Firefox", url = "https://www.firefox.com", isDefault = true, createdAt = 42),
+            PinnedSiteEntity(title = "Wikipedia", url = "https://www.wikipedia.com", isDefault = true, createdAt = 42),
+            PinnedSiteEntity(title = "Pocket", url = "https://www.getpocket.com", isDefault = true, createdAt = 42)
+        ))
+
+        Unit
+    }
+
+    @Test
+    fun addPinnedSite() = runBlocking {
+        val storage = PinnedSiteStorage(mock())
+        val dao = mockDao(storage)
+
+        storage.currentTimeMillis = { 3 }
+
+        storage.addPinnedSite("Mozilla", "https://www.mozilla.org")
+        storage.addPinnedSite("Firefox", "https://www.firefox.com", isDefault = true)
+
+        // PinnedSiteDao.insertPinnedSite is actually called with "id = null", but due to an
+        // extraneous assignment ("entity.id = ") in PinnedSiteStorage.addPinnedSite we can for now
+        // only verify the call with "id = 0". See issue #9708.
+        verify(dao).insertPinnedSite(PinnedSiteEntity(id = 0, title = "Mozilla", url = "https://www.mozilla.org", isDefault = false, createdAt = 3))
+        verify(dao).insertPinnedSite(PinnedSiteEntity(id = 0, title = "Firefox", url = "https://www.firefox.com", isDefault = true, createdAt = 3))
+
+        Unit
+    }
+
+    @Test
+    fun removePinnedSite() = runBlocking {
+        val storage = PinnedSiteStorage(mock())
+        val dao = mockDao(storage)
+
+        storage.removePinnedSite(TopSite(1, "Mozilla", "https://www.mozilla.org", 1, PINNED))
+        storage.removePinnedSite(TopSite(2, "Firefox", "https://www.firefox.com", 1, DEFAULT))
+
+        verify(dao).deletePinnedSite(PinnedSiteEntity(1, "Mozilla", "https://www.mozilla.org", false, 1))
+        verify(dao).deletePinnedSite(PinnedSiteEntity(2, "Firefox", "https://www.firefox.com", true, 1))
+    }
+
+    @Test
+    fun getPinnedSites() = runBlocking {
+        val storage = PinnedSiteStorage(mock())
+        val dao = mockDao(storage)
+
+        `when`(dao.getPinnedSites()).thenReturn(listOf(
+            PinnedSiteEntity(1, "Mozilla", "https://www.mozilla.org", false, 10),
+            PinnedSiteEntity(2, "Firefox", "https://www.firefox.com", true, 10)
+        ))
+        `when`(dao.getPinnedSitesCount()).thenReturn(2)
+
+        val topSites = storage.getPinnedSites()
+        val topSitesCount = storage.getPinnedSitesCount()
+
+        assertNotNull(topSites)
+        assertEquals(2, topSites.size)
+        assertEquals(2, topSitesCount)
+
+        with(topSites[0]) {
+            assertEquals(1L, id)
+            assertEquals("Mozilla", title)
+            assertEquals("https://www.mozilla.org", url)
+            assertEquals(PINNED, type)
+            assertEquals(10L, createdAt)
+        }
+
+        with(topSites[1]) {
+            assertEquals(2L, id)
+            assertEquals("Firefox", title)
+            assertEquals("https://www.firefox.com", url)
+            assertEquals(DEFAULT, type)
+            assertEquals(10L, createdAt)
+        }
+    }
+
+    @Test
+    fun updatePinnedSite() = runBlocking {
+        val storage = PinnedSiteStorage(mock())
+        val dao = mockDao(storage)
+
+        val site = TopSite(1, "Mozilla", "https://www.mozilla.org", 1, PINNED)
+        storage.updatePinnedSite(site, "Mozilla (IT)", "https://www.mozilla.org/it")
+
+        verify(dao).updatePinnedSite(PinnedSiteEntity(1, "Mozilla (IT)", "https://www.mozilla.org/it", false, 1))
+    }
+
+    private fun mockDao(storage: PinnedSiteStorage): PinnedSiteDao {
+        val db = mock<TopSiteDatabase>()
+        storage.database = lazy { db }
+        val dao = mock<PinnedSiteDao>()
+        `when`(db.pinnedSiteDao()).thenReturn(dao)
+        return dao
+    }
+}