Merge pull request #8 from KATTA-00/tests

Add test cases and implement the mock server

ballerina/Dependencies.toml

@@ -10,7 +10,7 @@ distribution-version = "2201.9.2"
 [[package]]
 org = "ballerina"
 name = "auth"
-version = "2.11.1"
+version = "2.11.2"
 dependencies = [
 	{org = "ballerina", name = "crypto"},
 	{org = "ballerina", name = "jballerina.java"},
@@ -144,6 +144,15 @@ dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
 ]
 
+[[package]]
+org = "ballerina"
+name = "lang.error"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"}
+]
+
 [[package]]
 org = "ballerina"
 name = "lang.int"
@@ -202,6 +211,9 @@ dependencies = [
 	{org = "ballerina", name = "lang.value"},
 	{org = "ballerina", name = "observe"}
 ]
+modules = [
+	{org = "ballerina", packageName = "log", moduleName = "log"}
+]
 
 [[package]]
 org = "ballerina"
@@ -245,6 +257,9 @@ dependencies = [
 	{org = "ballerina", name = "io"},
 	{org = "ballerina", name = "jballerina.java"}
 ]
+modules = [
+	{org = "ballerina", packageName = "os", moduleName = "os"}
+]
 
 [[package]]
 org = "ballerina"
@@ -255,6 +270,20 @@ dependencies = [
 	{org = "ballerina", name = "time"}
 ]
 
+[[package]]
+org = "ballerina"
+name = "test"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.array"},
+	{org = "ballerina", name = "lang.error"}
+]
+modules = [
+	{org = "ballerina", packageName = "test", moduleName = "test"}
+]
+
 [[package]]
 org = "ballerina"
 name = "time"
@@ -292,7 +321,10 @@ name = "openai.finetunes"
 version = "1.0.5"
 dependencies = [
 	{org = "ballerina", name = "http"},
+	{org = "ballerina", name = "log"},
 	{org = "ballerina", name = "mime"},
+	{org = "ballerina", name = "os"},
+	{org = "ballerina", name = "test"},
 	{org = "ballerina", name = "url"},
 	{org = "ballerinai", name = "observe"}
 ]

ballerina/tests/README.md

@@ -0,0 +1,89 @@
+# Running Tests
+
+## Prerequisites
+
+You need an API token from OpenAI.
+
+To obtain this, refer to the [Ballerina OpenAI Finetunes Connector](https://github.com/ballerina-platform/module-ballerinax-openai.finetunes/blob/main/ballerina/Module.md).
+
+## Test Environments
+
+There are two test environments for running the `openai.finetunes` connector tests. The default environment is a mock server for the OpenAI API. The other environment is the actual OpenAI API.
+
+You can run the tests in either of these environments, and each has its own compatible set of tests.
+
+| Test Groups | Environment                                       |
+|-------------|---------------------------------------------------|
+| mock_tests  | Mock server for OpenAI API (Default Environment)  |
+| live_tests  | OpenAI API                                        |
+
+## Running Tests in the Mock Server
+
+To execute the tests on the mock server, ensure that the `isLiveServer` environment variable is either set to `false` or left unset before initiating the tests.
+
+This environment variable can be configured within the `Config.toml` file located in the `tests` directory or specified as an environment variable.
+
+### Using a `Config.toml` File
+
+Create a `Config.toml` file in the `tests` directory with the following content:
+
+```toml
+isLiveServer = false
+```
+
+### Using Environment Variables
+
+Alternatively, you can set the environment variable directly.
+
+For Linux or macOS:
+
+```bash
+export isLiveServer=false
+```
+
+For Windows:
+
+```bash
+setx isLiveServer false
+```
+
+Then, run the following command to execute the tests:
+
+```bash
+./gradlew clean test
+```
+
+## Running Tests Against the OpenAI Live API
+
+### Using a `Config.toml` File
+
+Create a `Config.toml` file in the `tests` directory and add your authentication credentials:
+
+```toml
+isLiveServer = true
+token = "<your-openAI-api-key>"
+```
+
+### Using Environment Variables
+
+Alternatively, you can set your authentication credentials as environment variables.
+
+For Linux or macOS:
+
+```bash
+export isLiveServer=true
+export token="<your-openAI-api-key>"
+```
+
+For Windows:
+
+```bash
+setx isLiveServer true
+setx token <your-openAI-api-key>
+```
+
+Then, run the following command to execute the tests:
+
+```bash
+./gradlew clean test
+```