test: Create ChatCompletions tests

Author: osugikoji

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

@@ -4,7 +4,9 @@ import co.yml.ychat.data.api.ChatGptApi
 import co.yml.ychat.data.infrastructure.ApiExecutor
 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.entrypoint.features.ChatCompletions
 import co.yml.ychat.entrypoint.features.Completion
 import io.ktor.client.HttpClient
 import kotlin.test.AfterTest
@@ -35,5 +37,7 @@ class LibraryModuleTest : KoinTest {
         get<ApiExecutor>()
         get<ChatGptApi>()
         get<CompletionUseCase>()
+        get<ChatCompletionsUseCase>()
+        get<ChatCompletions>()
     }
 }

ychat/src/commonTest/kotlin/co/yml/ychat/domain/model/ChatCompletionsParamsTest.kt

@@ -0,0 +1,21 @@
+package co.yml.ychat.domain.model
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ChatCompletionsParamsTest {
+
+    @Test
+    fun `on ChatCompletionsParams verify default values`() {
+        // arrange
+        val params = ChatCompletionsParams()
+
+        // assert
+        assertEquals(true, params.messages.isEmpty())
+        assertEquals("gpt-3.5-turbo", params.model)
+        assertEquals(4096, params.maxTokens)
+        assertEquals(1, params.maxResults)
+        assertEquals(1.0, params.temperature)
+        assertEquals(1.0, params.topP)
+    }
+}

ychat/src/commonTest/kotlin/co/yml/ychat/domain/CompletionParamsTest.kt renamed to ychat/src/commonTest/kotlin/co/yml/ychat/domain/model/CompletionParamsTest.kt

@@ -1,6 +1,5 @@
-package co.yml.ychat.domain
+package co.yml.ychat.domain.model
 
-import co.yml.ychat.domain.model.CompletionParams
 import kotlin.test.Test
 import kotlin.test.assertEquals
 

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

@@ -0,0 +1,80 @@
+package co.yml.ychat.domain.usecases
+
+import co.yml.ychat.data.api.ChatGptApi
+import co.yml.ychat.data.dto.ChatCompletionsChoiceDto
+import co.yml.ychat.data.dto.ChatCompletionsDto
+import co.yml.ychat.data.dto.ChatMessageDto
+import co.yml.ychat.data.dto.UsageDto
+import co.yml.ychat.data.exception.ChatGptException
+import co.yml.ychat.data.infrastructure.ApiResult
+import co.yml.ychat.domain.model.ChatCompletionsParams
+import co.yml.ychat.domain.model.ChatMessage
+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 ChatCompletionsUseCaseTest {
+
+    private lateinit var chatCompletionsUseCase: ChatCompletionsUseCase
+
+    private val chatGptApiMock = mockk<ChatGptApi>()
+
+    @BeforeTest
+    fun setup() {
+        chatCompletionsUseCase = ChatCompletionsUseCase(chatGptApiMock)
+    }
+
+    @Test
+    fun `on requestChatCompletions when request succeed then should return formatted result`() {
+        // arrange
+        val messages = arrayListOf(ChatMessage("user", "Say this is a test."))
+        val chatCompletionDto = buildChatCompletionsDto("This indeed a test")
+        val params = ChatCompletionsParams(messages)
+        val apiResult = ApiResult(body = chatCompletionDto)
+        coEvery { chatGptApiMock.chatCompletions(any()) } returns apiResult
+
+        // act
+        val result = runBlocking { chatCompletionsUseCase.requestChatCompletions(params) }
+
+        // assert
+        assertEquals("This indeed a test", result.last().content)
+    }
+
+    @Test
+    fun `on requestChatCompletions when not request succeed then should throw an exception`() {
+        // arrange
+        val messages = arrayListOf(ChatMessage("user", "Say this is a test."))
+        val params = ChatCompletionsParams(messages)
+        val apiResult = ApiResult<ChatCompletionsDto>(exception = ChatGptException())
+        coEvery { chatGptApiMock.chatCompletions(any()) } returns apiResult
+
+        // act
+        val result =
+            runCatching { runBlocking { chatCompletionsUseCase.requestChatCompletions(params) } }
+
+        // assert
+        assertEquals(true, result.exceptionOrNull() is ChatGptException)
+    }
+
+    private fun buildChatCompletionsDto(answer: String): ChatCompletionsDto {
+        return ChatCompletionsDto(
+            id = "1",
+            model = "gpt",
+            choices = listOf(
+                ChatCompletionsChoiceDto(
+                    index = 0,
+                    message = ChatMessageDto("assistance", answer),
+                    finishReason = ""
+                )
+            ),
+            usage = UsageDto(
+                promptToken = 1,
+                completionTokens = 1,
+                totalTokens = 1
+            )
+        )
+    }
+}

ychat/src/commonTest/kotlin/co/yml/ychat/domain/CompletionUseCaseTest.kt renamed to ychat/src/commonTest/kotlin/co/yml/ychat/domain/usecases/CompletionUseCaseTest.kt

@@ -1,4 +1,4 @@
-package co.yml.ychat.domain
+package co.yml.ychat.domain.usecases
 
 import co.yml.ychat.data.api.ChatGptApi
 import co.yml.ychat.data.dto.ChoiceDto
@@ -7,7 +7,6 @@ import co.yml.ychat.data.dto.UsageDto
 import co.yml.ychat.data.exception.ChatGptException
 import co.yml.ychat.data.infrastructure.ApiResult
 import co.yml.ychat.data.storage.ChatLogStorage
-import co.yml.ychat.domain.usecases.CompletionUseCase
 import co.yml.ychat.domain.model.CompletionParams
 import io.mockk.coEvery
 import io.mockk.every

ychat/src/commonTest/kotlin/co/yml/ychat/entrypoint/CompletionIntegrationTest.kt renamed to ychat/src/commonTest/kotlin/co/yml/ychat/entrypoint/YChatTest.kt

@@ -15,19 +15,29 @@ import kotlin.test.assertEquals
 import kotlinx.coroutines.runBlocking
 import org.koin.dsl.module
 
-class CompletionIntegrationTest {
+class YChatTest {
 
     private lateinit var yChat: YChatImpl
 
     @BeforeTest
     fun setup() {
-        yChat = YChat.create("api.key") as YChatImpl
+        yChat = YChatImpl("api.key")
+    }
+
+    @Test
+    fun `on create method should return singleton instance`() {
+        // arrange
+        val yChatOne = YChat.create("api.key")
+        val yChatTwo = YChat.create("api.key")
+
+        // assert
+        assertEquals(yChatOne, yChatTwo)
     }
 
     @Test
     fun `on completion execute method should return result successfully`() {
         // arrange
-        val textResult = "This in indeed a text"
+        val textResult = "This in indeed a test"
         val completionSuccessResult = MockStorage.completionSuccessResult(textResult)
         mockHttpEngine(completionSuccessResult)
 
@@ -39,7 +49,28 @@ class CompletionIntegrationTest {
         }
 
         // assert
-        assertEquals("This in indeed a text", result)
+        assertEquals("This in indeed a test", result)
+    }
+
+    @Test
+    fun `on chatCompletions execute method should return result successfully`() {
+        // arrange
+        val textResult = "This in indeed a test"
+        val chatCompletionSuccessResult = MockStorage.chatCompletionsSuccessResult(textResult)
+        mockHttpEngine(chatCompletionSuccessResult)
+
+        // act
+        val result = runBlocking {
+            yChat.chatCompletions()
+                .setMaxResults(1)
+                .setTemperature(1.0)
+                .setTopP(1.0)
+                .execute("Say this is a test")
+                .first().content
+        }
+
+        // assert
+        assertEquals("This in indeed a test", result)
     }
 
     private fun mockHttpEngine(result: String) {

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

@@ -7,4 +7,10 @@ object MockStorage {
         "\"choices\":[{\"text\":\"\n\n$text\",\"index\":0,\"logprobs\":null," +
         "\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":8,\"completion_tokens\":9," +
         "\"total_tokens\":17}}"
+
+    fun chatCompletionsSuccessResult(text: String) = "{\"id\":\"1\",\"object\":\"chat.completion\"," +
+        "\"created\":1678144798,\"model\":\"gpt-3.5-turbo-0301\"," +
+        "\"usage\":{\"prompt_tokens\":13,\"completion_tokens\":12,\"total_tokens\":25}," +
+        "\"choices\":[{\"message\":{\"role\":\"assistant\",\"content\":\"$text\"}," +
+        "\"finish_reason\":\"stop\",\"index\":0}]}"
 }