Adding unit test for use cases

mnaturel · mnaturel · commit 212021e3007b · 2023-01-17T16:04:33.000+01:00
diff --git a/vector/src/main/java/im/vector/app/features/roomprofile/polls/list/domain/GetLoadedPollsStatusUseCase.kt b/vector/src/main/java/im/vector/app/features/roomprofile/polls/list/domain/GetLoadedPollsStatusUseCase.kt
@@ -20,7 +20,6 @@ import im.vector.app.features.roomprofile.polls.list.data.LoadedPollsStatus
 import im.vector.app.features.roomprofile.polls.list.data.RoomPollRepository
 import javax.inject.Inject
 
-// TODO add unit tests
 class GetLoadedPollsStatusUseCase @Inject constructor(
         private val roomPollRepository: RoomPollRepository,
 ) {
diff --git a/vector/src/main/java/im/vector/app/features/roomprofile/polls/list/domain/GetPollsUseCase.kt b/vector/src/main/java/im/vector/app/features/roomprofile/polls/list/domain/GetPollsUseCase.kt
@@ -22,7 +22,6 @@ import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
 import javax.inject.Inject
 
-// TODO add unit tests
 class GetPollsUseCase @Inject constructor(
         private val roomPollRepository: RoomPollRepository,
 ) {
diff --git a/vector/src/main/java/im/vector/app/features/roomprofile/polls/list/domain/LoadMorePollsUseCase.kt b/vector/src/main/java/im/vector/app/features/roomprofile/polls/list/domain/LoadMorePollsUseCase.kt
@@ -20,7 +20,6 @@ import im.vector.app.features.roomprofile.polls.list.data.LoadedPollsStatus
 import im.vector.app.features.roomprofile.polls.list.data.RoomPollRepository
 import javax.inject.Inject
 
-// TODO add unit tests
 class LoadMorePollsUseCase @Inject constructor(
         private val roomPollRepository: RoomPollRepository,
 ) {
diff --git a/vector/src/test/java/im/vector/app/features/roomprofile/polls/RoomPollsViewModelTest.kt b/vector/src/test/java/im/vector/app/features/roomprofile/polls/RoomPollsViewModelTest.kt
@@ -17,8 +17,11 @@
 package im.vector.app.features.roomprofile.polls
 
 import com.airbnb.mvrx.test.MavericksTestRule
+import im.vector.app.features.roomprofile.polls.list.domain.GetLoadedPollsStatusUseCase
 import im.vector.app.features.roomprofile.polls.list.ui.PollSummary
 import im.vector.app.features.roomprofile.polls.list.domain.GetPollsUseCase
+import im.vector.app.features.roomprofile.polls.list.domain.LoadMorePollsUseCase
+import im.vector.app.features.roomprofile.polls.list.domain.SyncPollsUseCase
 import im.vector.app.test.test
 import im.vector.app.test.testDispatcher
 import io.mockk.every
@@ -36,20 +39,26 @@ class RoomPollsViewModelTest {
     val mavericksTestRule = MavericksTestRule(testDispatcher = testDispatcher)
 
     private val fakeGetPollsUseCase = mockk<GetPollsUseCase>()
+    private val fakeGetLoadedPollsStatusUseCase = mockk<GetLoadedPollsStatusUseCase>()
+    private val fakeLoadMorePollsUseCase = mockk<LoadMorePollsUseCase>()
+    private val fakeSyncPollsUseCase = mockk<SyncPollsUseCase>()
     private val initialState = RoomPollsViewState(ROOM_ID)
 
     private fun createViewModel(): RoomPollsViewModel {
         return RoomPollsViewModel(
                 initialState = initialState,
                 getPollsUseCase = fakeGetPollsUseCase,
+                getLoadedPollsStatusUseCase = fakeGetLoadedPollsStatusUseCase,
+                loadMorePollsUseCase = fakeLoadMorePollsUseCase,
+                syncPollsUseCase = fakeSyncPollsUseCase,
         )
     }
 
     @Test
     fun `given viewModel when created then polls list is observed and viewState is updated`() {
         // Given
         val polls = listOf(givenAPollSummary())
-        every { fakeGetPollsUseCase.execute() } returns flowOf(polls)
+        every { fakeGetPollsUseCase.execute(ROOM_ID) } returns flowOf(polls)
         val expectedViewState = initialState.copy(polls = polls)
 
         // When
@@ -61,7 +70,7 @@ class RoomPollsViewModelTest {
                 .assertLatestState(expectedViewState)
                 .finish()
         verify {
-            fakeGetPollsUseCase.execute()
+            fakeGetPollsUseCase.execute(ROOM_ID)
         }
     }
 
diff --git a/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/GetLoadedPollsStatusUseCaseTest.kt b/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/GetLoadedPollsStatusUseCaseTest.kt
@@ -0,0 +1,52 @@
+/*
+ * 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.list.domain
+
+import im.vector.app.features.roomprofile.polls.list.data.LoadedPollsStatus
+import im.vector.app.features.roomprofile.polls.list.data.RoomPollRepository
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.Test
+
+class GetLoadedPollsStatusUseCaseTest {
+
+    private val fakeRoomPollRepository = mockk<RoomPollRepository>()
+
+    private val getLoadedPollsStatusUseCase = GetLoadedPollsStatusUseCase(
+            roomPollRepository = fakeRoomPollRepository,
+    )
+
+    @Test
+    fun `given repo when execute then correct method of repo is called`() {
+        // Given
+        val aRoomId = "roomId"
+        val expectedStatus = LoadedPollsStatus(
+                canLoadMore = true,
+                nbLoadedDays = 10,
+        )
+        every { fakeRoomPollRepository.getLoadedPollsStatus(aRoomId) } returns expectedStatus
+
+        // When
+        val status = getLoadedPollsStatusUseCase.execute(aRoomId)
+
+        // Then
+        status shouldBeEqualTo expectedStatus
+        verify { fakeRoomPollRepository.getLoadedPollsStatus(aRoomId) }
+    }
+}
diff --git a/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/GetPollsUseCaseTest.kt b/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/GetPollsUseCaseTest.kt
@@ -0,0 +1,63 @@
+/*
+ * 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.list.domain
+
+import im.vector.app.features.roomprofile.polls.list.data.RoomPollRepository
+import im.vector.app.features.roomprofile.polls.list.ui.PollSummary
+import im.vector.app.test.fixtures.RoomPollFixture
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.flow.flowOf
+import kotlinx.coroutines.test.runTest
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.Test
+
+class GetPollsUseCaseTest {
+    private val fakeRoomPollRepository = mockk<RoomPollRepository>()
+
+    private val getPollsUseCase = GetPollsUseCase(
+            roomPollRepository = fakeRoomPollRepository,
+    )
+
+    @Test
+    fun `given repo when execute then correct method of repo is called and polls are sorted most recent first`() = runTest {
+        // Given
+        val aRoomId = "roomId"
+        val poll1 = RoomPollFixture.anActivePollSummary(timestamp = 1)
+        val poll2 = RoomPollFixture.anActivePollSummary(timestamp = 2)
+        val poll3 = RoomPollFixture.anActivePollSummary(timestamp = 3)
+        val polls = listOf<PollSummary>(
+                poll1,
+                poll2,
+                poll3,
+        )
+        every { fakeRoomPollRepository.getPolls(aRoomId) } returns flowOf(polls)
+        val expectedPolls = listOf<PollSummary>(
+                poll3,
+                poll2,
+                poll1,
+        )
+        // When
+        val result = getPollsUseCase.execute(aRoomId).first()
+
+        // Then
+        result shouldBeEqualTo expectedPolls
+        verify { fakeRoomPollRepository.getPolls(aRoomId) }
+    }
+}
diff --git a/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/LoadMorePollsUseCaseTest.kt b/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/LoadMorePollsUseCaseTest.kt
@@ -0,0 +1,46 @@
+/*
+ * 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.list.domain
+
+import im.vector.app.features.roomprofile.polls.list.data.RoomPollRepository
+import io.mockk.coJustRun
+import io.mockk.coVerify
+import io.mockk.mockk
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class LoadMorePollsUseCaseTest {
+
+    private val fakeRoomPollRepository = mockk<RoomPollRepository>()
+
+    private val loadMorePollsUseCase = LoadMorePollsUseCase(
+            roomPollRepository = fakeRoomPollRepository,
+    )
+
+    @Test
+    fun `given repo when execute then correct method of repo is called`() = runTest {
+        // Given
+        val aRoomId = "roomId"
+        coJustRun { fakeRoomPollRepository.loadMorePolls(aRoomId) }
+
+        // When
+        loadMorePollsUseCase.execute(aRoomId)
+
+        // Then
+        coVerify { fakeRoomPollRepository.loadMorePolls(aRoomId) }
+    }
+}
diff --git a/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/SyncPollsUseCaseTest.kt b/vector/src/test/java/im/vector/app/features/roomprofile/polls/list/domain/SyncPollsUseCaseTest.kt
@@ -0,0 +1,46 @@
+/*
+ * 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.list.domain
+
+import im.vector.app.features.roomprofile.polls.list.data.RoomPollRepository
+import io.mockk.coJustRun
+import io.mockk.coVerify
+import io.mockk.mockk
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class SyncPollsUseCaseTest {
+
+    private val fakeRoomPollRepository = mockk<RoomPollRepository>()
+
+    private val syncPollsUseCase = SyncPollsUseCase(
+            roomPollRepository = fakeRoomPollRepository,
+    )
+
+    @Test
+    fun `given repo when execute then correct method of repo is called`() = runTest {
+        // Given
+        val aRoomId = "roomId"
+        coJustRun { fakeRoomPollRepository.syncPolls(aRoomId) }
+
+        // When
+        syncPollsUseCase.execute(aRoomId)
+
+        // Then
+        coVerify { fakeRoomPollRepository.syncPolls(aRoomId) }
+    }
+}
diff --git a/vector/src/test/java/im/vector/app/test/fixtures/RoomPollFixture.kt b/vector/src/test/java/im/vector/app/test/fixtures/RoomPollFixture.kt
@@ -0,0 +1,47 @@
+/*
+ * 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.test.fixtures
+
+import im.vector.app.features.home.room.detail.timeline.item.PollOptionViewState
+import im.vector.app.features.roomprofile.polls.list.ui.PollSummary
+
+object RoomPollFixture {
+
+    fun anActivePollSummary(
+            id: String = "",
+            timestamp: Long,
+            title: String = "",
+    ) = PollSummary.ActivePoll(
+            id = id,
+            creationTimestamp = timestamp,
+            title = title,
+    )
+
+    fun anEndedPollSummary(
+            id: String = "",
+            timestamp: Long,
+            title: String = "",
+            totalVotes: Int,
+            winnerOptions: List<PollOptionViewState.PollEnded>
+    ) = PollSummary.EndedPoll(
+            id = id,
+            creationTimestamp = timestamp,
+            title = title,
+            totalVotes = totalVotes,
+            winnerOptions = winnerOptions,
+    )
+}
