Reusable Execution Context (#792)

* It removes all programmatically created instances of ExecutionContext in main code.
* The ExecutionContext is now a Spring bean with @ExecutionScope
* execution scope and ends with a successful recipe run
* TestProjectContext uses Spring and components scan now to create the ProjectConetxtInitializer
* A new test helper ActionTest was created which allows testing actions that require the ExecutionContext that is now created together with beans to create a ProjectConetxtInitializer instance
* The execution times of tests might have become even worse as potential too many beans are created when org.springframework.sbm is scanned
* An ArchUnit test was introduced to flag invalid instance creations of any class implementing ExecutionContext.

---------

Co-authored-by: Fabian Krüger <[email protected]>
Co-authored-by: Fabian Krüger <[email protected]>

Author: sanagaraj-pivotal

applications/spring-shell/pom.xml

@@ -124,6 +124,13 @@
             <artifactId>sbm-recipes-boot-upgrade</artifactId>
             <version>0.13.1-SNAPSHOT</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.sbm</groupId>
+            <artifactId>sbm-core</artifactId>
+            <version>${project.version}</version>
+            <classifier>tests</classifier>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

applications/spring-shell/src/test/java/org/springframework/sbm/architecture/FindIllegalExecutionContextCreationsTest.java

@@ -0,0 +1,31 @@
+/*
+ * 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.architecture;
+
+import com.tngtech.archunit.core.importer.ImportOption;
+import com.tngtech.archunit.junit.AnalyzeClasses;
+import com.tngtech.archunit.junit.ArchTest;
+import com.tngtech.archunit.junit.ArchTests;
+
+/**
+ * @author Fabian Krüger
+ */
+@AnalyzeClasses(packages = {"org.springframework.sbm", "org.openrewrite"}, importOptions = {ImportOption.DoNotIncludeTests.class, ImportOption.DoNotIncludeJars.class})
+public class FindIllegalExecutionContextCreationsTest {
+    @ArchTest
+    static final ArchTests executionContextMustNotBeCreatedWithNew = ArchTests.in(
+            ControlledInstantiationOfExecutionContextTest.class);
+}

applications/spring-shell/src/test/java/org/springframework/sbm/shell/ScanCommandHeaderRendererTest.java renamed to applications/spring-shell/src/test/java/org/springframework/sbm/shell/ApplyRecipeCommandHeaderRendererTest.java

@@ -19,7 +19,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-class ScanCommandHeaderRendererTest {
+class ApplyRecipeCommandHeaderRendererTest {
 
     @Test
     void renderHeader() {

components/openrewrite-spring-recipes/src/main/java/org/springframework/sbm/spring/migration/actions/InitDataSourceAfterJpaInitAction.java

@@ -15,6 +15,9 @@
  */
 package org.springframework.sbm.spring.migration.actions;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import org.openrewrite.ExecutionContext;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.sbm.engine.recipe.AbstractAction;
 import org.springframework.sbm.engine.recipe.UserInteractions;
 import org.springframework.sbm.common.migration.conditions.FileExist;
@@ -28,9 +31,12 @@
 public class InitDataSourceAfterJpaInitAction extends AbstractAction {
 
     public static final String QUESTION = "Would you rather run the SQL init scripts after JPA initialization?";
-
     private final UserInteractions ui;
 
+    @Autowired
+    @JsonIgnore
+    private ExecutionContext executionContext;
+
     public InitDataSourceAfterJpaInitAction(UserInteractions ui) {
         this.ui = ui;
         setCondition(FileExist.builder().fileName("data.sql").build().or(FileExist.builder().fileName("schema.sql").build()));
@@ -44,7 +50,7 @@ public void apply(ProjectContext context) {
             SpringBootApplicationProperties applicationProperties;
             if (filteredResources.isEmpty()) {
                 Path path = context.getBuildFile().getResourceFolders().get(0).resolve("application.properties");
-				applicationProperties = SpringBootApplicationProperties.newApplicationProperties(context.getProjectRootDirectory(), path);
+				applicationProperties = SpringBootApplicationProperties.newApplicationProperties(context.getProjectRootDirectory(), path, executionContext);
                 context.getProjectResources().add(applicationProperties);
             } else {
                 applicationProperties = filteredResources.get(0);

components/recipe-test-support/pom.xml

@@ -62,7 +62,7 @@
         <dependency>
             <groupId>org.springframework.sbm</groupId>
             <artifactId>sbm-core</artifactId>
-            <version>0.13.1-SNAPSHOT</version>
+            <version>${project.version}</version>
             <type>test-jar</type>
             <scope>compile</scope>
         </dependency>

components/recipe-test-support/src/main/java/org/springframework/sbm/test/RecipeTestSupport.java

@@ -28,6 +28,9 @@
 import org.springframework.sbm.project.resource.ProjectResourceSetHolder;
 import org.springframework.sbm.project.resource.SbmApplicationProperties;
 import org.springframework.sbm.project.resource.ResourceHelper;
+import org.springframework.sbm.scopeplayground.ExecutionScope;
+import org.springframework.sbm.scopeplayground.ScanScope;
+import org.springframework.sbm.scopeplayground.ScopeConfiguration;
 import org.springframework.sbm.search.recipe.actions.OpenRewriteJavaSearchAction;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -77,7 +80,10 @@ private RecipeTestSupport() {
             RewriteMavenParser.class,
             MavenSettingsInitializer.class,
             MavenBuildFileRefactoringFactory.class,
-            ProjectResourceSetHolder.class
+            ProjectResourceSetHolder.class,
+            ScopeConfiguration.class,
+            ExecutionScope.class,
+            ScanScope.class
     };
 
 

components/recipe-test-support/src/main/java/org/springframework/sbm/test/SpringBeanProvider.java

@@ -38,6 +38,13 @@
             <artifactId>spring-boot-starter-freemarker</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>com.tngtech.archunit</groupId>
+            <artifactId>archunit-junit5</artifactId>
+            <version>1.0.1</version>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
@@ -175,7 +182,13 @@
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <excludes>
+                        <!-- Would be picked up by component scan in other modules -->
+                        <exclude>**/org/springframework/sbm/archfitfun/**</exclude>
+                    </excludes>
+                </configuration>
             </plugin>
         </plugins>
     </build>
-</project>
+</project>

components/sbm-core/pom.xml

@@ -15,6 +15,7 @@
  */
 package org.springframework.sbm.build.api;
 
+import org.openrewrite.ExecutionContext;
 import org.openrewrite.java.JavaParser;
 import org.openrewrite.maven.tree.MavenResolutionResult;
 import org.springframework.sbm.build.impl.JavaSourceSetImpl;
@@ -55,6 +56,7 @@ public class Module {
     private final JavaRefactoringFactory javaRefactoringFactory;
     private final BasePackageCalculator basePackageCalculator;
     private final JavaParser javaParser;
+    private final ExecutionContext executionContext;
 
     public JavaSourceLocation getBaseJavaSourceLocation() {
         return getMainJavaSourceSet().getJavaSourceLocation();
@@ -67,7 +69,8 @@ public JavaSourceLocation getBaseTestJavaSourceLocation() {
     public JavaSourceSet getTestJavaSourceSet() {
         Path testJavaPath = Path.of("src/test/java");
         // FIXME: #7 JavaParser
-        return new JavaSourceSetImpl(projectResourceSet, projectRootDir, modulePath, testJavaPath, javaRefactoringFactory, basePackageCalculator, javaParser);
+        return new JavaSourceSetImpl(projectResourceSet, projectRootDir, modulePath, testJavaPath, javaRefactoringFactory, basePackageCalculator, javaParser,
+                                     executionContext);
     }
 
     public List<? extends JavaSource> getMainJavaSources() {
@@ -83,7 +86,8 @@ public List<? extends JavaSource> getTestJavaSources() {
     public JavaSourceSet getMainJavaSourceSet() {
         Path mainJavaPath = Path.of("src/main/java");
 //        return new JavaSourceSetImpl(projectResourceSet, projectRootDir.resolve(modulePath).resolve(mainJavaPath), javaRefactoringFactory);
-        return new JavaSourceSetImpl(projectResourceSet, projectRootDir, modulePath, mainJavaPath, javaRefactoringFactory, basePackageCalculator, javaParser);
+        return new JavaSourceSetImpl(projectResourceSet, projectRootDir, modulePath, mainJavaPath, javaRefactoringFactory, basePackageCalculator, javaParser,
+                                     executionContext);
     }
 
     private List<JavaSource> cast(List<RewriteSourceFileHolder<? extends SourceFile>> filter) {
@@ -112,12 +116,12 @@ public Path getProjectRootDirectory() {
 
     public ResourceSet getMainResourceSet() {
         Path mainResourceSet = buildFile.getMainResourceFolder();
-        return new ResourceSet(projectResourceSet, projectRootDir, modulePath, mainResourceSet);
+        return new ResourceSet(projectResourceSet, projectRootDir, modulePath, mainResourceSet, executionContext);
     }
 
     public ResourceSet getTestResourceSet() {
         Path testResourceSet = buildFile.getTestResourceFolder();
-        return new ResourceSet(projectResourceSet, projectRootDir, modulePath, testResourceSet);
+        return new ResourceSet(projectResourceSet, projectRootDir, modulePath, testResourceSet, executionContext);
     }
 
     public List<Module> getModules() {
@@ -127,7 +131,7 @@ public List<Module> getModules() {
             return modulesMarker
                     .stream()
                     .map(m -> new Module(m.getPom().getGav().toString(), this.buildFile, projectRootDir, modulePath,
-                                         projectResourceSet, javaRefactoringFactory, basePackageCalculator, javaParser))
+                                         projectResourceSet, javaRefactoringFactory, basePackageCalculator, javaParser, executionContext))
                     .collect(Collectors.toList());
         } else {
             return new ArrayList<>();

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

@@ -15,6 +15,7 @@
  */
 package org.springframework.sbm.build.api;
 
+import org.openrewrite.ExecutionContext;
 import org.springframework.sbm.project.resource.ProjectResourceSet;
 import org.springframework.sbm.project.resource.RewriteSourceFileHolder;
 import org.springframework.sbm.project.resource.StringProjectResource;
@@ -30,10 +31,11 @@ public class ResourceSet {
     private final Path projectRoot;
     private final Path modulePath;
     private final Path resourceSetPath;
+    private final ExecutionContext executionContext;
 
     public void addStringResource(String filePath, String content) {
         Path absFilePath = getAbsolutePath().resolve(filePath);
-        StringProjectResource resource = new StringProjectResource(projectRoot, absFilePath, content);
+        StringProjectResource resource = new StringProjectResource(projectRoot, absFilePath, content, executionContext);
         resource.markAsChanged();
         projectResourceSet.add(resource);
     }

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

@@ -15,11 +15,11 @@
  */
 package org.springframework.sbm.build.api;
 
+import org.openrewrite.ExecutionContext;
 import org.openrewrite.maven.MavenDownloadingException;
 import org.openrewrite.maven.internal.MavenPomDownloader;
 import org.openrewrite.maven.tree.GroupArtifactVersion;
 import org.openrewrite.maven.tree.MavenRepository;
-import org.springframework.sbm.openrewrite.RewriteExecutionContext;
 
 import java.util.Collections;
 import java.util.HashMap;
@@ -39,17 +39,17 @@ public class SpringManagedDependencies {
     private List<org.openrewrite.maven.tree.Dependency> dependencies;
     private static Map<GroupArtifactVersion, SpringManagedDependencies> INSTANCES = new HashMap<>();
 
-    public static SpringManagedDependencies by(String groupId, String artifact, String version){
+    public static SpringManagedDependencies by(String groupId, String artifact, String version, ExecutionContext executionContext){
         final GroupArtifactVersion groupArtifactVersion =
                 new GroupArtifactVersion(groupId, artifact, version);
 
-        INSTANCES.computeIfAbsent(groupArtifactVersion, SpringManagedDependencies::new);
+        INSTANCES.computeIfAbsent(groupArtifactVersion, gav ->  new SpringManagedDependencies(gav, executionContext));
         return INSTANCES.get(groupArtifactVersion);
     }
 
-    private SpringManagedDependencies(GroupArtifactVersion groupArtifactVersion){
+    private SpringManagedDependencies(GroupArtifactVersion groupArtifactVersion, ExecutionContext executionContext){
         try {
-            dependencies = new MavenPomDownloader(Collections.emptyMap(), new RewriteExecutionContext())
+            dependencies = new MavenPomDownloader(Collections.emptyMap(), executionContext)
                     .download(groupArtifactVersion, null, null, SPRING_REPOSITORIES)
                     .getDependencies();
         } catch (MavenDownloadingException e) {

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

@@ -15,6 +15,7 @@
  */
 package org.springframework.sbm.build.impl;
 
+import org.openrewrite.ExecutionContext;
 import org.springframework.sbm.build.api.JavaSourceSet;
 import org.springframework.sbm.java.api.JavaSource;
 import org.springframework.sbm.java.api.JavaSourceLocation;
@@ -44,11 +45,13 @@ public class JavaSourceSetImpl implements JavaSourceSet {
     private final JavaRefactoringFactory javaRefactoringFactory;
     private final BasePackageCalculator basePackageCalculator;
     private final JavaParser javaParser;
+    private ExecutionContext executionContext;
 
-    public JavaSourceSetImpl(ProjectResourceSet projectResourceSet, Path projectRootDir, Path modulePath, Path mainJavaPath, JavaRefactoringFactory javaRefactoringFactory, BasePackageCalculator basePackageCalculator, JavaParser javaParser) {
+    public JavaSourceSetImpl(ProjectResourceSet projectResourceSet, Path projectRootDir, Path modulePath, Path mainJavaPath, JavaRefactoringFactory javaRefactoringFactory, BasePackageCalculator basePackageCalculator, JavaParser javaParser, ExecutionContext executionContext) {
         this.projectResourceSet = projectResourceSet;
         this.basePackageCalculator = basePackageCalculator;
         this.javaParser = javaParser;
+        this.executionContext = executionContext;
         this.sourceSetRoot = projectRootDir.resolve(modulePath).resolve(mainJavaPath);
         this.filter = (r) -> {
             return r.getAbsolutePath().getParent().normalize().toString().startsWith(sourceSetRoot.toString());
@@ -73,7 +76,7 @@ public JavaSource addJavaSource(Path projectRoot, Path sourceFolder, String sour
             throw new RuntimeException("The Java class you tried to add already lives here: '" + sourceFilePath + "'.");
         } else {
             J.CompilationUnit compilationUnit = parsedCompilationUnit.withSourcePath(sourceFilePath);
-            OpenRewriteJavaSource addedSource = new OpenRewriteJavaSource(projectRoot, compilationUnit, javaRefactoringFactory.createRefactoring(compilationUnit), javaParser);
+            OpenRewriteJavaSource addedSource = new OpenRewriteJavaSource(projectRoot, compilationUnit, javaRefactoringFactory.createRefactoring(compilationUnit), javaParser, executionContext);
             addedSource.markChanged();
             projectResourceSet.add(addedSource);
             return addedSource;
@@ -94,7 +97,7 @@ public List<JavaSource> addJavaSource(Path projectRoot, Path sourceFolder, Strin
             Path sourceFilePath = sourceFolder.resolve(sourceFileName);
             if(!Files.exists(sourceFilePath)) {
                 J.CompilationUnit compilationUnit = cu.withSourcePath(sourceFilePath);
-                OpenRewriteJavaSource addedSource = new OpenRewriteJavaSource(projectRoot, compilationUnit, javaRefactoringFactory.createRefactoring(compilationUnit), javaParser);
+                OpenRewriteJavaSource addedSource = new OpenRewriteJavaSource(projectRoot, compilationUnit, javaRefactoringFactory.createRefactoring(compilationUnit), javaParser, executionContext);
                 addedSource.markChanged();
                 projectResourceSet.add(addedSource);
                 addedSources.add(addedSource);

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

@@ -20,11 +20,9 @@
 import org.jetbrains.annotations.NotNull;
 import org.openrewrite.*;
 import org.openrewrite.marker.Markers;
-import org.openrewrite.marker.SearchResult;
 import org.openrewrite.maven.MavenVisitor;
 import org.openrewrite.maven.tree.MavenResolutionResult;
 import org.openrewrite.xml.tree.Xml;
-import org.springframework.sbm.openrewrite.RewriteExecutionContext;
 import org.springframework.sbm.project.resource.ProjectResourceSet;
 import org.springframework.sbm.project.resource.RewriteSourceFileHolder;
 import org.springframework.sbm.support.openrewrite.GenericOpenRewriteRecipe;
@@ -46,6 +44,7 @@
 public class MavenBuildFileRefactoring<T extends SourceFile> {
     private final ProjectResourceSet projectResourceSet;
     private final RewriteMavenParser mavenParser;
+    private final ExecutionContext executionContext;
 
     /**
      * Applies the provided {@code Visitor}s to all Maven build files in the {@code ProjectContext}.
@@ -107,7 +106,7 @@ public void refreshPomModels() {
                 .collect(Collectors.toList());
 
         // parse buildfiles
-        List<Xml.Document> newMavenFiles = mavenParser.parseInputs(parserInputs, null, new RewriteExecutionContext());
+        List<Xml.Document> newMavenFiles = mavenParser.parseInputs(parserInputs, null, executionContext);
 
         // replace new model in build files
         newMavenFiles.stream()
@@ -152,12 +151,12 @@ public BuildFileWithIndex(int index, RewriteSourceFileHolder<Xml.Document> xmlDo
     }
 
     private List<Result> executeRecipe(Recipe recipe) {
-        List<Result> results = recipe.run(getDocumentsWrappedInOpenRewriteMavenBuildFile(), new RewriteExecutionContext()).getResults();
+        List<Result> results = recipe.run(getDocumentsWrappedInOpenRewriteMavenBuildFile(), executionContext).getResults();
         return results;
     }
 
     private List<Result> executeRecipe(Recipe recipe, RewriteSourceFileHolder<Xml.Document> resource) {
-        List<Result> results = recipe.run(List.of(resource.getSourceFile()), new RewriteExecutionContext()).getResults();
+        List<Result> results = recipe.run(List.of(resource.getSourceFile()), executionContext).getResults();
         return results;
     }