Skip to content

Add missing observability tests #3170

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

Closed
wants to merge 1 commit into from
Closed

Add missing observability tests #3170

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
123 changes: 118 additions & 5 deletions ...ework/ai/model/chat/client/autoconfigure/ChatClientObservationAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,20 @@

import io.micrometer.tracing.Tracer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.ai.chat.client.observation.ChatClientObservationContext;
import org.springframework.ai.chat.client.observation.ChatClientPromptContentObservationHandler;
import org.springframework.ai.observation.TracingAwareLoggingObservationHandler;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.FilteredClassLoader;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

/**
* Unit tests for {@link ChatClientAutoConfiguration} observability support.
Expand All @@ -32,22 +40,127 @@
* @author Thomas Vitale
* @author Jonatan Ivanov
*/
@ExtendWith(OutputCaptureExtension.class)
class ChatClientObservationAutoConfigurationTests {

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(ChatClientAutoConfiguration.class));

@Test
void promptContentHandlerDefault() {
this.contextRunner
.run(context -> assertThat(context).doesNotHaveBean(ChatClientPromptContentObservationHandler.class));
void promptContentHandlerNoTracer() {
this.contextRunner.withClassLoader(new FilteredClassLoader(Tracer.class))
.run(context -> assertThat(context).doesNotHaveBean(ChatClientPromptContentObservationHandler.class)
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
}

@Test
void promptContentHandlerWithTracer() {
this.contextRunner.withUserConfiguration(TracerConfiguration.class)
.run(context -> assertThat(context).doesNotHaveBean(ChatClientPromptContentObservationHandler.class)
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
}

@Test
void promptContentHandlerEnabled() {
void promptContentHandlerEnabledNoTracer(CapturedOutput output) {
this.contextRunner.withClassLoader(new FilteredClassLoader(Tracer.class))
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=true")
.run(context -> assertThat(context).hasSingleBean(ChatClientPromptContentObservationHandler.class));
.run(context -> assertThat(context).hasSingleBean(ChatClientPromptContentObservationHandler.class)
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
assertThat(output).contains(
"You have enabled logging out the ChatClient prompt content with the risk of exposing sensitive or private information. Please, be careful!");
}

@Test
void promptContentHandlerEnabledWithTracer(CapturedOutput output) {
this.contextRunner.withUserConfiguration(TracerConfiguration.class)
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=true")
.run(context -> assertThat(context).doesNotHaveBean(ChatClientPromptContentObservationHandler.class)
.hasSingleBean(TracingAwareLoggingObservationHandler.class));
assertThat(output).contains(
"You have enabled logging out the ChatClient prompt content with the risk of exposing sensitive or private information. Please, be careful!");
}

@Test
void promptContentHandlerDisabledNoTracer() {
this.contextRunner.withClassLoader(new FilteredClassLoader(Tracer.class))
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=false")
.run(context -> assertThat(context).doesNotHaveBean(ChatClientPromptContentObservationHandler.class)
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
}

@Test
void promptContentHandlerDisabledWithTracer() {
this.contextRunner.withUserConfiguration(TracerConfiguration.class)
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=false")
.run(context -> assertThat(context).doesNotHaveBean(ChatClientPromptContentObservationHandler.class)
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
}

@Test
void customChatClientPromptContentObservationHandlerNoTracer() {
this.contextRunner.withClassLoader(new FilteredClassLoader(Tracer.class))
.withUserConfiguration(CustomChatClientPromptContentObservationHandlerConfiguration.class)
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=true")
.run(context -> assertThat(context).hasSingleBean(ChatClientPromptContentObservationHandler.class)
.hasBean("customChatClientPromptContentObservationHandler")
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
}

@Test
void customChatClientPromptContentObservationHandlerWithTracer() {
this.contextRunner.withUserConfiguration(TracerConfiguration.class)
.withUserConfiguration(CustomChatClientPromptContentObservationHandlerConfiguration.class)
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=true")
.run(context -> assertThat(context).hasSingleBean(ChatClientPromptContentObservationHandler.class)
.hasBean("customChatClientPromptContentObservationHandler")
.doesNotHaveBean(TracingAwareLoggingObservationHandler.class));
}

@Test
void customTracingAwareLoggingObservationHandler() {
this.contextRunner.withUserConfiguration(TracerConfiguration.class)
.withUserConfiguration(CustomTracingAwareLoggingObservationHandlerConfiguration.class)
.withPropertyValues("spring.ai.chat.client.observations.log-prompt=true")
.run(context -> {
assertThat(context).hasSingleBean(TracingAwareLoggingObservationHandler.class)
.hasBean("chatClientPromptContentObservationHandler")
.doesNotHaveBean(ChatClientPromptContentObservationHandler.class);
assertThat(context.getBean(TracingAwareLoggingObservationHandler.class))
.isSameAs(CustomTracingAwareLoggingObservationHandlerConfiguration.handlerInstance);
});
}

@Configuration(proxyBeanMethods = false)
static class TracerConfiguration {

@Bean
Tracer tracer() {
return mock(Tracer.class);
}

}

@Configuration(proxyBeanMethods = false)
static class CustomChatClientPromptContentObservationHandlerConfiguration {

@Bean
ChatClientPromptContentObservationHandler customChatClientPromptContentObservationHandler() {
return new ChatClientPromptContentObservationHandler();
}

}

@Configuration(proxyBeanMethods = false)
static class CustomTracingAwareLoggingObservationHandlerConfiguration {

static TracingAwareLoggingObservationHandler<ChatClientObservationContext> handlerInstance = new TracingAwareLoggingObservationHandler<>(
new ChatClientPromptContentObservationHandler(), null);

@Bean
TracingAwareLoggingObservationHandler<ChatClientObservationContext> chatClientPromptContentObservationHandler() {
return handlerInstance;
}

}

}
Loading