Adding unit tests for settings ViewModel

vector/src/main/java/im/vector/app/features/settings/notifications/VectorSettingsNotificationPreferenceViewModel.kt

@@ -49,7 +49,6 @@ class VectorSettingsNotificationPreferenceViewModel @AssistedInject constructor(
 
     companion object : MavericksViewModelFactory<VectorSettingsNotificationPreferenceViewModel, VectorDummyViewState> by hiltMavericksViewModelFactory()
 
-    // TODO add unit tests
     override fun handle(action: VectorSettingsNotificationPreferenceViewAction) {
         when (action) {
             VectorSettingsNotificationPreferenceViewAction.DisableNotificationsForDevice -> handleDisableNotificationsForDevice()

vector/src/test/java/im/vector/app/features/settings/notifications/VectorSettingsNotificationPreferenceViewModelTest.kt

@@ -0,0 +1,202 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.features.settings.notifications
+
+import com.airbnb.mvrx.test.MavericksTestRule
+import im.vector.app.core.platform.VectorDummyViewState
+import im.vector.app.core.pushers.EnsureFcmTokenIsRetrievedUseCase
+import im.vector.app.core.pushers.RegisterUnifiedPushUseCase
+import im.vector.app.core.pushers.UnregisterUnifiedPushUseCase
+import im.vector.app.test.fakes.FakePushersManager
+import im.vector.app.test.fakes.FakeVectorPreferences
+import im.vector.app.test.test
+import im.vector.app.test.testDispatcher
+import io.mockk.coEvery
+import io.mockk.coJustRun
+import io.mockk.coVerify
+import io.mockk.coVerifyOrder
+import io.mockk.justRun
+import io.mockk.mockk
+import org.junit.Rule
+import org.junit.Test
+
+class VectorSettingsNotificationPreferenceViewModelTest {
+
+    @get:Rule
+    val mavericksTestRule = MavericksTestRule(testDispatcher = testDispatcher)
+
+    private val fakePushersManager = FakePushersManager()
+    private val fakeVectorPreferences = FakeVectorPreferences()
+    private val fakeEnableNotificationsForCurrentSessionUseCase = mockk<EnableNotificationsForCurrentSessionUseCase>()
+    private val fakeDisableNotificationsForCurrentSessionUseCase = mockk<DisableNotificationsForCurrentSessionUseCase>()
+    private val fakeUnregisterUnifiedPushUseCase = mockk<UnregisterUnifiedPushUseCase>()
+    private val fakeRegisterUnifiedPushUseCase = mockk<RegisterUnifiedPushUseCase>()
+    private val fakeEnsureFcmTokenIsRetrievedUseCase = mockk<EnsureFcmTokenIsRetrievedUseCase>()
+
+    private fun createViewModel() = VectorSettingsNotificationPreferenceViewModel(
+            initialState = VectorDummyViewState(),
+            pushersManager = fakePushersManager.instance,
+            vectorPreferences = fakeVectorPreferences.instance,
+            enableNotificationsForCurrentSessionUseCase = fakeEnableNotificationsForCurrentSessionUseCase,
+            disableNotificationsForCurrentSessionUseCase = fakeDisableNotificationsForCurrentSessionUseCase,
+            unregisterUnifiedPushUseCase = fakeUnregisterUnifiedPushUseCase,
+            registerUnifiedPushUseCase = fakeRegisterUnifiedPushUseCase,
+            ensureFcmTokenIsRetrievedUseCase = fakeEnsureFcmTokenIsRetrievedUseCase,
+    )
+
+    @Test
+    fun `given DisableNotificationsForDevice action when handling action then disable use case is called`() {
+        // Given
+        val viewModel = createViewModel()
+        val action = VectorSettingsNotificationPreferenceViewAction.DisableNotificationsForDevice
+        coJustRun { fakeDisableNotificationsForCurrentSessionUseCase.execute() }
+        val expectedEvent = VectorSettingsNotificationPreferenceViewEvent.NotificationsForDeviceDisabled
+
+        // When
+        val viewModelTest = viewModel.test()
+        viewModel.handle(action)
+
+        // Then
+        viewModelTest
+                .assertEvent { event -> event == expectedEvent }
+                .finish()
+        coVerify {
+            fakeDisableNotificationsForCurrentSessionUseCase.execute()
+        }
+    }
+
+    @Test
+    fun `given EnableNotificationsForDevice action and enable success when handling action then enable use case is called`() {
+        // Given
+        val viewModel = createViewModel()
+        val aDistributor = "aDistributor"
+        val action = VectorSettingsNotificationPreferenceViewAction.EnableNotificationsForDevice(aDistributor)
+        coEvery { fakeEnableNotificationsForCurrentSessionUseCase.execute(any()) } returns
+                EnableNotificationsForCurrentSessionUseCase.EnableNotificationsResult.Success
+        val expectedEvent = VectorSettingsNotificationPreferenceViewEvent.NotificationsForDeviceEnabled
+
+        // When
+        val viewModelTest = viewModel.test()
+        viewModel.handle(action)
+
+        // Then
+        viewModelTest
+                .assertEvent { event -> event == expectedEvent }
+                .finish()
+        coVerify {
+            fakeEnableNotificationsForCurrentSessionUseCase.execute(aDistributor)
+        }
+    }
+
+    @Test
+    fun `given EnableNotificationsForDevice action and enable needs user choice when handling action then enable use case is called`() {
+        // Given
+        val viewModel = createViewModel()
+        val aDistributor = "aDistributor"
+        val action = VectorSettingsNotificationPreferenceViewAction.EnableNotificationsForDevice(aDistributor)
+        coEvery { fakeEnableNotificationsForCurrentSessionUseCase.execute(any()) } returns
+                EnableNotificationsForCurrentSessionUseCase.EnableNotificationsResult.NeedToAskUserForDistributor
+        val expectedEvent = VectorSettingsNotificationPreferenceViewEvent.AskUserForPushDistributor
+
+        // When
+        val viewModelTest = viewModel.test()
+        viewModel.handle(action)
+
+        // Then
+        viewModelTest
+                .assertEvent { event -> event == expectedEvent }
+                .finish()
+        coVerify {
+            fakeEnableNotificationsForCurrentSessionUseCase.execute(aDistributor)
+        }
+    }
+
+    @Test
+    fun `given EnableNotificationsForDevice action and enable failure when handling action then enable use case is called`() {
+        // Given
+        val viewModel = createViewModel()
+        val aDistributor = "aDistributor"
+        val action = VectorSettingsNotificationPreferenceViewAction.EnableNotificationsForDevice(aDistributor)
+        coEvery { fakeEnableNotificationsForCurrentSessionUseCase.execute(any()) } returns
+                EnableNotificationsForCurrentSessionUseCase.EnableNotificationsResult.Failure
+        val expectedEvent = VectorSettingsNotificationPreferenceViewEvent.EnableNotificationForDeviceFailure
+
+        // When
+        val viewModelTest = viewModel.test()
+        viewModel.handle(action)
+
+        // Then
+        viewModelTest
+                .assertEvent { event -> event == expectedEvent }
+                .finish()
+        coVerify {
+            fakeEnableNotificationsForCurrentSessionUseCase.execute(aDistributor)
+        }
+    }
+
+    @Test
+    fun `given RegisterPushDistributor action and register success when handling action then register use case is called`() {
+        // Given
+        val viewModel = createViewModel()
+        val aDistributor = "aDistributor"
+        val action = VectorSettingsNotificationPreferenceViewAction.RegisterPushDistributor(aDistributor)
+        coEvery { fakeRegisterUnifiedPushUseCase.execute(any()) } returns RegisterUnifiedPushUseCase.RegisterUnifiedPushResult.Success
+        coJustRun { fakeUnregisterUnifiedPushUseCase.execute(any()) }
+        val areNotificationsEnabled = true
+        fakeVectorPreferences.givenAreNotificationsEnabledForDevice(areNotificationsEnabled)
+        justRun { fakeEnsureFcmTokenIsRetrievedUseCase.execute(any(), any()) }
+        val expectedEvent = VectorSettingsNotificationPreferenceViewEvent.NotificationMethodChanged
+
+        // When
+        val viewModelTest = viewModel.test()
+        viewModel.handle(action)
+
+        // Then
+        viewModelTest
+                .assertEvent { event -> event == expectedEvent }
+                .finish()
+        coVerifyOrder {
+            fakeUnregisterUnifiedPushUseCase.execute(fakePushersManager.instance)
+            fakeRegisterUnifiedPushUseCase.execute(aDistributor)
+            fakeEnsureFcmTokenIsRetrievedUseCase.execute(fakePushersManager.instance, registerPusher = areNotificationsEnabled)
+        }
+    }
+
+    @Test
+    fun `given RegisterPushDistributor action and register needs user choice when handling action then register use case is called`() {
+        // Given
+        val viewModel = createViewModel()
+        val aDistributor = "aDistributor"
+        val action = VectorSettingsNotificationPreferenceViewAction.RegisterPushDistributor(aDistributor)
+        coEvery { fakeRegisterUnifiedPushUseCase.execute(any()) } returns RegisterUnifiedPushUseCase.RegisterUnifiedPushResult.NeedToAskUserForDistributor
+        coJustRun { fakeUnregisterUnifiedPushUseCase.execute(any()) }
+        val expectedEvent = VectorSettingsNotificationPreferenceViewEvent.AskUserForPushDistributor
+
+        // When
+        val viewModelTest = viewModel.test()
+        viewModel.handle(action)
+
+        // Then
+        viewModelTest
+                .assertEvent { event -> event == expectedEvent }
+                .finish()
+        coVerifyOrder {
+            fakeUnregisterUnifiedPushUseCase.execute(fakePushersManager.instance)
+            fakeRegisterUnifiedPushUseCase.execute(aDistributor)
+        }
+    }
+}

vector/src/test/java/im/vector/app/test/fakes/FakeVectorPreferences.kt

@@ -69,4 +69,8 @@ class FakeVectorPreferences {
     fun verifySetFdroidSyncBackgroundMode(mode: BackgroundSyncMode) {
         verify { instance.setFdroidSyncBackgroundMode(mode) }
     }
+
+    fun givenAreNotificationsEnabledForDevice(notificationsEnabled: Boolean) {
+        every { instance.areNotificationEnabledForDevice() } returns notificationsEnabled
+    }
 }