Adding unit tests for FCM token retrieval

vector/src/main/java/im/vector/app/core/pushers/EnsureFcmTokenIsRetrievedUseCase.kt

@@ -25,7 +25,6 @@ class EnsureFcmTokenIsRetrievedUseCase @Inject constructor(
         private val activeSessionHolder: ActiveSessionHolder,
 ) {
 
-    // TODO add unit tests
     fun execute(pushersManager: PushersManager, registerPusher: Boolean) {
         if (unifiedPushHelper.isEmbeddedDistributor()) {
             fcmHelper.ensureFcmTokenIsRetrieved(pushersManager, shouldAddHttpPusher(registerPusher))

vector/src/test/java/im/vector/app/core/pushers/EnsureFcmTokenIsRetrievedUseCaseTest.kt

@@ -0,0 +1,106 @@
+/*
+ * 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.core.pushers
+
+import im.vector.app.test.fakes.FakeActiveSessionHolder
+import im.vector.app.test.fakes.FakeFcmHelper
+import im.vector.app.test.fakes.FakePushersManager
+import im.vector.app.test.fakes.FakeUnifiedPushHelper
+import im.vector.app.test.fixtures.PusherFixture
+import io.mockk.verify
+import org.junit.Test
+
+class EnsureFcmTokenIsRetrievedUseCaseTest {
+
+    private val fakeUnifiedPushHelper = FakeUnifiedPushHelper()
+    private val fakeFcmHelper = FakeFcmHelper()
+    private val fakeActiveSessionHolder = FakeActiveSessionHolder()
+
+    private val ensureFcmTokenIsRetrievedUseCase = EnsureFcmTokenIsRetrievedUseCase(
+            unifiedPushHelper = fakeUnifiedPushHelper.instance,
+            fcmHelper = fakeFcmHelper.instance,
+            activeSessionHolder = fakeActiveSessionHolder.instance,
+    )
+
+    @Test
+    fun `given no registered pusher and distributor as embedded when execute then ensure the FCM token is retrieved with register pusher option`() {
+        // Given
+        val aPushersManager = FakePushersManager()
+        fakeUnifiedPushHelper.givenIsEmbeddedDistributorReturns(true)
+        fakeFcmHelper.givenEnsureFcmTokenIsRetrieved(aPushersManager.instance)
+        val aSessionId = "aSessionId"
+        fakeActiveSessionHolder.fakeSession.givenSessionId(aSessionId)
+        val expectedPusher = PusherFixture.aPusher(deviceId = "")
+        fakeActiveSessionHolder.fakeSession.fakePushersService.givenGetPushers(listOf(expectedPusher))
+
+        // When
+        ensureFcmTokenIsRetrievedUseCase.execute(aPushersManager.instance, registerPusher = true)
+
+        // Then
+        fakeFcmHelper.verifyEnsureFcmTokenIsRetrieved(aPushersManager.instance, registerPusher = true)
+    }
+
+    @Test
+    fun `given a registered pusher and distributor as embedded when execute then ensure the FCM token is retrieved without register pusher option`() {
+        // Given
+        val aPushersManager = FakePushersManager()
+        fakeUnifiedPushHelper.givenIsEmbeddedDistributorReturns(true)
+        fakeFcmHelper.givenEnsureFcmTokenIsRetrieved(aPushersManager.instance)
+        val aSessionId = "aSessionId"
+        fakeActiveSessionHolder.fakeSession.givenSessionId(aSessionId)
+        val expectedPusher = PusherFixture.aPusher(deviceId = aSessionId)
+        fakeActiveSessionHolder.fakeSession.fakePushersService.givenGetPushers(listOf(expectedPusher))
+
+        // When
+        ensureFcmTokenIsRetrievedUseCase.execute(aPushersManager.instance, registerPusher = true)
+
+        // Then
+        fakeFcmHelper.verifyEnsureFcmTokenIsRetrieved(aPushersManager.instance, registerPusher = false)
+    }
+
+    @Test
+    fun `given no registering asked and distributor as embedded when execute then ensure the FCM token is retrieved without register pusher option`() {
+        // Given
+        val aPushersManager = FakePushersManager()
+        fakeUnifiedPushHelper.givenIsEmbeddedDistributorReturns(true)
+        fakeFcmHelper.givenEnsureFcmTokenIsRetrieved(aPushersManager.instance)
+        val aSessionId = "aSessionId"
+        fakeActiveSessionHolder.fakeSession.givenSessionId(aSessionId)
+        val expectedPusher = PusherFixture.aPusher(deviceId = aSessionId)
+        fakeActiveSessionHolder.fakeSession.fakePushersService.givenGetPushers(listOf(expectedPusher))
+
+        // When
+        ensureFcmTokenIsRetrievedUseCase.execute(aPushersManager.instance, registerPusher = false)
+
+        // Then
+        fakeFcmHelper.verifyEnsureFcmTokenIsRetrieved(aPushersManager.instance, registerPusher = false)
+    }
+
+    @Test
+    fun `given distributor as not embedded when execute then nothing is done`() {
+        // Given
+        val aPushersManager = FakePushersManager()
+        fakeUnifiedPushHelper.givenIsEmbeddedDistributorReturns(false)
+
+        // When
+        ensureFcmTokenIsRetrievedUseCase.execute(aPushersManager.instance, registerPusher = true)
+
+        // Then
+        fakeFcmHelper.verifyEnsureFcmTokenIsRetrieved(aPushersManager.instance, registerPusher = true, inverse = true)
+        fakeFcmHelper.verifyEnsureFcmTokenIsRetrieved(aPushersManager.instance, registerPusher = false, inverse = true)
+    }
+}

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

@@ -33,7 +33,8 @@ class FakeFcmHelper {
     fun verifyEnsureFcmTokenIsRetrieved(
             pushersManager: PushersManager,
             registerPusher: Boolean,
+            inverse: Boolean = false,
     ) {
-        verify { instance.ensureFcmTokenIsRetrieved(pushersManager, registerPusher) }
+        verify(inverse = inverse) { instance.ensureFcmTokenIsRetrieved(pushersManager, registerPusher) }
     }
 }