Refactor Parser properties

* Change properties file name
* properties initialized with PostProcessor
* Cache added to ExecutionContext on bean declaration
* Remove unused property

Author: fabapp2

sbm-support-rewrite/src/main/java/org/springframework/sbm/ParserPropertiesPostProcessor.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2021 - 2023 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;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.env.EnvironmentPostProcessor;
+import org.springframework.boot.env.PropertiesPropertySourceLoader;
+import org.springframework.core.env.ConfigurableEnvironment;
+import org.springframework.core.env.PropertySource;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.core.io.Resource;
+import org.springframework.stereotype.Component;
+import org.springframework.util.Assert;
+
+import java.io.IOException;
+
+/**
+ * Add default values from 'sbm-support-rewrite.properties' to environment.
+ */
+@Component
+public class ParserPropertiesPostProcessor implements EnvironmentPostProcessor {
+
+    private final PropertiesPropertySourceLoader loader = new PropertiesPropertySourceLoader();
+
+    @Override
+    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
+        Resource path = new ClassPathResource("/META-INF/sbm-support-rewrite.properties");
+        PropertySource<?> propertySource = loadProperties(path);
+        environment.getPropertySources().addLast(propertySource);
+    }
+
+    private PropertySource<?> loadProperties(Resource path) {
+        Assert.isTrue(path.exists(), () -> "Resource " + path + " does not exist");
+        try {
+            return this.loader.load("custom-resource", path).get(0);
+        }
+        catch (IOException ex) {
+            throw new IllegalStateException("Failed to load properties configuration from " + path, ex);
+        }
+    }
+
+}

sbm-support-rewrite/src/main/java/org/springframework/sbm/RewriteParserConfig.java

@@ -16,29 +16,18 @@
 package org.springframework.sbm;
 
 import lombok.extern.slf4j.Slf4j;
-import org.openrewrite.ExecutionContext;
-import org.openrewrite.Recipe;
-import org.openrewrite.RecipeRun;
-import org.openrewrite.SourceFile;
-import org.openrewrite.internal.InMemoryLargeSourceSet;
-import org.openrewrite.maven.MavenExecutionContextView;
 import org.openrewrite.maven.cache.CompositeMavenPomCache;
 import org.openrewrite.maven.cache.InMemoryMavenPomCache;
 import org.openrewrite.maven.cache.MavenPomCache;
 import org.openrewrite.maven.cache.RocksdbMavenPomCache;
-import org.openrewrite.xml.tree.Xml;
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.SpringBootConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.sbm.parsers.ParserProperties;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.nio.file.Path;
-import java.util.List;
 
 
 /**
@@ -74,7 +63,6 @@ MavenPomCache mavenPomCache(ExecutionContext executionContext, ParserSettings pa
                 }
             }
         }
-        MavenExecutionContextView.view(executionContext).setPomCache(mavenPomCache);
         return mavenPomCache;
     }
 }

sbm-support-rewrite/src/main/java/org/springframework/sbm/parsers/ParserProperties.java

@@ -25,6 +25,7 @@
 
 /**
  * ConfigurationProperties with prefix {@code parser}.
+ * Defaults coming from {@code META-INF/sbm-support-rewrite.properties}
  *
  * @author Fabian Krüger
  */
@@ -47,13 +48,6 @@ public class ParserSettings {
     private List<String> activeProfiles = List.of("default");
     private Set<String> ignoredPathPatterns = new HashSet<>();
 
-    /**
-     * @return fully qualified classname of the logger to use.
-     */
-    public String getLoggerClass() {
-        return loggerClass;
-    }
-
     public void setLoggerClass(String loggerClass) {
         this.loggerClass = loggerClass;
     }

sbm-support-rewrite/src/main/resources/META-INF/sbm-support-rewrite.properties

@@ -0,0 +1,30 @@
+#
+# Copyright 2021 - 2023 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.
+#
+
+# Enable/Disable the MavenPomCache
+# With 'false' OpenRewrite's InMemoryMavenPomCache will be used.
+# With 'true' a composite cache of RocksdbMavenPomCache and InMemoryMavenPomCache will be used.
+parser.pomCacheEnabled=false
+
+# Defines the cache dir for RocksdbMavenPomCache when `parser.pomCacheEnabled` is `true`.
+parser.pomCacheDirectory=~/.rewrite-cache
+parser.skipMavenParsing=false
+parser.plainTextMasks=*.txt
+parser.sizeThresholdMb=10
+parser.runPerSubmodule=true
+parser.failOnInvalidActiveRecipes=true
+parser.activeProfiles=default
+parser.ignoredPathPatterns=**.idea,**.git

sbm-support-rewrite/src/main/resources/META-INF/spring.factories

@@ -0,0 +1 @@
+org.springframework.boot.env.EnvironmentPostProcessor=org.springframework.sbm.ParserPropertiesPostProcessor

sbm-support-rewrite/src/main/resources/parser.properties

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2021 - 2023 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.parsers;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+
+
+class ParserPropertiesTest {
+
+    @Nested
+    @SpringBootTest
+    public class GivenDefaultProperties {
+
+        @Autowired
+        private ParserProperties parserProperties;
+
+        @Test
+        @DisplayName("parser.pomCacheEnabled")
+        void validPomCacheEnabled() {
+            assertThat(parserProperties.isPomCacheEnabled()).isFalse();
+        }
+
+
+        @Test
+        @DisplayName("parser.pomCacheDirectory")
+        void validPomCacheDirectory() {
+            assertThat(parserProperties.getPomCacheDirectory()).isEqualTo("~/.rewrite-cache");
+        }
+
+        @Test
+        @DisplayName("parser.skipMavenParsing")
+        void validSkipMavenParsing() {
+            assertThat(parserProperties.isSkipMavenParsing()).isFalse();
+        }
+
+        @Test
+        @DisplayName("parser.plainTextMasks")
+        void validPlainTextMasks() {
+            assertThat(parserProperties.getPlainTextMasks()).containsExactlyInAnyOrder("*.txt");
+        }
+
+        @Test
+        @DisplayName("parser.sizeThresholdMb")
+        void validSizeThresholdMb() {
+            assertThat(parserProperties.getSizeThresholdMb()).isEqualTo(10);
+        }
+
+        @Test
+        @DisplayName("parser.runPerSubmodule")
+        void validRunPerSubmodule() {
+            assertThat(parserProperties.isRunPerSubmodule()).isTrue();
+        }
+
+        @Test
+        @DisplayName("parser.failOnInvalidActiveRecipes")
+        void validFailOnInvalidActiveRecipes() {
+            assertThat(parserProperties.isFailOnInvalidActiveRecipes()).isTrue();
+        }
+
+        @Test
+        @DisplayName("parser.activeProfiles")
+        void validActiveProfiles() {
+            assertThat(parserProperties.getActiveProfiles()).containsExactlyInAnyOrder("default");
+        }
+
+        @Test
+        @DisplayName("parser.ignoredPathPatterns")
+        void validIgnoredPathPatterns() {
+            assertThat(parserProperties.getIgnoredPathPatterns()).containsExactlyInAnyOrder("**.idea","**.git");
+        }
+
+    }
+
+}