Skip to content

Add JUnit 4 support to AddMockitoExtensionIfAnnotationsUsed #922

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

Merged
bmuschko merged 1 commit into from
Feb 28, 2026
Merged

Add JUnit 4 support to AddMockitoExtensionIfAnnotationsUsed #922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 32 additions & 6 deletions src/main/java/org/openrewrite/java/testing/mockito/AddMockitoExtensionIfAnnotationsUsed.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,14 @@ public class AddMockitoExtensionIfAnnotationsUsed extends Recipe {
final String displayName = "Adds Mockito extensions to Mockito tests";

@Getter
final String description = "Adds `@ExtendWith(MockitoExtension.class)` to tests using `@Mock` or `@Captor`.";
final String description = "Adds `@ExtendWith(MockitoExtension.class)` to JUnit 5 tests or " +
"`@RunWith(MockitoJUnitRunner.class)` to JUnit 4 tests using Mockito annotations like `@Mock` or `@Captor`.";

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {

TreeVisitor<?, ExecutionContext> hasExtendedWithAnnotation = new FindAnnotations("org.junit.jupiter.api.extension.ExtendWith(org.mockito.junit.jupiter.MockitoExtension.class)", false).getVisitor();
TreeVisitor<?, ExecutionContext> hasRunWithAnnotation = new FindAnnotations("org.junit.runner.RunWith", false).getVisitor();
@SuppressWarnings("unchecked")
TreeVisitor<?, ExecutionContext>[] hasAnyMockitoAnnotation = new TreeVisitor[]{
// see https://www.baeldung.com/mockito-annotations for examples
Expand All @@ -57,16 +59,23 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
};

return check(and(new IsLikelyTest().getVisitor(),
// check to only migrate JUnit 5 tests
new FindTypes("org.junit.jupiter..*", false).getVisitor(),
// prevent addition if present
not(hasExtendedWithAnnotation),
or(hasAnyMockitoAnnotation)),
or(hasAnyMockitoAnnotation),
or(
// JUnit 5: has JUnit 5 types and no @ExtendWith(MockitoExtension.class)
and(new FindTypes("org.junit.jupiter..*", false).getVisitor(),
not(hasExtendedWithAnnotation)),
// JUnit 4: has @org.junit.Test, no @RunWith
and(new FindAnnotations("org.junit.Test", false).getVisitor(),
not(hasRunWithAnnotation))
)),
new TreeVisitor<Tree, ExecutionContext>() {
@Override
public @Nullable Tree preVisit(Tree tree, ExecutionContext ctx) {
stopAfterPreVisit();
if (tree instanceof J.CompilationUnit) {
if (!FindAnnotations.find((J) tree, "@org.junit.Test").isEmpty()) {
return getJunit4JavaVisitor().visit(tree, ctx);
}
return getJavaVisitor().visit(tree, ctx);
}
if (tree instanceof K.CompilationUnit) {
Expand Down Expand Up @@ -94,6 +103,23 @@ public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, Ex
};
}

private JavaIsoVisitor<ExecutionContext> getJunit4JavaVisitor() {
return new JavaIsoVisitor<ExecutionContext>() {
@Override
public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) {
maybeAddImport("org.mockito.junit.MockitoJUnitRunner");
maybeAddImport("org.junit.runner.RunWith");

return JavaTemplate.builder("@RunWith(MockitoJUnitRunner.class)")
.imports("org.mockito.junit.MockitoJUnitRunner")
.imports("org.junit.runner.RunWith")
.javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "junit-4", "mockito-core"))
.build()
.apply(getCursor(), classDecl.getCoordinates().addAnnotation(comparing(J.Annotation::getSimpleName)));
}
};
}

private KotlinIsoVisitor<ExecutionContext> getKotlinVisitor() {
return new KotlinIsoVisitor<ExecutionContext>() {
@Override
Expand Down
84 changes: 71 additions & 13 deletions ...t/java/org/openrewrite/java/testing/mockito/AddMockitoExtensionIfAnnotationsUsedTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class AddMockitoExtensionIfAnnotationsUsedTest implements RewriteTest {
public void defaults(RecipeSpec spec) {
spec.recipe(new AddMockitoExtensionIfAnnotationsUsed())
.parser(JavaParser.fromJavaVersion()
.classpathFromResources(new InMemoryExecutionContext(), "junit-jupiter-api", "mockito-junit-jupiter", "mockito-core")
.classpathFromResources(new InMemoryExecutionContext(), "junit-4", "junit-jupiter-api", "mockito-junit-jupiter", "mockito-core")
.dependsOn("public class Service {}"))
.parser(KotlinParser.builder()
.classpathFromResources(new InMemoryExecutionContext(), "junit-jupiter-api", "mockito-junit-jupiter", "mockito-core")
Expand All @@ -42,7 +42,7 @@ public void defaults(RecipeSpec spec) {

@DocumentExample
@Test
void addForMock() {
void addForMockWithJUnit5() {
rewriteRun(
//language=java
java(
Expand Down Expand Up @@ -76,7 +76,7 @@ void test() {}
}

@Test
void addForCaptor() {
void addForCaptorWithJUnit5() {
rewriteRun(
//language=java
java(
Expand Down Expand Up @@ -110,7 +110,7 @@ void test() {}
}

@Test
void dontAddIfPresent() {
void doNotAddIfPresentWithJUnit5() {
rewriteRun(
//language=java
java(
Expand All @@ -133,29 +133,87 @@ class Test {
}

@Test
void dontAddIfJunit4() {
void addForMockWithJUnit4() {
rewriteRun(
//language=java
java(
"""
import org.junit.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

class Test {
public class MyTest {
@Mock
Service service;
@Test
void test() {}
public void test() {}
}
""",
"""
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

@RunWith(MockitoJUnitRunner.class)
public class MyTest {
@Mock
Service service;
@Test
public void test() {}
}
"""
)
);
}

@Test
void doNotAddIfPresentWithJUnit4() {
rewriteRun(
//language=java
java(
"""
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

@RunWith(MockitoJUnitRunner.class)
public class MyTest {
@Mock
Service service;
@Test
public void test() {}
}
"""
)
);
}

@Test
void notInferWithExistingAnnotations() {
void doNotAddIfOtherRunnerPresentWithJUnit4() {
rewriteRun(
//language=java
java(
"""
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Mock;

@RunWith(JUnit4.class)
public class MyTest {
@Mock
Service service;
@Test
public void test() {}
}
"""
)
);
}

@Test
void addWithExistingAnnotationsWithJUnit5() {
rewriteRun(
//language=java
java(
Expand Down Expand Up @@ -193,7 +251,7 @@ void test() {}
}

@Test
void dontAddIfPresentInKotlin() {
void doNotAddIfPresentInKotlinWithJUnit5() {
rewriteRun(
spec -> spec.parser(KotlinParser.builder()
.classpathFromResources(new InMemoryExecutionContext(), "junit-jupiter-api", "mockito-junit-jupiter", "mockito-core")),
Expand All @@ -219,9 +277,9 @@ fun test() {}
}

@Test
void addForMockKotlin() {
void addForMockKotlinWithJUnit5() {
rewriteRun(
//language=java
//language=kotlin
kotlin(
"""
import org.junit.jupiter.api.Test
Expand Down
Loading