Skip to content

Add debug information and error handling for intermittent ParseError in GradleUseJunitJupiter #810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add debug information and error handling for intermittent ParseError in GradleUseJunitJupiter #810

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d88cdcc
Adapted the failing recipe to add as much debug/retry information as …
Jenson3210 Sep 16, 2025
f372092
Update src/main/java/org/openrewrite/java/testing/junit5/GradleUseJun…
Jenson3210 Sep 17, 2025
cd33fde
Remove unused import
timtebeek Sep 18, 2025
ea243e2
Merge branch 'main' into debug-flagship-run-failure
timtebeek Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 47 additions & 16 deletions src/main/java/org/openrewrite/java/testing/junit5/GradleUseJunitJupiter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,18 @@
import lombok.EqualsAndHashCode;
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.*;
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.GroovyParser;
import org.openrewrite.groovy.tree.G;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.java.tree.TypeUtils;
import org.openrewrite.tree.ParseError;

import java.util.Optional;
import java.util.concurrent.atomic.AtomicBoolean;
Expand Down Expand Up @@ -115,9 +114,9 @@ private static boolean containsJUnitPlatformInvocation(G.CompilationUnit cu) {
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation m, AtomicBoolean found) {
// Groovy gradle scripts being weakly type-attributed means we will miss likely-correct changes if we are too strict
if ("useJUnitPlatform".equals(m.getSimpleName()) &&
(m.getArguments().isEmpty() ||
m.getArguments().size() == 1 &&
(m.getArguments().get(0) instanceof J.Empty || m.getArguments().get(0) instanceof J.Lambda))) {
(m.getArguments().isEmpty() ||
m.getArguments().size() == 1 &&
(m.getArguments().get(0) instanceof J.Empty || m.getArguments().get(0) instanceof J.Lambda))) {
found.set(true);
return m;
}
Expand Down Expand Up @@ -240,17 +239,49 @@ public J.Lambda visitLambda(J.Lambda l, ExecutionContext ctx) {
}

private static Optional<J.MethodInvocation> createTaskUseJUnitPlatform(ExecutionContext ctx, boolean forEachInvocation) {
return GradleParser.builder()
String snippet = "plugins {\n" +
" id 'java'\n" +
"}\n" +
"tasks.withType(Test)" + (forEachInvocation ? ".configureEach" : "") + " {\n" +
" useJUnitPlatform()\n" +
"}";
Optional<SourceFile> parsed = GradleParser.builder()
.build()
.parse(ctx,
"plugins {\n" +
" id 'java'\n" +
"}\n" +
"tasks.withType(Test)" + (forEachInvocation ? ".configureEach" : "") + " {\n" +
" useJUnitPlatform()\n" +
"}")
.parse(ctx, snippet)
.findFirst();
// If the Gradle parser fails try the Groovy parser as a fallback where we print the error from the Gradle parser as a marker so that users are not blocked
if (parsed.isPresent() && parsed.get() instanceof ParseError) {
ParseError error = (ParseError) parsed.get();
Optional<ParseExceptionResult> parseExceptionResult = error.getMarkers().findFirst(ParseExceptionResult.class);
if (parseExceptionResult.isPresent()) {
ParseExceptionResult gradleParsingError = parseExceptionResult.get();
parsed = GroovyParser.builder()
.build()
.parse(ctx, snippet)
.findFirst();
if (parsed.isPresent() && parsed.get() instanceof G.CompilationUnit) {
// Attach the Gradle parsing error as a marker to the Groovy parsed result so that we can see what went wrong in the Gradle parser
// but still get the desired LST structure from the Groovy parser
parsed = parsed.map(it -> it.withMarkers(it.getMarkers().add(gradleParsingError)));
}
if (parsed.isPresent() && parsed.get() instanceof ParseError) {
error = (ParseError) parsed.get();
parseExceptionResult = error.getMarkers().findFirst(ParseExceptionResult.class);
if (parseExceptionResult.isPresent()) {
//For debugging purposes we want to know if both parsers failed what the errors were even if this means the recipe will fail
throw new IllegalArgumentException("An error in both gradleParser and GroovyParser happened." +
"\nGradleParser error: " + gradleParsingError.getExceptionType() + " - " + gradleParsingError.getMessage() +
"\nGroovyParser error:" + parseExceptionResult.get().getExceptionType() + " - " + parseExceptionResult.get().getMessage()
);
}
}
}
}

// This is the happy path where we successfully parsed the snippet and can extract the useJUnitPlatform() method invocation
return parsed
.filter(G.CompilationUnit.class::isInstance)// This should always be true but we code this defensively to not break unexpectedly
.map(G.CompilationUnit.class::cast)
.findFirst()
.map(it -> (J.MethodInvocation) it.getStatements().get(1));
}
}