BIT-1419: Username generation options persistence (#586)

This commit is contained in:
Joshua Queen
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent 1f0a1bba6f
commit 5e2e23edec
9 changed files with 580 additions and 19 deletions
@@ -2,6 +2,7 @@ package com.x8bit.bitwarden.data.tools.generator.datasource.disk
import com.x8bit.bitwarden.data.platform.base.FakeSharedPreferences
import com.x8bit.bitwarden.data.tools.generator.repository.model.PasscodeGenerationOptions
import com.x8bit.bitwarden.data.tools.generator.repository.model.UsernameGenerationOptions
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
@@ -89,4 +90,72 @@ class GeneratorDiskSourceTest {
assertNotNull(storedValue)
assertEquals(json.encodeToString(options), storedValue)
}
@Test
fun `getUsernameGenerationOptions should return correct options when available`() {
val userId = "user123"
val options = UsernameGenerationOptions(
type = UsernameGenerationOptions.UsernameType.RANDOM_WORD,
serviceType = UsernameGenerationOptions.ForwardedEmailServiceType.NONE,
capitalizeRandomWordUsername = true,
includeNumberRandomWordUsername = false,
plusAddressedEmail = "example+plus@gmail.com",
catchAllEmailDomain = "example.com",
firefoxRelayApiAccessToken = "access_token_firefox_relay",
simpleLoginApiKey = "api_key_simple_login",
duckDuckGoApiKey = "api_key_duck_duck_go",
fastMailApiKey = "api_key_fast_mail",
anonAddyApiAccessToken = "access_token_anon_addy",
anonAddyDomainName = "anonaddy.com",
forwardEmailApiAccessToken = "access_token_forward_email",
forwardEmailDomainName = "forwardemail.net",
emailWebsite = "email.example.com",
)
val key = "bwPreferencesStorage_usernameGenerationOptions_$userId"
fakeSharedPreferences.edit().putString(key, json.encodeToString(options)).apply()
val result = generatorDiskSource.getUsernameGenerationOptions(userId)
assertEquals(options, result)
}
@Test
fun `getUsernameGenerationOptions should return null when options are not available`() {
val userId = "user123"
val result = generatorDiskSource.getUsernameGenerationOptions(userId)
assertNull(result)
}
@Test
fun `storeUsernameGenerationOptions should correctly store options`() {
val userId = "user123"
val options = UsernameGenerationOptions(
type = UsernameGenerationOptions.UsernameType.RANDOM_WORD,
serviceType = UsernameGenerationOptions.ForwardedEmailServiceType.NONE,
capitalizeRandomWordUsername = true,
includeNumberRandomWordUsername = false,
plusAddressedEmail = "example+plus@gmail.com",
catchAllEmailDomain = "example.com",
firefoxRelayApiAccessToken = "access_token_firefox_relay",
simpleLoginApiKey = "api_key_simple_login",
duckDuckGoApiKey = "api_key_duck_duck_go",
fastMailApiKey = "api_key_fast_mail",
anonAddyApiAccessToken = "access_token_anon_addy",
anonAddyDomainName = "anonaddy.com",
forwardEmailApiAccessToken = "access_token_forward_email",
forwardEmailDomainName = "forwardemail.net",
emailWebsite = "email.example.com",
)
val key = "bwPreferencesStorage_usernameGenerationOptions_$userId"
generatorDiskSource.storeUsernameGenerationOptions(userId, options)
val storedValue = fakeSharedPreferences.getString(key, null)
assertNotNull(storedValue)
assertEquals(json.encodeToString(options), storedValue)
}
}
@@ -31,6 +31,7 @@ import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedPasswo
import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedPlusAddressedUsernameResult
import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedRandomWordUsernameResult
import com.x8bit.bitwarden.data.tools.generator.repository.model.PasscodeGenerationOptions
import com.x8bit.bitwarden.data.tools.generator.repository.model.UsernameGenerationOptions
import com.x8bit.bitwarden.data.vault.datasource.sdk.VaultSdkSource
import io.mockk.coEvery
import io.mockk.coVerify
@@ -50,6 +51,7 @@ import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test
import java.time.Instant
@Suppress("LargeClass")
class GeneratorRepositoryTest {
private val mutableUserStateFlow = MutableStateFlow<UserStateJson?>(null)
@@ -644,6 +646,119 @@ class GeneratorRepositoryTest {
}
}
@Test
fun `getUsernameGenerationOptions should return options when available`() = runTest {
val userId = "activeUserId"
val expectedOptions = UsernameGenerationOptions(
type = UsernameGenerationOptions.UsernameType.RANDOM_WORD,
serviceType = UsernameGenerationOptions.ForwardedEmailServiceType.NONE,
capitalizeRandomWordUsername = true,
includeNumberRandomWordUsername = false,
plusAddressedEmail = "example+plus@gmail.com",
catchAllEmailDomain = "example.com",
firefoxRelayApiAccessToken = "access_token_firefox_relay",
simpleLoginApiKey = "api_key_simple_login",
duckDuckGoApiKey = "api_key_duck_duck_go",
fastMailApiKey = "api_key_fast_mail",
anonAddyApiAccessToken = "access_token_anon_addy",
anonAddyDomainName = "anonaddy.com",
forwardEmailApiAccessToken = "access_token_forward_email",
forwardEmailDomainName = "forwardemail.net",
emailWebsite = "email.example.com",
)
coEvery { authDiskSource.userState } returns USER_STATE
coEvery { generatorDiskSource.getUsernameGenerationOptions(userId) } returns expectedOptions
val result = repository.getUsernameGenerationOptions()
assertEquals(expectedOptions, result)
coVerify { generatorDiskSource.getUsernameGenerationOptions(userId) }
}
@Test
fun `getUsernameGenerationOptions should return null when there is no active user`() = runTest {
coEvery { authDiskSource.userState } returns null
val result = repository.getUsernameGenerationOptions()
assertNull(result)
coVerify(exactly = 0) { generatorDiskSource.getUsernameGenerationOptions(any()) }
}
@Test
fun `getUsernameGenerationOptions should return null when no data is stored for active user`() =
runTest {
val userId = "activeUserId"
coEvery { authDiskSource.userState } returns USER_STATE
coEvery { generatorDiskSource.getUsernameGenerationOptions(userId) } returns null
val result = repository.getUsernameGenerationOptions()
assertNull(result)
coVerify { generatorDiskSource.getUsernameGenerationOptions(userId) }
}
@Test
fun `saveUsernameGenerationOptions should store options correctly`() = runTest {
val userId = "activeUserId"
val optionsToSave = UsernameGenerationOptions(
type = UsernameGenerationOptions.UsernameType.RANDOM_WORD,
serviceType = UsernameGenerationOptions.ForwardedEmailServiceType.NONE,
capitalizeRandomWordUsername = true,
includeNumberRandomWordUsername = false,
plusAddressedEmail = "example+plus@gmail.com",
catchAllEmailDomain = "example.com",
firefoxRelayApiAccessToken = "access_token_firefox_relay",
simpleLoginApiKey = "api_key_simple_login",
duckDuckGoApiKey = "api_key_duck_duck_go",
fastMailApiKey = "api_key_fast_mail",
anonAddyApiAccessToken = "access_token_anon_addy",
anonAddyDomainName = "anonaddy.com",
forwardEmailApiAccessToken = "access_token_forward_email",
forwardEmailDomainName = "forwardemail.net",
emailWebsite = "email.example.com",
)
coEvery { authDiskSource.userState } returns USER_STATE
coEvery {
generatorDiskSource.storeUsernameGenerationOptions(userId, optionsToSave)
} just runs
repository.saveUsernameGenerationOptions(optionsToSave)
coVerify { generatorDiskSource.storeUsernameGenerationOptions(userId, optionsToSave) }
}
@Test
fun `saveUsernameGenerationOptions should not store options when there is no active user`() =
runTest {
val optionsToSave = UsernameGenerationOptions(
type = UsernameGenerationOptions.UsernameType.RANDOM_WORD,
serviceType = UsernameGenerationOptions.ForwardedEmailServiceType.NONE,
capitalizeRandomWordUsername = true,
includeNumberRandomWordUsername = false,
plusAddressedEmail = "example+plus@gmail.com",
catchAllEmailDomain = "example.com",
firefoxRelayApiAccessToken = "access_token_firefox_relay",
simpleLoginApiKey = "api_key_simple_login",
duckDuckGoApiKey = "api_key_duck_duck_go",
fastMailApiKey = "api_key_fast_mail",
anonAddyApiAccessToken = "access_token_anon_addy",
anonAddyDomainName = "anonaddy.com",
forwardEmailApiAccessToken = "access_token_forward_email",
forwardEmailDomainName = "forwardemail.net",
emailWebsite = "email.example.com",
)
coEvery { authDiskSource.userState } returns null
repository.saveUsernameGenerationOptions(optionsToSave)
coVerify(exactly = 0) {
generatorDiskSource.storeUsernameGenerationOptions(any(), any())
}
}
private val USER_STATE = UserStateJson(
activeUserId = "activeUserId",
accounts = mapOf(
@@ -13,6 +13,7 @@ import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedPasswo
import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedPlusAddressedUsernameResult
import com.x8bit.bitwarden.data.tools.generator.repository.model.GeneratedRandomWordUsernameResult
import com.x8bit.bitwarden.data.tools.generator.repository.model.PasscodeGenerationOptions
import com.x8bit.bitwarden.data.tools.generator.repository.model.UsernameGenerationOptions
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
@@ -30,6 +31,8 @@ class FakeGeneratorRepository : GeneratorRepository {
)
private var passcodeGenerationOptions: PasscodeGenerationOptions? = null
private var usernameGenerationOptions: UsernameGenerationOptions? = null
private val mutablePasswordHistoryStateFlow =
MutableStateFlow<LocalDataState<List<PasswordHistoryView>>>(LocalDataState.Loading)
@@ -101,6 +104,14 @@ class FakeGeneratorRepository : GeneratorRepository {
passcodeGenerationOptions = options
}
override fun getUsernameGenerationOptions(): UsernameGenerationOptions? {
return usernameGenerationOptions
}
override fun saveUsernameGenerationOptions(options: UsernameGenerationOptions) {
usernameGenerationOptions = options
}
override suspend fun storePasswordHistory(passwordHistoryView: PasswordHistoryView) {
val currentList = mutablePasswordHistoryStateFlow.value.data.orEmpty()
val updatedList = currentList + passwordHistoryView