feat: Enhance Spring Boot AI template

Author: ThomasVitale

app-config.yaml

@@ -13,6 +13,7 @@ backend:
     # host: 127.0.0.1
   csp:
     connect-src: ["'self'", 'http:', 'https:']
+    img-src: ["'self'", 'data:', 'https:', 'https://avatars.githubusercontent.com']
     # Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
     # Default Helmet Content-Security-Policy values can be removed by setting the key to false
   cors:

demo-catalog/templates/spring-boot-ai-rag/base/.github/workflows/commit-stage.yml

@@ -35,14 +35,14 @@ jobs:
       security-events: write
     steps:
       - name: Check out source code
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
 
       - name: Set up Java
         uses: actions/setup-java@b36c23c0d998641eff861008f374ee103c25ac73 # v4.4.0
         with:
-          java-version: 22
+          java-version: 23
           distribution: 'graalvm'
 
       - name: Setup Gradle
@@ -53,20 +53,17 @@ jobs:
         env:
           SONAR_TOKEN: ${{ '${{ secrets.SONAR_TOKEN }}' }}
 
-      - name: SBOM vulnerability scanning
-        uses: aquasecurity/trivy-action@97646fedde05bcd0961217c60b50e23f721e7ec7 # master
+      - name: Publish SBOM
+        uses: DependencyTrack/gh-upload-sbom@48feab3080ff9e8f51f4d21861d9fc914eb744f5 # v3.1.0
+        if: ${{ '${{ !contains(github.ref_name, '/') }}' }}
         with:
-          scan-type: 'sbom'
-          scan-ref: 'build/reports/application.cdx.json'
-          format: 'sarif'
-          output: 'trivy-results-build.sarif'
-
-      - name: Upload vulnerability report
-        uses: github/codeql-action/upload-sarif@461ef6c76dfe95d5c364de2f431ddbd31a417628 # v3.26.9
-        if: success() || failure()
-        with:
-          sarif_file: 'trivy-results-build.sarif'
-          category: build
+          serverHostname: ${{ '${{ secrets.DEPENDENCY_TRACK_HOSTNAME }}' }}
+          apiKey: ${{ '${{ secrets.DEPENDENCY_TRACK_API_KEY }}' }}
+          projectName: ${{ '${{ github.event.repository.name }}' }}
+          projectVersion: ${{ '${{ github.ref_name }}' }}
+          projectTags: 'java,spring-boot'
+          bomFilename: "build/reports/application.cdx.json"
+          autoCreate: true
 
       - name: Package as OCI image
         run: ./gradlew bootBuildImage --imageName ${{ '${{ env.REGISTRY }}' }}/${{ '${{ env.IMAGE_NAME }}' }}:${{ '${{ env.VERSION }}' }}

demo-catalog/templates/spring-boot-ai-rag/base/.sdkmanrc

@@ -3,4 +3,4 @@
 # See https://sdkman.io/usage#config
 # A summary is to add the following to ~/.sdkman/etc/config
 # sdkman_auto_env=true
-java=22-graalce
+java=23-graalce

demo-catalog/templates/spring-boot-ai-rag/base/README.md

@@ -19,11 +19,11 @@ LLM-powered application with RAG capabilities.
 This example uses [httpie](https://httpie.io) to send HTTP requests.
 
 ```shell
-http --raw "Who is the lead singer?" :8080/chat
+http --raw "Who is the lead singer?" :8080/chat -b --pretty none
 ```
 
 ```shell
-http --raw "What instrument does Clara play" :8080/chat
+http --raw "What instrument does Clara play" :8080/chat -b --pretty none
 ```
 
 ## 🖊️  License

demo-catalog/templates/spring-boot-ai-rag/base/build.gradle

@@ -3,15 +3,15 @@ plugins {
 	id 'org.springframework.boot' version '3.4.0-M3'
 	id 'io.spring.dependency-management' version '1.1.6'
 	id 'org.cyclonedx.bom' version '1.10.0'
-	id 'org.sonarqube' version '4.4.1.3373'
+	id 'org.sonarqube' version '5.1.0.4882'
 }
 
 group = '${{ values.groupId }}'
 version = '0.0.1-SNAPSHOT'
 
 java {
 	toolchain {
-		languageVersion = JavaLanguageVersion.of(22)
+		languageVersion = JavaLanguageVersion.of(23)
 	}
 }
 
@@ -26,7 +26,8 @@ repositories {
 }
 
 ext {
-	set('springAiVersion', "1.0.0-M2")
+	set('otelInstrumentationVersion', "2.9.0-alpha")
+	set('springAiVersion', "1.0.0-SNAPSHOT")
 }
 
 dependencies {
@@ -36,43 +37,45 @@ dependencies {
 	implementation 'io.micrometer:micrometer-tracing-bridge-otel'
 	implementation 'io.opentelemetry:opentelemetry-exporter-otlp'
 	implementation 'io.micrometer:micrometer-registry-otlp'
+	implementation 'io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0'
 
 	{% if values.llmProvider == "mistral-ai" %}
 	implementation 'org.springframework.ai:spring-ai-mistral-ai-spring-boot-starter'
-	{% endif %}
+	{%- endif %}
 	{% if values.llmProvider == "ollama" %}
 	implementation 'org.springframework.ai:spring-ai-ollama-spring-boot-starter'
 	testImplementation 'org.testcontainers:ollama'
-	{% endif %}
+	{%- endif %}
 	{% if values.llmProvider == "openai" %}
 	implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
-	{% endif %}
+	{%- endif %}
 	{% if values.vectorStore == "chroma" %}
 	implementation 'org.springframework.ai:spring-ai-chroma-store-spring-boot-starter'
 	testImplementation 'org.testcontainers:chromadb'
-	{% endif %}
+	{%- endif %}
 	{% if values.vectorStore == "postgresql" %}
 	implementation 'org.springframework.ai:spring-ai-pgvector-store-spring-boot-starter'
 	testImplementation 'org.testcontainers:postgresql'
-	{% endif %}
+	{%- endif %}
 	{% if values.vectorStore == "weaviate" %}
 	implementation 'org.springframework.ai:spring-ai-weaviate-store-spring-boot-starter'
 	testImplementation 'org.testcontainers:weaviate'
-	{% endif %}
+	{%- endif %}
 	implementation "org.springframework.ai:spring-ai-spring-cloud-bindings"
 
 	testAndDevelopmentOnly 'org.springframework.boot:spring-boot-devtools'
 
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testImplementation 'org.springframework.boot:spring-boot-testcontainers'
 	testImplementation 'org.springframework.ai:spring-ai-spring-boot-testcontainers'
-	testImplementation 'org.testcontainers:junit-jupiter'
+	testImplementation 'org.springframework:spring-webflux'
 	testImplementation 'org.testcontainers:grafana'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }
 
 dependencyManagement {
 	imports {
+		mavenBom "io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha:${otelInstrumentationVersion}"
 		mavenBom "org.springframework.ai:spring-ai-bom:${springAiVersion}"
 	}
 }
@@ -82,8 +85,7 @@ tasks.named('test') {
 }
 
 tasks.named('bootBuildImage') {
-	builder = "paketobuildpacks/builder-jammy-buildpackless-tiny"
-	buildpacks = [ "gcr.io/paketo-buildpacks/java" ]
+	builder = "paketobuildpacks/builder-noble-java-tiny"
 }
 
 sonar {

demo-catalog/templates/spring-boot-ai-rag/base/src/main/java/${{values.basePackageDir}}/Application.java

@@ -1,5 +1,7 @@
 package ${{ values.basePackage }};
 
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender;
 import jakarta.annotation.PostConstruct;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -11,9 +13,11 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
 import org.springframework.boot.web.client.ClientHttpRequestFactories;
 import org.springframework.boot.web.client.ClientHttpRequestFactorySettings;
 import org.springframework.boot.web.client.RestClientCustomizer;
+import org.springframework.context.ApplicationListener;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.io.Resource;
@@ -32,11 +36,18 @@ public static void main(String[] args) {
 		SpringApplication.run(Application.class, args);
 	}
 
+	@Bean
+	ApplicationListener<ApplicationReadyEvent> logbackOtelAppenderInitializer(OpenTelemetry openTelemetry) {
+		return _ -> OpenTelemetryAppender.install(openTelemetry);
+	}
+
 }
 
 @RestController
 class ChatController {
 
+	private static final Logger logger = LoggerFactory.getLogger(ChatController.class);
+
 	private final ChatClient chatClient;
 	private final VectorStore vectorStore;
 
@@ -47,6 +58,7 @@ class ChatController {
 
 	@PostMapping("/chat")
 	String chatWithDocument(@RequestBody String message) {
+		logger.info("Received user message: {}", message);
 		return chatClient.prompt()
 				.advisors(new QuestionAnswerAdvisor(vectorStore))
 				.user(message)

demo-catalog/templates/spring-boot-ai-rag/base/src/main/resources/application.yml

@@ -21,9 +21,11 @@ spring:
     {%- endif %}
     {%- if values.llmProvider == "ollama" %}
     ollama:
+      init:
+        pull-model-strategy: when_missing
       chat:
         options:
-          model: mistral
+          model: llama3.2
           num-ctx: 4096
           temperature: 0.7
       embedding:
@@ -64,3 +66,8 @@ management:
   tracing:
     sampling:
       probability: 1.0
+  otlp:
+    logging:
+      endpoint: "http://localhost:4318/v1/logs"
+    tracing:
+      endpoint: "http://localhost:4318/v1/traces"

demo-catalog/templates/spring-boot-ai-rag/base/src/main/resources/logback-spring.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <include resource="org/springframework/boot/logging/logback/base.xml" />
+
+    <appender name="OpenTelemetry"
+              class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender">
+        <captureExperimentalAttributes>true</captureExperimentalAttributes>
+        <captureCodeAttributes>true</captureCodeAttributes>
+        <captureKeyValuePairAttributes>true</captureKeyValuePairAttributes>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="OpenTelemetry"/>
+    </root>
+
+</configuration>

demo-catalog/templates/spring-boot-ai-rag/base/src/test/java/${{values.basePackageDir}}/ApplicationTests.java

@@ -1,11 +1,11 @@
 package ${{ values.basePackage }};
 
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Import;
 
 @SpringBootTest
-@Disabled
+@Import({IntegrationTestSetup.class, TestcontainersConfiguration.class})
 class ApplicationTests {
 
 	@Test

demo-catalog/templates/spring-boot-ai-rag/base/src/test/java/${{values.basePackageDir}}/IntegrationTestSetup.java

@@ -0,0 +1,24 @@
+package ${{ values.basePackage }};
+
+import org.springframework.boot.devtools.restart.RestartScope;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.context.annotation.Bean;
+{%- if values.llmProvider == "ollama" %}
+import org.testcontainers.ollama.OllamaContainer;
+{%- endif %}
+
+@TestConfiguration(proxyBeanMethods = false)
+public class IntegrationTestSetup {
+
+  {% if values.llmProvider == "ollama" %}
+  @Bean
+  @RestartScope
+  @ServiceConnection
+  OllamaContainer ollama() {
+    return new OllamaContainer("ollama/ollama").withReuse(true);
+  }
+  {%- endif %}
+
+}
+

demo-catalog/templates/spring-boot-ai-rag/base/src/test/java/${{values.basePackageDir}}/TestcontainersConfiguration.java

@@ -4,46 +4,30 @@
 import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
 import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Profile;
 {%- if values.vectorStore == "postgresql" %}
 import org.testcontainers.containers.PostgreSQLContainer;
 {%- endif %}
 import org.testcontainers.grafana.LgtmStackContainer;
-{% if values.llmProvider == "ollama" %}
-import org.testcontainers.ollama.OllamaContainer;
-{%- endif %}
-import org.testcontainers.utility.DockerImageName;
 
 import java.time.Duration;
 
 @TestConfiguration(proxyBeanMethods = false)
 class TestcontainersConfiguration {
 
-	{% if values.llmProvider == "ollama" %}
-	@Bean
-	@RestartScope
-	@ServiceConnection
-	@Profile("ollama-image")
-	OllamaContainer ollama() {
-		return new OllamaContainer(DockerImageName.parse("ghcr.io/thomasvitale/ollama-mistral")
-			.asCompatibleSubstituteFor("ollama/ollama"));
-	}
-	{%- endif %}
-
 	{% if values.vectorStore == "postgresql" %}
 	@Bean
 	@RestartScope
 	@ServiceConnection
 	PostgreSQLContainer<?> postgresContainer() {
-		return new PostgreSQLContainer<>(DockerImageName.parse("pgvector/pgvector:pg16"));
+		return new PostgreSQLContainer<>("pgvector/pgvector:pg17");
 	}
 	{%- endif %}
 
 	@Bean
 	@RestartScope
 	@ServiceConnection
 	LgtmStackContainer lgtmContainer() {
-		return new LgtmStackContainer("grafana/otel-lgtm:0.7.3")
+		return new LgtmStackContainer("grafana/otel-lgtm:0.7.6")
 				.withStartupTimeout(Duration.ofMinutes(2))
 				.withReuse(true);
 	}