test: unit test for profile context wrapper

Author: criticalAY

AnkiDroid/src/test/java/com/ichi2/anki/multiprofile/ProfileContextWrapperTest.kt

@@ -0,0 +1,169 @@
+/*
+ * Copyright (c) 2025 Ashish Yadav <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 3 of the License, or (at your option) any later
+ * version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.ichi2.anki.multiprofile
+
+import android.content.Context
+import android.content.SharedPreferences
+import androidx.test.core.app.ApplicationProvider
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertTrue
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.TemporaryFolder
+import org.junit.runner.RunWith
+import org.mockito.ArgumentMatchers.anyInt
+import org.mockito.kotlin.any
+import org.mockito.kotlin.doReturn
+import org.mockito.kotlin.eq
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.spy
+import org.mockito.kotlin.verify
+import org.robolectric.RobolectricTestRunner
+import java.io.File
+
+@RunWith(RobolectricTestRunner::class)
+class ProfileContextWrapperTest {
+    @get:Rule
+    val tempFolder = TemporaryFolder()
+
+    private lateinit var baseContext: Context
+    private lateinit var profileBaseDir: File
+    private val profileId = "p_test123"
+
+    @Before
+    fun setUp() {
+        // spy to verify calls passed to super.getSharedPreferences
+        baseContext = spy(ApplicationProvider.getApplicationContext<Context>())
+        profileBaseDir = tempFolder.newFolder("p_test123")
+    }
+
+    @Test
+    fun `getFilesDir returns correct path and creates directory`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val result = wrapper.filesDir
+        val expected = File(profileBaseDir, "files")
+        assertEquals(expected.absolutePath, result.absolutePath)
+        assertTrue("Directory should be created", result.exists())
+    }
+
+    @Test
+    fun `getCacheDir returns correct path and creates directory`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val result = wrapper.cacheDir
+        val expected = File(profileBaseDir, "cache")
+        assertEquals(expected.absolutePath, result.absolutePath)
+        assertTrue(result.exists())
+    }
+
+    @Test
+    fun `getCodeCacheDir returns correct path and creates directory`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val result = wrapper.codeCacheDir
+        val expected = File(profileBaseDir, "code_cache")
+        assertEquals(expected.absolutePath, result.absolutePath)
+        assertTrue(result.exists())
+    }
+
+    @Test
+    fun `getNoBackupFilesDir returns correct path and creates directory`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val result = wrapper.noBackupFilesDir
+        val expected = File(profileBaseDir, "no_backup")
+        assertEquals(expected.absolutePath, result.absolutePath)
+        assertTrue(result.exists())
+    }
+
+    @Test
+    fun `getDatabasePath returns correct path inside databases folder`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val dbName = "my_collection.db"
+        val result = wrapper.getDatabasePath(dbName)
+        val expectedDir = File(profileBaseDir, "databases")
+        val expectedFile = File(expectedDir, dbName)
+        assertEquals(expectedFile.absolutePath, result.absolutePath)
+        assertTrue("Parent databases folder should be created", expectedDir.exists())
+    }
+
+    @Test
+    fun `getDir returns correct custom path`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val dirName = "app_textures"
+        val result = wrapper.getDir(dirName, Context.MODE_PRIVATE)
+        val expected = File(profileBaseDir, dirName)
+        assertEquals(expected.absolutePath, result.absolutePath)
+        assertTrue(result.exists())
+    }
+
+    @Test
+    fun `getSharedPreferences prefixes name for custom profile`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val originalName = "deck_options"
+
+        doReturn(mock<SharedPreferences>())
+            .`when`(baseContext)
+            .getSharedPreferences(any(), anyInt())
+
+        wrapper.getSharedPreferences(originalName, Context.MODE_PRIVATE)
+
+        val expectedName = "profile_${profileId}_$originalName"
+        verify(baseContext).getSharedPreferences(eq(expectedName), eq(Context.MODE_PRIVATE))
+    }
+
+    @Test
+    fun `getSharedPreferences does NOT prefix name for default profile`() {
+        val defaultId = "default"
+        val wrapper = ProfileContextWrapper(baseContext, defaultId, profileBaseDir)
+        val originalName = "deck_options"
+
+        doReturn(mock<SharedPreferences>())
+            .`when`(baseContext)
+            .getSharedPreferences(any(), anyInt())
+
+        wrapper.getSharedPreferences(originalName, Context.MODE_PRIVATE)
+
+        verify(baseContext).getSharedPreferences(eq(originalName), eq(Context.MODE_PRIVATE))
+    }
+
+    @Test
+    fun `getSharedPreferences does NOT double-prefix if name is already prefixed`() {
+        val wrapper = ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+        val alreadyPrefixedName = "profile_${profileId}_deck_options"
+
+        doReturn(mock<SharedPreferences>())
+            .`when`(baseContext)
+            .getSharedPreferences(any(), anyInt())
+
+        wrapper.getSharedPreferences(alreadyPrefixedName, Context.MODE_PRIVATE)
+
+        verify(baseContext).getSharedPreferences(eq(alreadyPrefixedName), eq(Context.MODE_PRIVATE))
+    }
+
+    @Test
+    fun `init block creates directories immediately`() {
+        profileBaseDir.deleteRecursively()
+
+        ProfileContextWrapper(baseContext, profileId, profileBaseDir)
+
+        val filesDir = File(profileBaseDir, "files")
+        val databasesDir = File(profileBaseDir, "databases")
+
+        assertTrue("Files dir should be created in init", filesDir.exists())
+        assertTrue("Databases dir should be created in init", databasesDir.exists())
+    }
+}