Add overflow items to sends listings (#665)

This commit is contained in:
David Perez
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent 8c64d6b01b
commit 413677852b
9 changed files with 516 additions and 21 deletions
@@ -12,6 +12,7 @@ import androidx.compose.ui.test.isDialog
import androidx.compose.ui.test.isDisplayed
import androidx.compose.ui.test.isPopup
import androidx.compose.ui.test.onAllNodesWithText
import androidx.compose.ui.test.onChildren
import androidx.compose.ui.test.onNodeWithContentDescription
import androidx.compose.ui.test.onNodeWithText
import androidx.compose.ui.test.performClick
@@ -19,13 +20,18 @@ import androidx.compose.ui.test.performScrollToNode
import com.x8bit.bitwarden.R
import com.x8bit.bitwarden.data.platform.repository.model.Environment
import com.x8bit.bitwarden.data.platform.repository.util.baseIconUrl
import com.x8bit.bitwarden.data.platform.repository.util.baseWebSendUrl
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.asText
import com.x8bit.bitwarden.ui.platform.components.model.IconData
import com.x8bit.bitwarden.ui.platform.manager.intent.IntentManager
import com.x8bit.bitwarden.ui.util.assertNoDialogExists
import com.x8bit.bitwarden.ui.util.isProgressBar
import io.mockk.every
import io.mockk.just
import io.mockk.mockk
import io.mockk.runs
import io.mockk.verify
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.update
@@ -42,6 +48,9 @@ class VaultItemListingScreenTest : BaseComposeTest() {
private var onNavigateToEditSendItemId: String? = null
private var onNavigateToVaultItemId: String? = null
private val intentManager: IntentManager = mockk {
every { shareText(any()) } just runs
}
private val mutableEventFlow = bufferedMutableSharedFlow<VaultItemListingEvent>()
private val mutableStateFlow = MutableStateFlow(DEFAULT_STATE)
private val viewModel = mockk<VaultItemListingViewModel>(relaxed = true) {
@@ -54,6 +63,7 @@ class VaultItemListingScreenTest : BaseComposeTest() {
composeTestRule.setContent {
VaultItemListingScreen(
viewModel = viewModel,
intentManager = intentManager,
onNavigateBack = { onNavigateBackCalled = true },
onNavigateToVaultItem = { onNavigateToVaultItemId = it },
onNavigateToVaultAddItemScreen = { onNavigateToVaultAddItemScreenCalled = true },
@@ -113,6 +123,15 @@ class VaultItemListingScreenTest : BaseComposeTest() {
verify { viewModel.trySendAction(VaultItemListingsAction.RefreshClick) }
}
@Test
fun `ShowShareSheet event should call shareText in intentManager`() {
val content = "content"
mutableEventFlow.tryEmit(VaultItemListingEvent.ShowShareSheet(content = content))
verify {
intentManager.shareText(content)
}
}
@Test
fun `NavigateToAdd VaultItem event should call NavigateToVaultAddItemScreen`() {
mutableEventFlow.tryEmit(VaultItemListingEvent.NavigateToAddVaultItem)
@@ -476,6 +495,114 @@ class VaultItemListingScreenTest : BaseComposeTest() {
}
}
@Test
fun `on send item overflow click should display dialog`() {
val number = 1
mutableStateFlow.update {
it.copy(
viewState = VaultItemListingState.ViewState.Content(
displayItemList = listOf(createDisplayItem(number = number)),
),
)
}
composeTestRule.assertNoDialogExists()
composeTestRule
.onNodeWithContentDescription("Options")
.assertIsDisplayed()
.performClick()
composeTestRule
.onNode(isDialog())
.onChildren()
.filterToOne(hasText("mockTitle-$number"))
.assertIsDisplayed()
}
@Test
fun `on send item overflow option click should emit the appropriate action`() {
val number = 1
mutableStateFlow.update {
it.copy(
viewState = VaultItemListingState.ViewState.Content(
displayItemList = listOf(createDisplayItem(number = number)),
),
)
}
composeTestRule.assertNoDialogExists()
composeTestRule
.onNodeWithContentDescription("Options")
.assertIsDisplayed()
.performClick()
composeTestRule
.onNodeWithText("Edit")
.assert(hasAnyAncestor(isDialog()))
.performClick()
verify(exactly = 1) {
viewModel.trySendAction(
VaultItemListingsAction.ItemClick(id = "mockId-$number"),
)
}
composeTestRule
.onNodeWithContentDescription("Options")
.assertIsDisplayed()
.performClick()
composeTestRule
.onNodeWithText("Copy link")
.assert(hasAnyAncestor(isDialog()))
.performClick()
verify(exactly = 1) {
viewModel.trySendAction(
VaultItemListingsAction.CopySendUrlClick(sendUrl = "www.test.com"),
)
}
composeTestRule
.onNodeWithContentDescription("Options")
.assertIsDisplayed()
.performClick()
composeTestRule
.onNodeWithText("Share link")
.assert(hasAnyAncestor(isDialog()))
.performClick()
verify(exactly = 1) {
viewModel.trySendAction(
VaultItemListingsAction.ShareSendUrlClick(sendUrl = "www.test.com"),
)
}
composeTestRule
.onNodeWithContentDescription("Options")
.assertIsDisplayed()
.performClick()
composeTestRule
.onNodeWithText("Remove password")
.assert(hasAnyAncestor(isDialog()))
.performClick()
verify(exactly = 1) {
viewModel.trySendAction(
VaultItemListingsAction.RemoveSendPasswordClick(sendId = "mockId-$number"),
)
}
composeTestRule
.onNodeWithContentDescription("Options")
.assertIsDisplayed()
.performClick()
composeTestRule
.onNodeWithText("Delete")
.assert(hasAnyAncestor(isDialog()))
.performClick()
verify(exactly = 1) {
viewModel.trySendAction(
VaultItemListingsAction.DeleteSendClick(sendId = "mockId-$number"),
)
}
}
@Test
fun `loading dialog should be displayed according to state`() {
val loadingMessage = "syncing"
@@ -500,6 +627,7 @@ class VaultItemListingScreenTest : BaseComposeTest() {
private val DEFAULT_STATE = VaultItemListingState(
itemListingType = VaultItemListingState.ItemListingType.Vault.Login,
viewState = VaultItemListingState.ViewState.Loading,
baseWebSendUrl = Environment.Us.environmentUrlData.baseWebSendUrl,
isIconLoadingDisabled = false,
baseIconUrl = Environment.Us.environmentUrlData.baseIconUrl,
dialogState = null,
@@ -511,4 +639,26 @@ private fun createDisplayItem(number: Int): VaultItemListingState.DisplayItem =
title = "mockTitle-$number",
subtitle = "mockSubtitle-$number",
iconData = IconData.Local(R.drawable.ic_card_item),
overflowOptions = listOf(
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.edit.asText(),
action = VaultItemListingsAction.ItemClick(id = "mockId-$number"),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.copy_link.asText(),
action = VaultItemListingsAction.CopySendUrlClick(sendUrl = "www.test.com"),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.share_link.asText(),
action = VaultItemListingsAction.ShareSendUrlClick(sendUrl = "www.test.com"),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.remove_password.asText(),
action = VaultItemListingsAction.RemoveSendPasswordClick(sendId = "mockId-$number"),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.delete.asText(),
action = VaultItemListingsAction.DeleteSendClick(sendId = "mockId-$number"),
),
),
)
@@ -4,11 +4,13 @@ import android.net.Uri
import androidx.lifecycle.SavedStateHandle
import app.cash.turbine.test
import com.x8bit.bitwarden.R
import com.x8bit.bitwarden.data.platform.manager.clipboard.BitwardenClipboardManager
import com.x8bit.bitwarden.data.platform.repository.EnvironmentRepository
import com.x8bit.bitwarden.data.platform.repository.SettingsRepository
import com.x8bit.bitwarden.data.platform.repository.model.DataState
import com.x8bit.bitwarden.data.platform.repository.model.Environment
import com.x8bit.bitwarden.data.platform.repository.util.baseIconUrl
import com.x8bit.bitwarden.data.platform.repository.util.baseWebSendUrl
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockCipherView
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockCollectionView
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockFolderView
@@ -18,7 +20,7 @@ import com.x8bit.bitwarden.data.vault.repository.model.VaultData
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import com.x8bit.bitwarden.ui.platform.base.util.asText
import com.x8bit.bitwarden.ui.platform.base.util.concat
import com.x8bit.bitwarden.ui.vault.feature.itemlisting.util.createMockItemListingDisplayItem
import com.x8bit.bitwarden.ui.vault.feature.itemlisting.util.createMockDisplayItemForCipher
import com.x8bit.bitwarden.ui.vault.model.VaultItemListingType
import io.mockk.every
import io.mockk.just
@@ -36,6 +38,8 @@ import org.junit.jupiter.api.Test
class VaultItemListingViewModelTest : BaseViewModelTest() {
private val clipboardManager: BitwardenClipboardManager = mockk()
private val mutableVaultDataStateFlow =
MutableStateFlow<DataState<VaultData>>(DataState.Loading)
private val vaultRepository: VaultRepository = mockk {
@@ -48,7 +52,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
}
private val mutableIsIconLoadingDisabledFlow = MutableStateFlow(false)
private val settingsRepository: SettingsRepository = mockk() {
private val settingsRepository: SettingsRepository = mockk {
every { isIconLoadingDisabled } returns false
every { isIconLoadingDisabledFlow } returns mutableIsIconLoadingDisabledFlow
}
@@ -163,6 +167,59 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
verify { vaultRepository.sync() }
}
@Test
fun `CopySendUrlClick should call setText on clipboardManager`() {
val sendUrl = "www.test.com"
every { clipboardManager.setText(sendUrl) } just runs
val viewModel = createVaultItemListingViewModel()
viewModel.actionChannel.trySend(VaultItemListingsAction.CopySendUrlClick(sendUrl = sendUrl))
verify(exactly = 1) {
clipboardManager.setText(text = sendUrl)
}
}
@Test
fun `DeleteSendClick should emit ShowToast`() = runTest {
val sendId = "sendId"
val viewModel = createVaultItemListingViewModel()
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(
VaultItemListingsAction.DeleteSendClick(sendId = sendId),
)
assertEquals(
VaultItemListingEvent.ShowToast("Not yet implemented".asText()),
awaitItem(),
)
}
}
@Test
fun `ShareSendUrlClick should emit ShowShareSheet`() = runTest {
val sendUrl = "www.test.com"
val viewModel = createVaultItemListingViewModel()
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(
VaultItemListingsAction.ShareSendUrlClick(sendUrl = sendUrl),
)
assertEquals(VaultItemListingEvent.ShowShareSheet(sendUrl), awaitItem())
}
}
@Test
fun `RemoveSendPasswordClick should emit ShowToast`() = runTest {
val sendId = "sendId"
val viewModel = createVaultItemListingViewModel()
viewModel.eventFlow.test {
viewModel.actionChannel.trySend(
VaultItemListingsAction.RemoveSendPasswordClick(sendId = sendId),
)
assertEquals(
VaultItemListingEvent.ShowToast("Not yet implemented".asText()),
awaitItem(),
)
}
}
@Test
fun `vaultDataStateFlow Loaded with items should update ViewState to Content`() =
runTest {
@@ -190,7 +247,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
createVaultItemListingState(
viewState = VaultItemListingState.ViewState.Content(
displayItemList = listOf(
createMockItemListingDisplayItem(number = 1),
createMockDisplayItemForCipher(number = 1),
),
),
),
@@ -273,7 +330,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
createVaultItemListingState(
viewState = VaultItemListingState.ViewState.Content(
displayItemList = listOf(
createMockItemListingDisplayItem(number = 1),
createMockDisplayItemForCipher(number = 1),
),
),
),
@@ -365,7 +422,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
createVaultItemListingState(
viewState = VaultItemListingState.ViewState.Content(
displayItemList = listOf(
createMockItemListingDisplayItem(number = 1),
createMockDisplayItemForCipher(number = 1),
),
),
),
@@ -464,7 +521,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
createVaultItemListingState(
viewState = VaultItemListingState.ViewState.Content(
displayItemList = listOf(
createMockItemListingDisplayItem(number = 1),
createMockDisplayItemForCipher(number = 1),
),
),
),
@@ -577,6 +634,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
): VaultItemListingViewModel =
VaultItemListingViewModel(
savedStateHandle = savedStateHandle,
clipboardManager = clipboardManager,
vaultRepository = vaultRepository,
environmentRepository = environmentRepository,
settingsRepository = settingsRepository,
@@ -590,6 +648,7 @@ class VaultItemListingViewModelTest : BaseViewModelTest() {
VaultItemListingState(
itemListingType = itemListingType,
viewState = viewState,
baseWebSendUrl = Environment.Us.environmentUrlData.baseWebSendUrl,
baseIconUrl = environmentRepository.environment.environmentUrlData.baseIconUrl,
isIconLoadingDisabled = settingsRepository.isIconLoadingDisabled,
dialogState = null,
@@ -2,11 +2,14 @@ package com.x8bit.bitwarden.ui.vault.feature.itemlisting.util
import android.net.Uri
import com.bitwarden.core.CipherType
import com.bitwarden.core.SendType
import com.x8bit.bitwarden.data.platform.repository.model.Environment
import com.x8bit.bitwarden.data.platform.repository.util.baseIconUrl
import com.x8bit.bitwarden.data.platform.repository.util.baseWebSendUrl
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockCipherView
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockCollectionView
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockFolderView
import com.x8bit.bitwarden.data.vault.datasource.sdk.model.createMockSendView
import com.x8bit.bitwarden.ui.vault.feature.itemlisting.VaultItemListingState
import io.mockk.every
import io.mockk.mockk
@@ -249,6 +252,44 @@ class VaultItemListingDataExtensionsTest {
}
}
@Test
fun `determineListingPredicate should return the correct predicate for File sendView`() {
val sendView = createMockSendView(number = 1, type = SendType.FILE)
mapOf(
VaultItemListingState.ItemListingType.Send.SendFile to true,
VaultItemListingState.ItemListingType.Send.SendText to false,
)
.forEach { (type, expected) ->
val result = sendView.determineListingPredicate(
itemListingType = type,
)
assertEquals(
expected,
result,
)
}
}
@Test
fun `determineListingPredicate should return the correct predicate for Text sendView`() {
val sendView = createMockSendView(number = 1, type = SendType.TEXT)
mapOf(
VaultItemListingState.ItemListingType.Send.SendFile to false,
VaultItemListingState.ItemListingType.Send.SendText to true,
)
.forEach { (type, expected) ->
val result = sendView.determineListingPredicate(
itemListingType = type,
)
assertEquals(
expected,
result,
)
}
}
@Test
fun `toViewState should transform a list of CipherViews into a ViewState`() {
mockkStatic(Uri::class)
@@ -287,19 +328,19 @@ class VaultItemListingDataExtensionsTest {
assertEquals(
VaultItemListingState.ViewState.Content(
displayItemList = listOf(
createMockItemListingDisplayItem(
createMockDisplayItemForCipher(
number = 1,
cipherType = CipherType.LOGIN,
),
createMockItemListingDisplayItem(
createMockDisplayItemForCipher(
number = 2,
cipherType = CipherType.CARD,
),
createMockItemListingDisplayItem(
createMockDisplayItemForCipher(
number = 3,
cipherType = CipherType.SECURE_NOTE,
),
createMockItemListingDisplayItem(
createMockDisplayItemForCipher(
number = 4,
cipherType = CipherType.IDENTITY,
),
@@ -311,6 +352,28 @@ class VaultItemListingDataExtensionsTest {
unmockkStatic(Uri::class)
}
@Test
fun `toViewState should transform a list of SendViews into a ViewState`() {
val sendViewList = listOf(
createMockSendView(number = 1, type = SendType.FILE),
createMockSendView(number = 2, type = SendType.TEXT),
)
val result = sendViewList.toViewState(
baseWebSendUrl = Environment.Us.environmentUrlData.baseWebSendUrl,
)
assertEquals(
VaultItemListingState.ViewState.Content(
displayItemList = listOf(
createMockDisplayItemForSend(number = 1, sendType = SendType.FILE),
createMockDisplayItemForSend(number = 2, sendType = SendType.TEXT),
),
),
result,
)
}
@Test
fun `updateWithAdditionalDataIfNecessary should update a folder itemListingType`() {
val folderViewList = listOf(
@@ -1,14 +1,17 @@
package com.x8bit.bitwarden.ui.vault.feature.itemlisting.util
import com.bitwarden.core.CipherType
import com.bitwarden.core.SendType
import com.x8bit.bitwarden.R
import com.x8bit.bitwarden.ui.platform.base.util.asText
import com.x8bit.bitwarden.ui.platform.components.model.IconData
import com.x8bit.bitwarden.ui.vault.feature.itemlisting.VaultItemListingState
import com.x8bit.bitwarden.ui.vault.feature.itemlisting.VaultItemListingsAction
/**
* Create a mock [VaultItemListingState.DisplayItem] with a given [number].
*/
fun createMockItemListingDisplayItem(
fun createMockDisplayItemForCipher(
number: Int,
cipherType: CipherType = CipherType.LOGIN,
): VaultItemListingState.DisplayItem =
@@ -22,6 +25,7 @@ fun createMockItemListingDisplayItem(
"https://vault.bitwarden.com/icons/www.mockuri.com/icon.png",
fallbackIconRes = R.drawable.ic_login_item,
),
overflowOptions = emptyList(),
)
}
@@ -31,6 +35,7 @@ fun createMockItemListingDisplayItem(
title = "mockName-$number",
subtitle = null,
iconData = IconData.Local(R.drawable.ic_secure_note_item),
overflowOptions = emptyList(),
)
}
@@ -40,6 +45,7 @@ fun createMockItemListingDisplayItem(
title = "mockName-$number",
subtitle = "er-$number",
iconData = IconData.Local(R.drawable.ic_card_item),
overflowOptions = emptyList(),
)
}
@@ -49,6 +55,91 @@ fun createMockItemListingDisplayItem(
title = "mockName-$number",
subtitle = "mockFirstName-${number}mockLastName-$number",
iconData = IconData.Local(R.drawable.ic_identity_item),
overflowOptions = emptyList(),
)
}
}
/**
* Create a mock [VaultItemListingState.DisplayItem] with a given [number].
*/
@Suppress("MaxLineLength")
fun createMockDisplayItemForSend(
number: Int,
sendType: SendType = SendType.FILE,
): VaultItemListingState.DisplayItem =
when (sendType) {
SendType.FILE -> {
VaultItemListingState.DisplayItem(
id = "mockId-$number",
title = "mockName-$number",
subtitle = "2023-10-27T12:00:00Z",
iconData = IconData.Local(R.drawable.ic_send_file),
overflowOptions = listOfNotNull(
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.edit.asText(),
action = VaultItemListingsAction.ItemClick(id = "mockId-$number"),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.copy_link.asText(),
action = VaultItemListingsAction.CopySendUrlClick(
sendUrl = "https://vault.bitwarden.com/#/send/mockAccessId-$number/mockKey-$number",
),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.share_link.asText(),
action = VaultItemListingsAction.ShareSendUrlClick(
sendUrl = "https://vault.bitwarden.com/#/send/mockAccessId-$number/mockKey-$number",
),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.remove_password.asText(),
action = VaultItemListingsAction.RemoveSendPasswordClick(
sendId = "mockId-$number",
),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.delete.asText(),
action = VaultItemListingsAction.DeleteSendClick(sendId = "mockId-$number"),
),
),
)
}
SendType.TEXT -> {
VaultItemListingState.DisplayItem(
id = "mockId-$number",
title = "mockName-$number",
subtitle = "2023-10-27T12:00:00Z",
iconData = IconData.Local(R.drawable.ic_send_text),
overflowOptions = listOfNotNull(
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.edit.asText(),
action = VaultItemListingsAction.ItemClick(id = "mockId-$number"),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.copy_link.asText(),
action = VaultItemListingsAction.CopySendUrlClick(
sendUrl = "https://vault.bitwarden.com/#/send/mockAccessId-$number/mockKey-$number",
),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.share_link.asText(),
action = VaultItemListingsAction.ShareSendUrlClick(
sendUrl = "https://vault.bitwarden.com/#/send/mockAccessId-$number/mockKey-$number",
),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.remove_password.asText(),
action = VaultItemListingsAction.RemoveSendPasswordClick(
sendId = "mockId-$number",
),
),
VaultItemListingState.DisplayItem.OverflowItem(
title = R.string.delete.asText(),
action = VaultItemListingsAction.DeleteSendClick(sendId = "mockId-$number"),
),
),
)
}
}