Write unit tests for poll start event aggregation.

matrix-sdk-android/src/test/java/org/matrix/android/sdk/internal/session/room/aggregation/poll/PollAggregationProcessorTest.kt

@@ -16,19 +16,30 @@
 
 package org.matrix.android.sdk.internal.session.room.aggregation.poll
 
+import io.mockk.every
+import io.realm.RealmModel
+import io.realm.RealmQuery
+import org.amshove.kluent.shouldBeFalse
+import org.amshove.kluent.shouldBeTrue
 import org.junit.Test
 import org.matrix.android.sdk.api.session.events.model.Event
 import org.matrix.android.sdk.api.session.events.model.EventType
+import org.matrix.android.sdk.api.session.events.model.RelationType
 import org.matrix.android.sdk.api.session.events.model.toContent
 import org.matrix.android.sdk.api.session.room.model.message.MessagePollContent
 import org.matrix.android.sdk.api.session.room.model.message.PollAnswer
 import org.matrix.android.sdk.api.session.room.model.message.PollCreationInfo
 import org.matrix.android.sdk.api.session.room.model.message.PollQuestion
-import org.matrix.android.sdk.test.fakes.FakeMonarchy
+import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
+import org.matrix.android.sdk.internal.database.model.EventAnnotationsSummaryEntity
+import org.matrix.android.sdk.internal.database.model.EventAnnotationsSummaryEntityFields
+import org.matrix.android.sdk.internal.database.model.PollResponseAggregatedSummaryEntity
+import org.matrix.android.sdk.test.fakes.FakeRealm
 
 private const val A_USER_ID_1 = "@user_1:matrix.org"
 private const val A_USER_ID_2 = "@user_2:matrix.org"
 private const val A_ROOM_ID = "!sUeOGZKsBValPTUMax:matrix.org"
+private const val AN_EVENT_ID = "\$vApgexcL8Vfh-WxYKsFKCDooo67ttbjm3TiVKXaWijU"
 
 private val A_POLL_CONTENT = MessagePollContent(
         unstablePollCreationInfo = PollCreationInfo(
@@ -55,20 +66,79 @@ private val A_POLL_CONTENT = MessagePollContent(
 
 private val A_POLL_START_EVENT = Event(
         type = EventType.POLL_START.first(),
-        eventId = "\$vApgexcL8Vfh-WxYKsFKCDooo67ttbjm3TiVKXaWijU",
+        eventId = AN_EVENT_ID,
         originServerTs = 1652435922563,
         senderId = A_USER_ID_1,
         roomId = A_ROOM_ID,
         content = A_POLL_CONTENT.toContent()
 )
 
+private val A_POLL_REPLACE_EVENT = A_POLL_START_EVENT.copy(
+        content = A_POLL_CONTENT
+                .copy(
+                        relatesTo = RelationDefaultContent(
+                                type = RelationType.REPLACE,
+                                eventId = AN_EVENT_ID
+                        )
+                )
+                .toContent()
+)
+
+private val A_BROKEN_POLL_REPLACE_EVENT = A_POLL_START_EVENT.copy(
+        content = A_POLL_CONTENT
+                .copy(
+                        relatesTo = RelationDefaultContent(
+                                type = RelationType.REPLACE,
+                                eventId = null
+                        )
+                )
+                .toContent()
+)
+
+private val A_POLL_REFERENCE_EVENT = A_POLL_START_EVENT.copy(
+        content = A_POLL_CONTENT
+                .copy(
+                        relatesTo = RelationDefaultContent(
+                                type = RelationType.REFERENCE,
+                                eventId = AN_EVENT_ID
+                        )
+                )
+                .toContent()
+)
+
+private val AN_EVENT_ANNOTATIONS_SUMMARY_ENTITY = EventAnnotationsSummaryEntity(
+        roomId = A_ROOM_ID,
+        eventId = AN_EVENT_ID,
+        pollResponseSummary = PollResponseAggregatedSummaryEntity()
+)
+
 class PollAggregationProcessorTest {
 
     private val pollAggregationProcessor: PollAggregationProcessor = DefaultPollAggregationProcessor()
-    private val monarchy = FakeMonarchy()
+    private val realm = FakeRealm()
 
     @Test
-    fun handlePollStartEvent() {
+    fun `given a poll start event which is not a replace is not processed by poll aggregator`() {
+        pollAggregationProcessor.handlePollStartEvent(realm.instance, A_POLL_START_EVENT).shouldBeFalse()
+    }
+
+    @Test
+    fun `given a poll start event with a reference is not processed by poll aggregator`() {
+        pollAggregationProcessor.handlePollStartEvent(realm.instance, A_POLL_REFERENCE_EVENT).shouldBeFalse()
+    }
+
+    @Test
+    fun `given a poll start event with a replace but without target event id is not processed by poll aggregator`() {
+        pollAggregationProcessor.handlePollStartEvent(realm.instance, A_BROKEN_POLL_REPLACE_EVENT).shouldBeFalse()
+    }
+
+    @Test
+    fun `given a poll start event with a replace is processed by poll aggregator`() {
+        val queryResult = realm.givenWhereReturns(result = EventAnnotationsSummaryEntity())
+        queryResult.givenEqualTo(EventAnnotationsSummaryEntityFields.ROOM_ID, A_POLL_REPLACE_EVENT.roomId!!, queryResult)
+        queryResult.givenEqualTo(EventAnnotationsSummaryEntityFields.EVENT_ID, A_POLL_REPLACE_EVENT.eventId!!, queryResult)
+
+        pollAggregationProcessor.handlePollStartEvent(realm.instance, A_POLL_REPLACE_EVENT).shouldBeTrue()
     }
 
     @Test
@@ -78,4 +148,8 @@ class PollAggregationProcessorTest {
     @Test
     fun handlePollEndEvent() {
     }
+
+    private inline fun <reified T : RealmModel> RealmQuery<T>.givenEqualTo(fieldName: String, value: String, result: RealmQuery<T>) {
+        every { equalTo(fieldName, value) } returns result
+    }
 }

matrix-sdk-android/src/test/java/org/matrix/android/sdk/test/fakes/FakeRealm.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2022 The Matrix.org Foundation C.I.C.
+ *
+ * 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 org.matrix.android.sdk.test.fakes
+
+import io.mockk.every
+import io.mockk.mockk
+import io.realm.Realm
+import io.realm.RealmModel
+import io.realm.RealmQuery
+import io.realm.kotlin.where
+
+internal class FakeRealm {
+
+    val instance = mockk<Realm>(relaxed = true)
+
+    inline fun <reified T : RealmModel> givenWhereReturns(result: T?): RealmQuery<T> {
+        val queryResult = mockk<RealmQuery<T>>(relaxed = true)
+        every { queryResult.findFirst() } returns result
+        every { instance.where<T>() } returns queryResult
+        return queryResult
+    }
+}