BIT-534: Adding UI and tests for the the vault list screen (#216)

This commit is contained in:
joshua-livefront
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent 887fe99746
commit 9c82e575a1
9 changed files with 974 additions and 107 deletions
@@ -1,115 +1,165 @@
package com.x8bit.bitwarden.ui.vault.feature.vault
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.test.onNodeWithContentDescription
import androidx.compose.ui.test.onNodeWithText
import androidx.compose.ui.test.performClick
import androidx.compose.ui.test.performScrollTo
import com.x8bit.bitwarden.ui.platform.base.BaseComposeTest
import io.mockk.every
import io.mockk.mockk
import io.mockk.verify
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.emptyFlow
import kotlinx.coroutines.flow.flowOf
import kotlinx.coroutines.flow.update
import org.junit.Assert.assertTrue
import org.junit.Before
import org.junit.Test
class VaultScreenTest : BaseComposeTest() {
@Test
fun `search icon click should send SearchIconClick action`() {
val viewModel = mockk<VaultViewModel>(relaxed = true) {
every { eventFlow } returns emptyFlow()
every { stateFlow } returns MutableStateFlow(
VaultState(
avatarColor = Color.Blue,
initials = "BW",
viewState = VaultState.ViewState.NoItems,
),
private var onNavigateToVaultAddItemScreenCalled = false
private val mutableEventFlow = MutableSharedFlow<VaultEvent>(
extraBufferCapacity = Int.MAX_VALUE,
)
private val mutableStateFlow = MutableStateFlow(DEFAULT_STATE)
private val viewModel = mockk<VaultViewModel>(relaxed = true) {
every { eventFlow } returns mutableEventFlow
every { stateFlow } returns mutableStateFlow
}
@Before
fun setUp() {
composeTestRule.setContent {
VaultScreen(
viewModel = viewModel,
onNavigateToVaultAddItemScreen = { onNavigateToVaultAddItemScreenCalled = true },
)
}
composeTestRule.apply {
setContent {
VaultScreen(
viewModel = viewModel,
onNavigateToVaultAddItemScreen = {},
)
}
onNodeWithContentDescription("Search vault").performClick()
}
}
@Test
fun `search icon click should send SearchIconClick action`() {
mutableStateFlow.update { it.copy(viewState = VaultState.ViewState.NoItems) }
composeTestRule.onNodeWithContentDescription("Search vault").performClick()
verify { viewModel.trySendAction(VaultAction.SearchIconClick) }
}
@Test
fun `floating action button click should send AddItemClick action`() {
val viewModel = mockk<VaultViewModel>(relaxed = true) {
every { eventFlow } returns emptyFlow()
every { stateFlow } returns MutableStateFlow(
VaultState(
avatarColor = Color.Blue,
initials = "BW",
viewState = VaultState.ViewState.NoItems,
),
)
}
composeTestRule.apply {
setContent {
VaultScreen(
viewModel = viewModel,
onNavigateToVaultAddItemScreen = {},
)
}
onNodeWithContentDescription("Add item").performClick()
}
mutableStateFlow.update { it.copy(viewState = VaultState.ViewState.NoItems) }
composeTestRule.onNodeWithContentDescription("Add item").performClick()
verify { viewModel.trySendAction(VaultAction.AddItemClick) }
}
@Test
fun `add an item button click should send AddItemClick action`() {
val viewModel = mockk<VaultViewModel>(relaxed = true) {
every { eventFlow } returns emptyFlow()
every { stateFlow } returns MutableStateFlow(
VaultState(
avatarColor = Color.Blue,
initials = "BW",
viewState = VaultState.ViewState.NoItems,
),
)
}
composeTestRule.apply {
setContent {
VaultScreen(
viewModel = viewModel,
onNavigateToVaultAddItemScreen = {},
)
}
onNodeWithText("Add an Item").performClick()
}
mutableStateFlow.update { it.copy(viewState = VaultState.ViewState.NoItems) }
composeTestRule.onNodeWithText("Add an Item").performClick()
verify { viewModel.trySendAction(VaultAction.AddItemClick) }
}
@Test
fun `NavigateToAddItemScreen event should call onNavigateToVaultAddItemScreen`() {
var onNavigateToVaultAddItemScreenCalled = false
val viewModel = mockk<VaultViewModel>(relaxed = true) {
every { eventFlow } returns flowOf(VaultEvent.NavigateToAddItemScreen)
every { stateFlow } returns MutableStateFlow(
VaultState(
avatarColor = Color.Blue,
initials = "BW",
viewState = VaultState.ViewState.NoItems,
mutableEventFlow.tryEmit(VaultEvent.NavigateToAddItemScreen)
assertTrue(onNavigateToVaultAddItemScreenCalled)
}
@Test
fun `clicking a login item should send LoginGroupClick action`() {
mutableStateFlow.update {
it.copy(
viewState = VaultState.ViewState.Content(
loginItemsCount = 0,
cardItemsCount = 0,
identityItemsCount = 0,
secureNoteItemsCount = 0,
favoriteItems = emptyList(),
folderItems = emptyList(),
noFolderItems = emptyList(),
trashItemsCount = 0,
),
)
}
composeTestRule.setContent {
VaultScreen(
onNavigateToVaultAddItemScreen = { onNavigateToVaultAddItemScreenCalled = true },
viewModel = viewModel,
composeTestRule.onNodeWithText("Login").performScrollTo().performClick()
verify {
viewModel.trySendAction(VaultAction.LoginGroupClick)
}
}
@Test
fun `clicking a card item should send CardGroupClick action`() {
mutableStateFlow.update {
it.copy(
viewState = VaultState.ViewState.Content(
loginItemsCount = 0,
cardItemsCount = 0,
identityItemsCount = 0,
secureNoteItemsCount = 0,
favoriteItems = emptyList(),
folderItems = emptyList(),
noFolderItems = emptyList(),
trashItemsCount = 0,
),
)
}
assertTrue(onNavigateToVaultAddItemScreenCalled)
composeTestRule.onNodeWithText("Card").performScrollTo().performClick()
verify {
viewModel.trySendAction(VaultAction.CardGroupClick)
}
}
@Test
fun `clicking an identity item should send IdentityGroupClick action`() {
mutableStateFlow.update {
it.copy(
viewState = VaultState.ViewState.Content(
loginItemsCount = 0,
cardItemsCount = 0,
identityItemsCount = 0,
secureNoteItemsCount = 0,
favoriteItems = emptyList(),
folderItems = emptyList(),
noFolderItems = emptyList(),
trashItemsCount = 0,
),
)
}
composeTestRule.onNodeWithText("Identity").performScrollTo().performClick()
verify {
viewModel.trySendAction(VaultAction.IdentityGroupClick)
}
}
@Test
fun `clicking a secure note item should send SecureNoteGroupClick action`() {
mutableStateFlow.update {
it.copy(
viewState = VaultState.ViewState.Content(
loginItemsCount = 0,
cardItemsCount = 0,
identityItemsCount = 0,
secureNoteItemsCount = 0,
favoriteItems = emptyList(),
folderItems = emptyList(),
noFolderItems = emptyList(),
trashItemsCount = 0,
),
)
}
composeTestRule.onNodeWithText("Secure note").performScrollTo().performClick()
verify {
viewModel.trySendAction(VaultAction.SecureNoteGroupClick)
}
}
}
private val DEFAULT_STATE: VaultState = VaultState(
avatarColorString = "FF0000FF",
initials = "BW",
viewState = VaultState.ViewState.Loading,
)
@@ -1,7 +1,10 @@
package com.x8bit.bitwarden.ui.vault.feature.vault
import androidx.lifecycle.SavedStateHandle
import app.cash.turbine.test
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import io.mockk.every
import io.mockk.mockk
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
@@ -9,8 +12,24 @@ import org.junit.jupiter.api.Test
class VaultViewModelTest : BaseViewModelTest() {
@Test
fun `AddItemClick should navigate to the add item screen`() = runTest {
val viewModel = VaultViewModel()
fun `initial state should be correct when not set`() {
val viewModel = createViewModel()
assertEquals(DEFAULT_STATE, viewModel.stateFlow.value)
}
@Test
fun `initial state should be correct when set`() {
val state = DEFAULT_STATE.copy(
initials = "WB",
avatarColorString = "00FF00",
)
val viewModel = createViewModel(state = state)
assertEquals(state, viewModel.stateFlow.value)
}
@Test
fun `AddItemClick should emit NavigateToAddItemScreen`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.AddItemClick)
assertEquals(VaultEvent.NavigateToAddItemScreen, awaitItem())
@@ -18,11 +37,94 @@ class VaultViewModelTest : BaseViewModelTest() {
}
@Test
fun `SearchIconClick should navigate to the vault search screen`() = runTest {
val viewModel = VaultViewModel()
fun `CardGroupClick should emit NavigateToCardGroup`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.CardGroupClick)
assertEquals(VaultEvent.NavigateToCardGroup, awaitItem())
}
}
@Test
fun `FolderClick should emit NavigateToFolder with correct folder ID`() = runTest {
val viewModel = createViewModel()
val folderId = "12345"
val folder = mockk<VaultState.ViewState.FolderItem> {
every { id } returns folderId
}
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.FolderClick(folder))
assertEquals(VaultEvent.NavigateToFolder(folderId), awaitItem())
}
}
@Test
fun `IdentityGroupClick should emit NavigateToIdentityGroup`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.IdentityGroupClick)
assertEquals(VaultEvent.NavigateToIdentityGroup, awaitItem())
}
}
@Test
fun `LoginGroupClick should emit NavigateToLoginGroup`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.LoginGroupClick)
assertEquals(VaultEvent.NavigateToLoginGroup, awaitItem())
}
}
@Test
fun `SearchIconClick should emit NavigateToVaultSearchScreen`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.SearchIconClick)
assertEquals(VaultEvent.NavigateToVaultSearchScreen, awaitItem())
}
}
@Test
fun `SecureNoteGroupClick should emit NavigateToSecureNotesGroup`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.SecureNoteGroupClick)
assertEquals(VaultEvent.NavigateToSecureNotesGroup, awaitItem())
}
}
@Test
fun `TrashClick should emit NavigateToTrash`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.TrashClick)
assertEquals(VaultEvent.NavigateToTrash, awaitItem())
}
}
@Test
fun `VaultItemClick should emit NavigateToVaultItem with the correct item ID`() = runTest {
val viewModel = createViewModel()
val itemId = "54321"
val item = mockk<VaultState.ViewState.VaultItem> {
every { id } returns itemId
}
viewModel.eventFlow.test {
viewModel.trySendAction(VaultAction.VaultItemClick(item))
assertEquals(VaultEvent.NavigateToVaultItem(itemId), awaitItem())
}
}
private fun createViewModel(
state: VaultState? = DEFAULT_STATE,
): VaultViewModel = VaultViewModel(
savedStateHandle = SavedStateHandle().apply { set("state", state) },
)
}
private val DEFAULT_STATE: VaultState = VaultState(
avatarColorString = "FF0000FF",
initials = "BW",
viewState = VaultState.ViewState.Loading,
)