feat(tool-calls): add test unit classes and provide a constant class for each tool-call (#1132)

* feat: Remove Bing Search Tool-Calling (Bing Search API will be discontinued on August 11, 2025)

* feat: add AliTranslateTest

* feat: Change the AutoConfiguration class for Tool-Call from non-injection by default to injection by default.

* feat: add test unit class (amap, baidu map, baidu search)

* feat: Provide a Constant class for each Tool-Call to store the Bean name, configuration prefix, and environment variable name of each Tool-Call.

* fix: license

* fix: test without api-key

Author: VLSMB

community/tool-calls/README.md

@@ -10,6 +10,8 @@
 * Properties 类命名为：`${name}Properties`，例如：`BaiduSearchProperties`。
 * ToolFunction Impl name 命名为：`${name}Service`，通常是由声明 Bean 注解的方法名确定，如 `baiduSearchService`（建议，请根据插件实际情况确定）
 * ToolFunction bean name 命名为：`${name}`。
+* Constants 类命名为：``。
+* 单元测试类的名称为：``。
 
 2. 使用 **org.springframework.context.annotation.Description** `@Description("xxx")` 注解描述插件的功能，应提供对插件功能清晰明确的描述，例如：`@Description("百度搜索插件，用于查询百度上的新闻事件等信息")`
 3. 如果 Function Impl 实现较为复杂，需要使用一些自定义函数，方法命名规范为：`${name}Tool`，例如：`BaiduSearchTool`, 目录层级和实现类保持一致
@@ -34,15 +36,15 @@ public class BaiduTranslateProperties extends CommonToolCallProperties {
 
 7. 在Function Impl中，JSON的序列化与反序列化统一使用`spring-ai-alibaba-starter-tool-calling-common`模块的`JsonParseTool`对象，common模块自动注入了一个默认的Bean，如果有特殊需求也可以自定义`objectMapper`，在`AutoConfiguration`中覆盖原有的`JsonParseTool`的Bean。
 HTTP请求统一使用common模块的`RestClientTool`或者`WebClientTool`的对象，该类有`builder`方法，必要`CommonToolCallProperties`和`JsonParseTool`对象，根据需要也可以自定义其他对象。
-8. Auto Configuration 类中，应该声明一个Function Impl的Bean，供用户使用，例如：
+8. Auto Configuration 类中，应该声明一个Function Impl的Bean，供用户使用，且 Bean 的名称应该在对应的 Constants 类给出，常量的名称应为`TOOL_NAME`。例如：
 
 ```java
 @Configuration
 @EnableConfigurationProperties(BaiduTranslateProperties.class)
-@ConditionalOnProperty(prefix = BaiduTranslateProperties.BaiDuTranslatePrefix, name = "enabled", havingValue = "true",
+@ConditionalOnProperty(prefix = BaiduTranslateConstants.CONFIG_PREFIX, name = "enabled", havingValue = "true",
   matchIfMissing = true)
 public class BaiduTranslateAutoConfiguration {
- @Bean
+ @Bean(name = BaiduTranslateConstants.TOOL_NAME)
  @ConditionalOnMissingBean
  @Description("Baidu translation function for general text translation")
  public BaiduTranslateService baiduTranslate(BaiduTranslateProperties properties, JsonParseTool jsonParseTool) {
@@ -53,5 +55,19 @@ public class BaiduTranslateAutoConfiguration {
 }
 ```
 
+如果该插件有多个 ToolFunction Bean，Constants 类可以分别定义每个 Bean 名称的常量，但必须以 `_TOOL_NAME` 结尾，比如`GET_ADDRESS_TOOL_NAME`。
+
 9. 对于多个模块可能共用的方法，应该写到common模块的`CommonToolCallUtils`类中。对于多个模块可能共用的常量，应该写到common模块的`CommonToolCallConstants`中。
-10. 可以参考`baidumap`、`baidutranslate`、`baidusearch`这些已经应用上述规则的代码。
+10. 对于 Properties 类中需要用户隐私的信息（比如 API Key），需要在 Constants 类定义一个环境变量名词，并在 Properties 类的构造方法中读取系统环境变量的值，例如：
+
+```java
+// BaiduTranslateConstants
+public static final String SECRET_KEY_ENV = "BAIDU_TRANSLATE_SECRET_KEY";
+
+// BaiduTranslateProperties
+public BaiduTranslateProperties() {
+ this.secretKey = System.getenv(SECRET_KEY_ENV);
+}
+```
+
+11. 每一个插件都需要编写单元测试类。对于需要用户隐私的信息（比如 API Key）的插件，可以在测试方法上标注 `@EnabledIfEnvironmentVariable(named = XXXConstants.API_KEY_ENV, matches = CommonToolCallConstants.NOT_BLANK_REGEX)` 注解，保证自己本地能够通过单元测试。

community/tool-calls/spring-ai-alibaba-starter-tool-calling-alitranslate/pom.xml

@@ -63,6 +63,18 @@
             <version>1.0.3</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
     </dependencies>
 
 </project>

community/tool-calls/spring-ai-alibaba-starter-tool-calling-alitranslate/src/main/java/com/alibaba/cloud/ai/toolcalling/alitranslate/AliTranslateAutoConfiguration.java

@@ -29,10 +29,11 @@
 @Configuration
 @ConditionalOnClass(AliTranslateService.class)
 @EnableConfigurationProperties(AliTranslateProperties.class)
-@ConditionalOnProperty(prefix = AliTranslateProperties.PREFIX, name = "enabled", havingValue = "true")
+@ConditionalOnProperty(prefix = AliTranslateConstants.CONFIG_PREFIX, name = "enabled", havingValue = "true",
+		matchIfMissing = true)
 public class AliTranslateAutoConfiguration {
 
-	@Bean(destroyMethod = "close")
+	@Bean(name = AliTranslateConstants.TOOL_NAME, destroyMethod = "close")
 	@ConditionalOnMissingBean
 	@Description("Implement natural language translation capabilities.")
 	public AliTranslateService aliTranslateService(AliTranslateProperties properties) {

community/tool-calls/spring-ai-alibaba-starter-tool-calling-alitranslate/src/main/java/com/alibaba/cloud/ai/toolcalling/alitranslate/AliTranslateConstants.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.cloud.ai.toolcalling.alitranslate;
+
+import com.alibaba.cloud.ai.toolcalling.common.CommonToolCallConstants;
+
+/**
+ * @author vlsmb
+ */
+public final class AliTranslateConstants {
+
+	public static final String CONFIG_PREFIX = CommonToolCallConstants.TOOL_CALLING_CONFIG_PREFIX + ".alitranslate";
+
+	public static final String ACCESS_KEY_SECRET_ENV = "ALITRANSLATE_ACCESS_KEY_SECRET";
+
+	public static final String ACCESS_KEY_ID_ENV = "ALITRANSLATE_ACCESS_KEY_ID";
+
+	public static final String TOOL_NAME = "aliTranslateService";
+
+	/**
+	 * version of the api
+	 */
+	public static final String SCENE = "general";
+
+	/**
+	 * FormatType text or html
+	 */
+	public static final String FORM_TYPE = "text";
+
+	/**
+	 * offline doc:
+	 * https://help.aliyun.com/zh/machine-translation/support/supported-languages-and-codes?spm=api-workbench.api_explorer.0.0.37a94eecsclZw9
+	 */
+	public static final String LANGUAGE_CODE_ZH = "zh";
+
+	public static final String LANGUAGE_CODE_EN = "en";
+
+}

community/tool-calls/spring-ai-alibaba-starter-tool-calling-alitranslate/src/main/java/com/alibaba/cloud/ai/toolcalling/alitranslate/AliTranslateProperties.java

@@ -15,58 +15,24 @@
  */
 package com.alibaba.cloud.ai.toolcalling.alitranslate;
 
-import com.alibaba.cloud.ai.toolcalling.common.CommonToolCallConstants;
 import com.alibaba.cloud.ai.toolcalling.common.CommonToolCallProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.util.StringUtils;
 
 /**
- * <p>
  * Aliyun Translation Service Configuration Attributes Class
- * </p>
- * Fields that must be configured:<br>
- * - Aliyun accessKeyId: Set {@link #setAccessKeyId(String)} or the environment variable
- * {@code ALITRANSLATE_ACCESS_KEY_ID}.<br>
- * - Aliyun accessKeySecret: Set {@link #setSecretKey(String)} or the environment variable
- * {@code ALITRANSLATE_ACCESS_KEY_SECRET}.<br>
  *
- * @author yunlong
  * @author Allen Hu
  */
-@ConfigurationProperties(prefix = AliTranslateProperties.PREFIX)
+@ConfigurationProperties(prefix = AliTranslateConstants.CONFIG_PREFIX)
 public class AliTranslateProperties extends CommonToolCallProperties {
 
-	public static final String PREFIX = CommonToolCallConstants.TOOL_CALLING_CONFIG_PREFIX + ".alitranslate";
-
-	private String region;
-
 	public AliTranslateProperties() {
-		this.setPropertiesFromEnv(null, "ALITRANSLATE_ACCESS_KEY_SECRET", null, null);
-		String accessKeyIdEnv = "ALITRANSLATE_ACCESS_KEY_ID";
+		this.setPropertiesFromEnv(null, AliTranslateConstants.ACCESS_KEY_SECRET_ENV, null, null);
+		String accessKeyIdEnv = AliTranslateConstants.ACCESS_KEY_ID_ENV;
 		if (!StringUtils.hasText(this.getAccessKeyId())) {
 			this.setAccessKeyId(System.getenv(accessKeyIdEnv));
 		}
 	}
 
-	public String getAccessKeySecret() {
-		return getSecretKey();
-	}
-
-	/**
-	 * @param accessKeySecret AccessKeySecret
-	 * @deprecated use {@link #setSecretKey(String)} instead
-	 */
-	@Deprecated
-	public void setAccessKeySecret(String accessKeySecret) {
-		this.setSecretKey(accessKeySecret);
-	}
-
-	public String getRegion() {
-		return region;
-	}
-
-	public void setRegion(String region) {
-		this.region = region;
-	}
-
 }

community/tool-calls/spring-ai-alibaba-starter-tool-calling-alitranslate/src/main/java/com/alibaba/cloud/ai/toolcalling/alitranslate/AliTranslateService.java

@@ -45,35 +45,13 @@ public class AliTranslateService
 
 	private final AsyncClient client;
 
-	/**
-	 * version of the api
-	 */
-	public static final String SCENE = "general";
-
-	/**
-	 * FormatType text or html
-	 */
-	public static final String FORM_TYPE = "text";
-
-	/**
-	 * offline doc:
-	 * https://help.aliyun.com/zh/machine-translation/support/supported-languages-and-codes?spm=api-workbench.api_explorer.0.0.37a94eecsclZw9
-	 */
-	public static final String LANGUAGE_CODE_ZH = "zh";
-
-	public static final String LANGUAGE_CODE_EN = "en";
-
 	public AliTranslateService(AliTranslateProperties properties) {
-		assert StringUtils.hasText(properties.getRegion());
-		assert StringUtils.hasText(properties.getAccessKeyId());
-		assert StringUtils.hasText(properties.getAccessKeySecret());
 		StaticCredentialProvider provider = StaticCredentialProvider.create(Credential.builder()
 			.accessKeyId(properties.getAccessKeyId())
-			.accessKeySecret(properties.getAccessKeySecret())
+			.accessKeySecret(properties.getSecretKey())
 			.build());
 
 		this.client = AsyncClient.builder()
-			.region(properties.getRegion()) // Region ID
 			.credentialsProvider(provider)
 			.overrideConfiguration(ClientOverrideConfiguration.create().setEndpointOverride("mt.aliyuncs.com"))
 			.build();
@@ -87,11 +65,11 @@ public Response apply(Request request) {
 		}
 
 		TranslateGeneralRequest translateGeneralRequest = TranslateGeneralRequest.builder()
-			.formatType(FORM_TYPE)
+			.formatType(AliTranslateConstants.FORM_TYPE)
 			.sourceLanguage(request.sourceLanguage)
 			.targetLanguage(request.targetLanguage)
 			.sourceText(request.text)
-			.scene(SCENE)
+			.scene(AliTranslateConstants.SCENE)
 			.build();
 
 		CompletableFuture<TranslateGeneralResponse> response = client.translateGeneral(translateGeneralRequest);
@@ -145,7 +123,7 @@ public record Request(
 					value = "targetLanguage") @JsonPropertyDescription("Target language to alitranslate into, default is en") String targetLanguage) {
 
 		public Request(@JsonProperty("text") String text) {
-			this(text, LANGUAGE_CODE_ZH, LANGUAGE_CODE_EN);
+			this(text, AliTranslateConstants.LANGUAGE_CODE_ZH, AliTranslateConstants.LANGUAGE_CODE_EN);
 		}
 	}
 

community/tool-calls/spring-ai-alibaba-starter-tool-calling-alitranslate/src/test/java/com/alibaba/cloud/ai/toolcalling/alitranslate/AliTranslateTest.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.cloud.ai.toolcalling.alitranslate;
+
+import com.alibaba.cloud.ai.toolcalling.common.CommonToolCallAutoConfiguration;
+import com.alibaba.cloud.ai.toolcalling.common.CommonToolCallConstants;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.util.StringUtils;
+
+/**
+ * @author vlsmb
+ */
+@SpringBootTest(classes = { AliTranslateAutoConfiguration.class, CommonToolCallAutoConfiguration.class })
+@DisplayName("ALiTranslate Service Test")
+public class AliTranslateTest {
+
+	@Autowired
+	private AliTranslateService aliTranslateService;
+
+	private static final Logger log = LoggerFactory.getLogger(AliTranslateTest.class);
+
+	@Test
+	@DisplayName("Tool-Calling Test")
+	@EnabledIfEnvironmentVariable(named = AliTranslateConstants.ACCESS_KEY_SECRET_ENV,
+			matches = CommonToolCallConstants.NOT_BLANK_REGEX)
+	@EnabledIfEnvironmentVariable(named = AliTranslateConstants.ACCESS_KEY_ID_ENV,
+			matches = CommonToolCallConstants.NOT_BLANK_REGEX)
+	public void testAliTranslate() {
+		AliTranslateService.Response resp = aliTranslateService.apply(new AliTranslateService.Request("你好"));
+		log.info("Ali Translate Service Response: {}", resp);
+		assert resp != null && StringUtils.hasText(resp.translatedTexts());
+	}
+
+}

community/tool-calls/spring-ai-alibaba-starter-tool-calling-amap/pom.xml

@@ -58,6 +58,18 @@
             <version>${project.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
     </dependencies>
 
 </project>

community/tool-calls/spring-ai-alibaba-starter-tool-calling-amap/src/main/java/com/alibaba/cloud/ai/toolcalling/amp/AmapAutoConfiguration.java

@@ -29,10 +29,11 @@
  */
 @Configuration
 @EnableConfigurationProperties(AmapProperties.class)
-@ConditionalOnProperty(prefix = AmapProperties.AMAP_PREFIX, name = "enabled", havingValue = "true")
+@ConditionalOnProperty(prefix = AmapConstants.CONFIG_PREFIX, name = "enabled", havingValue = "true",
+		matchIfMissing = true)
 public class AmapAutoConfiguration {
 
-	@Bean
+	@Bean(name = AmapConstants.TOOL_NAME)
 	@ConditionalOnMissingBean
 	@Description("Get weather information according to address from Amap.")
 	public WeatherSearchService gaoDeGetAddressWeather(JsonParseTool jsonParseTool, AmapProperties amapProperties) {

community/tool-calls/spring-ai-alibaba-starter-tool-calling-amap/src/main/java/com/alibaba/cloud/ai/toolcalling/amp/AmapConstants.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.alibaba.cloud.ai.toolcalling.amp;
+
+import static com.alibaba.cloud.ai.toolcalling.common.CommonToolCallConstants.TOOL_CALLING_CONFIG_PREFIX;
+
+/**
+ * @author vlsmb
+ */
+public final class AmapConstants {
+
+	public static final String CONFIG_PREFIX = TOOL_CALLING_CONFIG_PREFIX + ".amap";
+
+	public static final String API_KEY_ENV = "GAODE_AMAP_API_KEY";
+
+	public static final String TOOL_NAME = "gaoDeGetAddressWeather";
+
+}