(Part 1) stream-chat-android-client unit tests - api package

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/interceptor/HeadersInterceptor.kt

@@ -20,6 +20,12 @@ import io.getstream.chat.android.client.utils.HeadersUtil
 import okhttp3.Interceptor
 import okhttp3.Response
 
+/**
+ * Interceptor that adds the default headers to the request.
+ *
+ * @param isAnonymous a function that returns true if the logged in user is anonymous.
+ * @param headersUtil a utility class for building headers.
+ */
 internal class HeadersInterceptor(
     private val isAnonymous: () -> Boolean,
     private val headersUtil: HeadersUtil,

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api/ErrorCallTest.kt

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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.getstream.chat.android.client.api
+
+import io.getstream.chat.android.test.TestCoroutineRule
+import io.getstream.result.Error
+import io.getstream.result.Result
+import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.runTest
+import org.amshove.kluent.`should be instance of`
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.Rule
+import org.junit.Test
+
+internal class ErrorCallTest {
+
+    @get:Rule
+    val coroutinesTestRule = TestCoroutineRule()
+
+    @Test
+    fun testErrorCallExecute() {
+        // given
+        val error = Error.GenericError("Generic error")
+        val errorCall = ErrorCall<Unit>(TestScope(), error)
+        // when
+        val result = errorCall.execute()
+        // then
+        result `should be instance of` Result.Failure::class
+        result as Result.Failure
+        result.value shouldBeEqualTo error
+    }
+
+    @Test
+    fun testErrorCallEnqueue() = runTest {
+        // given
+        val error = Error.GenericError("Generic error")
+        val errorCall = ErrorCall<Unit>(backgroundScope, error)
+        // when
+        errorCall.enqueue { result ->
+            // then
+            result `should be instance of` Result.Failure::class
+            result as Result.Failure
+            result.value shouldBeEqualTo error
+        }
+    }
+
+    @Test
+    fun testErrorCallAwait() = runTest {
+        // given
+        val error = Error.GenericError("Generic error")
+        val errorCall = ErrorCall<Unit>(TestScope(), error)
+        // when
+        val result = errorCall.await()
+        // then
+        result `should be instance of` Result.Failure::class
+        result as Result.Failure
+        result.value shouldBeEqualTo error
+    }
+}

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api/FakeChain.kt

@@ -24,7 +24,12 @@ import okhttp3.Request
 import okhttp3.Response
 import java.util.concurrent.TimeUnit
 
-internal class FakeChain(vararg val response: FakeResponse) : Interceptor.Chain {
+internal class FakeChain(
+    vararg val response: FakeResponse,
+    val request: Request = Request.Builder()
+        .url("https://hello.url")
+        .build(),
+) : Interceptor.Chain {
 
     var chainIndex = 0
 
@@ -61,9 +66,7 @@ internal class FakeChain(vararg val response: FakeResponse) : Interceptor.Chain
     }
 
     override fun request(): Request {
-        return Request.Builder()
-            .url("https://hello.url")
-            .build()
+        return request
     }
 
     override fun withConnectTimeout(timeout: Int, unit: TimeUnit): Interceptor.Chain {

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api/interceptor/ApiKeyInterceptorTest.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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.getstream.chat.android.client.api.interceptor
+
+import io.getstream.chat.android.client.api.FakeChain
+import io.getstream.chat.android.client.api.FakeResponse
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.Test
+
+internal class ApiKeyInterceptorTest {
+
+    @Test
+    fun testApiKeyIsAddedAsHeader() {
+        // given
+        val apiKey = "apiKeyValue"
+        val interceptor = ApiKeyInterceptor(apiKey)
+        // when
+        val response = interceptor.intercept(FakeChain(FakeResponse(200)))
+        // then
+        val apiKeyQueryParam = response.request.url.queryParameter("api_key")
+        apiKeyQueryParam shouldBeEqualTo apiKey
+    }
+}

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api/interceptor/ApiRequestAnalyserInterceptorTest.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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.getstream.chat.android.client.api.interceptor
+
+import io.getstream.chat.android.client.api.FakeChain
+import io.getstream.chat.android.client.api.FakeResponse
+import io.getstream.chat.android.client.plugins.requests.ApiRequestsAnalyser
+import org.junit.Test
+import org.mockito.kotlin.any
+import org.mockito.kotlin.doNothing
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.times
+import org.mockito.kotlin.verify
+import org.mockito.kotlin.whenever
+
+internal class ApiRequestAnalyserInterceptorTest {
+
+    @Test
+    fun testApiRequestAnalyserInterceptorRegistersTheRequestInTheAnalyser() {
+        // given
+        val analyser = mock<ApiRequestsAnalyser>()
+        doNothing().whenever(analyser).registerRequest(any(), any())
+        val interceptor = ApiRequestAnalyserInterceptor(analyser)
+        // when
+        val chain = FakeChain(FakeResponse(200))
+        interceptor.intercept(chain)
+        // then
+        verify(analyser, times(1)).registerRequest(
+            requestName = chain.request().url.toString(),
+            data = mapOf("body" to "no_body"),
+        )
+    }
+}

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api/interceptor/HeadersInterceptorTest.kt

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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.getstream.chat.android.client.api.interceptor
+
+import io.getstream.chat.android.client.api.FakeChain
+import io.getstream.chat.android.client.api.FakeResponse
+import io.getstream.chat.android.client.utils.HeadersUtil
+import org.amshove.kluent.`should be equal to`
+import org.junit.Test
+import org.mockito.kotlin.doReturn
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+
+internal class HeadersInterceptorTest {
+
+    @Test
+    fun testAnonymousUserHeaders() {
+        // given
+        val isAnonymous = { true }
+        val headersUtil = mock<HeadersUtil>()
+        whenever(headersUtil.buildSdkTrackingHeaders()).doReturn("sdkTrackingHeaders")
+        whenever(headersUtil.buildUserAgent()).doReturn("userAgent")
+        val interceptor = HeadersInterceptor(isAnonymous, headersUtil)
+        // when
+        val response = interceptor.intercept(FakeChain(FakeResponse(200)))
+        // then
+        response.request.header("User-Agent") `should be equal to` "userAgent"
+        response.request.header("Content-Type") `should be equal to` "application/json"
+        response.request.header("stream-auth-type") `should be equal to` "anonymous"
+        response.request.header("X-Stream-Client") `should be equal to` "sdkTrackingHeaders"
+        response.request.header("Cache-Control") `should be equal to` "no-cache"
+    }
+
+    @Test
+    fun testAuthenticatedUserHeaders() {
+        // given
+        val isAnonymous = { false }
+        val headersUtil = mock<HeadersUtil>()
+        whenever(headersUtil.buildSdkTrackingHeaders()).doReturn("sdkTrackingHeaders")
+        whenever(headersUtil.buildUserAgent()).doReturn("userAgent")
+        val interceptor = HeadersInterceptor(isAnonymous, headersUtil)
+        // when
+        val response = interceptor.intercept(FakeChain(FakeResponse(200)))
+        // then
+        response.request.header("User-Agent") `should be equal to` "userAgent"
+        response.request.header("Content-Type") `should be equal to` "application/json"
+        response.request.header("stream-auth-type") `should be equal to` "jwt"
+        response.request.header("X-Stream-Client") `should be equal to` "sdkTrackingHeaders"
+        response.request.header("Cache-Control") `should be equal to` "no-cache"
+    }
+}

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api/interceptor/ProgressInterceptorTest.kt

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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.getstream.chat.android.client.api.interceptor
+
+import io.getstream.chat.android.client.api.FakeChain
+import io.getstream.chat.android.client.api.FakeResponse
+import io.getstream.chat.android.client.api.models.ProgressRequestBody
+import io.getstream.chat.android.client.utils.ProgressCallback
+import io.getstream.result.Error
+import okhttp3.Request
+import okhttp3.RequestBody.Companion.toRequestBody
+import org.amshove.kluent.`should be instance of`
+import org.junit.Test
+
+internal class ProgressInterceptorTest {
+
+    @Test
+    fun testProgressInterceptor() {
+        // given
+        val interceptor = ProgressInterceptor()
+        val progressCallback = object : ProgressCallback {
+            override fun onSuccess(url: String?) { /* No-Op */ }
+            override fun onError(error: Error) { /* No-Op */ }
+            override fun onProgress(bytesUploaded: Long, totalBytes: Long) { /* No-Op */ }
+        }
+        val request = Request.Builder()
+            .url("https://hello.url")
+            .post("body".toRequestBody())
+            .tag(ProgressCallback::class.java, progressCallback)
+            .build()
+        val chain = FakeChain(FakeResponse(200), request = request)
+        // when
+        val response = interceptor.intercept(chain)
+        // then
+        response.request.body `should be instance of` ProgressRequestBody::class
+    }
+}