BIT-2293, BIT-2294: Add vault and generator shortcuts (#1306)

This commit is contained in:
David Perez
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent 80f6011571
commit bb1fd4ae4f
13 changed files with 336 additions and 11 deletions
@@ -18,6 +18,8 @@ import com.x8bit.bitwarden.data.platform.repository.SettingsRepository
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import com.x8bit.bitwarden.ui.platform.feature.settings.appearance.model.AppTheme
import com.x8bit.bitwarden.ui.platform.manager.intent.IntentManager
import com.x8bit.bitwarden.ui.platform.util.isMyVaultShortcut
import com.x8bit.bitwarden.ui.platform.util.isPasswordGeneratorShortcut
import io.mockk.every
import io.mockk.mockk
import io.mockk.mockkStatic
@@ -54,6 +56,10 @@ class MainViewModelTest : BaseViewModelTest() {
Intent::getAutofillSaveItemOrNull,
Intent::getAutofillSelectionDataOrNull,
)
mockkStatic(
Intent::isMyVaultShortcut,
Intent::isPasswordGeneratorShortcut,
)
}
@AfterEach
@@ -63,6 +69,10 @@ class MainViewModelTest : BaseViewModelTest() {
Intent::getAutofillSaveItemOrNull,
Intent::getAutofillSelectionDataOrNull,
)
unmockkStatic(
Intent::isMyVaultShortcut,
Intent::isPasswordGeneratorShortcut,
)
}
@Suppress("MaxLineLength")
@@ -150,6 +160,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns null
every { mockIntent.getAutofillSelectionDataOrNull() } returns null
every { intentManager.getShareDataFromIntent(mockIntent) } returns shareData
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveFirstIntent(
@@ -175,6 +187,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns null
every { mockIntent.getAutofillSelectionDataOrNull() } returns autofillSelectionData
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveFirstIntent(
@@ -200,6 +214,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns autofillSaveItem
every { mockIntent.getAutofillSelectionDataOrNull() } returns null
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveFirstIntent(
@@ -226,6 +242,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns null
every { mockIntent.getAutofillSelectionDataOrNull() } returns null
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveFirstIntent(
@@ -251,6 +269,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns null
every { mockIntent.getAutofillSelectionDataOrNull() } returns null
every { intentManager.getShareDataFromIntent(mockIntent) } returns shareData
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveNewIntent(
@@ -276,6 +296,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns null
every { mockIntent.getAutofillSelectionDataOrNull() } returns autofillSelectionData
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveNewIntent(
@@ -301,6 +323,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns autofillSaveItem
every { mockIntent.getAutofillSelectionDataOrNull() } returns null
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveNewIntent(
@@ -327,6 +351,8 @@ class MainViewModelTest : BaseViewModelTest() {
every { mockIntent.getAutofillSaveItemOrNull() } returns null
every { mockIntent.getAutofillSelectionDataOrNull() } returns null
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
every { mockIntent.isMyVaultShortcut } returns false
every { mockIntent.isPasswordGeneratorShortcut } returns false
viewModel.trySendAction(
MainAction.ReceiveNewIntent(
@@ -342,6 +368,54 @@ class MainViewModelTest : BaseViewModelTest() {
)
}
@Suppress("MaxLineLength")
@Test
fun `on ReceiveNewIntent with a Vault deeplink data should set the special circumstance to VaultShortcut`() {
val viewModel = createViewModel()
val mockIntent = mockk<Intent> {
every { getPasswordlessRequestDataIntentOrNull() } returns null
every { getAutofillSaveItemOrNull() } returns null
every { getAutofillSelectionDataOrNull() } returns null
every { isMyVaultShortcut } returns true
every { isPasswordGeneratorShortcut } returns false
}
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
viewModel.trySendAction(
MainAction.ReceiveNewIntent(
intent = mockIntent,
),
)
assertEquals(
SpecialCircumstance.VaultShortcut,
specialCircumstanceManager.specialCircumstance,
)
}
@Suppress("MaxLineLength")
@Test
fun `on ReceiveNewIntent with a password generator deeplink data should set the special circumstance to GeneratorShortcut`() {
val viewModel = createViewModel()
val mockIntent = mockk<Intent> {
every { getPasswordlessRequestDataIntentOrNull() } returns null
every { getAutofillSaveItemOrNull() } returns null
every { getAutofillSelectionDataOrNull() } returns null
every { isMyVaultShortcut } returns false
every { isPasswordGeneratorShortcut } returns true
}
every { intentManager.getShareDataFromIntent(mockIntent) } returns null
viewModel.trySendAction(
MainAction.ReceiveNewIntent(
intent = mockIntent,
),
)
assertEquals(
SpecialCircumstance.GeneratorShortcut,
specialCircumstanceManager.specialCircumstance,
)
}
@Suppress("MaxLineLength")
@Test
fun `changes in the allowed screen capture value should result in emissions of ScreenCaptureSettingChange `() =
@@ -34,6 +34,12 @@ class SpecialCircumstanceExtensionsTest {
data = mockk(),
shouldFinishWhenComplete = true,
),
SpecialCircumstance.PasswordlessRequest(
passwordlessRequestData = mockk(),
shouldFinishWhenComplete = true,
),
SpecialCircumstance.GeneratorShortcut,
SpecialCircumstance.VaultShortcut,
)
.forEach { specialCircumstance ->
assertNull(specialCircumstance.toAutofillSaveItemOrNull())
@@ -67,6 +73,12 @@ class SpecialCircumstanceExtensionsTest {
data = mockk(),
shouldFinishWhenComplete = true,
),
SpecialCircumstance.PasswordlessRequest(
passwordlessRequestData = mockk(),
shouldFinishWhenComplete = true,
),
SpecialCircumstance.GeneratorShortcut,
SpecialCircumstance.VaultShortcut,
)
.forEach { specialCircumstance ->
assertNull(specialCircumstance.toAutofillSelectionDataOrNull())
@@ -2,6 +2,8 @@ package com.x8bit.bitwarden.ui.platform.feature.vaultunlockednavbar
import app.cash.turbine.test
import com.x8bit.bitwarden.data.auth.repository.AuthRepository
import com.x8bit.bitwarden.data.platform.manager.SpecialCircumstanceManager
import com.x8bit.bitwarden.data.platform.manager.model.SpecialCircumstance
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import io.mockk.every
import io.mockk.just
@@ -16,6 +18,65 @@ class VaultUnlockedNavBarViewModelTest : BaseViewModelTest() {
private val authRepository: AuthRepository = mockk {
every { updateLastActiveTime() } just runs
}
private val specialCircumstancesManager: SpecialCircumstanceManager = mockk {
every { specialCircumstance = null } just runs
every { specialCircumstance } returns null
}
@Suppress("MaxLineLength")
@Test
fun `on init with GeneratorShortcut special circumstance should navigate to the generator screen`() =
runTest {
every {
specialCircumstancesManager.specialCircumstance
} returns SpecialCircumstance.GeneratorShortcut
val viewModel = createViewModel()
viewModel.eventFlow.test {
assertEquals(VaultUnlockedNavBarEvent.NavigateToGeneratorScreen, awaitItem())
}
verify(exactly = 1) {
specialCircumstancesManager.specialCircumstance
specialCircumstancesManager.specialCircumstance = null
}
}
@Suppress("MaxLineLength")
@Test
fun `on init with VaultShortcut special circumstance should navigate to the generator screen`() =
runTest {
every {
specialCircumstancesManager.specialCircumstance
} returns SpecialCircumstance.VaultShortcut
val viewModel = createViewModel()
viewModel.eventFlow.test {
assertEquals(VaultUnlockedNavBarEvent.NavigateToVaultScreen, awaitItem())
}
verify(exactly = 1) {
specialCircumstancesManager.specialCircumstance
specialCircumstancesManager.specialCircumstance = null
}
}
@Test
fun `on init with no shortcut special circumstance should do nothing`() = runTest {
every { specialCircumstancesManager.specialCircumstance } returns null
val viewModel = createViewModel()
viewModel.eventFlow.test {
expectNoEvents()
}
verify(exactly = 1) {
specialCircumstancesManager.specialCircumstance
}
verify(exactly = 0) {
specialCircumstancesManager.specialCircumstance = null
}
}
@Test
fun `VaultTabClick should navigate to the vault screen`() = runTest {
@@ -63,5 +124,6 @@ class VaultUnlockedNavBarViewModelTest : BaseViewModelTest() {
private fun createViewModel() =
VaultUnlockedNavBarViewModel(
authRepository = authRepository,
specialCircumstancesManager = specialCircumstancesManager,
)
}
@@ -0,0 +1,59 @@
package com.x8bit.bitwarden.ui.platform.util
import android.content.Intent
import io.mockk.every
import io.mockk.mockk
import org.junit.jupiter.api.Assertions.assertFalse
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test
class ShortcutUtilsTest {
@Test
fun `isMyVaultShortcut should return true when dataString is my vault deeplink`() {
val mockIntent = mockk<Intent> {
every { dataString } returns "bitwarden://my_vault"
}
assertTrue(mockIntent.isMyVaultShortcut)
}
@Test
fun `isMyVaultShortcut should return false when dataString is not my vault deeplink`() {
val mockIntent = mockk<Intent> {
every { dataString } returns "bitwarden://some_other_vault"
}
assertFalse(mockIntent.isMyVaultShortcut)
}
@Test
fun `isMyVaultShortcut should return false when dataString is null`() {
val mockIntent = mockk<Intent> {
every { dataString } returns null
}
assertFalse(mockIntent.isMyVaultShortcut)
}
@Test
fun `isPasswordGeneratorShortcut should return true when dataString is my vault deeplink`() {
val mockIntent = mockk<Intent> {
every { dataString } returns "bitwarden://password_generator"
}
assertTrue(mockIntent.isPasswordGeneratorShortcut)
}
@Suppress("MaxLineLength")
@Test
fun `isPasswordGeneratorShortcut should return false when dataString is not my vault deeplink`() {
val mockIntent = mockk<Intent> {
every { dataString } returns "bitwarden://some_other_generator"
}
assertFalse(mockIntent.isPasswordGeneratorShortcut)
}
@Test
fun `isPasswordGeneratorShortcut should return false when dataString is null`() {
val mockIntent = mockk<Intent> {
every { dataString } returns null
}
assertFalse(mockIntent.isPasswordGeneratorShortcut)
}
}