Enforcer plugin config for optional dependency and replicate import test for spring-ai

- sample app ignored from ban

Author: rpanackal

foundation-models/openai/pom.xml

@@ -89,6 +89,11 @@
       <groupId>com.google.guava</groupId>
       <artifactId>guava</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.ai</groupId>
+      <artifactId>spring-ai-core</artifactId>
+      <optional>true</optional>
+    </dependency>
     <!-- scope "provided" -->
     <dependency>
       <groupId>org.projectlombok</groupId>
@@ -122,8 +127,9 @@
       <scope>test</scope>
     </dependency>
     <dependency>
-      <groupId>org.springframework.ai</groupId>
-      <artifactId>spring-ai-core</artifactId>
+      <groupId>com.github.javaparser</groupId>
+      <artifactId>javaparser-core</artifactId>
+      <scope>test</scope>
     </dependency>
   </dependencies>
 </project>

foundation-models/openai/src/test/java/com/sap/ai/sdk/foundationmodels/openai/spring/ImportCheckTest.java

@@ -0,0 +1,65 @@
+package com.sap.ai.sdk.foundationmodels.openai.spring;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import com.github.javaparser.JavaParser;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import lombok.val;
+import org.junit.jupiter.api.Test;
+
+class ImportCheckTest {
+
+  private static final JavaParser PARSER = new JavaParser();
+
+  @Test
+  void testSpringAIOptional() throws IOException {
+    String springAI = "org.springframework.ai";
+    checkImports("com/sap/ai/sdk/foundationmodels/openai", springAI, false);
+    checkImports("com/sap/ai/sdk/foundationmodels/openai/spring", springAI, true);
+  }
+
+  private void checkImports(String packagePath, String imports, boolean shouldContain)
+      throws IOException {
+    List<File> javaFiles = getJavaFiles(packagePath);
+
+    boolean hasImport = false;
+    for (File file : javaFiles) {
+      val result = PARSER.parse(file).getResult();
+      assertThat(result).isPresent();
+
+      hasImport =
+          hasImport
+              || result.get().getImports().stream()
+                  .anyMatch(importDecl -> importDecl.getNameAsString().startsWith(imports));
+
+      if (!shouldContain) {
+        assertFalse(
+            hasImport, "File " + file.getName() + " contains a prohibited import: " + imports);
+      }
+    }
+
+    if (shouldContain) {
+      assertTrue(hasImport, "OpenAI Spring should contain Spring AI imports");
+    }
+  }
+
+  private List<File> getJavaFiles(String packagePath) throws IOException {
+    Path openAiPackage = Paths.get("src/main/java", packagePath);
+    try (Stream<Path> files = Files.list(openAiPackage)) {
+      return files
+          .filter(Files::isRegularFile)
+          .map(Path::toFile)
+          .filter(file -> file.getName().endsWith(".java"))
+          .collect(Collectors.toList());
+    }
+  }
+}

pom.xml

@@ -438,8 +438,11 @@
               <rules>
                 <bannedDependencies>
                   <message>Spring AI dependencies should be optional</message>
+                  <excludes>
+                    <exclude>org.springframework.ai:*</exclude>
+                  </excludes>
                   <includes>
-                    <include>org.springframework.ai:*</include>
+                    <include>com.sap.ai.sdk.app:*</include>
                   </includes>
                 </bannedDependencies>
               </rules>

sample-code/spring-app/pom.xml

@@ -41,6 +41,7 @@
     <!-- Allow logging frameworks because this module is not released -->
     <enforcer.skipBanLoggingFrameworks>true</enforcer.skipBanLoggingFrameworks>
     <enforcer.skipEnforceScopeLoggerBridges>true</enforcer.skipEnforceScopeLoggerBridges>
+    <enforcer.enforce-spring-ai-optional>false</enforcer.enforce-spring-ai-optional>
   </properties>
 
   <dependencies>
@@ -214,6 +215,16 @@
           <skipAddThirdParty>true</skipAddThirdParty>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-enforcer-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>enforce-spring-ai-optional</id>
+            <phase>none</phase>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 </project>