RewriteMavenParser honors Maven settings.xml

- Inject MavenParser into AddMinimalPomXml
- Refactor RewriteMavenParser

Author: fabapp2

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

@@ -16,6 +16,8 @@
 package org.springframework.sbm.test;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.sbm.build.impl.MavenSettingsInitializer;
+import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.engine.context.ProjectContextHolder;
 import org.springframework.sbm.engine.context.RewriteJavaSearchActionDeserializer;
 import org.springframework.sbm.engine.recipe.*;
@@ -69,7 +71,9 @@ private RecipeTestSupport() {
             RewriteSourceFileWrapper.class,
             SbmRecipeLoader.class,
             BasePackageCalculator.class,
-            ProjectContextHolder.class
+            ProjectContextHolder.class,
+            RewriteMavenParser.class,
+            MavenSettingsInitializer.class
     };
 
 

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

@@ -0,0 +1,41 @@
+/*
+ * 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.build.impl;
+
+import org.openrewrite.ExecutionContext;
+import org.openrewrite.maven.MavenExecutionContextView;
+import org.openrewrite.maven.MavenSettings;
+import org.springframework.stereotype.Component;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+/**
+ * @author Fabian Krüger
+ */
+@Component
+public class MavenSettingsInitializer {
+    public void initializeMavenSettings(ExecutionContext executionContext) {
+        // Read .m2/settings.xml
+        // TODO: Add support for global Maven settings (${maven.home}/conf/settings.xml).
+        MavenExecutionContextView mavenExecutionContextView = MavenExecutionContextView.view(executionContext);
+        Path mavenSettingsFile = Path.of(System.getProperty("user.home")).resolve(".m2/settings.xml");
+        if (Files.exists(mavenSettingsFile)) {
+            MavenSettings mavenSettings = MavenSettings.parse(mavenSettingsFile, mavenExecutionContextView);
+            mavenExecutionContextView.setMavenSettings(mavenSettings);
+        }
+    }
+}

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

@@ -28,27 +28,34 @@
 import java.util.List;
 import java.util.Optional;
 
+/**
+ * Class to parse Maven build files.
+ *
+ * It reads {@code .mvn/maven.config when a project root dir is provided.
+ * Maven's {@code settings.xml} is read when it exits. The result is stored in {@code ExecutionContext}.
+ * When an {@code ExecutionContext} is provided the MavenSettings are initilized again to guarantee that
+ * all settings from {@code settings.xml} are respected.
+ */
 @Component
 public class RewriteMavenParser implements Parser<Xml.Document> {
 
-    private final MavenParser parser;
+    private MavenParser parser;
+    private final MavenSettingsInitializer mavenSettingsInitializer;
 
-    // FIXME: #7 This does not work for singleton Spring bean, also profiles and cache cannot be changed
-    public RewriteMavenParser(Path projectRoot) {
-        this.parser = initMavenParser(new RewriteExecutionContext(), Optional.ofNullable(projectRoot));
-    }
-
-    public RewriteMavenParser() {
-        this.parser = initMavenParser(new RewriteExecutionContext(), Optional.empty());
+    public RewriteMavenParser(MavenSettingsInitializer mavenSettingsInitializer) {
+        this.mavenSettingsInitializer = mavenSettingsInitializer;
+        initMavenParser(new RewriteExecutionContext(), null);
     }
 
     @NotNull
-    private MavenParser initMavenParser(RewriteExecutionContext executionContext, Optional<Path> projectRoot) {
+    private void initMavenParser(ExecutionContext executionContext, Path projectRoot) {
+        mavenSettingsInitializer.initializeMavenSettings(executionContext);
+
         MavenParser.Builder builder = MavenParser.builder();
-        if(projectRoot.isPresent()) {
-            builder.mavenConfig(projectRoot.get().resolve(".mvn/maven.config"));
+        if (projectRoot != null && projectRoot.resolve(".mvn/maven.config").toFile().exists()) {
+            builder.mavenConfig(projectRoot.resolve(".mvn/maven.config"));
         }
-        builder.build();
+        this.parser = builder.build();
 //        if(executionContext.getMavenProfiles().length > 0) {
 //            builder.activeProfiles(executionContext.getMavenProfiles());
 //        }
@@ -58,16 +65,32 @@ private MavenParser initMavenParser(RewriteExecutionContext executionContext, Op
 //        if(executionContext.getMavenPomCache() != null) {
 //            builder.cache(executionContext.getMavenPomCache());
 //        }
-        return builder.build();
     }
 
     @Override
     public List<Xml.Document> parse(String... sources) {
         return parser.parse(sources);
     }
 
+    @Override
+    public List<Xml.Document> parse(ExecutionContext ctx, String... sources) {
+        mavenSettingsInitializer.initializeMavenSettings(ctx);
+        parser.parse(ctx, sources);
+        return Parser.super.parse(ctx, sources);
+    }
+
+    /**
+     * @param sources    the sources to parse
+     * @param relativeTo the project root, if null is given .mvn/maven.config will not be read
+     * @param ctx        the ExecutionContext,
+     */
     @Override
     public List<Xml.Document> parseInputs(Iterable<Input> sources, @Nullable Path relativeTo, ExecutionContext ctx) {
+        if (relativeTo != null) {
+            initMavenParser(ctx, relativeTo);
+        } else {
+            mavenSettingsInitializer.initializeMavenSettings(ctx);
+        }
         return parser.parseInputs(sources, relativeTo, ctx);
     }
 

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddMinimalPomXml.java

@@ -43,6 +43,10 @@ public class AddMinimalPomXml extends AbstractAction {
     @Setter
     private Configuration configuration;
 
+    @Autowired
+    @JsonIgnore
+    private RewriteMavenParser rewriteMavenParser;
+
     @Override
     public void apply(ProjectContext context) {
         String projectDir = context.getProjectRootDirectory().toString();
@@ -61,9 +65,9 @@ public void apply(ProjectContext context) {
         }
 
         String src = writer.toString();
-        RewriteMavenParser rewriteMavenParser = new RewriteMavenParser();
         Parser.Input input = new Parser.Input(Path.of("pom.xml"), () -> new ByteArrayInputStream(src.getBytes(StandardCharsets.UTF_8)));
-        Xml.Document maven = rewriteMavenParser.parseInputs(List.of(input), null, new RewriteExecutionContext(getEventPublisher())).get(0);
+        Xml.Document maven = rewriteMavenParser
+                .parseInputs(List.of(input), null, new RewriteExecutionContext(getEventPublisher())).get(0);
         OpenRewriteMavenBuildFile rewriteMavenBuildFile = new OpenRewriteMavenBuildFile(
                 context.getProjectRootDirectory(),
                 maven, getEventPublisher(), new RewriteExecutionContext(getEventPublisher())

components/sbm-core/src/test/java/org/springframework/sbm/build/impl/MavenSettingsInitializerTest.java

@@ -0,0 +1,88 @@
+/*
+ * 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.build.impl;
+
+import org.junit.jupiter.api.*;
+import org.openrewrite.maven.MavenExecutionContextView;
+import org.openrewrite.maven.tree.MavenRepository;
+import org.springframework.sbm.openrewrite.RewriteExecutionContext;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.nio.file.Path;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.*;
+
+/**
+ * @author Fabian Krüger
+ */
+class MavenSettingsInitializerTest {
+
+    // localRepository.getUri() will differ from '"file:" + userHome + "/.m2/repository/"' because
+    // MavenRepository.MAVEN_LOCAL_DEFAULT gets returned and this field is statically initialized.
+    // For this test it means that running the test in isolation succeeds but running it in combination
+    // with a test that loads MavenRepository before 'user.home' was changed in this test, it fails.
+    // And maybe even worse, running this test before others would set the local maven repository to the
+    // dummy dir used in this test.
+    // To prevent this it will be initialized (if it wasn't already) with the original settings with this line:
+    MavenRepository mavenLocalDefault = MavenRepository.MAVEN_LOCAL_DEFAULT;
+    private String actualUserHome;
+    private Path fakedUserHome;
+
+    @BeforeEach
+    void beforeEach() {
+        // Faking the local maven dir to provide the settings.xml for this test
+        fakedUserHome = Path.of("./testcode/project-with-maven-settings/user-home").toAbsolutePath().normalize();
+        actualUserHome = System.getProperty("user.home");
+        System.setProperty("user.home", fakedUserHome.toString());
+    }
+
+    @Test
+    void mavenParserMustAdhereToSettingsXmlTest() throws URISyntaxException {
+
+
+        RewriteExecutionContext executionContext = new RewriteExecutionContext();
+        MavenSettingsInitializer sut = new MavenSettingsInitializer();
+        sut.initializeMavenSettings(executionContext);
+        MavenExecutionContextView mavenExecutionContextView = MavenExecutionContextView.view(executionContext);
+
+        assertThat(mavenExecutionContextView.getRepositories()).hasSize(1);
+
+        MavenRepository mavenRepository = mavenExecutionContextView.getRepositories().get(0);
+
+        assertThat(mavenRepository.getId()).isEqualTo("central");
+        assertThat(mavenRepository.getUri()).isEqualTo("https://jcenter.bintray.com");
+        assertThat(mavenRepository.isReleases()).isTrue();
+        assertThat(mavenRepository.isSnapshots()).isFalse();
+
+        MavenRepository localRepository = mavenExecutionContextView.getLocalRepository();
+        assertThat(localRepository.isSnapshots()).isTrue();
+
+//        assertThat(localRepository.getUri()).isEqualTo("file:" + fakedUserHome + "/.m2/repository/");
+        assertThat(localRepository.getUri()).isEqualTo(MavenRepository.MAVEN_LOCAL_DEFAULT.getUri());
+        assertThat(localRepository.isSnapshots()).isTrue();
+        assertThat(localRepository.isKnownToExist()).isTrue();
+        assertThat(localRepository.getUsername()).isNull();
+        assertThat(localRepository.getPassword()).isNull();
+    }
+
+    @AfterEach
+    public void reset() {
+        // reset
+        System.setProperty("user.home", actualUserHome);
+    }
+}

components/sbm-core/src/test/java/org/springframework/sbm/build/impl/RewriteMavenParserTest.java

@@ -0,0 +1,57 @@
+/*
+ * 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.build.impl;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.openrewrite.ExecutionContext;
+import org.springframework.sbm.build.util.PomBuilder;
+import org.springframework.sbm.openrewrite.RewriteExecutionContext;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+/**
+ * @author Fabian Krüger
+ */
+@ExtendWith(MockitoExtension.class)
+class RewriteMavenParserTest {
+
+    @Mock
+    MavenSettingsInitializer mavenSettingsInitializer;
+    @InjectMocks
+    RewriteMavenParser sut;
+
+    @Test
+    void noExecutionContextGiven() {
+        verify(mavenSettingsInitializer).initializeMavenSettings(any(ExecutionContext.class));
+    }
+
+    @Test
+    void customExecutionContextGiven() {
+        String pom = PomBuilder.buiildPom("com.example:project:1.0").build();
+        ExecutionContext ctx = new RewriteExecutionContext();
+        sut.parse(ctx, pom);
+        // first time when initializing the parser
+        // second time in the parse method to guarantee ExecutionContext is enriched with MavenSettings
+        verify(mavenSettingsInitializer, times(2)).initializeMavenSettings(ctx);
+    }
+
+}

components/sbm-core/src/test/java/org/springframework/sbm/java/impl/ClasspathRegistryTest.java

@@ -22,6 +22,7 @@
 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 java.util.List;
@@ -101,7 +102,7 @@ void classpathRegistryShouldKeepOnlyExternalDependencies() {
         assertThat(sut.getCurrentDependencies()).isEmpty();
         assertThat(sut.getInitialDependencies()).isEmpty();
 
-        List<Xml.Document> poms = new RewriteMavenParser().parse(parentPom, pom1, pom2);
+        List<Xml.Document> poms = new RewriteMavenParser(new MavenSettingsInitializer()).parse(parentPom, pom1, pom2);
 
         Set<ResolvedDependency> resolvedDependencies = poms
                 .get(2)

components/sbm-core/src/test/java/org/springframework/sbm/project/parser/JavaProvenanceMarkerFactoryTest.java

@@ -23,6 +23,7 @@
 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.openrewrite.RewriteExecutionContext;
 
@@ -63,7 +64,7 @@ void test() {
                 "</project>";
 
         Path projectDirectory = Path.of("./faked-project-dir/pom.xml");
-        Xml.Document maven = new RewriteMavenParser().parse(pomXmlSource).get(0).withSourcePath(Path.of("pom.xml"));
+        Xml.Document maven = new RewriteMavenParser(new MavenSettingsInitializer()).parse(pomXmlSource).get(0).withSourcePath(Path.of("pom.xml"));
 
         List<Marker> javaProvenanceMarkers = sut.createJavaProvenanceMarkers(maven, projectDirectory, new RewriteExecutionContext());
 

components/sbm-core/src/test/java/org/springframework/sbm/project/parser/ProjectContextInitializerTest.java

@@ -29,6 +29,7 @@
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
+import org.springframework.sbm.build.impl.MavenSettingsInitializer;
 import org.springframework.sbm.build.impl.RewriteMavenArtifactDownloader;
 import org.springframework.sbm.build.impl.RewriteMavenParser;
 import org.springframework.sbm.build.migration.MavenPomCacheProvider;
@@ -78,6 +79,7 @@
         RewritePropertiesParser.class,
         MavenProjectParser.class,
         RewriteMavenParser.class,
+        MavenSettingsInitializer.class,
         RewriteXmlParser.class,
         ResourceHelper.class,
         ResourceLoader.class,

components/sbm-core/src/test/java/org/springframework/sbm/project/resource/TestProjectContext.java

@@ -23,6 +23,7 @@
 import org.springframework.core.annotation.Order;
 import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.core.io.Resource;
+import org.springframework.sbm.build.impl.MavenSettingsInitializer;
 import org.springframework.sbm.build.impl.OpenRewriteMavenBuildFile;
 import org.springframework.sbm.build.impl.RewriteMavenArtifactDownloader;
 import org.springframework.sbm.build.impl.RewriteMavenParser;
@@ -551,7 +552,7 @@ private ProjectContextInitializer createProjectContextInitializer(ProjectContext
                     new ResourceParser.ResourceFilter(),
                     eventPublisher);
 
-            RewriteMavenParser mavenParser =  new RewriteMavenParser();
+            RewriteMavenParser mavenParser =  new RewriteMavenParser(new MavenSettingsInitializer());
 
             MavenArtifactDownloader artifactDownloader = new RewriteMavenArtifactDownloader();