Added TestsShouldNotBePublic to JUnit5BestPractices, and added BeforeAll/AfterAll to TestsShouldNotBePublic scope (#286)

nmck257 · web-flow · commit 2d373c38191a · 2022-12-07T17:54:36.000-08:00
diff --git a/src/main/java/org/openrewrite/java/testing/cleanup/TestsShouldNotBePublic.java b/src/main/java/org/openrewrite/java/testing/cleanup/TestsShouldNotBePublic.java
@@ -58,7 +58,7 @@ public String getDisplayName() {
 
     @Override
     public String getDescription() {
-        return "Remove `public` and optionally `protected` modifiers from methods with `@Test`, `@ParameterizedTest`, `@RepeatedTest`, `@TestFactory`, `@BeforeEach` or `@AfterEach`. They no longer have to be public visibility to be usable by JUnit 5.";
+        return "Remove `public` and optionally `protected` modifiers from methods with `@Test`, `@ParameterizedTest`, `@RepeatedTest`, `@TestFactory`, `@BeforeEach`, `@AfterEach`, `@BeforeAll`, or `@AfterAll`. They no longer have to be public visibility to be usable by JUnit 5.";
     }
 
   @Override
@@ -154,7 +154,9 @@ private boolean hasJUnit5MethodAnnotation(MethodDeclaration method) {
                         || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.params.ParameterizedTest")
                         || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.TestFactory")
                         || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.AfterEach")
-                        || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.BeforeEach")) {
+                        || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.BeforeEach")
+                        || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.AfterAll")
+                        || TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.BeforeAll")) {
                     return true;
                 }
             }
diff --git a/src/main/resources/META-INF/rewrite/junit5.yml b/src/main/resources/META-INF/rewrite/junit5.yml
@@ -25,6 +25,7 @@ recipeList:
   - org.openrewrite.java.testing.junit5.StaticImports
   - org.openrewrite.java.testing.junit5.JUnit4to5Migration
   - org.openrewrite.java.testing.junit5.CleanupAssertions
+  - org.openrewrite.java.testing.cleanup.TestsShouldNotBePublic
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.testing.junit5.StaticImports
diff --git a/src/test/java/org/openrewrite/java/testing/junit5/AssertToAssertionsTest.java b/src/test/java/org/openrewrite/java/testing/junit5/AssertToAssertionsTest.java
@@ -316,7 +316,7 @@ void staticallyImportAssertions() {
           spec -> spec
             .cycles(3)
             .recipe(Environment.builder()
-              .scanRuntimeClasspath("org.openrewrite.java.testing.junit5")
+              .scanRuntimeClasspath("org.openrewrite.java.testing")
               .build()
               .activateRecipes("org.openrewrite.java.testing.junit5.JUnit5BestPractices")),
           //language=java
diff --git a/src/test/java/org/openrewrite/java/testing/junit5/AssumeToAssumptionsTest.java b/src/test/java/org/openrewrite/java/testing/junit5/AssumeToAssumptionsTest.java
@@ -37,7 +37,7 @@ public void defaults(RecipeSpec spec) {
     void assumeToAssumptions() {
         rewriteRun(
           spec -> spec.recipe(Environment.builder()
-            .scanRuntimeClasspath("org.openrewrite.java.testing.junit5")
+            .scanRuntimeClasspath("org.openrewrite.java.testing")
             .build()
             .activateRecipes("org.openrewrite.java.testing.junit5.JUnit5BestPractices")),
           //language=java
diff --git a/src/test/java/org/openrewrite/java/testing/junit5/JUnit5BestPracticesTest.java b/src/test/java/org/openrewrite/java/testing/junit5/JUnit5BestPracticesTest.java
@@ -31,7 +31,7 @@ public void defaults(RecipeSpec spec) {
         spec
           .parser(JavaParser.fromJavaVersion().classpath("junit"))
           .recipe(Environment.builder()
-            .scanRuntimeClasspath("org.openrewrite.java.testing.junit5")
+            .scanRuntimeClasspath("org.openrewrite.java.testing")
             .build()
             .activateRecipes("org.openrewrite.java.testing.junit5.JUnit5BestPractices"));
     }
@@ -53,9 +53,9 @@ public void initialize() {
             """
               import org.junit.jupiter.api.BeforeEach;
 
-              public class Example {
+              class Example {
                   @BeforeEach
-                  public void initialize() {
+                  void initialize() {
                   }
               }
               """
@@ -80,9 +80,9 @@ public void initialize() {
             """
               import org.junit.jupiter.api.AfterEach;
 
-              public class Example {
+              class Example {
                   @AfterEach
-                  public void initialize() {
+                  void initialize() {
                   }
               }
               """
@@ -107,9 +107,9 @@ public static void initialize() {
             """
               import org.junit.jupiter.api.BeforeAll;
 
-              public class Example {
+              class Example {
                   @BeforeAll
-                  public static void initialize() {
+                  static void initialize() {
                   }
               }
               """
@@ -134,9 +134,9 @@ public static void initialize() {
             """
               import org.junit.jupiter.api.AfterAll;
 
-              public class Example {
+              class Example {
                   @AfterAll
-                  public static void initialize() {
+                  static void initialize() {
                   }
               }
               """
@@ -152,20 +152,34 @@ void changeIgnoreToDisabled() {
           java(
             """
               import org.junit.Ignore;
+              import org.junit.Test;
 
               public class Example {
-                  @Ignore @Test public void something() {}
+                  @Ignore
+                  @Test
+                  public void something() {
+                  }
                             
-                  @Ignore("not ready yet") @Test public void somethingElse() {}
+                  @Ignore("not ready yet")
+                  @Test
+                  public void somethingElse() {
+                  }
               }
               """,
             """
               import org.junit.jupiter.api.Disabled;
+              import org.junit.jupiter.api.Test;
 
-              public class Example {
-                  @Disabled @Test public void something() {}
+              class Example {
+                  @Disabled
+                  @Test
+                  void something() {
+                  }
                             
-                  @Disabled("not ready yet") @Test public void somethingElse() {}
+                  @Disabled("not ready yet")
+                  @Test
+                  void somethingElse() {
+                  }
               }
               """
           )
diff --git a/src/test/java/org/openrewrite/java/testing/junit5/StaticImportsTest.java b/src/test/java/org/openrewrite/java/testing/junit5/StaticImportsTest.java
@@ -30,7 +30,7 @@ public void defaults(RecipeSpec spec) {
         spec
           .parser(JavaParser.fromJavaVersion().classpath("junit-jupiter-api"))
           .recipe(Environment.builder()
-            .scanRuntimeClasspath("org.openrewrite.java.testing.junit5")
+            .scanRuntimeClasspath("org.openrewrite.java.testing")
             .build()
             .activateRecipes("org.openrewrite.java.testing.junit5.JUnit5BestPractices"));
     }

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public String getDisplayName() {`
`58`	`58`
`59`	`59`	`@Override`
`60`	`60`	`public String getDescription() {`
`61`		- return "Remove `public` and optionally `protected` modifiers from methods with `@Test`, `@ParameterizedTest`, `@RepeatedTest`, `@TestFactory`, `@BeforeEach` or `@AfterEach`. They no longer have to be public visibility to be usable by JUnit 5.";
	`61`	+ return "Remove `public` and optionally `protected` modifiers from methods with `@Test`, `@ParameterizedTest`, `@RepeatedTest`, `@TestFactory`, `@BeforeEach`, `@AfterEach`, `@BeforeAll`, or `@AfterAll`. They no longer have to be public visibility to be usable by JUnit 5.";
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`@Override`
`@@ -154,7 +154,9 @@ private boolean hasJUnit5MethodAnnotation(MethodDeclaration method) {`
`154`	`154`	`\|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.params.ParameterizedTest")`
`155`	`155`	`\|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.TestFactory")`
`156`	`156`	`\|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.AfterEach")`
`157`		`- \|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.BeforeEach")) {`
	`157`	`+ \|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.BeforeEach")`
	`158`	`+ \|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.AfterAll")`
	`159`	`+ \|\| TypeUtils.isOfClassType(a.getType(), "org.junit.jupiter.api.BeforeAll")) {`
`158`	`160`	`return true;`
`159`	`161`	`}`
`160`	`162`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public void defaults(RecipeSpec spec) {`
`30`	`30`	`spec`
`31`	`31`	`.parser(JavaParser.fromJavaVersion().classpath("junit-jupiter-api"))`
`32`	`32`	`.recipe(Environment.builder()`
`33`		`- .scanRuntimeClasspath("org.openrewrite.java.testing.junit5")`
	`33`	`+ .scanRuntimeClasspath("org.openrewrite.java.testing")`
`34`	`34`	`.build()`
`35`	`35`	`.activateRecipes("org.openrewrite.java.testing.junit5.JUnit5BestPractices"));`
`36`	`36`	`}`