test: Add unit tests

Author: osugikoji

ychat/src/commonTest/kotlin/co/yml/ychat/di/LibraryModuleTest.kt

@@ -6,11 +6,14 @@ import co.yml.ychat.data.storage.ChatLogStorage
 import co.yml.ychat.di.module.LibraryModule
 import co.yml.ychat.domain.usecases.ChatCompletionsUseCase
 import co.yml.ychat.domain.usecases.CompletionUseCase
+import co.yml.ychat.domain.usecases.EditsUseCase
 import co.yml.ychat.domain.usecases.ImageGenerationsUseCase
+import co.yml.ychat.domain.usecases.ListModelsUseCase
 import co.yml.ychat.entrypoint.features.ChatCompletions
 import co.yml.ychat.entrypoint.features.Completion
 import co.yml.ychat.entrypoint.features.Edits
 import co.yml.ychat.entrypoint.features.ImageGenerations
+import co.yml.ychat.entrypoint.features.ListModels
 import io.ktor.client.HttpClient
 import kotlin.test.AfterTest
 import kotlin.test.BeforeTest
@@ -33,17 +36,28 @@ class LibraryModuleTest : KoinTest {
     }
 
     @Test
-    fun `should inject all modules without throwing exception`() {
+    fun `should inject all entrypoint modules without throwing exception`() {
         get<Completion>()
+        get<ChatCompletions>()
+        get<ImageGenerations>()
+        get<Edits>()
+        get<ListModels>()
+    }
+
+    @Test
+    fun `should inject all domain modules without throwing exception`() {
+        get<ListModelsUseCase>()
+        get<CompletionUseCase>()
+        get<ChatCompletionsUseCase>()
+        get<ImageGenerationsUseCase>()
+        get<EditsUseCase>()
+    }
+
+    @Test
+    fun `should inject all data modules without throwing exception`() {
         get<HttpClient>()
         get<ChatLogStorage>()
         get<ApiExecutor>()
         get<ChatGptApi>()
-        get<CompletionUseCase>()
-        get<ChatCompletionsUseCase>()
-        get<ChatCompletions>()
-        get<ImageGenerationsUseCase>()
-        get<ImageGenerations>()
-        get<Edits>()
     }
 }

ychat/src/commonTest/kotlin/co/yml/ychat/domain/usecases/ListModelsUseCaseTest.kt

@@ -0,0 +1,58 @@
+package co.yml.ychat.domain.usecases
+
+import co.yml.ychat.data.api.ChatGptApi
+import co.yml.ychat.data.dto.ModelDto
+import co.yml.ychat.data.dto.ModelListDto
+import co.yml.ychat.data.exception.ChatGptException
+import co.yml.ychat.data.infrastructure.ApiResult
+import io.mockk.coEvery
+import io.mockk.mockk
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlinx.coroutines.runBlocking
+
+class ListModelsUseCaseTest {
+
+    private lateinit var useCase: ListModelsUseCase
+
+    private val chatGptApiMock = mockk<ChatGptApi>()
+
+    @BeforeTest
+    fun setup() {
+        useCase = ListModelsUseCase(chatGptApiMock)
+    }
+
+    @Test
+    fun `on getListModels when request succeed then should return formatted result`() {
+        // arrange
+        val expectedIds = listOf("model1", "model2")
+        val modelListDto = buildModelListDto(expectedIds)
+        val apiResult = ApiResult(body = modelListDto)
+        coEvery { chatGptApiMock.models() } returns apiResult
+
+        // act
+        val result = runBlocking { useCase.getListModels() }
+
+        // assert
+        assertEquals("model1", result[0].id)
+        assertEquals("model2", result[1].id)
+    }
+
+    @Test
+    fun `on getListModels when not request succeed then should throw an exception`() {
+        // arrange
+        val apiResult = ApiResult<ModelListDto>(exception = ChatGptException())
+        coEvery { chatGptApiMock.models() } returns apiResult
+
+        // act
+        val result = runCatching { runBlocking { useCase.getListModels() } }
+
+        // assert
+        assertEquals(true, result.exceptionOrNull() is ChatGptException)
+    }
+
+    private fun buildModelListDto(modelIds: List<String>): ModelListDto {
+        return ModelListDto(modelIds.map { ModelDto(id = it, ownedBy = "", emptyList()) })
+    }
+}

ychat/src/commonTest/kotlin/co/yml/ychat/entrypoint/YChatTest.kt

@@ -115,6 +115,20 @@ class YChatTest {
         assertEquals(expectedResult, result.first())
     }
 
+    @Test
+    fun `on listModels execute method should return result successfully`() {
+        // arrange
+        val expectedResult = "model1"
+        val listModelsSuccessResult = MockStorage.listModelsSuccessResult(expectedResult)
+        mockHttpEngine(listModelsSuccessResult)
+
+        // act
+        val result = runBlocking { yChat.listModels().execute() }
+
+        // assert
+        assertEquals(expectedResult, result.first().id)
+    }
+
     private fun mockHttpEngine(result: String) {
         val httpEngine = MockEngine {
             respond(

ychat/src/commonTest/kotlin/infrastructure/MockStorage.kt

@@ -20,4 +20,13 @@ object MockStorage {
     fun editsSuccessResult(text: String) = "{\"object\":\"edit\",\"created\":1679072839," +
         "\"choices\":[{\"text\":\"$text\",\"index\":0}]," +
         "\"usage\":{\"prompt_tokens\":25,\"completion_tokens\":28,\"total_tokens\":53}}"
+
+    fun listModelsSuccessResult(id: String) =
+        "{\"object\":\"list\",\"data\":[{\"id\":\"$id\",\"object\":\"model\"," +
+            "\"created\":1649358449,\"owned_by\":\"openai\",\"permission\":" +
+            "[{\"id\":\"modelperm-49FUp5v084tBB49tC4z8LPH5\",\"object\":\"model_permission\"," +
+            "\"created\":1669085501,\"allow_create_engine\":false,\"allow_sampling\":true," +
+            "\"allow_logprobs\":true,\"allow_search_indices\":false,\"allow_view\":true," +
+            "\"allow_fine_tuning\":false,\"organization\":\"*\",\"group\":null,\"is_blocking" +
+            "\":false}],\"root\":\"$id\",\"parent\":null}]}"
 }