Matrix/element-android-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-android.git synced 2024-11-16 02:05:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adding unit tests for the set client info use case

Browse Source
This commit is contained in:
Maxime NATUREL 2022-09-30 17:41:01 +02:00
parent ccc3ac628a
commit 7d00908f11
5 changed files with 134 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
vector/src/main/java/im/vector/app/features/settings/devices/v2/details/extended/SetMatrixClientInfoUseCase.kt
View File

@ -28,15 +28,16 @@ class SetMatrixClientInfoUseCase @Inject constructor(
private val activeSessionHolder: ActiveSessionHolder,
) {
// TODO add unit tests
suspend fun execute(clientInfo: MatrixClientInfoContent): Result<Unit> = runCatching {
activeSessionHolder.getSafeActiveSession()
?.let { session ->
val deviceId = session.sessionParams.deviceId
if (deviceId != null) {
val deviceId = session.sessionParams.deviceId.orEmpty()
if (deviceId.isNotEmpty()) {
val type = MATRIX_CLIENT_INFO_KEY_PREFIX + deviceId
session.accountDataService()
.updateUserAccountData(type, clientInfo.toContent())
} else {
throw IllegalStateException("device id is empty")
}
}
}

6
vector/src/main/java/im/vector/app/features/settings/devices/v2/details/extended/UpdateMatrixClientInfoUseCase.kt
View File

@ -39,8 +39,10 @@ class UpdateMatrixClientInfoUseCase @Inject constructor(
name = appNameProvider.getAppName(),
version = buildMeta.versionName
)
val sessionId = activeSessionHolder.getActiveSession().sessionParams.deviceId
val storedClientInfo = sessionId?.let { getMatrixClientInfoUseCase.execute(it) }
val deviceId = activeSessionHolder.getActiveSession().sessionParams.deviceId.orEmpty()
val storedClientInfo = deviceId
.takeUnless { it.isEmpty() }
?.let { getMatrixClientInfoUseCase.execute(it) }
if (clientInfo != storedClientInfo) {
setMatrixClientInfoUseCase.execute(clientInfo)
}

109
vector/src/test/java/im/vector/app/features/settings/devices/v2/details/extended/SetMatrixClientInfoUseCaseTest.kt Normal file
View File

@ -0,0 +1,109 @@
/*
* Copyright (c) 2022 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.settings.devices.v2.details.extended
import MATRIX_CLIENT_INFO_KEY_PREFIX
import im.vector.app.test.fakes.FakeActiveSessionHolder
import kotlinx.coroutines.test.runTest
import org.amshove.kluent.shouldBe
import org.amshove.kluent.shouldBeEqualTo
import org.amshove.kluent.shouldBeInstanceOf
import org.junit.Test
import org.matrix.android.sdk.api.session.events.model.toContent
private const val A_DEVICE_ID = "device-id"
class SetMatrixClientInfoUseCaseTest {
private val fakeActiveSessionHolder = FakeActiveSessionHolder()
private val setMatrixClientInfoUseCase = SetMatrixClientInfoUseCase(
activeSessionHolder = fakeActiveSessionHolder.instance
)
@Test
fun `given client info and no error when setting the info then account data is correctly updated`() = runTest {
// Given
val type = MATRIX_CLIENT_INFO_KEY_PREFIX + A_DEVICE_ID
val clientInfo = givenClientInfo()
val content = clientInfo.toContent()
fakeActiveSessionHolder.fakeSession
.givenSessionId(A_DEVICE_ID)
fakeActiveSessionHolder.fakeSession
.fakeSessionAccountDataService
.givenUpdateUserAccountDataEventSucceeds()
// When
val result = setMatrixClientInfoUseCase.execute(clientInfo)
// Then
result.isSuccess shouldBe true
fakeActiveSessionHolder.fakeSession
.fakeSessionAccountDataService
.verifyUpdateUserAccountDataEventSucceeds(type, content)
}
@Test
fun `given client info and error during update when setting the info then result is failure`() = runTest {
// Given
val type = MATRIX_CLIENT_INFO_KEY_PREFIX + A_DEVICE_ID
val clientInfo = givenClientInfo()
val content = clientInfo.toContent()
fakeActiveSessionHolder.fakeSession
.givenSessionId(A_DEVICE_ID)
val error = Exception()
fakeActiveSessionHolder.fakeSession
.fakeSessionAccountDataService
.givenUpdateUserAccountDataEventFailsWithError(error)
// When
val result = setMatrixClientInfoUseCase.execute(clientInfo)
// Then
result.isFailure shouldBe true
result.exceptionOrNull() shouldBeEqualTo error
fakeActiveSessionHolder.fakeSession
.fakeSessionAccountDataService
.verifyUpdateUserAccountDataEventSucceeds(type, content)
}
@Test
fun `given client info and null device id when setting the info then result is failure`() = runTest {
// Given
val type = MATRIX_CLIENT_INFO_KEY_PREFIX + A_DEVICE_ID
val clientInfo = givenClientInfo()
val content = clientInfo.toContent()
fakeActiveSessionHolder.fakeSession
.givenSessionId(null)
// When
val result = setMatrixClientInfoUseCase.execute(clientInfo)
// Then
result.isFailure shouldBe true
result.exceptionOrNull() shouldBeInstanceOf IllegalStateException::class
fakeActiveSessionHolder.fakeSession
.fakeSessionAccountDataService
.verifyUpdateUserAccountDataEventSucceeds(type, content, inverse = true)
}
private fun givenClientInfo() = MatrixClientInfoContent(
name = "name",
version = "version",
url = null,
)
}

2
vector/src/test/java/im/vector/app/test/fakes/FakeSession.kt
View File

@ -82,7 +82,7 @@ class FakeSession(
every { this@FakeSession.sessionParams } returns sessionParams
}
fun givenSessionId(sessionId: String): SessionParams {
fun givenSessionId(sessionId: String?): SessionParams {
val sessionParams = mockk<SessionParams>()
every { sessionParams.deviceId } returns sessionId
givenSessionParams(sessionParams)

16
vector/src/test/java/im/vector/app/test/fakes/FakeSessionAccountDataService.kt
View File

@ -16,8 +16,12 @@
package im.vector.app.test.fakes
import io.mockk.coEvery
import io.mockk.coVerify
import io.mockk.every
import io.mockk.just
import io.mockk.mockk
import io.mockk.runs
import org.matrix.android.sdk.api.session.accountdata.SessionAccountDataService
import org.matrix.android.sdk.api.session.accountdata.UserAccountDataEvent
import org.matrix.android.sdk.api.session.events.model.Content
@ -27,4 +31,16 @@ class FakeSessionAccountDataService : SessionAccountDataService by mockk() {
fun givenGetUserAccountDataEventReturns(type: String, content: Content) {
every { getUserAccountDataEvent(type) } returns UserAccountDataEvent(type, content)
}
fun givenUpdateUserAccountDataEventSucceeds() {
coEvery { updateUserAccountData(any(), any()) } just runs
}
fun givenUpdateUserAccountDataEventFailsWithError(error: Exception) {
coEvery { updateUserAccountData(any(), any()) } throws error
}
fun verifyUpdateUserAccountDataEventSucceeds(type: String, content: Content, inverse: Boolean = false) {
coVerify(inverse = inverse) { updateUserAccountData(type, content) }
}
}