Issue #41: Updated headerTest to use AbstractRecipeTestSupport

Author: Anmol202005

src/main/java/org/checkstyle/autofix/parser/ConfigurationLoader.java

@@ -34,7 +34,7 @@ private ConfigurationLoader() {
         // utility class
     }
 
-    private static CheckConfiguration mapConfiguration(Configuration config) {
+    public static CheckConfiguration mapConfiguration(Configuration config) {
         final Map<String, String> properties = new HashMap<>();
         final String[] propertyNames = config.getPropertyNames();
         for (String propertyName : propertyNames) {

src/test/java/org/checkstyle/autofix/recipe/AbstractRecipeTestSupport.java

@@ -28,8 +28,10 @@
 import java.util.List;
 
 import org.checkstyle.autofix.InputClassRenamer;
+import org.checkstyle.autofix.parser.CheckConfiguration;
 import org.checkstyle.autofix.parser.CheckstyleReportParser;
 import org.checkstyle.autofix.parser.CheckstyleViolation;
+import org.checkstyle.autofix.parser.ConfigurationLoader;
 import org.openrewrite.Recipe;
 import org.openrewrite.test.RewriteTest;
 
@@ -45,7 +47,8 @@ public abstract class AbstractRecipeTestSupport extends AbstractXmlTestSupport
 
     protected abstract String getSubpackage();
 
-    protected abstract Recipe createRecipe(List<CheckstyleViolation> violations);
+    protected abstract Recipe createRecipe(List<CheckstyleViolation> violations,
+                                           CheckConfiguration configuration);
 
     @Override
     protected String getPackageLocation() {
@@ -57,19 +60,21 @@ private Recipe createPreprocessingRecipe() {
     }
 
     protected void verify(String testCaseName) throws Exception {
+        verify(getCheckConfigurations(testCaseName), testCaseName);
+    }
+
+    protected void verify(Configuration config, String testCaseName) throws Exception {
         final String inputFileName = "Input" + testCaseName + ".java";
         final String outputFileName = "Output" + testCaseName + ".java";
         final String inputPath = testCaseName.toLowerCase() + "/" + inputFileName;
         final String outputPath = testCaseName.toLowerCase() + "/" + outputFileName;
 
-        final Configuration config = getCheckConfigurations(inputPath);
         final List<CheckstyleViolation> violations = runCheckstyle(inputPath, config);
 
         final String beforeCode = readFile(getPath(inputPath));
         final String expectedAfterCode = readFile(getPath(outputPath));
-
-        final Recipe mainRecipe = createRecipe(violations);
-
+        final CheckConfiguration checkConfig = ConfigurationLoader.mapConfiguration(config);
+        final Recipe mainRecipe = createRecipe(violations, checkConfig);
         testRecipe(beforeCode, expectedAfterCode,
                 getPath(inputPath), createPreprocessingRecipe(), mainRecipe);
     }
@@ -95,7 +100,9 @@ private List<CheckstyleViolation> runCheckstyle(String inputPath,
         }
     }
 
-    private Configuration getCheckConfigurations(String inputPath) throws Exception {
+    private Configuration getCheckConfigurations(String testCaseName) throws Exception {
+        final String inputFileName = "Input" + testCaseName + ".java";
+        final String inputPath = testCaseName.toLowerCase() + "/" + inputFileName;
         final String configFilePath = getPath(inputPath);
         final TestInputConfiguration testInputConfiguration =
                 InlineConfigParser.parse(configFilePath);

src/test/java/org/checkstyle/autofix/recipe/HeaderTest.java

@@ -17,53 +17,57 @@
 
 package org.checkstyle.autofix.recipe;
 
-import java.io.IOException;
-import java.nio.file.Path;
 import java.util.List;
 
 import org.checkstyle.autofix.parser.CheckConfiguration;
-import org.checkstyle.autofix.parser.CheckstyleReportParser;
 import org.checkstyle.autofix.parser.CheckstyleViolation;
-import org.checkstyle.autofix.parser.ConfigurationLoader;
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Recipe;
 
-import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
+import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
+import com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck;
 
-public class HeaderTest extends AbstractRecipeTest {
+public class HeaderTest extends AbstractRecipeTestSupport {
 
     @Override
-    protected Recipe getRecipe() throws CheckstyleException {
-        final String reportPath = "src/test/resources/org/checkstyle/autofix/recipe/header"
-                + "/report.xml";
-
-        final String configPath = "src/test/resources/org/checkstyle/autofix/recipe/header"
-                + "/config.xml";
-
-        final CheckConfiguration config = ConfigurationLoader.loadConfiguration(configPath, null);
+    protected String getSubpackage() {
+        return "header";
+    }
 
-        final List<CheckstyleViolation> violations =
-                CheckstyleReportParser.parse(Path.of(reportPath));
+    @Override
+    protected Recipe createRecipe(List<CheckstyleViolation> violations, CheckConfiguration config) {
 
-        final CheckConfiguration checkConfig = config
-                .getChildConfig("Header");
+        return new Header(violations, config);
 
-        return new Header(violations, checkConfig);
     }
 
     @Test
-    void headerTest() throws IOException, CheckstyleException {
-        testRecipe("header", "HeaderBlankLines");
+    void headerTest() throws Exception {
+        final DefaultConfiguration checkConfig = createModuleConfig(HeaderCheck.class);
+        final String headerPath = "src/test/resources/org/checkstyle/autofix/"
+                + "recipe/header/header.txt";
+        checkConfig.addProperty("headerFile", headerPath);
+        checkConfig.addProperty("ignoreLines", "3");
+        verify(checkConfig, "HeaderBlankLines");
     }
 
     @Test
-    void headerCommentTest() throws IOException, CheckstyleException {
-        testRecipe("header", "HeaderComments");
+    void headerCommentTest() throws Exception {
+        final DefaultConfiguration checkConfig = createModuleConfig(HeaderCheck.class);
+        final String headerPath = "src/test/resources/org/checkstyle/autofix/"
+                + "recipe/header/header.txt";
+        checkConfig.addProperty("headerFile", headerPath);
+        checkConfig.addProperty("ignoreLines", "3");
+        verify(checkConfig, "HeaderComments");
     }
 
     @Test
-    void headerIncorrect() throws IOException, CheckstyleException {
-        testRecipe("header", "HeaderIncorrect");
+    void headerIncorrect() throws Exception {
+        final DefaultConfiguration checkConfig = createModuleConfig(HeaderCheck.class);
+        final String headerPath = "src/test/resources/org/checkstyle/"
+                + "autofix/recipe/header/header.txt";
+        checkConfig.addProperty("headerFile", headerPath);
+        checkConfig.addProperty("ignoreLines", "3");
+        verify(checkConfig, "HeaderIncorrect");
     }
-
 }

src/test/java/org/checkstyle/autofix/recipe/UpperEllTest.java

@@ -19,6 +19,7 @@
 
 import java.util.List;
 
+import org.checkstyle.autofix.parser.CheckConfiguration;
 import org.checkstyle.autofix.parser.CheckstyleViolation;
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Recipe;
@@ -31,7 +32,7 @@ protected String getSubpackage() {
     }
 
     @Override
-    protected Recipe createRecipe(List<CheckstyleViolation> violations) {
+    protected Recipe createRecipe(List<CheckstyleViolation> violations, CheckConfiguration config) {
 
         return new UpperEll(violations);
     }