Skip to content

test: Add comprehensive test coverage for tool calling observation components #4259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2025
Merged

test: Add comprehensive test coverage for tool calling observation components #4259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions ...org/springframework/ai/tool/observation/DefaultToolCallingObservationConventionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,47 @@ void shouldHaveHighCardinalityKeyValues() {
"{}"));
}

@Test
void shouldHaveAllStandardLowCardinalityKeys() {
ToolCallingObservationContext observationContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("tool").description("Tool").inputSchema("{}").build())
.toolCallArguments("args")
.build();

var lowCardinalityKeys = this.observationConvention.getLowCardinalityKeyValues(observationContext);

// Verify all expected low cardinality keys are present
assertThat(lowCardinalityKeys).extracting(KeyValue::getKey)
.contains(ToolCallingObservationDocumentation.LowCardinalityKeyNames.TOOL_DEFINITION_NAME.asString(),
ToolCallingObservationDocumentation.LowCardinalityKeyNames.AI_OPERATION_TYPE.asString(),
ToolCallingObservationDocumentation.LowCardinalityKeyNames.AI_PROVIDER.asString(),
ToolCallingObservationDocumentation.LowCardinalityKeyNames.SPRING_AI_KIND.asString());
}

@Test
void shouldHandleNullContext() {
assertThat(this.observationConvention.supportsContext(null)).isFalse();
}

@Test
void shouldBeConsistentAcrossMultipleCalls() {
ToolCallingObservationContext observationContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder()
.name("consistentTool")
.description("Consistent description")
.inputSchema("{}")
.build())
.toolCallArguments("args")
.build();

// Call multiple times and verify consistency
String name1 = this.observationConvention.getContextualName(observationContext);
String name2 = this.observationConvention.getContextualName(observationContext);
var lowCard1 = this.observationConvention.getLowCardinalityKeyValues(observationContext);
var lowCard2 = this.observationConvention.getLowCardinalityKeyValues(observationContext);

assertThat(name1).isEqualTo(name2);
assertThat(lowCard1).isEqualTo(lowCard2);
}

}
58 changes: 58 additions & 0 deletions ...ava/org/springframework/ai/tool/observation/ToolCallingContentObservationFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,62 @@ void augmentContextWhenNullResult() {
.isEmpty();
}

@Test
void whenToolCallArgumentsIsEmptyStringThenHighCardinalityKeyValueIsEmpty() {
var originalContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("toolA").description("description").inputSchema("{}").build())
.toolCallArguments("")
.toolCallResult("result")
.build();
var augmentedContext = this.observationFilter.map(originalContext);

assertThat(augmentedContext.getHighCardinalityKeyValues()).contains(KeyValue
.of(ToolCallingObservationDocumentation.HighCardinalityKeyNames.TOOL_CALL_ARGUMENTS.asString(), ""));
assertThat(augmentedContext.getHighCardinalityKeyValues()).contains(KeyValue
.of(ToolCallingObservationDocumentation.HighCardinalityKeyNames.TOOL_CALL_RESULT.asString(), "result"));
}

@Test
void whenToolCallResultIsEmptyStringThenHighCardinalityKeyValueIsEmpty() {
var originalContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("toolA").description("description").inputSchema("{}").build())
.toolCallArguments("input")
.toolCallResult("")
.build();
var augmentedContext = this.observationFilter.map(originalContext);

assertThat(augmentedContext.getHighCardinalityKeyValues()).contains(KeyValue
.of(ToolCallingObservationDocumentation.HighCardinalityKeyNames.TOOL_CALL_ARGUMENTS.asString(), "input"));
assertThat(augmentedContext.getHighCardinalityKeyValues()).contains(KeyValue
.of(ToolCallingObservationDocumentation.HighCardinalityKeyNames.TOOL_CALL_RESULT.asString(), ""));
}

@Test
void whenFilterAppliedMultipleTimesThenIdempotent() {
var originalContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("toolA").description("description").inputSchema("{}").build())
.toolCallArguments("input")
.toolCallResult("result")
.build();

var augmentedOnce = this.observationFilter.map(originalContext);
var augmentedTwice = this.observationFilter.map(augmentedOnce);

// Count occurrences of each key
long argumentsCount = augmentedTwice.getHighCardinalityKeyValues()
.stream()
.filter(kv -> kv.getKey()
.equals(ToolCallingObservationDocumentation.HighCardinalityKeyNames.TOOL_CALL_ARGUMENTS.asString()))
.count();
long resultCount = augmentedTwice.getHighCardinalityKeyValues()
.stream()
.filter(kv -> kv.getKey()
.equals(ToolCallingObservationDocumentation.HighCardinalityKeyNames.TOOL_CALL_RESULT.asString()))
.count();

// Should not duplicate keys
assertThat(argumentsCount).isEqualTo(1);
assertThat(resultCount).isEqualTo(1);
}

}
46 changes: 46 additions & 0 deletions ...test/java/org/springframework/ai/tool/observation/ToolCallingObservationContextTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,50 @@ void whenToolMetadataIsNullThenThrow() {
.build()).isInstanceOf(IllegalArgumentException.class).hasMessageContaining("toolMetadata cannot be null");
}

@Test
void whenToolArgumentsIsEmptyStringThenReturnEmptyString() {
var observationContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("toolA").description("description").inputSchema("{}").build())
.toolCallArguments("")
.build();
assertThat(observationContext).isNotNull();
assertThat(observationContext.getToolCallArguments()).isEqualTo("");
}

@Test
void whenToolCallResultIsNullThenReturnNull() {
var observationContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("toolA").description("description").inputSchema("{}").build())
.toolCallResult(null)
.build();
assertThat(observationContext).isNotNull();
assertThat(observationContext.getToolCallResult()).isNull();
}

@Test
void whenToolCallResultIsEmptyStringThenReturnEmptyString() {
var observationContext = ToolCallingObservationContext.builder()
.toolDefinition(ToolDefinition.builder().name("toolA").description("description").inputSchema("{}").build())
.toolCallResult("")
.build();
assertThat(observationContext).isNotNull();
assertThat(observationContext.getToolCallResult()).isEqualTo("");
}

@Test
void whenToolDefinitionIsSetThenGetReturnsIt() {
var toolDef = ToolDefinition.builder()
.name("testTool")
.description("Test description")
.inputSchema("{\"type\": \"object\"}")
.build();

var observationContext = ToolCallingObservationContext.builder().toolDefinition(toolDef).build();

assertThat(observationContext.getToolDefinition()).isEqualTo(toolDef);
assertThat(observationContext.getToolDefinition().name()).isEqualTo("testTool");
assertThat(observationContext.getToolDefinition().description()).isEqualTo("Test description");
assertThat(observationContext.getToolDefinition().inputSchema()).isEqualTo("{\"type\": \"object\"}");
}

}