388 lines
13 KiB
Kotlin
388 lines
13 KiB
Kotlin
/*
|
|
* Copyright (c) 2020 Proton Technologies AG
|
|
* This file is part of Proton Technologies AG and ProtonCore.
|
|
*
|
|
* ProtonCore is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* ProtonCore is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with ProtonCore. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
package me.proton.core.network.data
|
|
|
|
import android.os.Build
|
|
import io.mockk.MockKAnnotations
|
|
import io.mockk.coEvery
|
|
import io.mockk.every
|
|
import io.mockk.mockk
|
|
import io.mockk.spyk
|
|
import kotlinx.coroutines.CoroutineScope
|
|
import kotlinx.coroutines.runBlocking
|
|
import kotlinx.coroutines.test.TestCoroutineDispatcher
|
|
import me.proton.core.network.data.interceptor.TooManyRequestInterceptor
|
|
import me.proton.core.network.data.util.MockApiClient
|
|
import me.proton.core.network.data.util.MockClientId
|
|
import me.proton.core.network.data.util.MockLogger
|
|
import me.proton.core.network.data.util.MockNetworkPrefs
|
|
import me.proton.core.network.data.util.MockSession
|
|
import me.proton.core.network.data.util.MockSessionListener
|
|
import me.proton.core.network.data.util.TestRetrofitApi
|
|
import me.proton.core.network.data.util.TestTLSHelper
|
|
import me.proton.core.network.data.util.prepareResponse
|
|
import me.proton.core.network.domain.ApiManager
|
|
import me.proton.core.network.domain.ApiResult
|
|
import me.proton.core.network.domain.NetworkManager
|
|
import me.proton.core.network.domain.NetworkPrefs
|
|
import me.proton.core.network.domain.humanverification.HumanVerificationDetails
|
|
import me.proton.core.network.domain.client.ClientId
|
|
import me.proton.core.network.domain.client.ClientIdProvider
|
|
import me.proton.core.network.domain.client.ExtraHeaderProvider
|
|
import me.proton.core.network.domain.humanverification.HumanVerificationListener
|
|
import me.proton.core.network.domain.humanverification.HumanVerificationProvider
|
|
import me.proton.core.network.domain.humanverification.HumanVerificationState
|
|
import me.proton.core.network.domain.server.ServerTimeListener
|
|
import me.proton.core.network.domain.session.Session
|
|
import me.proton.core.network.domain.session.SessionListener
|
|
import me.proton.core.network.domain.session.SessionProvider
|
|
import okhttp3.OkHttpClient
|
|
import okhttp3.mockwebserver.MockResponse
|
|
import okhttp3.mockwebserver.MockWebServer
|
|
import org.junit.Assert
|
|
import org.junit.runner.RunWith
|
|
import org.robolectric.RobolectricTestRunner
|
|
import org.robolectric.annotation.Config
|
|
import retrofit2.converter.scalars.ScalarsConverterFactory
|
|
import java.net.HttpURLConnection
|
|
import kotlin.test.AfterTest
|
|
import kotlin.test.BeforeTest
|
|
import kotlin.test.Test
|
|
import kotlin.test.assertEquals
|
|
import kotlin.test.assertTrue
|
|
|
|
// Can't use runBlockingTest with MockWebServer. See:
|
|
// https://github.com/square/retrofit/issues/3330
|
|
// https://github.com/Kotlin/kotlinx.coroutines/issues/1204
|
|
@Config(sdk = [Build.VERSION_CODES.M])
|
|
@RunWith(RobolectricTestRunner::class)
|
|
internal class ProtonApiBackendTests {
|
|
|
|
private fun javaWallClockMs(): Long = System.currentTimeMillis()
|
|
|
|
val scope = CoroutineScope(TestCoroutineDispatcher())
|
|
|
|
private val testTlsHelper = TestTLSHelper()
|
|
private lateinit var apiManagerFactory: ApiManagerFactory
|
|
private lateinit var webServer: MockWebServer
|
|
|
|
private lateinit var backend: ProtonApiBackend<TestRetrofitApi>
|
|
|
|
private lateinit var session: Session
|
|
private lateinit var clientId: ClientId
|
|
private var extraHeaderProvider = mockk<ExtraHeaderProvider>()
|
|
private var clientIdProvider = mockk<ClientIdProvider>()
|
|
private var serverTimeListener = mockk<ServerTimeListener>()
|
|
|
|
private val sessionProvider = mockk<SessionProvider>()
|
|
private val humanVerificationProvider = mockk<HumanVerificationProvider>()
|
|
private val humanVerificationListener = mockk<HumanVerificationListener>()
|
|
|
|
private var sessionListener: SessionListener = MockSessionListener(
|
|
onTokenRefreshed = { session -> this.session = session }
|
|
)
|
|
private val cookieStore = mockk<ProtonCookieStore>()
|
|
|
|
private lateinit var client: MockApiClient
|
|
|
|
private var isNetworkAvailable = true
|
|
|
|
private val networkManager = mockk<NetworkManager>()
|
|
|
|
private lateinit var prefs: NetworkPrefs
|
|
|
|
@BeforeTest
|
|
fun before() {
|
|
MockKAnnotations.init(this)
|
|
client = MockApiClient()
|
|
prefs = MockNetworkPrefs()
|
|
|
|
session = MockSession.getDefault()
|
|
clientId = MockClientId.getForSession(session.sessionId)
|
|
every { clientIdProvider.getClientId(any()) } returns clientId
|
|
coEvery { sessionProvider.getSessionId(any()) } returns session.sessionId
|
|
coEvery { sessionProvider.getSession(any()) } returns session
|
|
every { cookieStore.get(any()) } returns emptyList()
|
|
every { extraHeaderProvider.headers }.answers { emptyList() }
|
|
|
|
apiManagerFactory = ApiManagerFactory(
|
|
"https://example.com/",
|
|
client,
|
|
clientIdProvider,
|
|
serverTimeListener,
|
|
networkManager,
|
|
prefs,
|
|
sessionProvider,
|
|
sessionListener,
|
|
humanVerificationProvider,
|
|
humanVerificationListener,
|
|
cookieStore,
|
|
scope,
|
|
cache = { null },
|
|
apiConnectionListener = null
|
|
)
|
|
|
|
every { networkManager.isConnectedToNetwork() } returns isNetworkAvailable
|
|
isNetworkAvailable = true
|
|
|
|
webServer = testTlsHelper.createMockServer()
|
|
|
|
backend = createBackend {
|
|
testTlsHelper.initPinning(it, TestTLSHelper.TEST_PINS)
|
|
}
|
|
|
|
val humanVerificationDetails = spyk(
|
|
HumanVerificationDetails(
|
|
clientId = clientId,
|
|
verificationMethods = mockk(),
|
|
captchaVerificationToken = null,
|
|
state = HumanVerificationState.HumanVerificationSuccess,
|
|
tokenType = "captcha",
|
|
tokenCode = "captcha token"
|
|
)
|
|
)
|
|
|
|
coEvery { humanVerificationProvider.getHumanVerificationDetails(clientId) } returns humanVerificationDetails
|
|
}
|
|
|
|
private fun createBackend(pinningInit: (OkHttpClient.Builder) -> Unit) =
|
|
ProtonApiBackend(
|
|
webServer.url("/").toString(),
|
|
client,
|
|
clientIdProvider,
|
|
serverTimeListener,
|
|
session.sessionId,
|
|
sessionProvider,
|
|
humanVerificationProvider,
|
|
{ apiManagerFactory.baseOkHttpClient },
|
|
listOf(
|
|
ScalarsConverterFactory.create(),
|
|
apiManagerFactory.jsonConverter
|
|
),
|
|
TestRetrofitApi::class,
|
|
networkManager,
|
|
pinningInit,
|
|
::javaWallClockMs,
|
|
extraHeaderProvider,
|
|
)
|
|
|
|
@AfterTest
|
|
fun after() {
|
|
webServer.shutdown()
|
|
}
|
|
|
|
@Test
|
|
fun `test ok call`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo" }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Success)
|
|
|
|
val data = result.valueOrNull
|
|
assertEquals(5, data.number)
|
|
assertEquals("foo", data.string)
|
|
}
|
|
|
|
@Test
|
|
fun `test http error`() = runBlocking {
|
|
webServer.prepareResponse(404)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Error.Http)
|
|
assertEquals(404, result.httpCode)
|
|
}
|
|
|
|
@Test
|
|
fun `test too many requests`() = runBlocking {
|
|
val response = MockResponse()
|
|
.setResponseCode(429)
|
|
.setHeader("Retry-After", "5")
|
|
webServer.enqueue(response)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Error.TooManyRequest)
|
|
assertEquals(429, result.httpCode)
|
|
assertEquals(5, result.retryAfterSeconds)
|
|
|
|
TooManyRequestInterceptor.reset()
|
|
}
|
|
|
|
@Test
|
|
fun `test proton error`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
401,
|
|
"""{ "Code": 10, "Error": "darn!" }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Error.Http)
|
|
|
|
assertEquals(10, result.proton?.code)
|
|
assertEquals(401, result.httpCode)
|
|
assertEquals("darn!", result.proton?.error)
|
|
}
|
|
|
|
@Test
|
|
fun `test Accept header override`() = runBlocking {
|
|
webServer.prepareResponse(HttpURLConnection.HTTP_OK, "plain")
|
|
|
|
val result = backend(ApiManager.Call(0) { testPlain() })
|
|
assertEquals("text/plain", webServer.takeRequest().headers["Accept"])
|
|
assertTrue(result is ApiResult.Success)
|
|
|
|
assertEquals("plain", result.value)
|
|
}
|
|
|
|
@Test
|
|
fun `test extra field ignored`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo", "Extra": "bar" }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Success)
|
|
|
|
val data = result.valueOrNull
|
|
assertEquals(5, data.number)
|
|
assertEquals("foo", data.string)
|
|
}
|
|
|
|
@Test
|
|
fun `test missing field`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "NumberTypo": 5, "String": "foo" }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Error.Parse)
|
|
}
|
|
|
|
@Test
|
|
fun `test default val`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo" }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertEquals(true, result.valueOrNull?.bool)
|
|
}
|
|
|
|
@Test
|
|
fun `can deserialize false from 0`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo", Bool: 0 }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertEquals(false, result.valueOrNull?.bool)
|
|
}
|
|
|
|
@Test
|
|
fun `can deserialize true from 1`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo", Bool: 1 }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertEquals(true, result.valueOrNull?.bool)
|
|
}
|
|
|
|
@Test
|
|
fun `can deserialize true from 5`() = runBlocking {
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo", Bool: 5 }"""
|
|
)
|
|
|
|
val result = backend(ApiManager.Call(0) { test() })
|
|
assertEquals(true, result.valueOrNull?.bool)
|
|
}
|
|
|
|
@Test
|
|
fun `test pinning error`() = runBlocking {
|
|
val badBackend = createBackend {
|
|
testTlsHelper.initPinning(it, TestTLSHelper.BAD_PINS)
|
|
}
|
|
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo" }"""
|
|
)
|
|
|
|
val result = badBackend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Error.Certificate)
|
|
}
|
|
|
|
@Test
|
|
fun `test spki leaf pinning ok`() = runBlocking {
|
|
val altBackend = createBackend { builder ->
|
|
testTlsHelper.setupSPKIleafPinning(
|
|
builder,
|
|
TestTLSHelper.TEST_PINS.toList().map {
|
|
it.removePrefix("sha256/")
|
|
}
|
|
)
|
|
}
|
|
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo" }"""
|
|
)
|
|
|
|
val result = altBackend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Success)
|
|
}
|
|
|
|
@Test
|
|
fun `test spki leaf pinning error`() = runBlocking {
|
|
val badAltBackend = createBackend { builder ->
|
|
testTlsHelper.setupSPKIleafPinning(builder, TestTLSHelper.BAD_PINS.toList().map {
|
|
it.removePrefix("sha256/")
|
|
})
|
|
}
|
|
|
|
webServer.prepareResponse(
|
|
HttpURLConnection.HTTP_OK,
|
|
"""{ "Number": 5, "String": "foo" }"""
|
|
)
|
|
|
|
val result = badAltBackend(ApiManager.Call(0) { test() })
|
|
assertTrue(result is ApiResult.Error.Certificate)
|
|
}
|
|
|
|
@Test
|
|
fun `Headers in extraHeaderProvider are included in requests`() = runBlocking {
|
|
val extraHeader = "my-header" to "some value"
|
|
every { extraHeaderProvider.headers }.answers { listOf(extraHeader) }
|
|
|
|
backend(ApiManager.Call(0) { test() })
|
|
|
|
val request = webServer.takeRequest()
|
|
val headerFound = request.headers.any { it == extraHeader }
|
|
Assert.assertTrue(headerFound)
|
|
}
|
|
}
|