Add unit test

vector/src/test/java/im/vector/app/features/voicebroadcast/usecase/GetVoiceBroadcastStateEventUseCaseTest.kt

@@ -0,0 +1,114 @@
+/*
+ * 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.voicebroadcast.usecase
+
+import im.vector.app.features.voicebroadcast.VoiceBroadcastConstants
+import im.vector.app.features.voicebroadcast.model.VoiceBroadcast
+import im.vector.app.test.fakes.FakeSession
+import io.mockk.every
+import io.mockk.mockk
+import org.amshove.kluent.shouldBeEqualTo
+import org.amshove.kluent.shouldBeNull
+import org.amshove.kluent.shouldNotBeNull
+import org.junit.Test
+import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
+
+private const val A_ROOM_ID = "A_ROOM_ID"
+private const val A_VOICE_BROADCAST_ID = "A_VOICE_BROADCAST_ID"
+
+internal class GetVoiceBroadcastStateEventUseCaseTest {
+
+    private val fakeSession = FakeSession()
+    private val getVoiceBroadcastStateEventUseCase = GetVoiceBroadcastStateEventUseCase(fakeSession)
+
+    private val fakeRoom get() = fakeSession.fakeRoomService.fakeRoom
+
+    @Test
+    fun `given there is no event related to the given vb, when execute, then return null`() {
+        // Given
+        val aVoiceBroadcast = VoiceBroadcast(A_VOICE_BROADCAST_ID, A_ROOM_ID)
+        every { fakeRoom.fakeTimelineService.getTimelineEventsRelatedTo(any(), any()) } returns emptyList()
+
+        // When
+        val result = getVoiceBroadcastStateEventUseCase.execute(aVoiceBroadcast)
+
+        // Then
+        result.shouldBeNull()
+    }
+
+    @Test
+    fun `given there are several related events related to the given vb, when execute, then return the most recent one`() {
+        // Given
+        val aVoiceBroadcast = VoiceBroadcast(A_VOICE_BROADCAST_ID, A_ROOM_ID)
+        val aListOfTimelineEvents = listOf<TimelineEvent>(
+                mockk(relaxed = true) {
+                    every { root.eventId } returns "event_id_1"
+                    every { root.type } returns VoiceBroadcastConstants.STATE_ROOM_VOICE_BROADCAST_INFO
+                    every { root.isRedacted() } returns false
+                    every { root.originServerTs } returns 1L
+                },
+                mockk(relaxed = true) {
+                    every { root.eventId } returns "event_id_3"
+                    every { root.type } returns VoiceBroadcastConstants.STATE_ROOM_VOICE_BROADCAST_INFO
+                    every { root.isRedacted() } returns false
+                    every { root.originServerTs } returns 3L
+                },
+                mockk(relaxed = true) {
+                    every { root.eventId } returns "event_id_2"
+                    every { root.type } returns VoiceBroadcastConstants.STATE_ROOM_VOICE_BROADCAST_INFO
+                    every { root.isRedacted() } returns false
+                    every { root.originServerTs } returns 2L
+                },
+        )
+        every { fakeRoom.fakeTimelineService.getTimelineEventsRelatedTo(any(), any()) } returns aListOfTimelineEvents
+
+        // When
+        val result = getVoiceBroadcastStateEventUseCase.execute(aVoiceBroadcast)
+
+        // Then
+        result.shouldNotBeNull()
+        result.root.eventId shouldBeEqualTo "event_id_3"
+    }
+
+    @Test
+    fun `given there are several related events related to the given vb, when execute, then return the most recent one which is not redacted`() {
+        // Given
+        val aVoiceBroadcast = VoiceBroadcast(A_VOICE_BROADCAST_ID, A_ROOM_ID)
+        val aListOfTimelineEvents = listOf<TimelineEvent>(
+                mockk(relaxed = true) {
+                    every { root.eventId } returns "event_id_1"
+                    every { root.type } returns VoiceBroadcastConstants.STATE_ROOM_VOICE_BROADCAST_INFO
+                    every { root.isRedacted() } returns false
+                    every { root.originServerTs } returns 1L
+                },
+                mockk(relaxed = true) {
+                    every { root.eventId } returns "event_id_2"
+                    every { root.type } returns VoiceBroadcastConstants.STATE_ROOM_VOICE_BROADCAST_INFO
+                    every { root.isRedacted() } returns true
+                    every { root.originServerTs } returns 2L
+                },
+        )
+        every { fakeRoom.fakeTimelineService.getTimelineEventsRelatedTo(any(), any()) } returns aListOfTimelineEvents
+
+        // When
+        val result = getVoiceBroadcastStateEventUseCase.execute(aVoiceBroadcast)
+
+        // Then
+        result.shouldNotBeNull()
+        result.root.eventId shouldBeEqualTo "event_id_1"
+    }
+}

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

@@ -22,7 +22,7 @@ import org.matrix.android.sdk.api.session.room.Room
 class FakeRoom(
         private val fakeLocationSharingService: FakeLocationSharingService = FakeLocationSharingService(),
         private val fakeSendService: FakeSendService = FakeSendService(),
-        private val fakeTimelineService: FakeTimelineService = FakeTimelineService(),
+        val fakeTimelineService: FakeTimelineService = FakeTimelineService(),
         private val fakeRelationService: FakeRelationService = FakeRelationService(),
         private val fakeStateService: FakeStateService = FakeStateService(),
 ) : Room by mockk() {

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

@@ -22,7 +22,7 @@ import org.matrix.android.sdk.api.session.room.RoomService
 import org.matrix.android.sdk.api.session.room.model.RoomSummary
 
 class FakeRoomService(
-        private val fakeRoom: FakeRoom = FakeRoom()
+        val fakeRoom: FakeRoom = FakeRoom()
 ) : RoomService by mockk() {
 
     override fun getRoom(roomId: String) = fakeRoom