Adding unit tests for GetEndedPollEventIdUseCase

vector/src/main/java/im/vector/app/features/roomprofile/polls/detail/domain/GetEndedPollEventIdUseCase.kt

@@ -19,20 +19,23 @@ package im.vector.app.features.roomprofile.polls.detail.domain
 import im.vector.app.core.di.ActiveSessionHolder
 import org.matrix.android.sdk.api.session.events.model.RelationType
 import org.matrix.android.sdk.api.session.events.model.isPollEnd
+import timber.log.Timber
 import javax.inject.Inject
 
-// TODO add unit tests
 class GetEndedPollEventIdUseCase @Inject constructor(
         private val activeSessionHolder: ActiveSessionHolder,
 ) {
 
     fun execute(roomId: String, startPollEventId: String): String? {
-        return activeSessionHolder.getActiveSession()
+        val result = runCatching {
+            activeSessionHolder.getActiveSession()
                     .roomService()
                     .getRoom(roomId)
                     ?.timelineService()
                     ?.getTimelineEventsRelatedTo(RelationType.REFERENCE, startPollEventId)
                     ?.find { it.root.isPollEnd() }
                     ?.eventId
+        }.onFailure { Timber.w("failed to retrieve the ended poll event id for eventId:$startPollEventId") }
+        return result.getOrNull()
     }
 }

vector/src/test/java/im/vector/app/features/roomprofile/polls/detail/domain/GetEndedPollEventIdUseCaseTest.kt

@@ -0,0 +1,136 @@
+/*
+ * Copyright (c) 2023 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.roomprofile.polls.detail.domain
+
+import im.vector.app.test.fakes.FakeActiveSessionHolder
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.mockkStatic
+import io.mockk.unmockkAll
+import org.amshove.kluent.shouldBe
+import org.junit.After
+import org.junit.Before
+import org.junit.Test
+import org.matrix.android.sdk.api.session.events.model.Event
+import org.matrix.android.sdk.api.session.events.model.RelationType
+import org.matrix.android.sdk.api.session.events.model.isPollEnd
+import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
+
+private const val A_ROOM_ID = "room-id"
+private const val A_START_POLL_EVENT_ID = "start-poll-id"
+private const val AN_END_POLL_EVENT_ID = "end-poll-id"
+
+internal class GetEndedPollEventIdUseCaseTest {
+
+    private val fakeActiveSessionHolder = FakeActiveSessionHolder()
+
+    private val getEndedPollEventIdUseCase = GetEndedPollEventIdUseCase(
+            activeSessionHolder = fakeActiveSessionHolder.instance
+    )
+
+    @Before
+    fun setup() {
+        mockkStatic("org.matrix.android.sdk.api.session.events.model.EventKt")
+    }
+
+    @After
+    fun tearDown() {
+        unmockkAll()
+    }
+
+    @Test
+    fun `given existing related end event when execute then result is id of the end event`() {
+        // Given
+        val timelineEvent = givenEvent(eventId = AN_END_POLL_EVENT_ID, isPollEnd = true)
+        givenARelatedEvent(timelineEvent = timelineEvent)
+
+        // When
+        val result = getEndedPollEventIdUseCase.execute(A_ROOM_ID, A_START_POLL_EVENT_ID)
+
+        // Then
+        result shouldBe AN_END_POLL_EVENT_ID
+    }
+
+    @Test
+    fun `given existing related event but not end poll event when execute then result is null`() {
+        // Given
+        val timelineEvent = givenEvent(eventId = AN_END_POLL_EVENT_ID, isPollEnd = false)
+        givenARelatedEvent(timelineEvent = timelineEvent)
+
+        // When
+        val result = getEndedPollEventIdUseCase.execute(A_ROOM_ID, A_START_POLL_EVENT_ID)
+
+        // Then
+        result shouldBe null
+    }
+
+    @Test
+    fun `given no existing related event when execute then result is null`() {
+        // Given
+        givenARelatedEvent(timelineEvent = null)
+
+        // When
+        val result = getEndedPollEventIdUseCase.execute(A_ROOM_ID, A_START_POLL_EVENT_ID)
+
+        // Then
+        result shouldBe null
+    }
+
+    @Test
+    fun `given error occurred when execute then result is null`() {
+        // Given
+        givenErrorDuringRequest(error = Exception())
+
+        // When
+        val result = getEndedPollEventIdUseCase.execute(A_ROOM_ID, A_START_POLL_EVENT_ID)
+
+        // Then
+        result shouldBe null
+    }
+
+    private fun givenEvent(eventId: String, isPollEnd: Boolean): TimelineEvent {
+        val timelineEvent = mockk<TimelineEvent>()
+        val event = mockk<Event>()
+        every { timelineEvent.root } returns event
+        every { timelineEvent.eventId } returns eventId
+        every { event.isPollEnd() } returns isPollEnd
+        return timelineEvent
+    }
+
+    private fun givenARelatedEvent(timelineEvent: TimelineEvent?) {
+        val result: List<TimelineEvent> = timelineEvent?.let { listOf(it) } ?: emptyList()
+        every {
+            fakeActiveSessionHolder.instance
+                    .getActiveSession()
+                    .roomService()
+                    .getRoom(A_ROOM_ID)
+                    ?.timelineService()
+                    ?.getTimelineEventsRelatedTo(RelationType.REFERENCE, A_START_POLL_EVENT_ID)
+        } returns result
+    }
+
+    private fun givenErrorDuringRequest(error: Exception) {
+        every {
+            fakeActiveSessionHolder.instance
+                    .getActiveSession()
+                    .roomService()
+                    .getRoom(A_ROOM_ID)
+                    ?.timelineService()
+                    ?.getTimelineEventsRelatedTo(RelationType.REFERENCE, A_START_POLL_EVENT_ID)
+        } throws error
+    }
+}