Проблемы с Kotlin Result<T> в модульных тестах

У меня была такая же проблема.

Я заметил, что мой метод внедренного класса, который должен возвращать Result<List<Any>>, на самом деле возвращает Result<Result<List<Any>>>, что вызывает ClassCastException. Я использовал опцию Evaluate Expression для результата метода, и я получил

Success(Success([]))

Приложение работает хорошо, но модульные тесты не прошли из-за этой проблемы.

В качестве временного решения я создал новую простую реализацию Result запечатанного класса с fold() функцией расширения. В будущем должно быть легко заменить на kotlin.Result

Result закрытый класс:

sealed class Result<T> {
    data class Success<T>(val value: T) : Result<T>()
    data class Failure<T>(val error: Throwable) : Result<T>()
}

fold() функция расширения:

inline fun <R, T> Result<T>.fold(
    onSuccess: (value: T) -> R,
    onFailure: (exception: Throwable) -> R
): R = when (this) {
    is Result.Success -> onSuccess(value)
    is Result.Failure -> onFailure(error)
}

Я нашел другой обходной путь для этой проблемы с переносом результатов для тех, кто не хочет создавать свой собственный тип Result.

Эта проблема возникает именно при использовании функций Mockito .thenReturn on suspend. Я обнаружил, что использование .thenAnswer не вызывает проблем.

Поэтому вместо того, чтобы писать это в своем модульном тесте (изменено doReturn на thenReturn здесь):

whenever(fireStoreClient.items()).thenReturn(success(MOCK_ITEMS_DOCUMENT))

Использовать:

whenever(fireStoreClient.items()).thenAnswer { success(MOCK_ITEMS_DOCUMENT) }

Обновлено: я должен отметить, что я все еще сталкивался с этой проблемой при запуске Kotlin 1.5.0.

Обновлено: в Kotlin 1.5.20 я снова могу использовать .thenReturn.

После глубокого изучения проблемы я, наконец, нашел временное решение, которое работает в тестовой среде. Проблема в том, что каким-то образом значение объекта Result обернуто другим Result, и мы можем получить желаемое значение или исключение, используя отражение.

Итак, я создал функцию расширения под названием mockSafeFold, которая реализует поведение fold в обычных вызовах и отлично работает при выполнении модульных тестов.

inline fun <R, reified T> Result<T>.mockSafeFold(
    onSuccess: (value: T) -> R,
    onFailure: (exception: Throwable) -> R
): R = when {
    isSuccess -> {
        val value = getOrNull()
        try {
            onSuccess(value as T)
        } catch (e: ClassCastException) {
            // This block of code is only executed in testing environment, when we are mocking a
            // function that returns a `Result` object.
            val valueNotNull = value!!
            if ((value as Result<*>).isSuccess) {
                valueNotNull::class.java.getDeclaredField("value").let {
                    it.isAccessible = true
                    it.get(value) as T
                }.let(onSuccess)
            } else {
                valueNotNull::class.java.getDeclaredField("value").let {
                    it.isAccessible = true
                    it.get(value)
                }.let { failure ->
                    failure!!::class.java.getDeclaredField("exception").let {
                        it.isAccessible = true
                        it.get(failure) as Exception
                    }
                }.let(onFailure)
            }
        }
    }
    else -> onFailure(exceptionOrNull() ?: Exception())
}

Затем просто назовите его вместо fold:

val result: Result = myUseCase(param)

result.mockSafeFold(
    onSuccess = { /* do whatever */ },
    onFailure = { /* do whatever */ }
)