mirror of
https://github.com/bitwarden/android.git
synced 2026-11-19 17:40:12 -06:00
BIT-279, BIT-1201: Storage, retrieval, and clearing implementation for password history (#416)
This commit is contained in:
committed by
Álison Fernandes
parent
39e285fff8
commit
27140bf02c
+81
-34
@@ -25,20 +25,21 @@ import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedPassph
|
||||
import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedPasswordResult
|
||||
import com.x8bit.bitwarden.data.tools.generator.repository.model.PasscodeGenerationOptions
|
||||
import com.x8bit.bitwarden.data.vault.datasource.sdk.VaultSdkSource
|
||||
import io.mockk.clearMocks
|
||||
import io.mockk.coEvery
|
||||
import io.mockk.coVerify
|
||||
import io.mockk.every
|
||||
import io.mockk.just
|
||||
import io.mockk.mockk
|
||||
import io.mockk.mockkStatic
|
||||
import io.mockk.runs
|
||||
import io.mockk.unmockkStatic
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.flowOf
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import org.junit.jupiter.api.AfterEach
|
||||
import org.junit.jupiter.api.Assertions.assertEquals
|
||||
import org.junit.jupiter.api.Assertions.assertNull
|
||||
import org.junit.jupiter.api.Assertions.assertTrue
|
||||
import org.junit.jupiter.api.BeforeEach
|
||||
import org.junit.jupiter.api.Test
|
||||
import java.time.Instant
|
||||
|
||||
@@ -50,6 +51,7 @@ class GeneratorRepositoryTest {
|
||||
private val generatorDiskSource: GeneratorDiskSource = mockk()
|
||||
private val authDiskSource: AuthDiskSource = mockk {
|
||||
every { userStateFlow } returns mutableUserStateFlow
|
||||
every { userState } returns null
|
||||
}
|
||||
private val passwordHistoryDiskSource: PasswordHistoryDiskSource = mockk()
|
||||
private val vaultSdkSource: VaultSdkSource = mockk()
|
||||
@@ -64,13 +66,19 @@ class GeneratorRepositoryTest {
|
||||
dispatcherManager = dispatcherManager,
|
||||
)
|
||||
|
||||
@BeforeEach
|
||||
fun setUp() {
|
||||
clearMocks(generatorSdkSource)
|
||||
@AfterEach
|
||||
fun tearDown() {
|
||||
unmockkStatic(Instant::class)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `generatePassword should emit Success result with the generated password`() = runTest {
|
||||
fun `generatePassword should emit Success result and store the generated password`() = runTest {
|
||||
val fixedInstant = Instant.parse("2021-01-01T00:00:00Z")
|
||||
|
||||
mockkStatic(Instant::class)
|
||||
every { Instant.now() } returns fixedInstant
|
||||
|
||||
val userId = "testUserId"
|
||||
val request = PasswordGeneratorRequest(
|
||||
lowercase = true,
|
||||
uppercase = true,
|
||||
@@ -83,15 +91,30 @@ class GeneratorRepositoryTest {
|
||||
minNumber = null,
|
||||
minSpecial = null,
|
||||
)
|
||||
val expectedResult = "GeneratedPassword123!"
|
||||
coEvery {
|
||||
generatorSdkSource.generatePassword(request)
|
||||
} returns Result.success(expectedResult)
|
||||
val generatedPassword = "GeneratedPassword123!"
|
||||
val encryptedPasswordHistory =
|
||||
PasswordHistory(password = generatedPassword, lastUsedDate = Instant.now())
|
||||
|
||||
coEvery { authDiskSource.userState?.activeUserId } returns userId
|
||||
|
||||
coEvery { generatorSdkSource.generatePassword(request) } returns
|
||||
Result.success(generatedPassword)
|
||||
|
||||
coEvery { vaultSdkSource.encryptPasswordHistory(any()) } returns
|
||||
Result.success(encryptedPasswordHistory)
|
||||
|
||||
coEvery { passwordHistoryDiskSource.insertPasswordHistory(any()) } just runs
|
||||
|
||||
val result = repository.generatePassword(request)
|
||||
|
||||
assertEquals(expectedResult, (result as GeneratedPasswordResult.Success).generatedString)
|
||||
assertEquals(generatedPassword, (result as GeneratedPasswordResult.Success).generatedString)
|
||||
coVerify { generatorSdkSource.generatePassword(request) }
|
||||
|
||||
coVerify {
|
||||
passwordHistoryDiskSource.insertPasswordHistory(
|
||||
encryptedPasswordHistory.toPasswordHistoryEntity(userId),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -118,23 +141,47 @@ class GeneratorRepositoryTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `generatePassphrase should emit Success result with the generated passphrase`() = runTest {
|
||||
val request = PassphraseGeneratorRequest(
|
||||
numWords = 5.toUByte(),
|
||||
capitalize = true,
|
||||
includeNumber = true,
|
||||
wordSeparator = '-'.toString(),
|
||||
)
|
||||
val expectedResult = "Generated-Passphrase-123!"
|
||||
coEvery {
|
||||
generatorSdkSource.generatePassphrase(request)
|
||||
} returns Result.success(expectedResult)
|
||||
fun `generatePassphrase should emit Success result and store the generated passphrase`() =
|
||||
runTest {
|
||||
val fixedInstant = Instant.parse("2021-01-01T00:00:00Z")
|
||||
mockkStatic(Instant::class)
|
||||
every { Instant.now() } returns fixedInstant
|
||||
|
||||
val result = repository.generatePassphrase(request)
|
||||
val userId = "testUserId"
|
||||
val request = PassphraseGeneratorRequest(
|
||||
numWords = 5.toUByte(),
|
||||
capitalize = true,
|
||||
includeNumber = true,
|
||||
wordSeparator = "-",
|
||||
)
|
||||
val generatedPassphrase = "Generated-Passphrase-123"
|
||||
val encryptedPasswordHistory =
|
||||
PasswordHistory(password = generatedPassphrase, lastUsedDate = Instant.now())
|
||||
|
||||
assertEquals(expectedResult, (result as GeneratedPassphraseResult.Success).generatedString)
|
||||
coVerify { generatorSdkSource.generatePassphrase(request) }
|
||||
}
|
||||
coEvery { authDiskSource.userState?.activeUserId } returns userId
|
||||
|
||||
coEvery { generatorSdkSource.generatePassphrase(request) } returns
|
||||
Result.success(generatedPassphrase)
|
||||
|
||||
coEvery { vaultSdkSource.encryptPasswordHistory(any()) } returns
|
||||
Result.success(encryptedPasswordHistory)
|
||||
|
||||
coEvery { passwordHistoryDiskSource.insertPasswordHistory(any()) } just runs
|
||||
|
||||
val result = repository.generatePassphrase(request)
|
||||
|
||||
assertEquals(
|
||||
generatedPassphrase,
|
||||
(result as GeneratedPassphraseResult.Success).generatedString,
|
||||
)
|
||||
coVerify { generatorSdkSource.generatePassphrase(request) }
|
||||
coVerify { vaultSdkSource.encryptPasswordHistory(any()) }
|
||||
coVerify {
|
||||
passwordHistoryDiskSource.insertPasswordHistory(
|
||||
encryptedPasswordHistory.toPasswordHistoryEntity(userId),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Suppress("MaxLineLength")
|
||||
@Test
|
||||
@@ -278,25 +325,25 @@ class GeneratorRepositoryTest {
|
||||
val encryptedPasswordHistoryEntities = listOf(
|
||||
PasswordHistoryEntity(
|
||||
userId = USER_STATE.activeUserId,
|
||||
encryptedPassword = "encryptedPassword1",
|
||||
generatedDateTimeMs = Instant.parse("2021-01-01T00:00:00Z").toEpochMilli(),
|
||||
encryptedPassword = "encryptedPassword2",
|
||||
generatedDateTimeMs = Instant.parse("2021-01-02T00:00:00Z").toEpochMilli(),
|
||||
),
|
||||
PasswordHistoryEntity(
|
||||
userId = USER_STATE.activeUserId,
|
||||
encryptedPassword = "encryptedPassword2",
|
||||
generatedDateTimeMs = Instant.parse("2021-01-02T00:00:00Z").toEpochMilli(),
|
||||
encryptedPassword = "encryptedPassword1",
|
||||
generatedDateTimeMs = Instant.parse("2021-01-01T00:00:00Z").toEpochMilli(),
|
||||
),
|
||||
)
|
||||
|
||||
val decryptedPasswordHistoryList = listOf(
|
||||
PasswordHistoryView(
|
||||
password = "password1",
|
||||
lastUsedDate = Instant.parse("2021-01-01T00:00:00Z"),
|
||||
),
|
||||
PasswordHistoryView(
|
||||
password = "password2",
|
||||
lastUsedDate = Instant.parse("2021-01-02T00:00:00Z"),
|
||||
),
|
||||
PasswordHistoryView(
|
||||
password = "password1",
|
||||
lastUsedDate = Instant.parse("2021-01-01T00:00:00Z"),
|
||||
),
|
||||
)
|
||||
|
||||
coEvery {
|
||||
|
||||
+15
@@ -74,4 +74,19 @@ class FakeGeneratorRepository : GeneratorRepository {
|
||||
fun setMockGeneratePassphraseResult(result: GeneratedPassphraseResult) {
|
||||
generatePassphraseResult = result
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a specific password is in the history.
|
||||
*/
|
||||
fun isPasswordStoredInHistory(password: String): Boolean {
|
||||
val passwordHistoryList = mutablePasswordHistoryStateFlow.value.data.orEmpty()
|
||||
return passwordHistoryList.any { it.password == password }
|
||||
}
|
||||
|
||||
/**
|
||||
* Emits specified state to the passwordHistoryStateFlow.
|
||||
*/
|
||||
fun emitPasswordHistoryState(state: LocalDataState<List<PasswordHistoryView>>) {
|
||||
mutablePasswordHistoryStateFlow.value = state
|
||||
}
|
||||
}
|
||||
|
||||
+4
-1
@@ -5,6 +5,7 @@ import androidx.compose.ui.test.onNodeWithContentDescription
|
||||
import androidx.compose.ui.test.onNodeWithText
|
||||
import androidx.compose.ui.test.performClick
|
||||
import com.x8bit.bitwarden.ui.platform.base.BaseComposeTest
|
||||
import com.x8bit.bitwarden.ui.platform.base.util.asText
|
||||
import io.mockk.every
|
||||
import io.mockk.mockk
|
||||
import io.mockk.verify
|
||||
@@ -49,7 +50,9 @@ class PasswordHistoryScreenTest : BaseComposeTest() {
|
||||
@Test
|
||||
fun `Error state should display error message`() {
|
||||
val errorMessage = "Error occurred"
|
||||
updateState(PasswordHistoryState(PasswordHistoryState.ViewState.Error(errorMessage)))
|
||||
updateState(
|
||||
PasswordHistoryState(PasswordHistoryState.ViewState.Error(errorMessage.asText())),
|
||||
)
|
||||
composeTestRule.onNodeWithText(errorMessage).assertIsDisplayed()
|
||||
}
|
||||
|
||||
|
||||
+103
-17
@@ -1,10 +1,18 @@
|
||||
package com.x8bit.bitwarden.ui.tools.feature.generator.passwordhistory
|
||||
|
||||
import app.cash.turbine.test
|
||||
import com.bitwarden.core.PasswordHistoryView
|
||||
import com.x8bit.bitwarden.data.platform.repository.model.LocalDataState
|
||||
import com.x8bit.bitwarden.data.tools.generator.repository.util.FakeGeneratorRepository
|
||||
import com.x8bit.bitwarden.R
|
||||
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
|
||||
import com.x8bit.bitwarden.ui.platform.base.util.asText
|
||||
import com.x8bit.bitwarden.ui.tools.feature.generator.util.toFormattedPattern
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import org.junit.jupiter.api.Assertions.assertEquals
|
||||
import org.junit.jupiter.api.Assertions.assertTrue
|
||||
import org.junit.jupiter.api.Test
|
||||
import java.time.Instant
|
||||
|
||||
class PasswordHistoryViewModelTest : BaseViewModelTest() {
|
||||
|
||||
@@ -18,6 +26,77 @@ class PasswordHistoryViewModelTest : BaseViewModelTest() {
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `when repository emits Loading state the state updates correctly`() = runTest {
|
||||
val fakeRepository = FakeGeneratorRepository().apply {
|
||||
emitPasswordHistoryState(LocalDataState.Loading)
|
||||
}
|
||||
val viewModel = PasswordHistoryViewModel(generatorRepository = fakeRepository)
|
||||
|
||||
viewModel.stateFlow.test {
|
||||
val expectedState = PasswordHistoryState(PasswordHistoryState.ViewState.Loading)
|
||||
val actualState = awaitItem()
|
||||
assertEquals(expectedState, actualState)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `when repository emits Error state the state updates correctly`() = runTest {
|
||||
val fakeRepository = FakeGeneratorRepository().apply {
|
||||
emitPasswordHistoryState(LocalDataState.Error(Exception("An error has occurred.")))
|
||||
}
|
||||
val viewModel = PasswordHistoryViewModel(generatorRepository = fakeRepository)
|
||||
|
||||
viewModel.stateFlow.test {
|
||||
val expectedState = PasswordHistoryState(
|
||||
PasswordHistoryState.ViewState.Error(R.string.an_error_has_occurred.asText()),
|
||||
)
|
||||
val actualState = awaitItem()
|
||||
assertEquals(expectedState, actualState)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `when repository emits Empty state the state updates correctly`() = runTest {
|
||||
val fakeRepository = FakeGeneratorRepository().apply {
|
||||
emitPasswordHistoryState(LocalDataState.Loaded(emptyList()))
|
||||
}
|
||||
val viewModel = PasswordHistoryViewModel(generatorRepository = fakeRepository)
|
||||
|
||||
viewModel.stateFlow.test {
|
||||
val expectedState = PasswordHistoryState(PasswordHistoryState.ViewState.Empty)
|
||||
val actualState = awaitItem()
|
||||
assertEquals(expectedState, actualState)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `when password history updates the state updates correctly`() = runTest {
|
||||
val fakeRepository = FakeGeneratorRepository()
|
||||
val viewModel = PasswordHistoryViewModel(generatorRepository = fakeRepository)
|
||||
|
||||
val passwordHistoryView = PasswordHistoryView("password", Instant.now())
|
||||
fakeRepository.storePasswordHistory(passwordHistoryView)
|
||||
|
||||
val expectedState = PasswordHistoryState(
|
||||
viewState = PasswordHistoryState.ViewState.Content(
|
||||
passwords = listOf(
|
||||
PasswordHistoryState.GeneratedPassword(
|
||||
password = "password",
|
||||
date = passwordHistoryView.lastUsedDate.toFormattedPattern(
|
||||
pattern = "MM/dd/yy h:mm a",
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
)
|
||||
|
||||
viewModel.stateFlow.test {
|
||||
val actualState = awaitItem()
|
||||
assertEquals(expectedState, actualState)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `CloseClick action should emit NavigateBack event`() = runTest {
|
||||
val viewModel = createViewModel()
|
||||
@@ -29,37 +108,44 @@ class PasswordHistoryViewModelTest : BaseViewModelTest() {
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `PasswordCopyClick action should emit password copied ShowToast event`() = runTest {
|
||||
fun `PasswordCopyClick action should emit CopyTextToClipboard event`() = runTest {
|
||||
val viewModel = createViewModel()
|
||||
val generatedPassword = PasswordHistoryState.GeneratedPassword(
|
||||
password = "testPassword",
|
||||
date = "01/01/23",
|
||||
)
|
||||
|
||||
viewModel.eventFlow.test {
|
||||
viewModel.actionChannel.trySend(
|
||||
PasswordHistoryAction.PasswordCopyClick(
|
||||
PasswordHistoryState.GeneratedPassword(password = "Password", date = "Date"),
|
||||
),
|
||||
PasswordHistoryAction.PasswordCopyClick(generatedPassword),
|
||||
)
|
||||
assertEquals(
|
||||
PasswordHistoryEvent.CopyTextToClipboard(generatedPassword.password),
|
||||
awaitItem(),
|
||||
)
|
||||
assertEquals(PasswordHistoryEvent.ShowToast("Not yet implemented."), awaitItem())
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `PasswordClearClick action should emit password history cleared ShowToast event`() =
|
||||
runTest {
|
||||
val viewModel = createViewModel()
|
||||
fun `PasswordClearClick action should update to Empty ViewState`() = runTest {
|
||||
val fakeRepository = FakeGeneratorRepository()
|
||||
val viewModel = PasswordHistoryViewModel(generatorRepository = fakeRepository)
|
||||
|
||||
viewModel.eventFlow.test {
|
||||
viewModel.actionChannel.trySend(PasswordHistoryAction.PasswordClearClick)
|
||||
assertEquals(
|
||||
PasswordHistoryEvent.ShowToast("Not yet implemented."),
|
||||
awaitItem(),
|
||||
)
|
||||
}
|
||||
}
|
||||
val passwordHistoryView = PasswordHistoryView("password", Instant.now())
|
||||
fakeRepository.storePasswordHistory(passwordHistoryView)
|
||||
|
||||
viewModel.actionChannel.trySend(PasswordHistoryAction.PasswordClearClick)
|
||||
|
||||
assertTrue(fakeRepository.passwordHistoryStateFlow.value is LocalDataState.Loaded)
|
||||
assertTrue(
|
||||
(fakeRepository.passwordHistoryStateFlow.value as LocalDataState.Loaded).data.isEmpty(),
|
||||
)
|
||||
}
|
||||
|
||||
//region Helper Functions
|
||||
|
||||
private fun createViewModel(): PasswordHistoryViewModel {
|
||||
return PasswordHistoryViewModel()
|
||||
return PasswordHistoryViewModel(generatorRepository = FakeGeneratorRepository())
|
||||
}
|
||||
|
||||
//endregion Helper Functions
|
||||
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
package com.x8bit.bitwarden.ui.tools.feature.generator.util
|
||||
|
||||
import org.junit.jupiter.api.Assertions.assertEquals
|
||||
import org.junit.jupiter.api.Test
|
||||
import java.time.Instant
|
||||
import java.time.ZoneId
|
||||
|
||||
class InstantExtensionsTest {
|
||||
|
||||
@Test
|
||||
fun `toFormattedPattern should return correctly formatted string`() {
|
||||
val instant = Instant.parse("2023-12-10T15:30:00Z")
|
||||
val pattern = "MM/dd/yyyy hh:mm a"
|
||||
val zone = ZoneId.of("UTC")
|
||||
val expectedFormattedString = "12/10/2023 03:30 PM"
|
||||
val formattedString = instant.toFormattedPattern(pattern, zone)
|
||||
|
||||
assertEquals(expectedFormattedString, formattedString)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user