Move module matrixtest to matrix.test

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt

@@ -0,0 +1,82 @@
+/*
+ * 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 io.element.android.libraries.matrix.test
+
+import io.element.android.libraries.matrix.MatrixClient
+import io.element.android.libraries.matrix.core.RoomId
+import io.element.android.libraries.matrix.core.SessionId
+import io.element.android.libraries.matrix.media.MediaResolver
+import io.element.android.libraries.matrix.room.MatrixRoom
+import io.element.android.libraries.matrix.room.RoomSummaryDataSource
+import io.element.android.libraries.matrix.test.media.FakeMediaResolver
+import io.element.android.libraries.matrix.test.room.FakeMatrixRoom
+import io.element.android.libraries.matrix.test.room.FakeRoomSummaryDataSource
+import kotlinx.coroutines.delay
+import org.matrix.rustcomponents.sdk.MediaSource
+
+class FakeMatrixClient(
+    override val sessionId: SessionId = A_SESSION_ID,
+    private val userDisplayName: Result<String> = Result.success(A_USER_NAME),
+    private val userAvatarURLString: Result<String> = Result.success(AN_AVATAR_URL),
+    val roomSummaryDataSource: RoomSummaryDataSource = FakeRoomSummaryDataSource()
+) : MatrixClient {
+
+    private var logoutFailure: Throwable? = null
+
+    override fun getRoom(roomId: RoomId): MatrixRoom? {
+        return FakeMatrixRoom(roomId)
+    }
+
+    override fun startSync() = Unit
+
+    override fun stopSync() = Unit
+
+    override fun roomSummaryDataSource(): RoomSummaryDataSource {
+        return roomSummaryDataSource
+    }
+
+    override fun mediaResolver(): MediaResolver {
+        return FakeMediaResolver()
+    }
+
+    fun givenLogoutError(failure: Throwable) {
+        logoutFailure = failure
+    }
+
+    override suspend fun logout() {
+        delay(100)
+        logoutFailure?.let { throw it }
+    }
+
+    override suspend fun loadUserDisplayName(): Result<String> {
+        return userDisplayName
+    }
+
+    override suspend fun loadUserAvatarURLString(): Result<String> {
+        return userAvatarURLString
+    }
+
+    override suspend fun loadMediaContentForSource(source: MediaSource): Result<ByteArray> {
+        return Result.success(ByteArray(0))
+    }
+
+    override suspend fun loadMediaThumbnailForSource(source: MediaSource, width: Long, height: Long): Result<ByteArray> {
+        return Result.success(ByteArray(0))
+    }
+
+    override fun close() = Unit
+}

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/TestData.kt

@@ -0,0 +1,45 @@
+/*
+ * 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 io.element.android.libraries.matrix.test
+
+import io.element.android.libraries.matrix.core.EventId
+import io.element.android.libraries.matrix.core.RoomId
+import io.element.android.libraries.matrix.core.SessionId
+import io.element.android.libraries.matrix.core.UserId
+
+const val A_USER_NAME = "alice"
+const val A_PASSWORD = "password"
+
+val A_USER_ID = UserId("@alice:server.org")
+val A_SESSION_ID = SessionId(A_USER_ID.value)
+val A_ROOM_ID = RoomId("!aRoomId")
+val AN_EVENT_ID = EventId("\$anEventId")
+
+const val A_ROOM_NAME = "A room name"
+const val A_MESSAGE = "Hello world!"
+const val A_REPLY = "OK, I'll be there!"
+const val ANOTHER_MESSAGE = "Hello universe!"
+
+const val A_HOMESERVER = "matrix.org"
+const val A_HOMESERVER_2 = "matrix-client.org"
+
+const val AN_AVATAR_URL = "mxc://data"
+
+const val A_FAILURE_REASON = "There has been a failure"
+val A_THROWABLE = Throwable(A_FAILURE_REASON)
+val AN_EXCEPTION = Exception(A_FAILURE_REASON)
+

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/auth/FakeAuthenticationService.kt

@@ -0,0 +1,69 @@
+/*
+ * 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 io.element.android.libraries.matrix.test.auth
+
+import io.element.android.libraries.matrix.MatrixClient
+import io.element.android.libraries.matrix.auth.MatrixAuthenticationService
+import io.element.android.libraries.matrix.core.UserId
+import io.element.android.libraries.matrix.test.A_HOMESERVER
+import io.element.android.libraries.matrix.test.A_USER_ID
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flowOf
+
+class FakeAuthenticationService : MatrixAuthenticationService {
+    private var homeserver: String = A_HOMESERVER
+    private var loginError: Throwable? = null
+
+    override fun isLoggedIn(): Flow<Boolean> {
+        return flowOf(false)
+    }
+
+    override suspend fun getLatestSessionId(): UserId? {
+        return null
+    }
+
+    override suspend fun restoreSession(userId: UserId): MatrixClient? {
+        return null
+    }
+
+    override fun getHomeserver(): String? {
+        return null
+    }
+
+    fun givenHomeserver(homeserver: String) {
+        this.homeserver = homeserver
+    }
+
+    override fun getHomeserverOrDefault(): String {
+        return homeserver
+    }
+
+    override suspend fun setHomeserver(homeserver: String) {
+        delay(100)
+    }
+
+    override suspend fun login(username: String, password: String): UserId {
+        delay(100)
+        loginError?.let { throw it }
+        return A_USER_ID
+    }
+
+    fun givenLoginError(throwable: Throwable?) {
+        loginError = throwable
+    }
+}

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/media/FakeMediaResolver.kt

@@ -0,0 +1,29 @@
+/*
+ * 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 io.element.android.libraries.matrix.test.media
+
+import io.element.android.libraries.matrix.media.MediaResolver
+
+class FakeMediaResolver : MediaResolver {
+    override suspend fun resolve(url: String?, kind: MediaResolver.Kind): ByteArray? {
+        return null
+    }
+
+    override suspend fun resolve(meta: MediaResolver.Meta): ByteArray? {
+        return null
+    }
+}

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/room/FakeMatrixRoom.kt

@@ -0,0 +1,90 @@
+/*
+ * 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 io.element.android.libraries.matrix.test.room
+
+import io.element.android.libraries.matrix.core.EventId
+import io.element.android.libraries.matrix.core.RoomId
+import io.element.android.libraries.matrix.room.MatrixRoom
+import io.element.android.libraries.matrix.test.A_ROOM_ID
+import io.element.android.libraries.matrix.test.timeline.FakeMatrixTimeline
+import io.element.android.libraries.matrix.timeline.MatrixTimeline
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.emptyFlow
+
+class FakeMatrixRoom(
+    override val roomId: RoomId = A_ROOM_ID,
+    override val name: String? = null,
+    override val bestName: String = "",
+    override val displayName: String = "",
+    override val topic: String? = null,
+    override val avatarUrl: String? = null,
+    private val matrixTimeline: MatrixTimeline = FakeMatrixTimeline(),
+) : MatrixRoom {
+
+    override fun syncUpdateFlow(): Flow<Long> {
+        return emptyFlow()
+    }
+
+    override fun timeline(): MatrixTimeline {
+        return matrixTimeline
+    }
+
+    override suspend fun fetchMembers(): Result<Unit> {
+        return Result.success(Unit)
+    }
+
+    override suspend fun userDisplayName(userId: String): Result<String?> {
+        return Result.success("")
+    }
+
+    override suspend fun userAvatarUrl(userId: String): Result<String?> {
+        TODO("Not yet implemented")
+    }
+
+    override suspend fun sendMessage(message: String): Result<Unit> {
+        delay(100)
+        return Result.success(Unit)
+    }
+
+    var editMessageParameter: String? = null
+        private set
+
+    override suspend fun editMessage(originalEventId: EventId, message: String): Result<Unit> {
+        editMessageParameter = message
+        delay(100)
+        return Result.success(Unit)
+    }
+
+    var replyMessageParameter: String? = null
+        private set
+
+    override suspend fun replyMessage(eventId: EventId, message: String): Result<Unit> {
+        replyMessageParameter = message
+        delay(100)
+        return Result.success(Unit)
+    }
+
+    var redactEventEventIdParam: EventId? = null
+        private set
+
+    override suspend fun redactEvent(eventId: EventId, reason: String?): Result<Unit> {
+        redactEventEventIdParam = eventId
+        delay(100)
+        return Result.success(Unit)
+    }
+}

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/room/FakeRoomSummaryDataSource.kt

@@ -0,0 +1,42 @@
+/*
+ * 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 io.element.android.libraries.matrix.test.room
+
+import io.element.android.libraries.matrix.room.RoomSummary
+import io.element.android.libraries.matrix.room.RoomSummaryDataSource
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+
+class FakeRoomSummaryDataSource : RoomSummaryDataSource {
+
+    private val roomSummariesFlow = MutableStateFlow<List<RoomSummary>>(emptyList())
+
+    suspend fun postRoomSummary(roomSummaries: List<RoomSummary>) {
+        roomSummariesFlow.emit(roomSummaries)
+    }
+
+    override fun roomSummaries(): StateFlow<List<RoomSummary>> {
+        return roomSummariesFlow
+    }
+
+    var latestSlidingSyncRange: IntRange? = null
+        private set
+
+    override fun setSlidingSyncRange(range: IntRange) {
+        latestSlidingSyncRange = range
+    }
+}

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/room/RoomSummaryFixture.kt

@@ -0,0 +1,62 @@
+/*
+ * 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 io.element.android.libraries.matrix.test.room
+
+import io.element.android.libraries.matrix.core.RoomId
+import io.element.android.libraries.matrix.room.RoomSummary
+import io.element.android.libraries.matrix.room.RoomSummaryDetails
+import io.element.android.libraries.matrix.test.A_MESSAGE
+import io.element.android.libraries.matrix.test.A_ROOM_ID
+import io.element.android.libraries.matrix.test.A_ROOM_NAME
+
+fun aRoomSummaryFilled(
+    roomId: RoomId = A_ROOM_ID,
+    name: String = A_ROOM_NAME,
+    isDirect: Boolean = false,
+    avatarURLString: String? = null,
+    lastMessage: CharSequence? = A_MESSAGE,
+    lastMessageTimestamp: Long? = null,
+    unreadNotificationCount: Int = 2,
+) = RoomSummary.Filled(
+    aRoomSummaryDetail(
+        roomId = roomId,
+        name = name,
+        isDirect = isDirect,
+        avatarURLString = avatarURLString,
+        lastMessage = lastMessage,
+        lastMessageTimestamp = lastMessageTimestamp,
+        unreadNotificationCount = unreadNotificationCount,
+    )
+)
+
+fun aRoomSummaryDetail(
+    roomId: RoomId = A_ROOM_ID,
+    name: String = A_ROOM_NAME,
+    isDirect: Boolean = false,
+    avatarURLString: String? = null,
+    lastMessage: CharSequence? = A_MESSAGE,
+    lastMessageTimestamp: Long? = null,
+    unreadNotificationCount: Int = 2,
+) = RoomSummaryDetails(
+    roomId = roomId,
+    name = name,
+    isDirect = isDirect,
+    avatarURLString = avatarURLString,
+    lastMessage = lastMessage,
+    lastMessageTimestamp = lastMessageTimestamp,
+    unreadNotificationCount = unreadNotificationCount,
+)

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/timeline/FakeMatrixTimeline.kt

@@ -0,0 +1,85 @@
+/*
+ * 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 io.element.android.libraries.matrix.test.timeline
+
+import io.element.android.libraries.matrix.core.EventId
+import io.element.android.libraries.matrix.timeline.MatrixTimeline
+import io.element.android.libraries.matrix.timeline.MatrixTimelineItem
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+
+class FakeMatrixTimeline(
+    initialTimelineItems: List<MatrixTimelineItem> = emptyList(),
+    initialPaginationState: MatrixTimeline.PaginationState = MatrixTimeline.PaginationState(canBackPaginate = true, isBackPaginating = false)
+) : MatrixTimeline {
+
+    private val paginationState: MutableStateFlow<MatrixTimeline.PaginationState> = MutableStateFlow(initialPaginationState)
+    private val timelineItems: MutableStateFlow<List<MatrixTimelineItem>> = MutableStateFlow(initialTimelineItems)
+    var isInitialized = false
+
+    fun updatePaginationState(update: (MatrixTimeline.PaginationState.() -> MatrixTimeline.PaginationState)) {
+        paginationState.value = update(paginationState.value)
+    }
+
+    fun updateTimelineItems(update: (items: List<MatrixTimelineItem>) -> List<MatrixTimelineItem>) {
+        timelineItems.value = update(timelineItems.value)
+    }
+
+    override fun paginationState(): StateFlow<MatrixTimeline.PaginationState> {
+        return paginationState
+    }
+
+    override fun timelineItems(): Flow<List<MatrixTimelineItem>> {
+        return timelineItems
+    }
+
+    override suspend fun paginateBackwards(requestSize: Int, untilNumberOfItems: Int): Result<Unit> {
+        updatePaginationState {
+            copy(isBackPaginating = true)
+        }
+        delay(100)
+        updatePaginationState {
+            copy(isBackPaginating = false)
+        }
+        updateTimelineItems { timelineItems ->
+            timelineItems
+        }
+        return Result.success(Unit)
+    }
+
+    override fun initialize() {
+        isInitialized = true
+    }
+
+    override fun dispose() {
+        isInitialized = false
+    }
+
+    override suspend fun sendMessage(message: String): Result<Unit> {
+        return Result.success(Unit)
+    }
+
+    override suspend fun editMessage(originalEventId: EventId, message: String): Result<Unit> {
+        return Result.success(Unit)
+    }
+
+    override suspend fun replyMessage(inReplyToEventId: EventId, message: String): Result<Unit> {
+        return Result.success(Unit)
+    }
+}