Issue #41: Updated AbstractRecipeTest to remove external report

Author: Anmol202005

config/import-control-test.xml

@@ -12,4 +12,5 @@
     <allow pkg="java.nio"/>
     <allow pkg="java.lang"/>
     <allow pkg="javax.xml.stream"/>
+    <allow pkg="com.puppycrawl.tools.checkstyle"/>
 </import-control>

pom.xml

@@ -65,6 +65,13 @@
         </dependency>
 
         <!-- Test dependencies -->
+        <dependency>
+            <groupId>com.puppycrawl.tools</groupId>
+            <artifactId>checkstyle</artifactId>
+            <version>${checkstyle.version}</version>
+            <classifier>tests</classifier>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.openrewrite</groupId>
             <artifactId>rewrite-test</artifactId>

src/main/java/org/checkstyle/autofix/recipe/UpperEll.java

@@ -165,7 +165,13 @@ private int computeLinePosition(J tree, J targetElement, Cursor cursor) {
         }
 
         private int computeColumnPosition(J tree, J targetElement, Cursor cursor) {
-            return computePosition(tree, targetElement, cursor, this::calculateColumnOffset);
+            return computePosition(tree, targetElement, cursor, out -> {
+                int column = calculateColumnOffset(out);
+                if (((J.Literal) targetElement).getValueSource().matches("^[+-].*")) {
+                    column++;
+                }
+                return column;
+            });
         }
 
         private int calculateColumnOffset(String out) {
@@ -175,8 +181,9 @@ private int calculateColumnOffset(String out) {
                 result = out.length();
             }
             else {
-                result = out.length() - lineBreakIndex - 1;
+                result = out.length() - lineBreakIndex;
             }
+
             return result;
         }
 

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

@@ -20,44 +20,91 @@
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.openrewrite.java.Assertions.java;
 
-import java.io.IOException;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.nio.file.Files;
-import java.nio.file.Paths;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.List;
 
 import org.checkstyle.autofix.InputClassRenamer;
+import org.checkstyle.autofix.parser.CheckstyleReportParser;
+import org.checkstyle.autofix.parser.CheckstyleViolation;
 import org.openrewrite.Recipe;
 import org.openrewrite.test.RewriteTest;
 
-public abstract class AbstractRecipeTest implements RewriteTest {
+import com.puppycrawl.tools.checkstyle.AbstractXmlTestSupport;
+import com.puppycrawl.tools.checkstyle.Checker;
+import com.puppycrawl.tools.checkstyle.XMLLogger;
+import com.puppycrawl.tools.checkstyle.api.Configuration;
+import com.puppycrawl.tools.checkstyle.bdd.InlineConfigParser;
+import com.puppycrawl.tools.checkstyle.bdd.TestInputConfiguration;
 
-    private static final String BASE_TEST_RESOURCES_PATH = "src/test/resources/org"
-            + "/checkstyle/autofix/recipe/";
+public abstract class AbstractRecipeTest extends AbstractXmlTestSupport implements RewriteTest {
+
+    protected abstract String getSubpackage();
+
+    protected abstract Recipe createRecipe(List<CheckstyleViolation> violations);
+
+    @Override
+    protected String getPackageLocation() {
+        return "org/checkstyle/autofix/recipe/" + getSubpackage();
+    }
 
     private Recipe createPreprocessingRecipe() {
         return new InputClassRenamer();
     }
 
-    protected abstract Recipe getRecipe();
-
-    protected void testRecipe(String recipePath, String testCaseName) throws IOException {
-        final String testCaseDir = testCaseName.toLowerCase();
+    protected void verify(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 List<CheckstyleViolation> violations = runCheckstyleAndGetViolations(inputPath);
 
-        final String beforeCode = Files.readString(Paths.get(BASE_TEST_RESOURCES_PATH
-                + recipePath + "/" + testCaseDir + "/" + inputFileName));
+        final String beforeCode = readFile(getPath(inputPath));
+        final String expectedAfterCode = readFile(getPath(outputPath));
+        final Recipe mainRecipe = createRecipe(violations);
 
-        final String afterCode = Files.readString(Paths.get(BASE_TEST_RESOURCES_PATH
-                + recipePath + "/" + testCaseDir + "/" + outputFileName));
+        testRecipe(beforeCode, expectedAfterCode,
+                getPath(inputPath), createPreprocessingRecipe(), mainRecipe);
+    }
 
-        final Recipe preprocessing = createPreprocessingRecipe();
-        final Recipe mainRecipe = getRecipe();
+    private List<CheckstyleViolation> runCheckstyleAndGetViolations(String inputPath)
+            throws Exception {
 
+        final String configFilePath = getPath(inputPath);
+        final TestInputConfiguration testInputConfiguration =
+                InlineConfigParser.parse(configFilePath);
+        final Configuration parsedConfig = testInputConfiguration.createConfiguration();
+
+        final Checker checker = createChecker(parsedConfig);
+        final ByteArrayOutputStream xmlOutput = new ByteArrayOutputStream();
+        final XMLLogger logger = new XMLLogger(xmlOutput, XMLLogger.OutputStreamOptions.CLOSE);
+        checker.addListener(logger);
+
+        final List<File> filesToCheck = Collections.singletonList(new File(configFilePath));
+        checker.process(filesToCheck);
+
+        final Path tempXmlPath = Files.createTempFile("checkstyle-report", ".xml");
+        try {
+            Files.write(tempXmlPath, xmlOutput.toByteArray());
+            return CheckstyleReportParser.parse(tempXmlPath);
+        }
+        finally {
+            Files.deleteIfExists(tempXmlPath);
+        }
+    }
+
+    private void testRecipe(String beforeCode, String expectedAfterCode,
+                            String filePath, Recipe... recipes) {
         assertDoesNotThrow(() -> {
             rewriteRun(
-                    spec -> spec.recipes(preprocessing, mainRecipe),
-                    java(beforeCode, afterCode)
+                    spec -> spec.recipes(recipes),
+                    java(beforeCode, expectedAfterCode, spec -> spec.path(filePath))
             );
         });
     }
+
 }

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

@@ -17,39 +17,37 @@
 
 package org.checkstyle.autofix.recipe;
 
-import java.io.IOException;
-import java.nio.file.Path;
 import java.util.List;
 
-import org.checkstyle.autofix.parser.CheckstyleReportParser;
 import org.checkstyle.autofix.parser.CheckstyleViolation;
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Recipe;
 
 public class UpperEllTest extends AbstractRecipeTest {
 
     @Override
-    protected Recipe getRecipe() {
-        final String reportPath = "src/test/resources/org/checkstyle/autofix/recipe/upperell"
-                + "/report.xml";
+    protected String getSubpackage() {
+        return "upperell";
+    }
+
+    @Override
+    protected Recipe createRecipe(List<CheckstyleViolation> violations) {
 
-        final List<CheckstyleViolation> violations =
-                CheckstyleReportParser.parse(Path.of(reportPath));
         return new UpperEll(violations);
     }
 
     @Test
-    void hexOctalLiteralTest() throws IOException {
-        testRecipe("upperell", "HexOctalLiteral");
+    void hexOctalLiteral() throws Exception {
+        verify("HexOctalLiteral");
     }
 
     @Test
-    void complexLongLiterals() throws IOException {
-        testRecipe("upperell", "ComplexLongLiterals");
+    void complexLongLiterals() throws Exception {
+        verify("ComplexLongLiterals");
     }
 
     @Test
-    void stringAndCommentTest() throws IOException {
-        testRecipe("upperell", "StringAndComments");
+    void stringAndComments() throws Exception {
+        verify("StringAndComments");
     }
 }

src/test/resources/org/checkstyle/autofix/recipe/upperell/complexlongliterals/InputComplexLongLiterals.java

@@ -1,3 +1,8 @@
+/*
+com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
+
+*/
+
 package org.checkstyle.autofix.recipe.upperell.complexlongliterals;
 
 public class InputComplexLongLiterals {
@@ -11,8 +16,8 @@ public class InputComplexLongLiterals {
     private Long simpleLong = 1234l;
     private Long negativeLong = -5678l;
     private Long underscoreLong = 1_000_000l;
-    Long maxLongObject = 9223372036854775807l;    //suppressed violation
-    Long minLongObject = -9223372036854775808l;    //suppressed violation
+    Long maxLongObject = 9223372036854775807l;
+    Long minLongObject = -9223372036854775808l;
 
     public long calculate(long input1, long input2) {
         return input1 + input2 + 1000l;

src/test/resources/org/checkstyle/autofix/recipe/upperell/complexlongliterals/OutputComplexLongLiterals.java

@@ -1,3 +1,8 @@
+/*
+com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
+
+*/
+
 package org.checkstyle.autofix.recipe.upperell.complexlongliterals;
 
 public class OutputComplexLongLiterals {
@@ -11,8 +16,8 @@ public class OutputComplexLongLiterals {
     private Long simpleLong = 1234L;
     private Long negativeLong = -5678L;
     private Long underscoreLong = 1_000_000L;
-    Long maxLongObject = 9223372036854775807l;    //suppressed violation
-    Long minLongObject = -9223372036854775808l;    //suppressed violation
+    Long maxLongObject = 9223372036854775807L;
+    Long minLongObject = -9223372036854775808L;
 
     public long calculate(long input1, long input2) {
         return input1 + input2 + 1000L;

src/test/resources/org/checkstyle/autofix/recipe/upperell/hexoctalliteral/InputHexOctalLiteral.java

@@ -1,3 +1,8 @@
+/*
+com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
+
+*/
+
 package org.checkstyle.autofix.recipe.upperell.hexoctalliteral;
 
 public class InputHexOctalLiteral {
@@ -8,8 +13,8 @@ public class InputHexOctalLiteral {
     private long decimal = 12345l;
 
     public void calculateValues() {
-        long hexResult = 0xDEADBEEFl + 0xDEADBEFl; //suppressed violation for 0xDEADBEFl
-        long octalResult = 01234l + 0xDEADBEEFl;   //suppressed violation for 0xDEADBEFl
+        long hexResult = 0xDEADBEEFl + 0xDEADBEFl;
+        long octalResult = 01234l + 0xDEADBEEFl;
         long binaryResult = 0b11110000l;
     }
 }

src/test/resources/org/checkstyle/autofix/recipe/upperell/hexoctalliteral/OutputHexOctalLiteral.java

@@ -1,3 +1,8 @@
+/*
+com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
+
+*/
+
 package org.checkstyle.autofix.recipe.upperell.hexoctalliteral;
 
 public class OutputHexOctalLiteral {
@@ -8,8 +13,8 @@ public class OutputHexOctalLiteral {
     private long decimal = 12345L;
 
     public void calculateValues() {
-        long hexResult = 0xDEADBEEFL + 0xDEADBEFl; //suppressed violation for 0xDEADBEFl
-        long octalResult = 01234L + 0xDEADBEEFl;   //suppressed violation for 0xDEADBEFl
+        long hexResult = 0xDEADBEEFL + 0xDEADBEFL;
+        long octalResult = 01234L + 0xDEADBEEFL;
         long binaryResult = 0b11110000L;
     }
 }