test: Add Unit Test for `:feature:auth` module by Shreyash16b · Pull Request #1871 · openMF/mifos-pay

Shreyash16b · 2025-06-03T14:53:10Z

Issue Fix

Fixes 221
Jira Task: 221

Screenshots

Description

Added dependency (mokkery) for unit tests.
Wrote tests for LoginViewModel.kt, SignUpViewModel.kt, MobileVerificationViewModel.kt.
These tests run on the Android and Desktop platforms, but give errors for JS and WASM.

This is the error while running command ./gradlew :feature:auth:jsTest

This is the error while running command ./gradlew :feature:auth:wasmJsBrowserTest

Apply the AndroidStyle.xml style template to your code in Android Studio.
[✅] Run the unit tests with ./gradlew check to make sure you didn't break anything
[✅] If you have multiple commits please combine them into one commit by squashing them.

HekmatullahAmin · 2025-06-26T20:40:49Z

feature/auth/src/commonMain/kotlin/org/mifospay/feature/auth/signup/SignupViewModel.kt

        state.savingsProductId == 0 -> {
            mutableStateFlow.update {
-                it.copy(dialogState = SignUpDialog.Error("Please select a savings account."))
+                it.copy(dialogState = SignUpDialog.Error(SELECT_SAVINGS_ACCOUNT))


Revert it back to previous as we don't use Constants for these messages we are gonna use stringResource which if we target different audience we will use localization

HekmatullahAmin · 2025-06-26T21:03:07Z

feature/auth/build.gradle.kts

+        commonTest.dependencies {
+            implementation(kotlin("test-common"))
+            implementation(kotlin("test-annotations-common"))
+            implementation(libs.kotlinx.coroutines.test)


Add the dependencies if it is needs for example implementation(libs.kotlinx.coroutines.test) this one is already added in KMPLibraryConventionPlugin.kt or implementation(compose.uiTest) as we are not focusing in UI test don't add it and other dependecnies that you added.

@niyajali should he use mokerry third party library for testing?

HekmatullahAmin · 2025-06-26T21:28:38Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/login/LoginViewModelTest.kt

+    }
+
+    @Test
+    fun `username change updates state`() = runTest(testDispatcher) {


use one style for naming the test.
for example loginViewModel_UsernameChanged_UpdatesState

HekmatullahAmin · 2025-06-26T21:30:39Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/login/LoginViewModelTest.kt

+        viewModel.trySendAction(LoginAction.PasswordChanged("testpass"))
+        viewModel.trySendAction(LoginAction.LoginClicked)
+
+        println(viewModel.stateFlow.value)


remove the printlns

HekmatullahAmin · 2025-06-26T21:34:12Z

core/data/src/commonMain/kotlin/org/mifospay/core/data/util/Constants.kt

    const val UNAUTHORIZED_ERROR = "401 Unauthorized"
+
+    const val SELECT_SAVINGS_ACCOUNT = "Please select a savings account."
+    const val ENTER_FIRST_NAME = "Please enter your first name."


remove these added these constants as i mentioned the reason below

HekmatullahAmin · 2025-06-26T21:35:13Z

@niyajali if you have any suggestions for him regarding to which format or how to write unit testing regarding our format let him know

biplab1 · 2025-07-05T19:39:29Z

feature/auth/build.gradle.kts

    alias(libs.plugins.mifospay.cmp.feature)
    alias(libs.plugins.kotlin.parcelize)
    alias(libs.plugins.kotlin.serialization)
+    id("dev.mokkery") version "2.7.2"


This direct version dependency should be replaced. Please use alias(libs.mokkery) instead to keep it consistent with the version catalog.

HekmatullahAmin · 2025-07-08T16:35:29Z

feature/auth/src/commonMain/kotlin/org/mifospay/feature/auth/signup/SignupViewModel.kt

        state.mobileNumberInput.isEmpty() -> {
            mutableStateFlow.update {
-                it.copy(dialogState = SignUpDialog.Error("Please enter your mobile number."))
+                it.copy(dialogState = SignUpDialog.Error("Please enter a your mobile number."))


adding a is a grammatical mistake this should not ne added

HekmatullahAmin · 2025-07-08T16:36:49Z

feature/auth/src/commonMain/kotlin/org/mifospay/feature/auth/signup/SignupViewModel.kt

-                "\n- At least one lowercase character" +
-                "\n- At least one numeric digit" +
-                "\n- At least one special character"
+                ?: """


don't remove the \n otherwise it will show all message attach to each other

revert any changes regarding the text

HekmatullahAmin · 2025-07-08T16:37:26Z

feature/auth/src/commonMain/kotlin/org/mifospay/feature/auth/signup/SignupViewModel.kt

        state.countryInput.isEmpty() -> {
            mutableStateFlow.update {
-                it.copy(dialogState = SignUpDialog.Error("Please enter your country."))
+                it.copy(dialogState = SignUpDialog.Error("Please enter your country"))


just one thing keep the text as the way were before

HekmatullahAmin · 2025-07-08T17:00:55Z

@Shreyash16b fix the things that i mentioned and give me the authority to push changes to this PR. once i get the change i will pull it

HekmatullahAmin · 2025-07-10T13:49:17Z

@Shreyash16b don't push any new code for now. just give me the authority so i do it

Shreyash16b · 2025-07-10T13:51:45Z

@HekmatullahAmin Sorry, I just pushed the code a minute before your message.

HekmatullahAmin · 2025-07-11T20:00:58Z

@Shreyash16b i can't change the PR title. could u please change it to this: Add feature/auth unit tests and add KDoc for clarity
And also add these photos in the description of PR remove those error images that u received and posted.

Description

This PR improves test coverage and developer experience in the authentication feature by:

✅ Added unit tests for:
- SignUpViewModelTest
- LoginViewModelTest
- MobileVerificationViewModelTest
🔧 Mocking approach:
- Used Mokkery to mock repositories in SignUpViewModelTest and MobileVerificationViewModelTest.
- Mocked LoginUseCase in LoginViewModelTest for isolated and deterministic behavior.
🛠️ Test support enhancements:
- Introduced the @OpenForMokkery annotation and applied the kotlin-allopen plugin scoped to this module, allowing open classes for mocking without polluting production codebase.
- Created and integrated a StringProvider interface to decouple direct usage of getString() in ViewModels.
  - This enables test-safe injection of fake/mock StringProvider implementations.
  - In production, DefaultStringProvider uses the real Compose getString() call.
📚 Documentation:
- Added comprehensive KDoc comments to improve test and utility class readability and maintainability.

Android

SignUpViewModelTest

LoginViewModelTest

MobileVerificationViewModelTest

Ios

Desktop

WasmJsBrowser

JsNode

niyajali · 2025-07-12T09:41:51Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/fakes/FakeSearchResult.kt

+
+import org.mifospay.core.model.search.SearchResult
+
+val fakeSearchResult = SearchResult(


Move this directly on that file where it has been used no need to create separate file for this

niyajali · 2025-07-12T09:47:21Z

feature/auth/src/commonMain/kotlin/org/mifospay/feature/auth/signup/SignupViewModel.kt

        Enhancement: Move the following code in to a Use Case
     */
    private fun initiateSignUp() {
-        DialogManager.showLoading()


When we introduced DialogManager, @HekmatullahAmin are you sure that these changes are necessary

@niyajali Previously i created so to have one object handle the dialog logic in all our screens and cause of Parcelization we couldn't persist those of StringResource type. Although we can achieve the unit testing with DialogManager, but it will bound to lifecycle of viewmodel and also in unit testing then we also need to call it to check it is state.

niyajali · 2025-07-12T09:51:34Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/fakes/FakeUserInfo.kt

+
+import org.mifospay.core.model.user.UserInfo
+
+val fakeUserInfo = UserInfo(


this too and make it internal

niyajali · 2025-07-12T09:51:47Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/login/LoginViewModelTest.kt

+        Dispatchers.resetMain()
+    }
+
+    // --------------------------------------------------------------------------


remove this comments

niyajali · 2025-07-12T09:53:05Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/login/LoginViewModelTest.kt

+     * Verifies initial state values are set correctly on ViewModel init.
+     */
+    @Test
+    fun loginViewModel_InitialState_ValidInitialConditions() = runTest(testDispatcher) {


remove the prefix from all test methods, and try to followT, est method should follow the given_when_then or when_then format.

niyajali · 2025-07-12T09:54:33Z

feature/auth/src/commonTest/kotlin/org/mifospay/feature/auth/login/LoginViewModelTest.kt

+        assertFalse(viewModel.stateFlow.value.isPasswordVisible)
+
+        viewModel.trySendAction(LoginAction.TogglePasswordVisibility)
+        advanceUntilIdle()


we won't need this always, remove the testDispatcher from this lamda runTest(testDispatcher) as you've defined in setup method, use turbine libray to test the flow

For reference - https://github.com/openMF/kmp-project-template/blob/dev/core-base/datastore/src/commonTest/kotlin/template/core/base/datastore/repository/DefaultReactiveUserPreferencesRepositoryTest.kt

And this is not a KMP project, but you can check it out just for reference - https://github.com/devikontech/restaurant-billing-pos/tree/main/feature/addonitem/src/test/kotlin/com/niyaj/addonitem

i removed it, but we don't have any flow in the view models to test

viewModel.stateFlow, viewModel.eventFlow are flowable property

I understand your point, but testing can be inconsistent and really sucks sometimes in my experience, sometimes the UI displays correct output while tests fail, or tests pass locally in your IDE but fail in CI.

This is why I'd suggest combining both approaches. When collecting values with .value, you might need to use waitUntilIdle() or collect the flow properly, since flows only emit values when there's an active collector. However, this might not be necessary in some cases as this project designed UDF (Unidirectional Data Flow) pattern.

Let's implement what works best for our use case, and for reference, check the Now in Android project or other similar examples given above.

https://github.com/android/nowinandroid/blob/main/feature/foryou/src/test/kotlin/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModelTest.kt

@niyajali

Our BaseViewModel handles every user action asynchronously via viewModelScope.launch, using advanceUntilIdle() is necessary to ensure state changes are fully applied before we assert on stateFlow.value.

viewModelScope.launch { internalActionChannel.consumeAsFlow().collect { action -> handleAction(action) } }

This means:

Even if handleAction updates the state immediately, it's still queued on a coroutine and will run in a future dispatch cycle.

So when your test does:

viewModel.trySendAction(...) assertEquals(expected, viewModel.stateFlow.value)

...it might assert too early, before handleAction actually runs.

That's why you use advanceUntilIdle() — it gives the coroutine scheduler time to process any enqueued tasks before you assert.

.value makes perfect sense when we only care about the final, conflated state.

That said, Turbine is a great fit when we need to capture multiple state emissions over time.

So going forward, I’ll continue using .value + advanceUntilIdle() for most simple stateFlow assertions, but I’ll switch to using Turbine for eventFlow testing to ensure we properly collect and verify emitted events.

below is an example for both approach which i think using turbine here is not necessary our logic is more simple in first one:

@Test fun givenFirstName_whenInputChanged_thenFirstNameIsUpdated() = runTest { val firstName = "John" viewModel.trySendAction(SignUpAction.FirstNameInputChange(firstName)) advanceUntilIdle() assertEquals(firstName, viewModel.stateFlow.value.firstNameInput) } @Test fun givenFirstNames_whenInputChanged_thenFirstNameIsUpdated() = runTest { viewModel.stateFlow.test { // Skip initial state skipItems(1) // Act: send username change val firstName = "John" viewModel.trySendAction(SignUpAction.FirstNameInputChange(firstName)) // Assert: username should now be "alice" val state = awaitItem() assertEquals(firstName, state.firstNameInput) } }

Yes, I meant the same, refactor all the test cases accordingly and use proper naming conventions like given_when_then or when_then and let me know.

@niyajali yeah already used given_when_then naming convention.
and also added unit test for eventFlow

I’ve directly tested the stateFlow using .value along with advanceUntilIdle(), as done in the Now in Android project. Since our logic is relatively simple and we only care about the latest state, using Turbine would’ve added unnecessary checks like skipItems() or awaitItem() that don’t add value in this case.

niyajali · 2025-07-12T10:00:14Z

.../commonTest/kotlin/org/mifospay/feature/auth/mobileVerify/MobileVerificationViewModelTest.kt

+import kotlin.test.assertTrue
+
+@OptIn(ExperimentalCoroutinesApi::class)
+class MobileVerificationViewModelTest {


Similarly apply those changes on these test classes

niyajali · 2025-07-15T11:34:56Z

@HekmatullahAmin Upload Test results for all platforms

HekmatullahAmin · 2025-07-15T14:53:02Z

@HekmatullahAmin Upload Test results for all platforms

@niyajali done. i run one viewmodel test in one platform if i did all it would take a lot of space. and also could u just cut it and paste it in PR description i don't have authority to do it.

HekmatullahAmin reviewed Jun 26, 2025

View reviewed changes

biplab1 reviewed Jul 5, 2025

View reviewed changes

HekmatullahAmin reviewed Jul 8, 2025

View reviewed changes

HekmatullahAmin force-pushed the MW-221 branch from 2e9e07a to e9e3eae Compare July 11, 2025 19:56

HekmatullahAmin approved these changes Jul 11, 2025

View reviewed changes

Shreyash16b changed the title ~~Initial commit feature/auth unit test~~ Add feature/auth unit tests and add KDoc for clarity Jul 12, 2025

niyajali requested changes Jul 12, 2025

View reviewed changes

niyajali changed the title ~~Add feature/auth unit tests and add KDoc for clarity~~ test: Add Unit Test for :feature:auth module Jul 12, 2025

Shreyash16b and others added 11 commits July 14, 2025 14:39

Initial commit feature/auth unit test

2e7943f

ViewModel Tests added

01ef7cb

Proper naming convention used

58eb592

Initial commit feature/auth unit test

2f9a608

ViewModel Tests added

4af0cee

Proper naming convention used

b1fae80

mokkery-plugin import with alias

6448d61

test(feature/auth): enhance unit tests and add KDoc for clarity

3e10486

changed the unit tests names

d9b63b5

remove testDispatcher fron runTest

564a2dc

add test for eventFlow

255cc5e

HekmatullahAmin force-pushed the MW-221 branch from 0f7d4e3 to 255cc5e Compare July 14, 2025 13:41

niyajali approved these changes Jul 16, 2025

View reviewed changes

niyajali merged commit 72c988b into openMF:development Jul 16, 2025
7 checks passed


		import org.mifospay.core.model.search.SearchResult

		val fakeSearchResult = SearchResult(


		import org.mifospay.core.model.user.UserInfo

		val fakeUserInfo = UserInfo(

Conversation

Shreyash16b commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Fix

Screenshots

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HekmatullahAmin commented Jun 26, 2025

Uh oh!

biplab1 Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HekmatullahAmin Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HekmatullahAmin commented Jul 8, 2025

Uh oh!

HekmatullahAmin commented Jul 10, 2025

Uh oh!

Shreyash16b commented Jul 10, 2025

Uh oh!

HekmatullahAmin commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Android

SignUpViewModelTest

LoginViewModelTest

MobileVerificationViewModelTest

Ios

Desktop

WasmJsBrowser

JsNode

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HekmatullahAmin Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Shreyash16b commented Jun 3, 2025 •

edited

Loading

biplab1 Jul 5, 2025 •

edited

Loading

HekmatullahAmin Jul 8, 2025 •

edited

Loading

HekmatullahAmin commented Jul 11, 2025 •

edited

Loading

HekmatullahAmin Jul 12, 2025 •

edited

Loading

niyajali Jul 12, 2025 •

edited

Loading

niyajali commented Jul 15, 2025 •

edited

Loading