880 adhere to m2settings securityxml and m2settingsxml (#986)

Add support for `~/.m2/settings.xml` and `~/.m2/settings-security.xml`. - `Maven SettingsInitializer` reads the settings with decrypted credentials and adds them to the `ExecutionContext` Maven when build files get parsed. - `PrivateArtifactRepositoryTest` tests the behavior e2e. - Add Maven-related Autoconfiguration and move some beans there - `MavenExecutionRequest` now has the path to `settings.xml` - Polishing
spring-projects-experimental · Nov 10, 2023 · 275b211 · 275b211
1 parent d9c9bdb
commit 275b211
Show file tree

Hide file tree

Showing 63 changed files with 1,248 additions and 529 deletions.
diff --git a/.github/workflows/build-sbm-revamp.yml b/.github/workflows/build-sbm-revamp.yml
@@ -22,9 +22,6 @@ jobs:
         working-directory: sbm-support-rewrite
         run: mvn --batch-mode clean install
 
-      - name: clean install skipTests
-        run: mvn clean install -DskipTests
-
       - name: clean
         run: mvn clean
 

diff --git a/...b/workflows/build-sbm-support-rewrite.yml → ...workflows/build-sbm-support-rewrite.yml-- b/...b/workflows/build-sbm-support-rewrite.yml → ...workflows/build-sbm-support-rewrite.yml--
diff --git a/.gitignore b/.gitignore
@@ -20,4 +20,4 @@ out/
 pom.xml.versionsBackup
 **/src/generated/java/META-INF
 **.java-version
-.rewrite-cache
+.rewrite-cache
diff --git a/...nts/recipe-test-support/src/main/java/org/springframework/sbm/test/RecipeTestSupport.java b/...nts/recipe-test-support/src/main/java/org/springframework/sbm/test/RecipeTestSupport.java
@@ -17,7 +17,7 @@
 
 import org.springframework.sbm.boot.autoconfigure.ScopeConfiguration;
 import org.springframework.sbm.build.impl.MavenBuildFileRefactoringFactory;
-import org.springframework.sbm.build.impl.MavenSettingsInitializer;
+import org.springframework.sbm.parsers.maven.MavenSettingsInitializer;
 import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.engine.context.ProjectContextHolder;
 import org.springframework.sbm.engine.context.RewriteJavaSearchActionDeserializer;

diff --git a/...s/sbm-core/src/main/java/org/springframework/sbm/build/impl/MavenSettingsInitializer.java b/...s/sbm-core/src/main/java/org/springframework/sbm/build/impl/MavenSettingsInitializer.java
diff --git a/.../sbm-core/src/main/java/org/springframework/sbm/build/impl/OpenRewriteMavenBuildFile.java b/.../sbm-core/src/main/java/org/springframework/sbm/build/impl/OpenRewriteMavenBuildFile.java
@@ -40,7 +40,7 @@
 import org.springframework.sbm.build.migration.visitor.AddOrUpdateDependencyManagement;
 import org.springframework.sbm.java.impl.ClasspathRegistry;
 import org.springframework.sbm.project.resource.RewriteSourceFileHolder;
-import org.springframework.sbm.parsers.RewriteMavenArtifactDownloader;
+import org.springframework.sbm.parsers.maven.RewriteMavenArtifactDownloader;
 import org.springframework.sbm.support.openrewrite.GenericOpenRewriteRecipe;
 import org.springframework.util.Assert;
 

diff --git a/components/sbm-core/src/main/java/org/springframework/sbm/build/impl/RewriteMavenParser.java b/components/sbm-core/src/main/java/org/springframework/sbm/build/impl/RewriteMavenParser.java
@@ -21,12 +21,10 @@
 import org.openrewrite.SourceFile;
 import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.maven.MavenParser;
-import org.openrewrite.xml.XmlParser;
-import org.openrewrite.xml.tree.Xml;
+import org.springframework.sbm.parsers.maven.MavenSettingsInitializer;
 import org.springframework.stereotype.Component;
 
 import java.nio.file.Path;
-import java.util.List;
 import java.util.stream.Stream;
 
 /**
@@ -76,7 +74,7 @@ public Stream<SourceFile> parse(String... sources) {
 
     @Override
     public Stream<SourceFile> parse(ExecutionContext ctx, String... sources) {
-        mavenSettingsInitializer.initializeMavenSettings(ctx);
+        mavenSettingsInitializer.initializeMavenSettings();
         return parser.parse(ctx, sources);
     }
 
@@ -90,7 +88,7 @@ public Stream<SourceFile> parseInputs(Iterable<Input> sources, @Nullable Path re
         if (relativeTo != null) {
             initMavenParser(ctx, relativeTo);
         } else {
-            mavenSettingsInitializer.initializeMavenSettings(ctx);
+            mavenSettingsInitializer.initializeMavenSettings();
         }
         return parser.parseInputs(sources, relativeTo, ctx);
     }

diff --git a/...-core/src/main/java/org/springframework/sbm/build/migration/actions/AddMinimalPomXml.java b/...-core/src/main/java/org/springframework/sbm/build/migration/actions/AddMinimalPomXml.java
@@ -28,7 +28,7 @@
 import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.engine.context.ProjectContext;
 import org.springframework.sbm.engine.recipe.AbstractAction;
-import org.springframework.sbm.parsers.RewriteMavenArtifactDownloader;
+import org.springframework.sbm.parsers.maven.RewriteMavenArtifactDownloader;
 
 import java.io.ByteArrayInputStream;
 import java.io.StringWriter;

diff --git a/...m-core/src/main/java/org/springframework/sbm/build/resource/BuildFileResourceWrapper.java b/...m-core/src/main/java/org/springframework/sbm/build/resource/BuildFileResourceWrapper.java
@@ -24,7 +24,7 @@
 import org.springframework.sbm.build.impl.MavenBuildFileRefactoring;
 import org.springframework.sbm.build.impl.MavenBuildFileRefactoringFactory;
 import org.springframework.sbm.build.impl.OpenRewriteMavenBuildFile;
-import org.springframework.sbm.parsers.RewriteMavenArtifactDownloader;
+import org.springframework.sbm.parsers.maven.RewriteMavenArtifactDownloader;
 import org.springframework.sbm.project.resource.ProjectResourceWrapper;
 import org.springframework.sbm.project.resource.RewriteSourceFileHolder;
 import org.springframework.stereotype.Component;

diff --git a/components/sbm-core/src/main/java/org/springframework/sbm/java/impl/ClasspathRegistry.java b/components/sbm-core/src/main/java/org/springframework/sbm/java/impl/ClasspathRegistry.java
@@ -21,7 +21,7 @@
 import org.openrewrite.maven.tree.Scope;
 import org.springframework.sbm.build.api.BuildFile;
 import org.springframework.sbm.build.impl.OpenRewriteMavenBuildFile;
-import org.springframework.sbm.parsers.RewriteMavenArtifactDownloader;
+import org.springframework.sbm.parsers.maven.RewriteMavenArtifactDownloader;
 import org.springframework.sbm.project.parser.DependencyHelper;
 
 import java.nio.file.Path;

diff --git a/.../sbm-core/src/test/java/org/springframework/sbm/archfitfun/ExecutionScopeArchFitTest.java b/.../sbm-core/src/test/java/org/springframework/sbm/archfitfun/ExecutionScopeArchFitTest.java
@@ -28,7 +28,7 @@
 import org.springframework.core.io.FileSystemResource;
 import org.springframework.sbm.boot.autoconfigure.SbmSupportRewriteConfiguration;
 import org.springframework.sbm.boot.autoconfigure.ScopeConfiguration;
-import org.springframework.sbm.build.impl.MavenSettingsInitializer;
+import org.springframework.sbm.parsers.maven.MavenSettingsInitializer;
 import org.springframework.sbm.engine.commands.ApplicableRecipeListCommand;
 import org.springframework.sbm.engine.commands.ApplyCommand;
 import org.springframework.sbm.engine.commands.ScanCommand;

diff --git a/...nents/sbm-core/src/test/java/org/springframework/sbm/java/impl/ClasspathRegistryTest.java b/...nents/sbm-core/src/test/java/org/springframework/sbm/java/impl/ClasspathRegistryTest.java
@@ -22,9 +22,10 @@
 import org.openrewrite.maven.tree.ResolvedDependency;
 import org.openrewrite.maven.tree.Scope;
 import org.openrewrite.xml.tree.Xml;
-import org.springframework.sbm.build.impl.MavenSettingsInitializer;
 import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.parsers.RewriteExecutionContext;
+import org.springframework.sbm.parsers.maven.MavenSettingsInitializer;
+import org.springframework.sbm.scopes.ProjectMetadata;
 
 import java.util.List;
 import java.util.Set;
@@ -105,7 +106,7 @@ void classpathRegistryShouldKeepOnlyExternalDependencies() {
 
         ExecutionContext executionContext = new RewriteExecutionContext();
         List<Xml.Document> poms = new RewriteMavenParser(
-                new MavenSettingsInitializer(),
+                new MavenSettingsInitializer(executionContext, new ProjectMetadata()),
                 executionContext
         ).parse(parentPom, pom1, pom2)
                 .map(Xml.Document.class::cast)

diff --git a/...src/test/java/org/springframework/sbm/project/parser/JavaProvenanceMarkerFactoryTest.java b/...src/test/java/org/springframework/sbm/project/parser/JavaProvenanceMarkerFactoryTest.java
@@ -17,14 +17,16 @@
 
 import org.jetbrains.annotations.NotNull;
 import org.junit.jupiter.api.Test;
+import org.openrewrite.ExecutionContext;
 import org.openrewrite.java.marker.JavaProject;
 import org.openrewrite.java.marker.JavaVersion;
 import org.openrewrite.marker.BuildTool;
 import org.openrewrite.marker.Marker;
 import org.openrewrite.xml.tree.Xml;
-import org.springframework.sbm.build.impl.MavenSettingsInitializer;
 import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.parsers.RewriteExecutionContext;
+import org.springframework.sbm.parsers.maven.MavenSettingsInitializer;
+import org.springframework.sbm.scopes.ProjectMetadata;
 
 import java.nio.file.Path;
 import java.util.List;
@@ -63,7 +65,8 @@ void test() {
                 "</project>";
 
         Path projectDirectory = Path.of("./faked-project-dir/pom.xml");
-        Xml.Document maven = new RewriteMavenParser(new MavenSettingsInitializer(), new RewriteExecutionContext()).parse(pomXmlSource).toList().get(0).withSourcePath(Path.of("pom.xml"));
+        ExecutionContext executionContext = new RewriteExecutionContext();
+        Xml.Document maven = new RewriteMavenParser(new MavenSettingsInitializer(executionContext, new ProjectMetadata()), executionContext).parse(pomXmlSource).toList().get(0).withSourcePath(Path.of("pom.xml"));
 
         List<Marker> javaProvenanceMarkers = sut.createJavaProvenanceMarkers(maven, projectDirectory, new RewriteExecutionContext());
 

diff --git a/...e/src/test/java/org/springframework/sbm/project/parser/ProjectContextInitializerTest.java b/...e/src/test/java/org/springframework/sbm/project/parser/ProjectContextInitializerTest.java
@@ -34,7 +34,7 @@
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.sbm.boot.autoconfigure.ScopeConfiguration;
-import org.springframework.sbm.build.impl.MavenSettingsInitializer;
+import org.springframework.sbm.parsers.maven.MavenSettingsInitializer;
 import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.build.migration.MavenPomCacheProvider;
 import org.springframework.sbm.engine.commands.ScanCommand;
@@ -64,7 +64,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.springframework.sbm.project.parser.ResourceVerifierTestHelper.*;
-import org.springframework.sbm.parsers.RewriteMavenArtifactDownloader;
+import org.springframework.sbm.parsers.maven.RewriteMavenArtifactDownloader;
 
 @SpringBootTest(classes = {
         ProjectContextInitializer.class,

diff --git a/components/sbm-core/testcode/project-with-maven-settings/.gitignore b/components/sbm-core/testcode/project-with-maven-settings/.gitignore
diff --git a/sbm-support-rewrite/.gitignore b/sbm-support-rewrite/.gitignore
@@ -0,0 +1,2 @@
+/testcode/**/target/**
+/testcode/**/.rewrite-cache/**
diff --git a/sbm-support-rewrite/pom.xml b/sbm-support-rewrite/pom.xml
@@ -230,7 +230,6 @@
             <groupId>org.codehaus.plexus</groupId>
             <artifactId>plexus-cipher</artifactId>
             <version>${plexus-cypher.version}</version>
-            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.apache.maven.shared</groupId>
@@ -249,6 +248,31 @@
             <version>${junit-pioneer.version}</version>
             <scope>test</scope>
         </dependency>
+        <!-- Required by PrivateArtifactRepositoryTest -->
+        <!-- TODO: Move into separate module -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-testcontainers</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-text</artifactId>
+            <version>1.10.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.powermock</groupId>
+            <artifactId>powermock-core</artifactId>
+            <version>2.0.9</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- END: Required by PrivateArtifactRepositoryTest -->
     </dependencies>
 
     <build>

diff --git a/...-rewrite/src/main/java/org/springframework/sbm/boot/autoconfigure/ScopeConfiguration.java b/...-rewrite/src/main/java/org/springframework/sbm/boot/autoconfigure/ScopeConfiguration.java
@@ -17,8 +17,6 @@
 
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.InMemoryExecutionContext;
-import org.openrewrite.java.AddOrUpdateAnnotationAttribute;
-import org.openrewrite.maven.MavenExecutionContextView;
 import org.openrewrite.maven.cache.MavenPomCache;
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
@@ -74,9 +72,6 @@ Supplier<ExecutionContext> executionContextSupplier() {
     @org.springframework.sbm.scopes.annotations.ScanScope
     ExecutionContext executionContext(ProjectMetadata projectMetadata, Supplier<ExecutionContext> executionContextSupplier, MavenPomCache mavenPomCache) {
         ExecutionContext executionContext = executionContextSupplier.get();
-        MavenExecutionContextView contextView = MavenExecutionContextView.view(executionContext);
-        contextView.setMavenSettings(projectMetadata.getMavenSettings());
-        contextView.setPomCache(mavenPomCache);
         return executionContext;
     }
 

diff --git a/...ort-rewrite/src/main/java/org/springframework/sbm/parsers/RewriteParserConfiguration.java b/...ort-rewrite/src/main/java/org/springframework/sbm/parsers/RewriteParserConfiguration.java
@@ -17,7 +17,6 @@
 
 import lombok.extern.slf4j.Slf4j;
 import org.openrewrite.ExecutionContext;
-import org.openrewrite.maven.MavenExecutionContextView;
 import org.openrewrite.maven.cache.*;
 import org.openrewrite.maven.utilities.MavenArtifactDownloader;
 import org.openrewrite.tree.ParsingEventListener;
@@ -34,13 +33,11 @@
 import org.springframework.sbm.parsers.events.RewriteParsingEventListenerAdapter;
 import org.springframework.sbm.parsers.maven.*;
 import org.springframework.sbm.project.resource.SbmApplicationProperties;
-import org.springframework.sbm.scopes.ProjectMetadata;
 import org.springframework.sbm.scopes.ScanScope;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.function.Consumer;
 
 
@@ -52,19 +49,9 @@
 @Slf4j
 @AutoConfiguration(after = {ScopeConfiguration.class})
 @EnableConfigurationProperties({ParserProperties.class, SbmApplicationProperties.class})
-@Import({ScanScope.class, ScopeConfiguration.class})
+@Import({ScanScope.class, ScopeConfiguration.class, RewriteParserMavenConfiguration.class})
 public class RewriteParserConfiguration {
 
-    @Bean
-    MavenPasswordDecrypter mavenPasswordDecrypter() {
-        return new MavenPasswordDecrypter();
-    }
-
-    @Bean
-    MavenProvenanceMarkerFactory mavenProvenanceMarkerFactory() {
-        return new MavenProvenanceMarkerFactory();
-    }
-
     @Bean
     ProvenanceMarkerFactory provenanceMarkerFactory(MavenProvenanceMarkerFactory mavenPovenanceMarkerFactory) {
         return new ProvenanceMarkerFactory(mavenPovenanceMarkerFactory);
@@ -76,38 +63,19 @@ JavaParserBuilder javaParserBuilder() {
         return new JavaParserBuilder();
     }
 
-    @Bean
-    BuildFileParser buildFileParser() {
-        return new BuildFileParser();
-    }
-
-
-    @Bean
-    @ConditionalOnMissingBean(MavenArtifactCache.class)
-    MavenArtifactCache mavenArtifactCache() {
-        return new LocalMavenArtifactCache(Paths.get(System.getProperty("user.home"), ".m2", "repository")).orElse(
-                new LocalMavenArtifactCache(Paths.get(System.getProperty("user.home"), ".rewrite", "cache", "artifacts"))
-        );
-    }
-
     @Bean
     Consumer<Throwable> artifactDownloaderErrorConsumer() {
         return (t) -> {throw new RuntimeException(t);};
     }
 
     @Bean
-    RewriteMavenArtifactDownloader artifactDownloader(MavenArtifactCache mavenArtifactCache, ProjectMetadata projectMetadata, Consumer<Throwable> artifactDownloaderErrorConsumer) {
-        return new RewriteMavenArtifactDownloader(mavenArtifactCache, projectMetadata.getMavenSettings(), artifactDownloaderErrorConsumer);
-    }
-
-    @Bean
-    ModuleParser helperWithoutAGoodName() {
+    ModuleParser moduleParser() {
         return new ModuleParser();
     }
 
     @Bean
-    MavenModuleParser mavenModuleParser(ParserProperties parserPropeties, ModuleParser moduleParser) {
-        return new MavenModuleParser(parserPropeties, moduleParser);
+    MavenModuleParser mavenModuleParser(ParserProperties parserProperties, ModuleParser moduleParser) {
+        return new MavenModuleParser(parserProperties, moduleParser);
     }
 
     @Bean
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		/testcode//target/
		/testcode//.rewrite-cache/