Skip to content

Commit

Permalink
Add IsBuildGradle precondition to GradleUseJunitJupiter
Browse files Browse the repository at this point in the history 
Fixes openrewrite/rewrite-spring#654
  • Loading branch information
@timtebeek
timtebeek committed Dec 31, 2024
1 parent ea60250 commit b9fa756
Showing 1 changed file with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions src/main/java/org/openrewrite/java/testing/junit5/GradleUseJunitJupiter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.gradle.GradleParser;
import org.openrewrite.gradle.IsBuildGradle;
import org.openrewrite.gradle.marker.GradleProject;
import org.openrewrite.groovy.GroovyIsoVisitor;
import org.openrewrite.groovy.tree.G;
Expand All @@ -48,33 +50,33 @@ public String getDisplayName() {
@Override
public String getDescription() {
return "By default Gradle's `Test` tasks use JUnit 4. " +
"Gradle `Test` tasks must be configured with `useJUnitPlatform()` to run JUnit Jupiter tests. " +
"This recipe adds the `useJUnitPlatform()` method call to the `Test` task configuration.";
"Gradle `Test` tasks must be configured with `useJUnitPlatform()` to run JUnit Jupiter tests. " +
"This recipe adds the `useJUnitPlatform()` method call to the `Test` task configuration.";
}

private static final String USE_JUNIT_PLATFORM_PATTERN = "org.gradle.api.tasks.testing.Test useJUnitPlatform()";
private static final MethodMatcher USE_JUNIT_PLATFORM_MATCHER = new MethodMatcher(USE_JUNIT_PLATFORM_PATTERN);
private static final MethodMatcher USE_JUNIT4_MATCHER = new MethodMatcher("org.gradle.api.tasks.testing.Test useJUnit()");
private static final MethodMatcher USE_JUNIT4_ALTERNATE_MATCHER = new MethodMatcher("RewriteTestSpec useJUnit()");
private static final MethodMatcher TEST_DSL_MATCHER = new MethodMatcher("RewriteGradleProject test(..)");

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
//noinspection NotNullFieldNotInitialized
return new GroovyIsoVisitor<ExecutionContext>() {

GroovyIsoVisitor<ExecutionContext> visitor = new GroovyIsoVisitor<ExecutionContext>() {
GradleProject gp;

@Override
public G.CompilationUnit visitCompilationUnit(G.CompilationUnit compilationUnit, ExecutionContext ctx) {
//noinspection DataFlowIssue
gp = compilationUnit.getMarkers().findFirst(GradleProject.class).orElse(null);
if(gp == null) {
if (gp == null) {
return compilationUnit;
}
if(gp.getPlugins().stream().noneMatch(plugin -> plugin.getFullyQualifiedClassName().contains("org.gradle.api.plugins.JavaBasePlugin"))) {
if (gp.getPlugins().stream().noneMatch(plugin -> plugin.getFullyQualifiedClassName().contains("org.gradle.api.plugins.JavaBasePlugin"))) {
return compilationUnit;
}
if(containsJUnitPlatformInvocation(compilationUnit)) {
if (containsJUnitPlatformInvocation(compilationUnit)) {
return compilationUnit;
}
// If anywhere in the tree there is a useJunit() we can swap it out for useJUnitPlatform() and be done in one step
Expand All @@ -86,22 +88,23 @@ public G.CompilationUnit visitCompilationUnit(G.CompilationUnit compilationUnit,
// No useJUnit(), but there might already be configuration of a Test task, add useJUnitPlatform() to it
cu = (G.CompilationUnit) new AddJUnitPlatformToExistingTestDsl()
.visitNonNull(cu, ctx, requireNonNull(getCursor().getParent()));
if(cu != compilationUnit) {
if (cu != compilationUnit) {
return cu;
}
// No existing test task configuration seems to exist, add a whole new one
return (G.CompilationUnit) new AddUseJUnitPlatform()
.visitNonNull(cu, ctx, getCursor().getParent());
}
};
return Preconditions.check(new IsBuildGradle<>(), visitor);
}

private static boolean containsJUnitPlatformInvocation(G.CompilationUnit cu) {
AtomicBoolean found = new AtomicBoolean(false);
new GroovyIsoVisitor<AtomicBoolean>() {
@Override
public @Nullable J preVisit(J tree, AtomicBoolean found) {
if(found.get()) {
if (found.get()) {
stopAfterPreVisit();
return tree;
}
Expand Down Expand Up @@ -177,7 +180,7 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
return m;
}
// Other DSLs may be named "test" so only assume it is test {} if it isn't enclosed in anything else
if(getCursor().getParentTreeCursor().firstEnclosing(J.MethodInvocation.class) != null) {
if (getCursor().getParentTreeCursor().firstEnclosing(J.MethodInvocation.class) != null) {
return m;
}
break;
Expand All @@ -195,23 +198,23 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
break;
case "withType":
if (m.getSelect() == null ||
!TypeUtils.isOfClassType(m.getSelect().getType(), "org.gradle.api.tasks.TaskContainer") ||
!(m.getArguments().get(0) instanceof J.Identifier && "Test".equals(((J.Identifier) m.getArguments().get(0)).getSimpleName()))) {
!TypeUtils.isOfClassType(m.getSelect().getType(), "org.gradle.api.tasks.TaskContainer") ||
!(m.getArguments().get(0) instanceof J.Identifier && "Test".equals(((J.Identifier) m.getArguments().get(0)).getSimpleName()))) {
return m;
}
break;
case "configureEach":
if(m.getArguments().size() != 1 || !(m.getArguments().get(0) instanceof J.Lambda)) {
if (m.getArguments().size() != 1 || !(m.getArguments().get(0) instanceof J.Lambda)) {
return m;
}
if(m.getSelect() == null || !(m.getSelect() instanceof J.MethodInvocation)) {
if (m.getSelect() == null || !(m.getSelect() instanceof J.MethodInvocation)) {
return m;
}
J.MethodInvocation select = (J.MethodInvocation) m.getSelect();
if(!"withType".equals(select.getSimpleName()) ||
select.getArguments().size() != 1 ||
!(select.getArguments().get(0) instanceof J.Identifier) ||
!"Test".equals(((J.Identifier) select.getArguments().get(0)).getSimpleName())) {
if (!"withType".equals(select.getSimpleName()) ||
select.getArguments().size() != 1 ||
!(select.getArguments().get(0) instanceof J.Identifier) ||
!"Test".equals(((J.Identifier) select.getArguments().get(0)).getSimpleName())) {
return m;
}
break;
Expand All @@ -227,7 +230,7 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
private static class AddJUnitPlatformAsLastStatementInClosure extends GroovyIsoVisitor<ExecutionContext> {
@Override
public J.Lambda visitLambda(J.Lambda l, ExecutionContext ctx) {
if(!(l.getBody() instanceof J.Block)) {
if (!(l.getBody() instanceof J.Block)) {
return l;
}
G.CompilationUnit cu = GradleParser.builder()
Expand All @@ -254,7 +257,7 @@ public J.Lambda visitLambda(J.Lambda l, ExecutionContext ctx) {
.map(J.Return::getExpression)
.map(J.MethodInvocation.class::cast)
.orElse(null);
if(useJUnitPlatform == null) {
if (useJUnitPlatform == null) {
return l;
}
J.Block b = (J.Block) l.getBody();
Expand Down

0 comments on commit b9fa756

Please sign in to comment.