BIT-333: Handle Passphrase state in GeneratorViewModel (#64)

2026-06-02 18:59:15 -05:00 · 2023-09-25 15:12:26 -04:00
parent 26e447d71d
commit 0f4e16b542
3 changed files with 1182 additions and 97 deletions
--- a/app/src/test/java/com/x8bit/bitwarden/ui/tools/feature/generator/GeneratorViewModelTest.kt
+++ b/app/src/test/java/com/x8bit/bitwarden/ui/tools/feature/generator/GeneratorViewModelTest.kt
@@ -0,0 +1,239 @@
+@file:Suppress("MaxLineLength")
+
+package com.x8bit.bitwarden.ui.tools.feature.generator
+
+import androidx.lifecycle.SavedStateHandle
+import app.cash.turbine.test
+import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
+import kotlinx.coroutines.test.runTest
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Nested
+import org.junit.jupiter.api.Test
+
+class GeneratorViewModelTest : BaseViewModelTest() {
+
+    private val initialState = createPasswordState()
+    private val initialSavedStateHandle = createSavedStateHandleWithState(initialState)
+
+    @Test
+    fun `initial state should be correct`() = runTest {
+        val viewModel = GeneratorViewModel(initialSavedStateHandle)
+        viewModel.stateFlow.test {
+            assertEquals(initialState, awaitItem())
+        }
+    }
+
+    @Test
+    fun `MainTypeOptionSelect PASSWORD should switch to Passcode`() = runTest {
+        val viewModel = GeneratorViewModel(initialSavedStateHandle)
+        val action = GeneratorAction.MainTypeOptionSelect(GeneratorState.MainTypeOption.PASSWORD)
+
+        viewModel.actionChannel.trySend(action)
+
+        val expectedState =
+            initialState.copy(selectedType = GeneratorState.MainType.Passcode())
+
+        assertEquals(expectedState, viewModel.stateFlow.value)
+    }
+
+    @Test
+    fun `MainTypeOptionSelect USERNAME should switch to Username`() = runTest {
+        val viewModel = GeneratorViewModel(initialSavedStateHandle)
+        val action = GeneratorAction.MainTypeOptionSelect(GeneratorState.MainTypeOption.USERNAME)
+
+        viewModel.actionChannel.trySend(action)
+
+        val expectedState = initialState.copy(selectedType = GeneratorState.MainType.Username)
+
+        assertEquals(expectedState, viewModel.stateFlow.value)
+    }
+
+    @Test
+    fun `PasscodeTypeOptionSelect PASSWORD should switch to PasswordType`() = runTest {
+        val viewModel = GeneratorViewModel(initialSavedStateHandle)
+        val action = GeneratorAction.MainType.Passcode.PasscodeTypeOptionSelect(
+            passcodeTypeOption = GeneratorState.MainType.Passcode.PasscodeTypeOption.PASSWORD,
+        )
+
+        viewModel.actionChannel.trySend(action)
+
+        val expectedState = initialState.copy(
+            selectedType = GeneratorState.MainType.Passcode(
+                selectedType = GeneratorState.MainType.Passcode.PasscodeType.Password(),
+            ),
+        )
+
+        assertEquals(expectedState, viewModel.stateFlow.value)
+    }
+
+    @Test
+    fun `PasscodeTypeOptionSelect PASSPHRASE should switch to PassphraseType`() = runTest {
+        val viewModel = GeneratorViewModel(initialSavedStateHandle)
+        val action = GeneratorAction.MainType.Passcode.PasscodeTypeOptionSelect(
+            passcodeTypeOption = GeneratorState.MainType.Passcode.PasscodeTypeOption.PASSPHRASE,
+        )
+
+        viewModel.actionChannel.trySend(action)
+
+        val expectedState = initialState.copy(
+            selectedType = GeneratorState.MainType.Passcode(
+                selectedType = GeneratorState.MainType.Passcode.PasscodeType.Passphrase(),
+            ),
+        )
+
+        assertEquals(expectedState, viewModel.stateFlow.value)
+    }
+
+    @Nested
+    inner class PassphraseActions {
+
+        private val defaultPassphraseState = createPassphraseState()
+        private val passphraseSavedStateHandle =
+            createSavedStateHandleWithState(defaultPassphraseState)
+
+        private lateinit var viewModel: GeneratorViewModel
+
+        @BeforeEach
+        fun setup() {
+            viewModel = GeneratorViewModel(passphraseSavedStateHandle)
+        }
+
+        @Test
+        fun `NumWordsCounterChange should update the numWords property correctly`() =
+            runTest {
+                viewModel.eventFlow.test {
+                    val newNumWords = 4
+                    viewModel.actionChannel.trySend(
+                        GeneratorAction.MainType.Passcode.PasscodeType.Passphrase.NumWordsCounterChange(
+                            numWords = newNumWords,
+                        ),
+                    )
+
+                    val expectedState = defaultPassphraseState.copy(
+                        generatedText = "redlohecalP",
+                        selectedType = GeneratorState.MainType.Passcode(
+                            GeneratorState.MainType.Passcode.PasscodeType.Passphrase(
+                                numWords = newNumWords,
+                            ),
+                        ),
+                    )
+
+                    assertEquals(expectedState, viewModel.stateFlow.value)
+                }
+            }
+
+        @Test
+        fun `WordSeparatorTextChange should update wordSeparator correctly to new value`() =
+            runTest {
+                viewModel.eventFlow.test {
+                    val newWordSeparatorChar = '_'
+
+                    viewModel.actionChannel.trySend(
+                        GeneratorAction
+                            .MainType
+                            .Passcode
+                            .PasscodeType.Passphrase
+                            .WordSeparatorTextChange(
+                                wordSeparator = newWordSeparatorChar,
+                            ),
+                    )
+
+                    val expectedState = defaultPassphraseState.copy(
+                        generatedText = "redlohecalP",
+                        selectedType = GeneratorState.MainType.Passcode(
+                            GeneratorState.MainType.Passcode.PasscodeType.Passphrase(
+                                wordSeparator = newWordSeparatorChar,
+                            ),
+                        ),
+                    )
+
+                    assertEquals(expectedState, viewModel.stateFlow.value)
+                }
+            }
+
+        @Test
+        fun `ToggleIncludeNumberChange should update the includeNumber property correctly`() =
+            runTest {
+                viewModel.eventFlow.test {
+                    viewModel.actionChannel.trySend(
+                        GeneratorAction.MainType.Passcode.PasscodeType.Passphrase.ToggleIncludeNumberChange(
+                            includeNumber = true,
+                        ),
+                    )
+
+                    val expectedState = defaultPassphraseState.copy(
+                        generatedText = "redlohecalP",
+                        selectedType = GeneratorState.MainType.Passcode(
+                            selectedType = GeneratorState.MainType.Passcode.PasscodeType.Passphrase(
+                                includeNumber = true,
+                            ),
+                        ),
+                    )
+
+                    assertEquals(expectedState, viewModel.stateFlow.value)
+                }
+            }
+
+        @Test
+        fun `ToggleCapitalizeChange should update the capitalize property correctly`() =
+            runTest {
+                viewModel.eventFlow.test {
+                    viewModel.actionChannel.trySend(
+                        GeneratorAction.MainType.Passcode.PasscodeType.Passphrase.ToggleCapitalizeChange(
+                            capitalize = true,
+                        ),
+                    )
+
+                    val expectedState = defaultPassphraseState.copy(
+                        generatedText = "redlohecalP",
+                        selectedType = GeneratorState.MainType.Passcode(
+                            GeneratorState.MainType.Passcode.PasscodeType.Passphrase(
+                                capitalize = true,
+                            ),
+                        ),
+                    )
+
+                    assertEquals(expectedState, viewModel.stateFlow.value)
+                }
+            }
+    }
+    //region Helper Functions
+
+    private fun createPasswordState(
+        generatedText: String = "Placeholder",
+        length: Int = 10,
+    ): GeneratorState =
+        GeneratorState(
+            generatedText = generatedText,
+            selectedType = GeneratorState.MainType.Passcode(
+                GeneratorState.MainType.Passcode.PasscodeType.Password(length = length),
+            ),
+        )
+
+    private fun createPassphraseState(
+        generatedText: String = "Placeholder",
+        numWords: Int = 3,
+        wordSeparator: Char = '-',
+        capitalize: Boolean = false,
+        includeNumber: Boolean = false,
+    ): GeneratorState =
+        GeneratorState(
+            generatedText = generatedText,
+            selectedType = GeneratorState.MainType.Passcode(
+                GeneratorState.MainType.Passcode.PasscodeType.Passphrase(
+                    numWords = numWords,
+                    wordSeparator = wordSeparator,
+                    capitalize = capitalize,
+                    includeNumber = includeNumber,
+                ),
+            ),
+        )
+
+    private fun createSavedStateHandleWithState(state: GeneratorState) =
+        SavedStateHandle().apply {
+            set("state", state)
+        }
+
+    //endregion Helper Functions
+}