|
| 1 | +/* |
| 2 | + * Copyright 2023-2025 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.springframework.ai.model.tool; |
| 18 | + |
| 19 | +import io.micrometer.observation.ObservationRegistry; |
| 20 | +import org.junit.jupiter.api.Test; |
| 21 | +import org.springframework.ai.chat.messages.AssistantMessage; |
| 22 | +import org.springframework.ai.chat.messages.UserMessage; |
| 23 | +import org.springframework.ai.chat.model.ChatResponse; |
| 24 | +import org.springframework.ai.chat.model.Generation; |
| 25 | +import org.springframework.ai.chat.prompt.Prompt; |
| 26 | +import org.springframework.ai.tool.ToolCallback; |
| 27 | +import org.springframework.ai.tool.definition.DefaultToolDefinition; |
| 28 | +import org.springframework.ai.tool.definition.ToolDefinition; |
| 29 | +import org.springframework.ai.tool.metadata.ToolMetadata; |
| 30 | + |
| 31 | +import java.util.List; |
| 32 | +import java.util.Map; |
| 33 | + |
| 34 | +import static org.assertj.core.api.Assertions.assertThat; |
| 35 | +import static org.assertj.core.api.Assertions.assertThatNoException; |
| 36 | + |
| 37 | +/** |
| 38 | + * Tests for {@link DefaultToolCallingManager} with empty/null arguments handling. |
| 39 | + * |
| 40 | + * @author Spring AI Team |
| 41 | + */ |
| 42 | +class DefaultToolCallingManagerTest { |
| 43 | + |
| 44 | + @Test |
| 45 | + void shouldHandleNullArgumentsInStreamMode() { |
| 46 | + // Create a mock tool callback |
| 47 | + ToolCallback mockToolCallback = new ToolCallback() { |
| 48 | + @Override |
| 49 | + public ToolDefinition getToolDefinition() { |
| 50 | + return DefaultToolDefinition.builder() |
| 51 | + .name("testTool") |
| 52 | + .description("A test tool") |
| 53 | + .inputSchema("{}") |
| 54 | + .build(); |
| 55 | + } |
| 56 | + |
| 57 | + @Override |
| 58 | + public ToolMetadata getToolMetadata() { |
| 59 | + return ToolMetadata.builder().build(); |
| 60 | + } |
| 61 | + |
| 62 | + @Override |
| 63 | + public String call(String toolInput) { |
| 64 | + // Verify the input is not null or empty |
| 65 | + assertThat(toolInput).isNotNull(); |
| 66 | + assertThat(toolInput).isNotEmpty(); |
| 67 | + return "{\"result\": \"success\"}"; |
| 68 | + } |
| 69 | + }; |
| 70 | + |
| 71 | + // Create DefaultToolCallingManager with tool callback |
| 72 | + DefaultToolCallingManager manager = DefaultToolCallingManager.builder() |
| 73 | + .observationRegistry(ObservationRegistry.NOOP) |
| 74 | + .build(); |
| 75 | + |
| 76 | + // Create a ToolCall with empty parameters |
| 77 | + AssistantMessage.ToolCall toolCall = new AssistantMessage.ToolCall("1", "function", "testTool", null); |
| 78 | + |
| 79 | + // Create a ChatResponse |
| 80 | + AssistantMessage assistantMessage = new AssistantMessage("", Map.of(), List.of(toolCall)); |
| 81 | + Generation generation = new Generation(assistantMessage); |
| 82 | + ChatResponse chatResponse = new ChatResponse(List.of(generation)); |
| 83 | + |
| 84 | + // Create a Prompt with tool callbacks |
| 85 | + Prompt prompt = new Prompt(List.of(new UserMessage("test"))); |
| 86 | + |
| 87 | + // Mock the tool callbacks resolution by creating a custom ToolCallbackResolver |
| 88 | + DefaultToolCallingManager managerWithCallback = DefaultToolCallingManager.builder() |
| 89 | + .observationRegistry(ObservationRegistry.NOOP) |
| 90 | + .toolCallbackResolver(toolName -> { |
| 91 | + if ("testTool".equals(toolName)) { |
| 92 | + return mockToolCallback; |
| 93 | + } |
| 94 | + return null; |
| 95 | + }) |
| 96 | + .build(); |
| 97 | + |
| 98 | + // Verify that no exception is thrown |
| 99 | + assertThatNoException().isThrownBy(() -> { |
| 100 | + managerWithCallback.executeToolCalls(prompt, chatResponse); |
| 101 | + }); |
| 102 | + } |
| 103 | + |
| 104 | + @Test |
| 105 | + void shouldHandleEmptyArgumentsInStreamMode() { |
| 106 | + // Create a mock tool callback |
| 107 | + ToolCallback mockToolCallback = new ToolCallback() { |
| 108 | + @Override |
| 109 | + public ToolDefinition getToolDefinition() { |
| 110 | + return DefaultToolDefinition.builder() |
| 111 | + .name("testTool") |
| 112 | + .description("A test tool") |
| 113 | + .inputSchema("{}") |
| 114 | + .build(); |
| 115 | + } |
| 116 | + |
| 117 | + @Override |
| 118 | + public ToolMetadata getToolMetadata() { |
| 119 | + return ToolMetadata.builder().build(); |
| 120 | + } |
| 121 | + |
| 122 | + @Override |
| 123 | + public String call(String toolInput) { |
| 124 | + // Verify the input is not null or empty |
| 125 | + assertThat(toolInput).isNotNull(); |
| 126 | + assertThat(toolInput).isNotEmpty(); |
| 127 | + return "{\"result\": \"success\"}"; |
| 128 | + } |
| 129 | + }; |
| 130 | + |
| 131 | + // Create DefaultToolCallingManager with tool callback |
| 132 | + DefaultToolCallingManager manager = DefaultToolCallingManager.builder() |
| 133 | + .observationRegistry(ObservationRegistry.NOOP) |
| 134 | + .build(); |
| 135 | + |
| 136 | + // Create a ToolCall with empty parameters |
| 137 | + AssistantMessage.ToolCall toolCall = new AssistantMessage.ToolCall("1", "function", "testTool", ""); |
| 138 | + |
| 139 | + // Create a ChatResponse |
| 140 | + AssistantMessage assistantMessage = new AssistantMessage("", Map.of(), List.of(toolCall)); |
| 141 | + Generation generation = new Generation(assistantMessage); |
| 142 | + ChatResponse chatResponse = new ChatResponse(List.of(generation)); |
| 143 | + |
| 144 | + // Create a Prompt with tool callbacks |
| 145 | + Prompt prompt = new Prompt(List.of(new UserMessage("test"))); |
| 146 | + |
| 147 | + // Mock the tool callbacks resolution by creating a custom ToolCallbackResolver |
| 148 | + DefaultToolCallingManager managerWithCallback = DefaultToolCallingManager.builder() |
| 149 | + .observationRegistry(ObservationRegistry.NOOP) |
| 150 | + .toolCallbackResolver(toolName -> { |
| 151 | + if ("testTool".equals(toolName)) { |
| 152 | + return mockToolCallback; |
| 153 | + } |
| 154 | + return null; |
| 155 | + }) |
| 156 | + .build(); |
| 157 | + |
| 158 | + // Verify that no exception is thrown |
| 159 | + assertThatNoException().isThrownBy(() -> { |
| 160 | + managerWithCallback.executeToolCalls(prompt, chatResponse); |
| 161 | + }); |
| 162 | + } |
| 163 | + |
| 164 | +} |
0 commit comments