Sulkta-OSS/element-x-ada
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add isInDebug variable to simulate debug/release configs for tests (#2566)

Browse source 
* `isInDebug` as `ThreadLocal<Boolean>`

* Use a simple var for `isInDebug` and add a helper method to test release mode, when running the debug test.

* Add some more docs

---------

Co-authored-by: Benoit Marty <benoit@matrix.org>
This commit is contained in:
Jorge Martin Espinosa 2024-03-18 17:56:07 +01:00 • committed by GitHub
parent fb64018110
commit 5cc5a0b699
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 60 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

4
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/EventId.kt
View file

@ -16,13 +16,13 @@
package io.element.android.libraries.matrix.api.core
import io.element.android.libraries.matrix.api.BuildConfig
import io.element.android.libraries.androidutils.metadata.isInDebug
import java.io.Serializable
@JvmInline
value class EventId(val value: String) : Serializable {
init {
if (BuildConfig.DEBUG && !MatrixPatterns.isEventId(value)) {
if (isInDebug && !MatrixPatterns.isEventId(value)) {
error("`$value` is not a valid event id.\nExample event id: `\$Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg`.")
}
}

4
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/MatrixPatterns.kt
View file

@ -16,7 +16,7 @@
package io.element.android.libraries.matrix.api.core
import io.element.android.libraries.matrix.api.BuildConfig
import io.element.android.libraries.androidutils.metadata.isInDebug
import timber.log.Timber
/**
@ -217,7 +217,7 @@ object MatrixPatterns {
* - "@bob:domain.org:3455".getDomain() will return "domain.org:3455"
*/
fun String.getServerName(): String {
if (BuildConfig.DEBUG && !isUserId(this)) {
if (isInDebug && !isUserId(this)) {
// They are some invalid userId localpart in the wild, but the domain part should be there anyway
Timber.w("Not a valid user ID: $this")
}

4
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/RoomId.kt
View file

@ -16,13 +16,13 @@
package io.element.android.libraries.matrix.api.core
import io.element.android.libraries.matrix.api.BuildConfig
import io.element.android.libraries.androidutils.metadata.isInDebug
import java.io.Serializable
@JvmInline
value class RoomId(val value: String) : Serializable {
init {
if (BuildConfig.DEBUG && !MatrixPatterns.isRoomId(value)) {
if (isInDebug && !MatrixPatterns.isRoomId(value)) {
error("`$value` is not a valid room id.\n Example room id: `!room_id:domain`.")
}
}

4
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/SpaceId.kt
View file

@ -16,13 +16,13 @@
package io.element.android.libraries.matrix.api.core
import io.element.android.libraries.matrix.api.BuildConfig
import io.element.android.libraries.androidutils.metadata.isInDebug
import java.io.Serializable
@JvmInline
value class SpaceId(val value: String) : Serializable {
init {
if (BuildConfig.DEBUG && !MatrixPatterns.isSpaceId(value)) {
if (isInDebug && !MatrixPatterns.isSpaceId(value)) {
error(
"`$value` is not a valid space id.\n" +
"Space ids are the same as room ids.\n" +

4
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/ThreadId.kt
View file

@ -16,13 +16,13 @@
package io.element.android.libraries.matrix.api.core
import io.element.android.libraries.matrix.api.BuildConfig
import io.element.android.libraries.androidutils.metadata.isInDebug
import java.io.Serializable
@JvmInline
value class ThreadId(val value: String) : Serializable {
init {
if (BuildConfig.DEBUG && !MatrixPatterns.isThreadId(value)) {
if (isInDebug && !MatrixPatterns.isThreadId(value)) {
error(
"`$value` is not a valid thread id.\n" +
"Thread ids are the same as event ids.\n" +

4
libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/UserId.kt
View file

@ -16,7 +16,7 @@
package io.element.android.libraries.matrix.api.core
import io.element.android.libraries.matrix.api.BuildConfig
import io.element.android.libraries.androidutils.metadata.isInDebug
import java.io.Serializable
/**
@ -27,7 +27,7 @@ import java.io.Serializable
@JvmInline
value class UserId(val value: String) : Serializable {
init {
if (BuildConfig.DEBUG && !MatrixPatterns.isUserId(value)) {
if (isInDebug && !MatrixPatterns.isUserId(value)) {
error("`$value` is not a valid user id.\nExample user id: `@name:domain`.")
}
}

6
libraries/matrix/api/src/test/kotlin/io/element/android/libraries/matrix/api/permalink/PermalinkBuilderTest.kt
View file

@ -17,10 +17,10 @@
package io.element.android.libraries.matrix.api.permalink
import com.google.common.truth.Truth.assertThat
import io.element.android.libraries.androidutils.metadata.withReleaseBehavior
import io.element.android.libraries.matrix.api.core.RoomId
import io.element.android.libraries.matrix.api.core.UserId
import io.element.android.tests.testutils.assertThrowsInDebug
import io.element.android.tests.testutils.isInDebug
import org.junit.Test
class PermalinkBuilderTest {
@ -40,7 +40,7 @@ class PermalinkBuilderTest {
@Test
fun `building a permalink for an invalid user id returns failure when not verifying the id`() {
if (!isInDebug()) {
withReleaseBehavior {
val userId = UserId("some invalid user id")
assertThat(PermalinkBuilder.permalinkForUser(userId).isFailure).isTrue()
}
@ -48,7 +48,7 @@ class PermalinkBuilderTest {
@Test
fun `building a permalink for an invalid room id returns failure when not verifying the id`() {
if (!isInDebug()) {
withReleaseBehavior {
val roomId = RoomId("some invalid room id")
assertThat(PermalinkBuilder.permalinkForRoomId(roomId).isFailure).isTrue()
}