Adding unit tests for CheckIfCurrentSessionCanBeVerifiedUseCase

vector/src/main/java/im/vector/app/features/settings/devices/v2/verification/CheckIfCurrentSessionCanBeVerifiedUseCase.kt

@@ -23,7 +23,6 @@ import org.matrix.android.sdk.flow.flow
 import timber.log.Timber
 import javax.inject.Inject
 
-// TODO add unit tests
 class CheckIfCurrentSessionCanBeVerifiedUseCase @Inject constructor(
         private val activeSessionHolder: ActiveSessionHolder,
 ) {

vector/src/test/java/im/vector/app/features/settings/devices/v2/DevicesViewModelTest.kt

@@ -18,6 +18,7 @@ package im.vector.app.features.settings.devices.v2
 
 import com.airbnb.mvrx.Success
 import com.airbnb.mvrx.test.MvRxTestRule
+import im.vector.app.features.settings.devices.v2.verification.CheckIfCurrentSessionCanBeVerifiedUseCase
 import im.vector.app.test.fakes.FakeActiveSessionHolder
 import im.vector.app.test.fakes.FakeVerificationService
 import im.vector.app.test.test
@@ -45,6 +46,7 @@ class DevicesViewModelTest {
     private val getDeviceFullInfoListUseCase = mockk<GetDeviceFullInfoListUseCase>()
     private val refreshDevicesUseCase = mockk<RefreshDevicesUseCase>()
     private val refreshDevicesOnCryptoDevicesChangeUseCase = mockk<RefreshDevicesOnCryptoDevicesChangeUseCase>()
+    private val checkIfCurrentSessionCanBeVerifiedUseCase = mockk<CheckIfCurrentSessionCanBeVerifiedUseCase>()
 
     private fun createViewModel(): DevicesViewModel {
         return DevicesViewModel(
@@ -54,6 +56,7 @@ class DevicesViewModelTest {
                 getDeviceFullInfoListUseCase,
                 refreshDevicesOnCryptoDevicesChangeUseCase,
                 refreshDevicesUseCase,
+                checkIfCurrentSessionCanBeVerifiedUseCase,
         )
     }
 

vector/src/test/java/im/vector/app/features/settings/devices/v2/verification/CheckIfCurrentSessionCanBeVerifiedUseCaseTest.kt

@@ -0,0 +1,124 @@
+/*
+ * 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.devices.v2.verification
+
+import im.vector.app.test.fakes.FakeActiveSessionHolder
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.mockkStatic
+import io.mockk.unmockkAll
+import io.mockk.verify
+import kotlinx.coroutines.flow.flowOf
+import kotlinx.coroutines.test.runTest
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.After
+import org.junit.Before
+import org.junit.Test
+import org.matrix.android.sdk.api.session.crypto.model.CryptoDeviceInfo
+import org.matrix.android.sdk.flow.FlowSession
+import org.matrix.android.sdk.flow.flow
+
+class CheckIfCurrentSessionCanBeVerifiedUseCaseTest {
+
+    private val fakeActiveSessionHolder = FakeActiveSessionHolder()
+
+    private val checkIfCurrentSessionCanBeVerifiedUseCase = CheckIfCurrentSessionCanBeVerifiedUseCase(
+            activeSessionHolder = fakeActiveSessionHolder.instance
+    )
+
+    @Before
+    fun setUp() {
+        mockkStatic("org.matrix.android.sdk.flow.FlowSessionKt")
+    }
+
+    @After
+    fun tearDown() {
+        unmockkAll()
+    }
+
+    @Test
+    fun `given there are other sessions when checking if session can be verified then result is true`() = runTest {
+        // Given
+        val device1 = givenACryptoDevice()
+        val device2 = givenACryptoDevice()
+        val devices = listOf(device1, device2)
+        val fakeSession = fakeActiveSessionHolder.fakeSession
+        val flowSession = mockk<FlowSession>()
+        every { fakeSession.flow() } returns flowSession
+        every { flowSession.liveUserCryptoDevices(any()) } returns flowOf(devices)
+
+        fakeSession.fakeSharedSecretStorageService.givenIsRecoverySetupReturns(false)
+
+        // When
+        val result = checkIfCurrentSessionCanBeVerifiedUseCase.execute()
+
+        // Then
+        result shouldBeEqualTo true
+        verify {
+            flowSession.liveUserCryptoDevices(fakeSession.myUserId)
+            fakeSession.fakeSharedSecretStorageService.isRecoverySetup()
+        }
+    }
+
+    @Test
+    fun `given recovery is setup when checking if session can be verified then result is true`() = runTest {
+        // Given
+        val device1 = givenACryptoDevice()
+        val devices = listOf(device1)
+        val fakeSession = fakeActiveSessionHolder.fakeSession
+        val flowSession = mockk<FlowSession>()
+        every { fakeSession.flow() } returns flowSession
+        every { flowSession.liveUserCryptoDevices(any()) } returns flowOf(devices)
+
+        fakeSession.fakeSharedSecretStorageService.givenIsRecoverySetupReturns(true)
+
+        // When
+        val result = checkIfCurrentSessionCanBeVerifiedUseCase.execute()
+
+        // Then
+        result shouldBeEqualTo true
+        verify {
+            flowSession.liveUserCryptoDevices(fakeSession.myUserId)
+            fakeSession.fakeSharedSecretStorageService.isRecoverySetup()
+        }
+    }
+
+    @Test
+    fun `given recovery is not setup and there are no other sessions when checking if session can be verified then result is false`() = runTest {
+        // Given
+        val device1 = givenACryptoDevice()
+        val devices = listOf(device1)
+        val fakeSession = fakeActiveSessionHolder.fakeSession
+        val flowSession = mockk<FlowSession>()
+        every { fakeSession.flow() } returns flowSession
+        every { flowSession.liveUserCryptoDevices(any()) } returns flowOf(devices)
+
+        fakeSession.fakeSharedSecretStorageService.givenIsRecoverySetupReturns(false)
+
+        // When
+        val result = checkIfCurrentSessionCanBeVerifiedUseCase.execute()
+
+        // Then
+        result shouldBeEqualTo false
+        verify {
+            flowSession.liveUserCryptoDevices(fakeSession.myUserId)
+            fakeSession.fakeSharedSecretStorageService.isRecoverySetup()
+        }
+    }
+
+    private fun givenACryptoDevice(): CryptoDeviceInfo = mockk()
+}

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

@@ -16,6 +16,8 @@
 
 package im.vector.app.test.fakes
 
+import io.mockk.every
+import io.mockk.mockk
 import org.matrix.android.sdk.api.listeners.ProgressListener
 import org.matrix.android.sdk.api.session.securestorage.IntegrityResult
 import org.matrix.android.sdk.api.session.securestorage.KeyInfoResult
@@ -26,7 +28,7 @@ import org.matrix.android.sdk.api.session.securestorage.SharedSecretStorageServi
 import org.matrix.android.sdk.api.session.securestorage.SsssKeyCreationInfo
 import org.matrix.android.sdk.api.session.securestorage.SsssKeySpec
 
-class FakeSharedSecretStorageService : SharedSecretStorageService {
+class FakeSharedSecretStorageService : SharedSecretStorageService by mockk() {
 
     var integrityResult: IntegrityResult = IntegrityResult.Error(SharedSecretStorageError.OtherError(IllegalStateException()))
     var _defaultKey: KeyInfoResult = KeyInfoResult.Error(SharedSecretStorageError.OtherError(IllegalStateException()))
@@ -76,4 +78,8 @@ class FakeSharedSecretStorageService : SharedSecretStorageService {
     override suspend fun requestSecret(name: String, myOtherDeviceId: String) {
         TODO("Not yet implemented")
     }
+
+    fun givenIsRecoverySetupReturns(isRecoverySetup: Boolean) {
+        every { isRecoverySetup() } returns isRecoverySetup
+    }
 }