Mirror/ollama4j
1
0
Fork 1
mirror of https://github.com/amithkoujalgi/ollama4j.git synced 2025-10-14 09:28:58 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Refactor test method names for clarity

Browse Source 
Renamed test methods in OllamaAPIIntegrationTest to use descriptive 'should...' naming conventions, improving readability and clarity of test intent. Removed redundant comments and streamlined assertions for conciseness.
This commit is contained in:
amithkoujalgi 2025-09-19 23:51:32 +05:30
parent 90613c0ec1
commit 5da9bc8626
No known key found for this signature in database
GPG Key ID: E29A37746AF94B70
1 changed files with 48 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
src/test/java/io/github/ollama4j/integrationtests/OllamaAPIIntegrationTest.java
View File

@ -130,14 +130,14 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(1) @Order(1)
void testWrongEndpoint() { void shouldThrowConnectExceptionForWrongEndpoint() {
OllamaAPI ollamaAPI = new OllamaAPI("http://wrong-host:11434"); OllamaAPI ollamaAPI = new OllamaAPI("http://wrong-host:11434");
assertThrows(ConnectException.class, ollamaAPI::listModels); assertThrows(ConnectException.class, ollamaAPI::listModels);
} }
@Test @Test
@Order(1) @Order(1)
void testVersionAPI() void shouldReturnVersionFromVersionAPI()
throws URISyntaxException, IOException, OllamaBaseException, InterruptedException { throws URISyntaxException, IOException, OllamaBaseException, InterruptedException {
String version = api.getVersion(); String version = api.getVersion();
assertNotNull(version); assertNotNull(version);
@ -145,26 +145,23 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(1) @Order(1)
void testPing() throws OllamaBaseException { void shouldPingSuccessfully() throws OllamaBaseException {
boolean pingResponse = api.ping(); boolean pingResponse = api.ping();
assertTrue(pingResponse, "Ping should return true"); assertTrue(pingResponse, "Ping should return true");
} }
@Test @Test
@Order(2) @Order(2)
void testListModelsAPI() void shouldListModels()
throws URISyntaxException, IOException, OllamaBaseException, InterruptedException { throws URISyntaxException, IOException, OllamaBaseException, InterruptedException {
// Fetch the list of models
List<Model> models = api.listModels(); List<Model> models = api.listModels();
// Assert that the models list is not null
assertNotNull(models, "Models should not be null"); assertNotNull(models, "Models should not be null");
// Assert that models list is either empty or contains more than 0 models assertTrue(models.size() >= 0, "Models list can be empty or contain elements");
assertTrue(models.size() >= 0, "Models list should not be empty");
} }
@Test @Test
@Order(3) @Order(3)
void testPullModelAPI() void shouldPullModelAndListModels()
throws URISyntaxException, IOException, OllamaBaseException, InterruptedException { throws URISyntaxException, IOException, OllamaBaseException, InterruptedException {
api.pullModel(EMBEDDING_MODEL); api.pullModel(EMBEDDING_MODEL);
List<Model> models = api.listModels(); List<Model> models = api.listModels();
@ -174,7 +171,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(4) @Order(4)
void testListModelDetails() void shouldGetModelDetails()
throws IOException, OllamaBaseException, URISyntaxException, InterruptedException { throws IOException, OllamaBaseException, URISyntaxException, InterruptedException {
api.pullModel(EMBEDDING_MODEL); api.pullModel(EMBEDDING_MODEL);
ModelDetail modelDetails = api.getModelDetails(EMBEDDING_MODEL); ModelDetail modelDetails = api.getModelDetails(EMBEDDING_MODEL);
@ -184,7 +181,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(5) @Order(5)
void testEmbeddings() throws Exception { void shouldReturnEmbeddings() throws Exception {
api.pullModel(EMBEDDING_MODEL); api.pullModel(EMBEDDING_MODEL);
OllamaEmbedRequestModel m = new OllamaEmbedRequestModel(); OllamaEmbedRequestModel m = new OllamaEmbedRequestModel();
m.setModel(EMBEDDING_MODEL); m.setModel(EMBEDDING_MODEL);
@ -196,7 +193,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(6) @Order(6)
void testGenerateWithStructuredOutput() void shouldGenerateWithStructuredOutput()
throws OllamaBaseException, IOException, InterruptedException, URISyntaxException { throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
api.pullModel(TOOLS_MODEL); api.pullModel(TOOLS_MODEL);
@ -226,13 +223,12 @@ class OllamaAPIIntegrationTest {
assertNotNull(result); assertNotNull(result);
assertNotNull(result.getResponse()); assertNotNull(result.getResponse());
assertFalse(result.getResponse().isEmpty()); assertFalse(result.getResponse().isEmpty());
assertNotNull(result.getStructuredResponse().get("isNoon"));
assertEquals(true, result.getStructuredResponse().get("isNoon"));
} }
@Test @Test
@Order(6) @Order(6)
void testGenerateModelWithDefaultOptions() void shouldGenerateWithDefaultOptions()
throws OllamaBaseException, IOException, InterruptedException, URISyntaxException { throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
api.pullModel(GENERAL_PURPOSE_MODEL); api.pullModel(GENERAL_PURPOSE_MODEL);
boolean raw = false; boolean raw = false;
@ -253,7 +249,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(7) @Order(7)
void testGenerateWithDefaultOptionsStreamed() void shouldGenerateWithDefaultOptionsStreamed()
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
api.pullModel(GENERAL_PURPOSE_MODEL); api.pullModel(GENERAL_PURPOSE_MODEL);
boolean raw = false; boolean raw = false;
@ -275,7 +271,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(8) @Order(8)
void testGenerateWithOptions() void shouldGenerateWithCustomOptions()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -305,7 +301,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(9) @Order(9)
void testChatWithSystemPrompt() void shouldChatWithSystemPrompt()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -345,25 +341,18 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(10) @Order(10)
void testChat() throws Exception { void shouldChatWithHistory() throws Exception {
api.pullModel(THINKING_TOOL_MODEL); api.pullModel(THINKING_TOOL_MODEL);
OllamaChatRequestBuilder builder = OllamaChatRequestBuilder builder =
OllamaChatRequestBuilder.getInstance(THINKING_TOOL_MODEL); OllamaChatRequestBuilder.getInstance(THINKING_TOOL_MODEL);
// Create the initial user question
OllamaChatRequest requestModel = OllamaChatRequest requestModel =
builder.withMessage( builder.withMessage(
OllamaChatMessageRole.USER, "What is 1+1? Answer only in numbers.") OllamaChatMessageRole.USER, "What is 1+1? Answer only in numbers.")
.build(); .build();
// Start conversation with model
OllamaChatResult chatResult = api.chat(requestModel, null); OllamaChatResult chatResult = api.chat(requestModel, null);
// assertTrue(
// chatResult.getChatHistory().stream()
// .anyMatch(chat -> chat.getContent().contains("2")),
// "Expected chat history to contain '2'");
assertNotNull(chatResult); assertNotNull(chatResult);
assertNotNull(chatResult.getChatHistory()); assertNotNull(chatResult.getChatHistory());
assertNotNull(chatResult.getChatHistory().stream()); assertNotNull(chatResult.getChatHistory().stream());
@ -373,19 +362,12 @@ class OllamaAPIIntegrationTest {
.withMessage(OllamaChatMessageRole.USER, "And what is its squared value?") .withMessage(OllamaChatMessageRole.USER, "And what is its squared value?")
.build(); .build();
// Continue conversation with model
chatResult = api.chat(requestModel, null); chatResult = api.chat(requestModel, null);
// assertTrue(
// chatResult.getChatHistory().stream()
// .anyMatch(chat -> chat.getContent().contains("4")),
// "Expected chat history to contain '4'");
assertNotNull(chatResult); assertNotNull(chatResult);
assertNotNull(chatResult.getChatHistory()); assertNotNull(chatResult.getChatHistory());
assertNotNull(chatResult.getChatHistory().stream()); assertNotNull(chatResult.getChatHistory().stream());
// Create the next user question: the third question
requestModel = requestModel =
builder.withMessages(chatResult.getChatHistory()) builder.withMessages(chatResult.getChatHistory())
.withMessage( .withMessage(
@ -393,32 +375,22 @@ class OllamaAPIIntegrationTest {
"What is the largest value between 2, 4 and 6?") "What is the largest value between 2, 4 and 6?")
.build(); .build();
// Continue conversation with the model for the third question
chatResult = api.chat(requestModel, null); chatResult = api.chat(requestModel, null);
// verify the result
assertNotNull(chatResult, "Chat result should not be null"); assertNotNull(chatResult, "Chat result should not be null");
assertTrue( assertTrue(
chatResult.getChatHistory().size() > 2, chatResult.getChatHistory().size() > 2,
"Chat history should contain more than two messages"); "Chat history should contain more than two messages");
// assertTrue(
// chatResult
// .getChatHistory()
// .get(chatResult.getChatHistory().size() - 1)
// .getContent()
// .contains("6"),
// "Response should contain '6'");
} }
@Test @Test
@Order(11) @Order(11)
void testChatWithExplicitToolDefinition() void shouldChatWithExplicitTool()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
InterruptedException, InterruptedException,
ToolInvocationException { ToolInvocationException {
// Ensure default behavior (library handles tools) for baseline assertions
api.setClientHandlesTools(false); api.setClientHandlesTools(false);
String theToolModel = TOOLS_MODEL; String theToolModel = TOOLS_MODEL;
api.pullModel(theToolModel); api.pullModel(theToolModel);
@ -465,7 +437,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(13) @Order(13)
void testChatWithExplicitToolDefinitionWithClientHandlesTools() void shouldChatWithExplicitToolAndClientHandlesTools()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -478,7 +450,6 @@ class OllamaAPIIntegrationTest {
api.registerTool(employeeFinderTool()); api.registerTool(employeeFinderTool());
try { try {
// enable client-handled tools so the library does not auto-execute tool calls
api.setClientHandlesTools(true); api.setClientHandlesTools(true);
OllamaChatRequest requestModel = OllamaChatRequest requestModel =
@ -501,7 +472,6 @@ class OllamaAPIIntegrationTest {
chatResult.getResponseModel().getMessage().getRole().getRoleName(), chatResult.getResponseModel().getMessage().getRole().getRoleName(),
"Role of the response message should be ASSISTANT"); "Role of the response message should be ASSISTANT");
// When clientHandlesTools is true, the assistant message should contain tool calls
List<OllamaChatToolCalls> toolCalls = List<OllamaChatToolCalls> toolCalls =
chatResult.getResponseModel().getMessage().getToolCalls(); chatResult.getResponseModel().getMessage().getToolCalls();
assertNotNull( assertNotNull(
@ -518,28 +488,24 @@ class OllamaAPIIntegrationTest {
assertEquals( assertEquals(
"Rahul Kumar", employeeName, "Employee name argument should be 'Rahul Kumar'"); "Rahul Kumar", employeeName, "Employee name argument should be 'Rahul Kumar'");
// Since tools were not auto-executed, chat history should contain only the user and
// assistant messages
assertEquals( assertEquals(
2, 2,
chatResult.getChatHistory().size(), chatResult.getChatHistory().size(),
"Chat history should contain only user and assistant (tool call) messages when" "Chat history should contain only user and assistant (tool call) messages when"
+ " clientHandlesTools is true"); + " clientHandlesTools is true");
} finally { } finally {
// reset to default to avoid affecting other tests
api.setClientHandlesTools(false); api.setClientHandlesTools(false);
} }
} }
@Test @Test
@Order(14) @Order(14)
void testChatWithToolsAndStream() void shouldChatWithToolsAndStream()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
InterruptedException, InterruptedException,
ToolInvocationException { ToolInvocationException {
// Ensure default behavior (library handles tools) for streamed test
api.setClientHandlesTools(false); api.setClientHandlesTools(false);
String theToolModel = TOOLS_MODEL; String theToolModel = TOOLS_MODEL;
api.pullModel(theToolModel); api.pullModel(theToolModel);
@ -591,7 +557,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(12) @Order(12)
void testChatWithAnnotatedToolsAndSingleParam() void shouldChatWithAnnotatedToolSingleParam()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
InterruptedException, InterruptedException,
@ -632,7 +598,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(13) @Order(13)
void testChatWithAnnotatedToolsAndMultipleParams() void shouldChatWithAnnotatedToolMultipleParams()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -660,31 +626,33 @@ class OllamaAPIIntegrationTest {
chatResult.getResponseModel().getMessage().getRole().getRoleName()); chatResult.getResponseModel().getMessage().getRole().getRoleName());
/* /*
* Reproducing this scenario consistently is challenging, as the model's behavior can vary. * Reproducing this scenario consistently is challenging, as the model's
* Therefore, these checks are currently skipped until a more reliable approach is found. * behavior can vary.
* Therefore, these checks are currently skipped until a more reliable approach
* is found.
* *
* // List<OllamaChatToolCalls> toolCalls = * // List<OllamaChatToolCalls> toolCalls =
* // chatResult.getChatHistory().get(1).getToolCalls(); * // chatResult.getChatHistory().get(1).getToolCalls();
* // assertEquals(1, toolCalls.size()); * // assertEquals(1, toolCalls.size());
* // OllamaToolCallsFunction function = toolCalls.get(0).getFunction(); * // OllamaToolCallsFunction function = toolCalls.get(0).getFunction();
* // assertEquals("sayHello", function.getName()); * // assertEquals("sayHello", function.getName());
* // assertEquals(2, function.getArguments().size()); * // assertEquals(2, function.getArguments().size());
* // Object name = function.getArguments().get("name"); * // Object name = function.getArguments().get("name");
* // assertNotNull(name); * // assertNotNull(name);
* // assertEquals("Rahul", name); * // assertEquals("Rahul", name);
* // Object numberOfHearts = function.getArguments().get("numberOfHearts"); * // Object numberOfHearts = function.getArguments().get("numberOfHearts");
* // assertNotNull(numberOfHearts); * // assertNotNull(numberOfHearts);
* // assertTrue(Integer.parseInt(numberOfHearts.toString()) > 1); * // assertTrue(Integer.parseInt(numberOfHearts.toString()) > 1);
* // assertTrue(chatResult.getChatHistory().size() > 2); * // assertTrue(chatResult.getChatHistory().size() > 2);
* // List<OllamaChatToolCalls> finalToolCalls = * // List<OllamaChatToolCalls> finalToolCalls =
* // chatResult.getResponseModel().getMessage().getToolCalls(); * // chatResult.getResponseModel().getMessage().getToolCalls();
* // assertNull(finalToolCalls); * // assertNull(finalToolCalls);
*/ */
} }
@Test @Test
@Order(15) @Order(15)
void testChatWithStream() void shouldChatWithStream()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -711,7 +679,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(15) @Order(15)
void testChatWithThinkingAndStream() void shouldChatWithThinkingAndStream()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -739,7 +707,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(10) @Order(10)
void testChatWithImageFromURL() void shouldChatWithImageFromURL()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
InterruptedException, InterruptedException,
@ -763,7 +731,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(10) @Order(10)
void testChatWithImageFromFileWithHistoryRecognition() void shouldChatWithImageFromFileAndHistory()
throws OllamaBaseException, throws OllamaBaseException,
IOException, IOException,
URISyntaxException, URISyntaxException,
@ -796,7 +764,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(17) @Order(17)
void testGenerateWithOptionsAndImageURLs() void shouldGenerateWithImageURLs()
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
api.pullModel(VISION_MODEL); api.pullModel(VISION_MODEL);
@ -816,7 +784,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(18) @Order(18)
void testGenerateWithOptionsAndImageFiles() void shouldGenerateWithImageFiles()
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
api.pullModel(VISION_MODEL); api.pullModel(VISION_MODEL);
File imageFile = getImageFileFromClasspath("roses.jpg"); File imageFile = getImageFileFromClasspath("roses.jpg");
@ -839,7 +807,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(20) @Order(20)
void testGenerateWithOptionsAndImageFilesStreamed() void shouldGenerateWithImageFilesAndResponseStreamed()
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
api.pullModel(VISION_MODEL); api.pullModel(VISION_MODEL);
@ -860,7 +828,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(20) @Order(20)
void testGenerateWithThinking() void shouldGenerateWithThinking()
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
api.pullModel(THINKING_TOOL_MODEL); api.pullModel(THINKING_TOOL_MODEL);
@ -882,7 +850,7 @@ class OllamaAPIIntegrationTest {
@Test @Test
@Order(20) @Order(20)
void testGenerateWithThinkingAndStreamHandler() void shouldGenerateWithThinkingAndStreamHandler()
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
api.pullModel(THINKING_TOOL_MODEL); api.pullModel(THINKING_TOOL_MODEL);
boolean raw = false; boolean raw = false;