Check for dependency on AppEngineDriver (closes #207, wip #237)

Author: fabapp2

components/sbm-core/src/main/java/org/springframework/sbm/java/api/ProjectJavaSources.java

@@ -50,4 +50,6 @@ public interface ProjectJavaSources {
     List<MethodCall> findMethodCalls(String pattern);
 
     List<JavaSourceAndType> findTypesImplementing(String jpaRepositoryInterface);
+
+    List<? extends JavaSource> findClassesUsingType(String databaseDriverGAE);
 }

components/sbm-core/src/main/java/org/springframework/sbm/java/impl/ProjectJavaSourcesImpl.java

@@ -16,10 +16,13 @@
 package org.springframework.sbm.java.impl;
 
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.exception.ExceptionContext;
+import org.openrewrite.ExecutionContext;
 import org.openrewrite.Recipe;
 import org.openrewrite.java.ChangeType;
 import org.openrewrite.java.MethodMatcher;
 import org.openrewrite.java.search.FindMethods;
+import org.openrewrite.java.search.UsesType;
 import org.openrewrite.java.tree.J;
 import org.openrewrite.java.tree.JavaType;
 import org.openrewrite.java.tree.TypeUtils;
@@ -28,10 +31,12 @@
 import org.springframework.sbm.java.refactoring.JavaGlobalRefactoring;
 import org.springframework.sbm.project.resource.ProjectResourceSet;
 import org.springframework.sbm.project.resource.RewriteSourceFileHolder;
+import org.springframework.sbm.support.openrewrite.GenericOpenRewriteRecipe;
 
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 @Slf4j
@@ -119,6 +124,18 @@ public List<JavaSourceAndType> findTypesImplementing(String type) {
         return matches;
     }
 
+    @Override
+    public List<? extends JavaSource> findClassesUsingType(String fqName) {
+        UsesType<ExecutionContext> usesType = new UsesType<>(fqName);
+        GenericOpenRewriteRecipe<UsesType<ExecutionContext>> recipe = new GenericOpenRewriteRecipe<>(() -> usesType);
+        return find(recipe).stream()
+                .filter(RewriteSourceFileHolder.class::isInstance)
+                .map(RewriteSourceFileHolder.class::cast)
+                .filter(r -> r.getType().isAssignableFrom(J.CompilationUnit.class))
+                .map(r -> (OpenRewriteJavaSource)r)
+                .collect(Collectors.toList());
+    }
+
     private boolean hasTypeImplementing(J.ClassDeclaration c, String type) {
         try {
             return c.getImplements() != null &&

components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/Sbu30_PreconditionCheck.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2021 - 2022 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 org.springframework.sbm.boot.upgrade_27_30;
+
+import org.springframework.sbm.engine.context.ProjectContext;
+
+public interface Sbu30_PreconditionCheck {
+    Sbu30_PreconditionCheckResult run(ProjectContext context);
+}

components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/Sbu30_PreconditionCheckResult.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 - 2022 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 org.springframework.sbm.boot.upgrade_27_30;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.springframework.sbm.engine.precondition.PreconditionCheck;
+
+@Getter
+@RequiredArgsConstructor
+public class Sbu30_PreconditionCheckResult {
+    private final PreconditionCheck.ResultState state;
+    private final String message;
+}

components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/Sbu30_PreconditionChecks.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2021 - 2022 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 org.springframework.sbm.boot.upgrade_27_30;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.precondition.PreconditionCheck;
+import org.springframework.sbm.engine.recipe.AbstractAction;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class Sbu30_PreconditionChecks extends AbstractAction {
+
+    @Autowired
+    @JsonIgnore
+    private List<Sbu30_PreconditionCheck> checks = new ArrayList<>();
+
+    @Override
+    public void apply(ProjectContext context) {
+        List<Sbu30_PreconditionCheckResult> results = checks.stream()
+                .map(sbu30_preconditionCheck -> sbu30_preconditionCheck.run(context))
+                .collect(Collectors.toList());
+
+        results.forEach(this::render);
+
+        if(results.stream().anyMatch(c -> c.getState().equals(PreconditionCheck.ResultState.FAILED))) {
+            // TODO: ask user to proceed, fail/end otherwise
+        }
+
+    }
+
+    private void render(Sbu30_PreconditionCheckResult result) {
+        System.out.println(result.getMessage());
+    }
+}

components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/checks/DatabaseDriverGaeCheck.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2021 - 2022 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 org.springframework.sbm.boot.upgrade_27_30.checks;
+
+import org.openrewrite.java.tree.JavaType;
+import org.springframework.sbm.boot.upgrade_27_30.Sbu30_PreconditionCheck;
+import org.springframework.sbm.boot.upgrade_27_30.Sbu30_PreconditionCheckResult;
+import org.springframework.sbm.build.api.ApplicationModule;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.precondition.PreconditionCheck;
+import org.springframework.sbm.java.api.JavaSource;
+import org.springframework.sbm.java.impl.OpenRewriteJavaSource;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+@Component
+public class DatabaseDriverGaeCheck implements Sbu30_PreconditionCheck {
+
+    @Override
+    public Sbu30_PreconditionCheckResult run(ProjectContext context) {
+
+        Set<ApplicationModule> collect = context.getApplicationModules()
+                .stream()
+                .filter(this::hasClassAppEngineDriverOnClasspath)
+                .collect(Collectors.toSet());
+
+        if(collect.isEmpty()) {
+            return  new Sbu30_PreconditionCheckResult(PreconditionCheck.ResultState.PASSED, "No dependency to Google AppEngine's AppEngineDriver found.");
+        } else {
+            String message = "Dependencies containing 'com.google.appengine.api.rdbms.AppEngineDriver' were found in these modules: '" + collect.stream().map(m -> m.getBuildFile().getCoordinates()).collect(Collectors.joining("', '")) + "'";
+            return new Sbu30_PreconditionCheckResult(PreconditionCheck.ResultState.FAILED, message);
+        }
+    }
+
+    private boolean hasClassAppEngineDriverOnClasspath(ApplicationModule m) {
+        return Stream.concat(m.getTestJavaSourceSet().stream(), m.getMainJavaSourceSet().stream())
+                .anyMatch(js -> {
+                    if (dependsOn(js, "com.google.appengine.api.rdbms.AppEngineDriver")) {
+                        return true;
+                    } else {
+                        return false;
+                    }
+                });
+    }
+
+    private boolean dependsOn(JavaSource js, String s) {
+        if (OpenRewriteJavaSource.class.isInstance(js)) {
+            OpenRewriteJavaSource javaSource = OpenRewriteJavaSource.class.cast(js);
+            return javaSource.getSourceFile().getMarkers().findFirst(org.openrewrite.java.marker.JavaSourceSet.class).get()
+                    .getClasspath()
+                    .stream()
+                    .map(JavaType.FullyQualified::getFullyQualifiedName)
+                    .anyMatch(fq -> s.equals(fq));
+        }
+        return false;
+    }
+}

components/sbm-recipes-boot-upgrade/src/main/resources/recipes/boot-2.7-3.0-dependency-version-update.yaml

@@ -2,9 +2,14 @@
   description: Bump spring-boot-starter-parent from 2.7.x to 3.0.0-M3
   condition:
     type: org.springframework.sbm.boot.common.conditions.HasSpringBootStarterParent
+#    TODO: pattern should also allow 3.0.* as it can't be re-run otherwise agfter bumping the version to 3.0.0
     versionPattern: "2\\.7\\..*"
 
   actions:
+    - type: org.springframework.sbm.boot.upgrade_27_30.Sbu30_PreconditionChecks
+      description: "Check if the application adheres to preconditions."
+      condition:
+        type: org.springframework.sbm.common.migration.conditions.TrueCondition
 
       # TODO: upgrades for 2.7
     - type: org.springframework.sbm.build.migration.actions.AddRepositoryAction
@@ -22,12 +27,13 @@
         type: org.springframework.sbm.boot.upgrade.common.conditions.HasSpringBootParentOfVersion
         versionStartingWith: "2.7."
       description: Add Spring Milestone Repository and bump parent pom to 3.0.0-M3
+      # TODO: remove TEST in name
       openRewriteRecipe: |-
         type: specs.openrewrite.org/v1beta/recipe
         name: org.openrewrite.java.spring.boot3.data.TEST
         displayName: Upgrade to Spring Data 3.0
         description: 'Upgrade to Spring Data to 3.0 from any prior version.'
-        recipeList:
+        recipeList: 
           - org.openrewrite.maven.UpgradeParentVersion:
               groupId: org.springframework.boot
               artifactId: spring-boot-starter-parent

components/sbm-recipes-boot-upgrade/src/test/java/org/springframework/sbm/boot/upgrade_27_30/checks/DatabaseDriverGaeCheckTest.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2021 - 2022 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 org.springframework.sbm.boot.upgrade_27_30.checks;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.sbm.boot.upgrade_27_30.Sbu30_PreconditionCheckResult;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.precondition.PreconditionCheck;
+import org.springframework.sbm.project.resource.TestProjectContext;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class DatabaseDriverGaeCheckTest {
+
+    @Test
+    void checkShouldFailWhenAppEngineDriverIsFoundOnClasspath() {
+
+        String javaClass =
+                "import org.springframework.boot.jdbc.DatabaseDriver;\n" +
+                        "\n" +
+                        "public class Foo {\n" +
+                        "    public Foo() {\n" +
+                        "        DatabaseDriver driver = DatabaseDriver.GAE;\n" +
+                        "        com.google.appengine.api.rdbms.AppEngineDriver d;" +
+                        "    }\n" +
+                        "}";
+
+        ProjectContext context = TestProjectContext.buildProjectContext()
+                .withBuildFileHavingDependencies("org.springframework.boot:spring-boot:2.7.1", "com.google.appengine:appengine-api-1.0-sdk:1.9.17")
+                .addJavaSource("src/main/java", javaClass)
+                .build();
+
+        Sbu30_PreconditionCheckResult result = new DatabaseDriverGaeCheck().run(context);
+
+        assertThat(result.getState()).isEqualTo(PreconditionCheck.ResultState.FAILED);
+        assertThat(result.getMessage()).isEqualTo("Dependencies containing 'com.google.appengine.api.rdbms.AppEngineDriver' were found in these modules: 'com.example:dummy-root:0.1.0-SNAPSHOT'");
+
+    }
+}