From 8ef97b7a108d1f71f4114752aa049da6d5c50a2f Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Wed, 22 May 2024 23:51:10 +0200
Subject: [PATCH] Add test on DefaultUnifiedPushNewGatewayHandler

---
 ...DefaultUnifiedPushNewGatewayHandlerTest.kt | 143 ++++++++++++++++++
 1 file changed, 143 insertions(+)
 create mode 100644 libraries/pushproviders/unifiedpush/src/test/kotlin/io/element/android/libraries/pushproviders/unifiedpush/DefaultUnifiedPushNewGatewayHandlerTest.kt

diff --git a/libraries/pushproviders/unifiedpush/src/test/kotlin/io/element/android/libraries/pushproviders/unifiedpush/DefaultUnifiedPushNewGatewayHandlerTest.kt b/libraries/pushproviders/unifiedpush/src/test/kotlin/io/element/android/libraries/pushproviders/unifiedpush/DefaultUnifiedPushNewGatewayHandlerTest.kt
new file mode 100644
index 0000000000..3f0b7409cc
--- /dev/null
+++ b/libraries/pushproviders/unifiedpush/src/test/kotlin/io/element/android/libraries/pushproviders/unifiedpush/DefaultUnifiedPushNewGatewayHandlerTest.kt
@@ -0,0 +1,143 @@
+/*
+ * Copyright (c) 2024 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 io.element.android.libraries.pushproviders.unifiedpush
+
+import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.matrix.api.MatrixClient
+import io.element.android.libraries.matrix.api.auth.MatrixAuthenticationService
+import io.element.android.libraries.matrix.test.A_SECRET
+import io.element.android.libraries.matrix.test.A_USER_ID
+import io.element.android.libraries.matrix.test.FakeMatrixClient
+import io.element.android.libraries.matrix.test.auth.FakeAuthenticationService
+import io.element.android.libraries.push.test.FakePusherSubscriber
+import io.element.android.libraries.pushproviders.api.PusherSubscriber
+import io.element.android.libraries.pushstore.api.UserPushStoreFactory
+import io.element.android.libraries.pushstore.api.clientsecret.PushClientSecret
+import io.element.android.libraries.pushstore.test.userpushstore.FakeUserPushStore
+import io.element.android.libraries.pushstore.test.userpushstore.FakeUserPushStoreFactory
+import io.element.android.libraries.pushstore.test.userpushstore.clientsecret.FakePushClientSecret
+import io.element.android.tests.testutils.lambda.lambdaRecorder
+import io.element.android.tests.testutils.lambda.value
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class DefaultUnifiedPushNewGatewayHandlerTest {
+    @Test
+    fun `error when fail to retrieve the session`() = runTest {
+        val defaultUnifiedPushNewGatewayHandler = createDefaultUnifiedPushNewGatewayHandler(
+            pushClientSecret = FakePushClientSecret(
+                getUserIdFromSecretResult = { null }
+            )
+        )
+        val result = defaultUnifiedPushNewGatewayHandler.handle(
+            endpoint = "aEndpoint",
+            pushGateway = "aPushGateway",
+            clientSecret = A_SECRET,
+        )
+        assertThat(result.isFailure).isTrue()
+        assertThat(result.exceptionOrNull()).isInstanceOf(IllegalStateException::class.java)
+        assertThat(result.exceptionOrNull()?.message).isEqualTo("Unable to retrieve session")
+    }
+
+    @Test
+    fun `error when the session is not using UnifiedPush`() = runTest {
+        val defaultUnifiedPushNewGatewayHandler = createDefaultUnifiedPushNewGatewayHandler(
+            pushClientSecret = FakePushClientSecret(
+                getUserIdFromSecretResult = { A_USER_ID }
+            ),
+            userPushStoreFactory = FakeUserPushStoreFactory(
+                userPushStore = { FakeUserPushStore(pushProviderName = "other") }
+            )
+        )
+        val result = defaultUnifiedPushNewGatewayHandler.handle(
+            endpoint = "aEndpoint",
+            pushGateway = "aPushGateway",
+            clientSecret = A_SECRET,
+        )
+        assertThat(result.isFailure).isTrue()
+        assertThat(result.exceptionOrNull()).isInstanceOf(IllegalStateException::class.java)
+        assertThat(result.exceptionOrNull()?.message).isEqualTo("This session is not using UnifiedPush pusher")
+    }
+
+    @Test
+    fun `error when the registration fails`() = runTest {
+        val aMatrixClient = FakeMatrixClient()
+        val defaultUnifiedPushNewGatewayHandler = createDefaultUnifiedPushNewGatewayHandler(
+            pushClientSecret = FakePushClientSecret(
+                getUserIdFromSecretResult = { A_USER_ID }
+            ),
+            userPushStoreFactory = FakeUserPushStoreFactory(
+                userPushStore = { FakeUserPushStore(pushProviderName = UnifiedPushConfig.NAME) }
+            ),
+            pusherSubscriber = FakePusherSubscriber(
+                registerPusherResult = { _, _, _ -> Result.failure(IllegalStateException("an error")) }
+            ),
+            matrixAuthenticationService = FakeAuthenticationService(matrixClientResult = { Result.success(aMatrixClient) }),
+        )
+        val result = defaultUnifiedPushNewGatewayHandler.handle(
+            endpoint = "aEndpoint",
+            pushGateway = "aPushGateway",
+            clientSecret = A_SECRET,
+        )
+        assertThat(result.isFailure).isTrue()
+        assertThat(result.exceptionOrNull()).isInstanceOf(IllegalStateException::class.java)
+        assertThat(result.exceptionOrNull()?.message).isEqualTo("an error")
+    }
+
+    @Test
+    fun `happy path`() = runTest {
+        val aMatrixClient = FakeMatrixClient()
+        val lambda = lambdaRecorder { _: MatrixClient, _: String, _: String ->
+            Result.success(Unit)
+        }
+        val defaultUnifiedPushNewGatewayHandler = createDefaultUnifiedPushNewGatewayHandler(
+            pushClientSecret = FakePushClientSecret(
+                getUserIdFromSecretResult = { A_USER_ID }
+            ),
+            userPushStoreFactory = FakeUserPushStoreFactory(
+                userPushStore = { FakeUserPushStore(pushProviderName = UnifiedPushConfig.NAME) }
+            ),
+            pusherSubscriber = FakePusherSubscriber(
+                registerPusherResult = lambda
+            ),
+            matrixAuthenticationService = FakeAuthenticationService(matrixClientResult = { Result.success(aMatrixClient) }),
+        )
+        val result = defaultUnifiedPushNewGatewayHandler.handle(
+            endpoint = "aEndpoint",
+            pushGateway = "aPushGateway",
+            clientSecret = A_SECRET,
+        )
+        assertThat(result).isEqualTo(Result.success(Unit))
+        lambda.assertions()
+            .isCalledOnce()
+            .with(value(aMatrixClient), value("aEndpoint"), value("aPushGateway"))
+    }
+
+    private fun createDefaultUnifiedPushNewGatewayHandler(
+        pusherSubscriber: PusherSubscriber = FakePusherSubscriber(),
+        userPushStoreFactory: UserPushStoreFactory = FakeUserPushStoreFactory(),
+        pushClientSecret: PushClientSecret = FakePushClientSecret(),
+        matrixAuthenticationService: MatrixAuthenticationService = FakeAuthenticationService()
+    ): DefaultUnifiedPushNewGatewayHandler {
+        return DefaultUnifiedPushNewGatewayHandler(
+            pusherSubscriber = pusherSubscriber,
+            userPushStoreFactory = userPushStoreFactory,
+            pushClientSecret = pushClientSecret,
+            matrixAuthenticationService = matrixAuthenticationService
+        )
+    }
+}