BIT-1114 Add code manual entry (#523)

This commit is contained in:
Oleg Semenenko
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent 0ee25a3dd5
commit e863559c12
16 changed files with 747 additions and 37 deletions
@@ -54,6 +54,7 @@ class VaultAddEditScreenTest : BaseComposeTest() {
private var onNavigateBackCalled = false
private var onNavigateQrCodeScanScreenCalled = false
private var onNavigateToManualCodeEntryScreenCalled = false
private val mutableEventFlow = bufferedMutableSharedFlow<VaultAddEditEvent>()
private val mutableStateFlow = MutableStateFlow(DEFAULT_STATE_LOGIN)
@@ -69,12 +70,15 @@ class VaultAddEditScreenTest : BaseComposeTest() {
fun setup() {
composeTestRule.setContent {
VaultAddEditScreen(
viewModel = viewModel,
onNavigateBack = { onNavigateBackCalled = true },
permissionsManager = fakePermissionManager,
onNavigateToQrCodeScanScreen = {
onNavigateQrCodeScanScreenCalled = true
},
onNavigateToManualCodeEntryScreen = {
onNavigateToManualCodeEntryScreenCalled = true
},
viewModel = viewModel,
permissionsManager = fakePermissionManager,
)
}
}
@@ -92,6 +96,13 @@ class VaultAddEditScreenTest : BaseComposeTest() {
assertTrue(onNavigateQrCodeScanScreenCalled)
}
@Suppress("MaxLineLength")
@Test
fun `on NavigateToManualCodeEntry event should invoke NavigateToManualCodeEntry`() {
mutableEventFlow.tryEmit(VaultAddEditEvent.NavigateToManualCodeEntry)
assertTrue(onNavigateToManualCodeEntryScreenCalled)
}
@Test
fun `clicking close button should send CloseClick action`() {
composeTestRule
@@ -1429,6 +1440,7 @@ class VaultAddEditScreenTest : BaseComposeTest() {
.onNodeWithTextAfterScroll(text = "Security code")
.assertTextContains("123")
}
@Test
fun `clicking New Custom Field button should allow creation of Linked type`() {
mutableStateFlow.value = DEFAULT_STATE_LOGIN
@@ -558,7 +558,7 @@ class VaultAddEditViewModelTest : BaseViewModelTest() {
@Suppress("MaxLineLength")
@Test
fun `SetupTotpClick should emit ShowToast with permission not granted when isGranted is false`() =
fun `SetupTotpClick should emit NavigateToManualCodeEntry when isGranted is false`() =
runTest {
val viewModel = createAddVaultItemViewModel()
@@ -568,10 +568,8 @@ class VaultAddEditViewModelTest : BaseViewModelTest() {
isGranted = false,
),
)
assertEquals(
VaultAddEditEvent.ShowToast("Permission Not Granted, Manual QR Code Entry Not Implemented".asText()),
awaitItem(),
)
assertEquals(VaultAddEditEvent.NavigateToManualCodeEntry, awaitItem())
}
}
@@ -0,0 +1,204 @@
package com.x8bit.bitwarden.ui.vault.feature.manualcodeentry
import android.app.Application
import android.content.Intent
import android.net.Uri
import androidx.compose.ui.test.assertIsDisplayed
import androidx.compose.ui.test.assertIsNotDisplayed
import androidx.compose.ui.test.assertTextEquals
import androidx.compose.ui.test.filterToOne
import androidx.compose.ui.test.hasAnyAncestor
import androidx.compose.ui.test.isDialog
import androidx.compose.ui.test.onAllNodesWithText
import androidx.compose.ui.test.onFirst
import androidx.compose.ui.test.onNodeWithText
import androidx.compose.ui.test.performClick
import androidx.compose.ui.test.performTextInput
import androidx.test.core.app.ApplicationProvider
import com.x8bit.bitwarden.data.platform.repository.util.bufferedMutableSharedFlow
import com.x8bit.bitwarden.ui.platform.base.BaseComposeTest
import com.x8bit.bitwarden.ui.platform.base.util.FakePermissionManager
import com.x8bit.bitwarden.ui.platform.base.util.IntentHandler
import io.mockk.every
import io.mockk.mockk
import io.mockk.slot
import io.mockk.verify
import junit.framework.TestCase.assertEquals
import junit.framework.TestCase.assertTrue
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.update
import org.junit.Before
import org.junit.Test
class ManualCodeEntryScreenTests : BaseComposeTest() {
private var onNavigateBackCalled = false
private var onNavigateToScanQrCodeCalled = false
private val mutableEventFlow = bufferedMutableSharedFlow<ManualCodeEntryEvent>()
private val mutableStateFlow =
MutableStateFlow(ManualCodeEntryState(""))
private val fakePermissionManager: FakePermissionManager = FakePermissionManager()
private val intentHandler = mockk<IntentHandler>(relaxed = true)
private val viewModel = mockk<ManualCodeEntryViewModel>(relaxed = true) {
every { eventFlow } returns mutableEventFlow
every { stateFlow } returns mutableStateFlow
}
@Before
fun setup() {
composeTestRule.setContent {
ManualCodeEntryScreen(
onNavigateBack = { onNavigateBackCalled = true },
viewModel = viewModel,
onNavigateToQrCodeScreen = {
onNavigateToScanQrCodeCalled = true
},
permissionsManager = fakePermissionManager,
intentHandler = intentHandler,
)
}
}
@Test
fun `on NavigateBack event should invoke onNavigateBack`() {
mutableEventFlow.tryEmit(ManualCodeEntryEvent.NavigateBack)
assertTrue(onNavigateBackCalled)
}
@Test
fun `on NavigateToScanQrCode event should invoke NavigateToScanQrCode`() {
mutableEventFlow.tryEmit(ManualCodeEntryEvent.NavigateToQrCodeScreen)
assertTrue(onNavigateToScanQrCodeCalled)
}
@Test
fun `on NavigateToAppSettings event should invoke intent handler`() {
mutableEventFlow.tryEmit(ManualCodeEntryEvent.NavigateToAppSettings)
val uri = Uri.parse(
"package:" +
ApplicationProvider
.getApplicationContext<Application>()
.packageName,
)
val intentSlot = slot<Intent>()
verify { intentHandler.startActivity(capture(intentSlot)) }
assertEquals(
uri,
intentSlot.captured.data,
)
}
@Suppress("MaxLineLength")
@Test
fun `clicking on manual text should send ScanQrCodeTextClick if camera permission is granted`() {
fakePermissionManager.checkPermissionResult = true
composeTestRule
.onNodeWithText("Scan QR Code")
.performClick()
verify {
viewModel.trySendAction(ManualCodeEntryAction.ScanQrCodeTextClick)
}
}
@Test
fun `dialog should be dismissed on dismiss click in settings dialog`() {
fakePermissionManager.checkPermissionResult = false
composeTestRule
.onNodeWithText("Scan QR Code")
.performClick()
composeTestRule
.onAllNodesWithText("Enable camera permission to use the scanner")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onNodeWithText("No thanks")
.performClick()
composeTestRule
.onAllNodesWithText("Enable camera permission to use the scanner")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsNotDisplayed()
}
@Test
fun `settings dialog should call SettingsClick action on confirm click`() {
fakePermissionManager.checkPermissionResult = false
composeTestRule
.onNodeWithText("Scan QR Code")
.performClick()
composeTestRule
.onAllNodesWithText("Enable camera permission to use the scanner")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onNodeWithText("Settings")
.performClick()
verify {
viewModel.trySendAction(ManualCodeEntryAction.SettingsClick)
}
}
@Test
fun `CodeTextChanged will be sent when text for code is updated`() {
composeTestRule
.onAllNodesWithText(text = "Authenticator key")
.onFirst()
.assertTextEquals("Authenticator key", "")
composeTestRule
.onAllNodesWithText(text = "Authenticator key")
.onFirst()
.performTextInput(text = "TestCode")
verify {
viewModel.trySendAction(
ManualCodeEntryAction.CodeTextChange("TestCode"),
)
}
}
@Test
fun `Authenticator key text should display the text provided by the state`() {
composeTestRule
.onAllNodesWithText(text = "Authenticator key")
.onFirst()
.assertTextEquals("Authenticator key", "")
mutableStateFlow.update {
it.copy(code = "TestCode")
}
composeTestRule
.onAllNodesWithText(text = "Authenticator key")
.onFirst()
.assertTextEquals("Authenticator key", "TestCode")
}
@Test
fun `clicking Add TOTP button should send CodeSubmit action`() {
composeTestRule
.onNodeWithText(text = "Add TOTP")
.performClick()
verify {
viewModel.trySendAction(
ManualCodeEntryAction.CodeSubmit,
)
}
}
}
@@ -0,0 +1,92 @@
package com.x8bit.bitwarden.ui.vault.feature.manualcodeentry
import androidx.lifecycle.SavedStateHandle
import app.cash.turbine.test
import com.x8bit.bitwarden.data.platform.repository.util.bufferedMutableSharedFlow
import com.x8bit.bitwarden.data.vault.repository.VaultRepository
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import io.mockk.every
import io.mockk.just
import io.mockk.mockk
import io.mockk.runs
import io.mockk.verify
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
class ManualCodeEntryViewModelTests : BaseViewModelTest() {
private val totpTestCodeFlow: Flow<String> = bufferedMutableSharedFlow()
private val vaultRepository: VaultRepository = mockk {
every { totpCodeFlow } returns totpTestCodeFlow
every { emitTotpCode(any()) } just runs
}
@Test
fun `CloseClick should emit NavigateBack`() = runTest {
val viewModel = createViewModel(initialState = ManualCodeEntryState(""))
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(ManualCodeEntryAction.CloseClick)
assertEquals(ManualCodeEntryEvent.NavigateBack, awaitItem())
}
}
@Test
fun `CodeSubmit should emit new code and NavigateBack`() = runTest {
val viewModel =
createViewModel(initialState = ManualCodeEntryState("TestCode"))
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(ManualCodeEntryAction.CodeSubmit)
verify(exactly = 1) { vaultRepository.emitTotpCode("TestCode") }
assertEquals(ManualCodeEntryEvent.NavigateBack, awaitItem())
}
}
@Test
fun `CodeTextChange should update state with new value`() = runTest {
val viewModel =
createViewModel(initialState = ManualCodeEntryState("TestCode"))
val expectedState = ManualCodeEntryState("NewCode")
viewModel.actionChannel.trySend(ManualCodeEntryAction.CodeTextChange("NewCode"))
assertEquals(expectedState, viewModel.stateFlow.value)
}
@Test
fun `SettingsClick should emit NavigateToAppSettings and update state`() = runTest {
val viewModel = createViewModel(initialState = ManualCodeEntryState(""))
val expectedState = ManualCodeEntryState("")
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(ManualCodeEntryAction.SettingsClick)
assertEquals(ManualCodeEntryEvent.NavigateToAppSettings, awaitItem())
assertEquals(expectedState, viewModel.stateFlow.value)
}
}
@Test
fun `ScanQrTextCodeClick should emit NavigateToQrCodeScreen`() = runTest {
val viewModel = createViewModel(initialState = ManualCodeEntryState(""))
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(ManualCodeEntryAction.ScanQrCodeTextClick)
assertEquals(ManualCodeEntryEvent.NavigateToQrCodeScreen, awaitItem())
}
}
private fun createViewModel(initialState: ManualCodeEntryState): ManualCodeEntryViewModel =
ManualCodeEntryViewModel(
vaultRepository = vaultRepository,
savedStateHandle = SavedStateHandle(
initialState = mapOf("state" to initialState),
),
)
}
@@ -17,6 +17,7 @@ import org.robolectric.annotation.Config
class QrCodeScanScreenTest : BaseComposeTest() {
private var onNavigateBackCalled = false
private var onNavigateToManualCodeEntryScreenCalled = false
private val imageProxy: ImageProxy = mockk()
private val qrCodeAnalyzer = FakeQrCodeAnalyzer()
@@ -31,9 +32,12 @@ class QrCodeScanScreenTest : BaseComposeTest() {
fun setup() {
composeTestRule.setContent {
QrCodeScanScreen(
qrCodeAnalyzer = qrCodeAnalyzer,
viewModel = viewModel,
onNavigateBack = { onNavigateBackCalled = true },
viewModel = viewModel,
qrCodeAnalyzer = qrCodeAnalyzer,
onNavigateToManualCodeEntryScreen = {
onNavigateToManualCodeEntryScreenCalled = true
},
)
}
}
@@ -44,6 +48,12 @@ class QrCodeScanScreenTest : BaseComposeTest() {
assertTrue(onNavigateBackCalled)
}
@Test
fun `on NavigateToManualCodeEntry event should invoke onNavigateToManualCodeEntryScreen`() {
mutableEventFlow.tryEmit(QrCodeScanEvent.NavigateToManualCodeEntry)
assertTrue(onNavigateToManualCodeEntryScreenCalled)
}
@Test
fun `when unable to setup camera CameraErrorReceive will be sent`() = runTest {
// Because the camera is not set up in the tests, this will always be triggered
@@ -4,7 +4,6 @@ import app.cash.turbine.test
import com.x8bit.bitwarden.data.platform.repository.util.bufferedMutableSharedFlow
import com.x8bit.bitwarden.data.vault.repository.VaultRepository
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import com.x8bit.bitwarden.ui.platform.base.util.asText
import io.mockk.every
import io.mockk.just
import io.mockk.mockk
@@ -34,13 +33,13 @@ class QrCodeScanViewModelTest : BaseViewModelTest() {
}
@Test
fun `CameraErrorReceive should emit ShowToast`() = runTest {
fun `CameraErrorReceive should emit NavigateToManualCodeEntry`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(QrCodeScanAction.CameraSetupErrorReceive)
assertEquals(
QrCodeScanEvent.ShowToast("Not yet implemented.".asText()),
QrCodeScanEvent.NavigateToManualCodeEntry,
awaitItem(),
)
}
@@ -53,7 +52,7 @@ class QrCodeScanViewModelTest : BaseViewModelTest() {
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(QrCodeScanAction.ManualEntryTextClick)
assertEquals(
QrCodeScanEvent.ShowToast("Not yet implemented.".asText()),
QrCodeScanEvent.NavigateToManualCodeEntry,
awaitItem(),
)
}