Add whitespace validation to RewriteTest

openrewrite · Feb 3, 2024 · 33d8f7d · 33d8f7d
1 parent 2923de5
commit 33d8f7d
Show file tree

Hide file tree

Showing 41 changed files with 326 additions and 99 deletions.
diff --git a/rewrite-core/src/main/java/org/openrewrite/SourceFile.java b/rewrite-core/src/main/java/org/openrewrite/SourceFile.java
@@ -112,6 +112,11 @@ default <P> TreeVisitor<?, PrintOutputCapture<P>> printer(Cursor cursor) {
         throw new UnsupportedOperationException("SourceFile implementations should override this method");
     }
 
+    @Incubating(since = "8.2.0")
+    default <S, T extends S> T service(Class<S> service) {
+        throw new UnsupportedOperationException("Service " + service + " not supported");
+    }
+
     /**
      * A measure of the size of the AST by count of number of AST nodes or some other similar measure. Because perfect referential
      * uniqueness is space inefficient, this weight will always be approximate and is best used for comparative size between two ASTs

diff --git a/rewrite-core/src/main/java/org/openrewrite/internal/WhitespaceValidationService.java b/rewrite-core/src/main/java/org/openrewrite/internal/WhitespaceValidationService.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 the original author or authors.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.openrewrite.internal;
+
+import org.openrewrite.ExecutionContext;
+import org.openrewrite.TreeVisitor;
+
+/**
+ * Return a visitor suitable for use by the test framework to validate that whitespace contains no non-whitespace characters.
+ */
+public interface WhitespaceValidationService {
+
+    TreeVisitor<?, ExecutionContext> getVisitor();
+}
diff --git a/.../openrewrite/groovy/GroovyParserTest.java → ...al/GroovyWhitespaceValidationService.java b/.../openrewrite/groovy/GroovyParserTest.java → ...al/GroovyWhitespaceValidationService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 the original author or authors.
+ * Copyright 2024 the original author or authors.
  * <p>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,58 +13,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.openrewrite.groovy;
+package org.openrewrite.groovy.internal;
 
-import lombok.EqualsAndHashCode;
-import lombok.Value;
 import org.openrewrite.ExecutionContext;
-import org.openrewrite.Recipe;
 import org.openrewrite.TreeVisitor;
+import org.openrewrite.groovy.GroovyVisitor;
 import org.openrewrite.groovy.tree.GSpace;
+import org.openrewrite.internal.StringUtils;
+import org.openrewrite.internal.WhitespaceValidationService;
 import org.openrewrite.java.tree.Space;
-import org.openrewrite.test.RecipeSpec;
-import org.openrewrite.test.RewriteTest;
-
-public interface GroovyParserTest extends RewriteTest {
-    @Override
-    default void defaults(RecipeSpec spec) {
-        spec.recipe(new SpaceContainsOnlyWhitespace());
-    }
-}
-
-@Value
-@EqualsAndHashCode(callSuper = false)
-class SpaceContainsOnlyWhitespace extends Recipe {
-
-    @Override
-    public String getDisplayName() {
-        return "Space contains only whitespace";
-    }
-
-    @Override
-    public String getDescription() {
-        return "Spaces containing non-whitespace characters is a common parser failure mode not otherwise detected.";
-    }
 
+public class GroovyWhitespaceValidationService implements WhitespaceValidationService {
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
-        return new GroovyVisitor<>() {
+        return new GroovyVisitor<ExecutionContext>() {
             @Override
             public Space visitSpace(Space space, GSpace.Location loc, ExecutionContext executionContext) {
-                if(!space.getWhitespace().isBlank()) {
+                if(!StringUtils.isBlank(space.getWhitespace())) {
                     return space.withWhitespace("~~(non-whitespace)~~>" + space.getWhitespace() + "<~~");
                 }
                 return space;
             }
 
             @Override
             public Space visitSpace(Space space, Space.Location loc, ExecutionContext executionContext) {
-                if(!space.getWhitespace().isBlank()) {
+                if(!StringUtils.isBlank(space.getWhitespace())) {
                     return space.withWhitespace("~~(non-whitespace)~~>" + space.getWhitespace() + "<~~");
                 }
                 return space;
             }
         };
-
     }
 }
diff --git a/rewrite-groovy/src/main/java/org/openrewrite/groovy/internal/package-info.java b/rewrite-groovy/src/main/java/org/openrewrite/groovy/internal/package-info.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 the original author or authors.
+ * <p>
+ * 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.
+ */
+@NonNullApi
+package org.openrewrite.groovy.internal;
+
+import org.openrewrite.internal.lang.NonNullApi;
diff --git a/rewrite-groovy/src/main/java/org/openrewrite/groovy/tree/G.java b/rewrite-groovy/src/main/java/org/openrewrite/groovy/tree/G.java
@@ -21,6 +21,8 @@
 import org.openrewrite.*;
 import org.openrewrite.groovy.GroovyPrinter;
 import org.openrewrite.groovy.GroovyVisitor;
+import org.openrewrite.groovy.internal.GroovyWhitespaceValidationService;
+import org.openrewrite.internal.WhitespaceValidationService;
 import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.java.internal.TypesInUse;
 import org.openrewrite.java.tree.*;
@@ -136,6 +138,15 @@ public G.CompilationUnit withPackageDeclaration(Package packageDeclaration) {
             return getPadding().withPackageDeclaration(JRightPadded.withElement(this.packageDeclaration, packageDeclaration));
         }
 
+        @SuppressWarnings("unchecked")
+        @Override
+        public <S, T extends S> T service(Class<S> service) {
+            if(WhitespaceValidationService.class.getName().equals(service.getName())) {
+                return (T) new GroovyWhitespaceValidationService();
+            }
+            return JavaSourceFile.super.service(service);
+        }
+
         List<JRightPadded<Statement>> statements;
 
         public List<Statement> getStatements() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/AssertTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/AssertTest.java
@@ -17,12 +17,12 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings({"GroovyUnusedAssignment", "GrUnnecessarySemicolon"})
-class AssertTest implements GroovyParserTest {
+class AssertTest implements RewriteTest {
 
     @Issue("https://github.com/openrewrite/rewrite/issues/3473")
     @Test

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/AssignmentTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/AssignmentTest.java
@@ -17,12 +17,12 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings({"GroovyUnusedAssignment", "GrUnnecessarySemicolon"})
-class AssignmentTest implements GroovyParserTest {
+class AssignmentTest implements RewriteTest {
 
     @Test
     void concat() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/BinaryTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/BinaryTest.java
@@ -17,12 +17,12 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings({"GroovyUnusedAssignment", "GrUnnecessarySemicolon", "UnnecessaryQualifiedReference"})
-class BinaryTest implements GroovyParserTest {
+class BinaryTest implements RewriteTest {
 
     @SuppressWarnings("GroovyConstantConditional")
     @Test

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/BlockTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/BlockTest.java
@@ -16,12 +16,12 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings("GrUnnecessarySemicolon")
-class BlockTest implements GroovyParserTest {
+class BlockTest implements RewriteTest {
 
     @Test
     void block() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ClassDeclarationTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ClassDeclarationTest.java
@@ -18,7 +18,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 import org.openrewrite.java.tree.J;
 import org.openrewrite.java.tree.JavaType;
 import org.openrewrite.java.tree.TypeUtils;
@@ -28,7 +28,7 @@
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings("GrUnnecessaryPublicModifier")
-class ClassDeclarationTest implements GroovyParserTest {
+class ClassDeclarationTest implements RewriteTest {
 
     @Test
     void multipleClassDeclarationsInOneCompilationUnit() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ClassExpressionTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ClassExpressionTest.java
@@ -16,11 +16,11 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
-class ClassExpressionTest implements GroovyParserTest {
+class ClassExpressionTest implements RewriteTest {
 
     @Test
     void classExpressions() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/CompilationUnitTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/CompilationUnitTest.java
@@ -19,12 +19,12 @@
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
 import org.openrewrite.groovy.GroovyParser;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings("GroovyUnusedAssignment")
-class CompilationUnitTest implements GroovyParserTest {
+class CompilationUnitTest implements RewriteTest {
 
     @SuppressWarnings("GrPackage")
     @Test

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ConstructorTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ConstructorTest.java
@@ -16,11 +16,11 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
-public class ConstructorTest implements GroovyParserTest {
+public class ConstructorTest implements RewriteTest {
 
     @Test
     void inParens() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/EnumTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/EnumTest.java
@@ -17,11 +17,11 @@
 
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
-class EnumTest implements GroovyParserTest {
+class EnumTest implements RewriteTest {
 
     @Disabled
     @Test

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/FieldAccessTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/FieldAccessTest.java
@@ -16,11 +16,11 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
-class FieldAccessTest implements GroovyParserTest {
+class FieldAccessTest implements RewriteTest {
 
     @Test
     void starAccess() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ForLoopTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ForLoopTest.java
@@ -17,12 +17,12 @@
 
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings({"GroovyEmptyStatementBody", "GroovyUnusedAssignment", "GrUnnecessarySemicolon", "GroovyUnnecessaryContinue"})
-class ForLoopTest implements GroovyParserTest {
+class ForLoopTest implements RewriteTest {
 
     @Test
     void forLoopMultipleInit() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/IfTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/IfTest.java
@@ -16,12 +16,12 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings({"GroovyIfStatementWithIdenticalBranches", "GroovyConstantIfStatement", "GrUnnecessarySemicolon", "GroovyUnusedIncOrDec", "GroovyEmptyStatementBody"})
-class IfTest implements GroovyParserTest {
+class IfTest implements RewriteTest {
 
     @Test
     void ifElse() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ImportTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ImportTest.java
@@ -16,13 +16,13 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 import org.openrewrite.java.tree.Space;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.openrewrite.groovy.Assertions.groovy;
 
-class ImportTest implements GroovyParserTest {
+class ImportTest implements RewriteTest {
     @Test
     void classImport() {
         rewriteRun(

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/LabelsTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/LabelsTest.java
@@ -16,11 +16,11 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
-class LabelsTest implements GroovyParserTest {
+class LabelsTest implements RewriteTest {
 
     @Test
     void singleLabel() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/LambdaTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/LambdaTest.java
@@ -17,12 +17,12 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings("GroovyUnusedAssignment")
-class LambdaTest implements GroovyParserTest {
+class LambdaTest implements RewriteTest {
 
     @Test
     void lambdaExpressionNoParens() {

diff --git a/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ListTest.java b/rewrite-groovy/src/test/java/org/openrewrite/groovy/tree/ListTest.java
@@ -16,12 +16,12 @@
 package org.openrewrite.groovy.tree;
 
 import org.junit.jupiter.api.Test;
-import org.openrewrite.groovy.GroovyParserTest;
+import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.groovy.Assertions.groovy;
 
 @SuppressWarnings("GroovyUnusedAssignment")
-class ListTest implements GroovyParserTest {
+class ListTest implements RewriteTest {
 
     @Test
     void listLiteral() {