Skip to content

Retain the original stubbing method when rewriting static when to MockedStatic #1106

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
timtebeek merged 1 commit into from
Aug 25, 2026
Merged

Retain the original stubbing method when rewriting static when to MockedStatic #1106

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
42 changes: 29 additions & 13 deletions src/main/java/org/openrewrite/java/testing/mockito/MockitoWhenOnStaticToMockStatic.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;

import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
import static java.util.Objects.requireNonNull;
import static org.openrewrite.java.VariableNameUtils.GenerationStrategy.INCREMENT_NUMBER;
import static org.openrewrite.java.VariableNameUtils.generateVariableName;
Expand Down Expand Up @@ -150,13 +152,13 @@ private J.Try tryWithMockedStatic(J.Block block, List<Statement> statements, Int
Map<String, String> pendingResources) {
String className = invokedType.getClassName();
String variableName = generateVariableName("mock" + className + ++varCounter, updateCursor(block), INCREMENT_NUMBER);
Expression thenReturnArg = statement.getArguments().get(0);
List<Expression> stubbingArguments = stubbingArguments(statement);

J.Try try_ = (J.Try) javaTemplateMockStatic(String.format(
"try(MockedStatic<%1$s> %2$s = mockStatic(%1$s.class)) {\n" +
" %2$s.when(() -> #{any()}).thenReturn(#{any()});\n" +
"}", className, variableName), ctx)
.<J.Block>apply(getCursor(), block.getCoordinates().firstStatement(), whenArg, thenReturnArg)
" %2$s.when(() -> #{any()}).%3$s(%4$s);\n" +
"}", className, variableName, statement.getSimpleName(), argumentPlaceholders(stubbingArguments)), ctx)
.<J.Block>apply(getCursor(), block.getCoordinates().firstStatement(), templateParameters(singletonList(whenArg), stubbingArguments))
.getStatements().get(0);

List<Statement> precedingStatements = statements.subList(0, index);
Expand Down Expand Up @@ -187,8 +189,10 @@ private Object nameForReuse(J.Block block, String className, J.VariableDeclarati
private Statement reuseMockedStatic(J.Block block, J.MethodInvocation statement, Object variable, J.MethodInvocation whenArg, ExecutionContext ctx) {
String mockedStaticVariableTemplate = variable instanceof J ? "#{any()}" : "#{}";
J.Block cursorBlock = (J.Block) getCursor().getValue();
Statement replacement = javaTemplateMockStatic(mockedStaticVariableTemplate + ".when(() -> #{any()}).thenReturn(#{any()});", ctx)
.<J.Block>apply(getCursor(), cursorBlock.getCoordinates().firstStatement(), variable, whenArg, statement.getArguments().get(0))
List<Expression> stubbingArguments = stubbingArguments(statement);
Statement replacement = javaTemplateMockStatic(String.format("%s.when(() -> #{any()}).%s(%s);",
mockedStaticVariableTemplate, statement.getSimpleName(), argumentPlaceholders(stubbingArguments)), ctx)
.<J.Block>apply(getCursor(), cursorBlock.getCoordinates().firstStatement(), templateParameters(asList(variable, whenArg), stubbingArguments))
.getStatements().get(0);
return replacement.withPrefix(statement.getPrefix());
}
Expand All @@ -200,12 +204,12 @@ private List<Statement> mockedStatic(J.Block block, J.MethodInvocation statement
// We know it will have a matching `@Before*` annotation based on callers
String matchedAnnotation = requireNonNull(tryGetMatchedAnnotationOnMethodDeclaration(containingMethod, BEFORE));
String correspondingAfterFqn = matchedAnnotation.replace(".Before", ".After");
Expression thenReturnArg = statement.getArguments().get(0);
List<Expression> stubbingArguments = stubbingArguments(statement);

List<Statement> statements = javaTemplateMockStatic(String.format(
"%2$s = mockStatic(%1$s.class);\n" +
"%2$s.when(() -> #{any()}).thenReturn(#{any()});", className, variableName), ctx)
.<J.Block>apply(getCursor(), block.getCoordinates().firstStatement(), whenArg, thenReturnArg)
"%2$s.when(() -> #{any()}).%3$s(%4$s);", className, variableName, statement.getSimpleName(), argumentPlaceholders(stubbingArguments)), ctx)
.<J.Block>apply(getCursor(), block.getCoordinates().firstStatement(), templateParameters(singletonList(whenArg), stubbingArguments))
.getStatements().subList(0, 2);

doAfterVisit(new JavaIsoVisitor<ExecutionContext>() {
Expand Down Expand Up @@ -307,14 +311,14 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
}

String returnTypeName = getReturnTypeName(whenArg);
Expression thenReturnArg = m.getArguments().get(0);
List<Expression> stubbingArguments = stubbingArguments(m);
J.MethodInvocation rewritten = KotlinTemplate.builder(String.format(
"%s.`when`<%s> { #{any()} }.thenReturn(#{any()})",
paramName, returnTypeName))
"%s.`when`<%s> { #{any()} }.%s(%s)",
paramName, returnTypeName, m.getSimpleName(), argumentPlaceholders(stubbingArguments)))
.imports("org.mockito.MockedStatic")
.parser(KotlinParser.builder().classpathFromResources(ctx, "mockito-core-5"))
.build()
.apply(getCursor(), m.getCoordinates().replace(), whenArg, thenReturnArg);
.apply(getCursor(), m.getCoordinates().replace(), templateParameters(singletonList(whenArg), stubbingArguments));
maybeRemoveImport("org.mockito.Mockito.when");
return rewritten;
}
Expand All @@ -334,6 +338,18 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
return null;
}

private static List<Expression> stubbingArguments(J.MethodInvocation statement) {
return ListUtils.filter(statement.getArguments(), argument -> !(argument instanceof J.Empty));
}

private static String argumentPlaceholders(List<Expression> arguments) {
return String.join(", ", Collections.nCopies(arguments.size(), "#{any()}"));
}

private static Object[] templateParameters(List<Object> leading, List<Expression> stubbingArguments) {
return ListUtils.concatAll(leading, stubbingArguments).toArray();
}

private static JavaType.@Nullable Class getTypeFromInvocation(J.MethodInvocation whenArg) {
J.Identifier clazz = null;
// Having a fieldType implies that something is a field rather than a class itself
Expand Down
256 changes: 256 additions & 0 deletions src/test/java/org/openrewrite/java/testing/mockito/MockitoWhenOnStaticToMockStaticTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,178 @@ void tearDown() {
);
}

@Test
void retainsThenAnswer() {
rewriteRun(
//language=java
java(
"""
import org.example.A;

import static org.mockito.Mockito.*;

class Test {
void test() {
when(A.getNumber()).thenAnswer(invocation -> -1);
}
}
""",
"""
import org.example.A;
import org.mockito.MockedStatic;

import static org.mockito.Mockito.*;

class Test {
void test() {
try (MockedStatic<A> mockA1 = mockStatic(A.class)) {
mockA1.when(() -> A.getNumber()).thenAnswer(invocation -> -1);
}
}
}
"""
)
);
}

@Test
void retainsThenThrow() {
rewriteRun(
//language=java
java(
"""
import org.example.A;

import static org.mockito.Mockito.*;

class Test {
void test() {
when(A.getNumber()).thenThrow(new IllegalStateException());
}
}
""",
"""
import org.example.A;
import org.mockito.MockedStatic;

import static org.mockito.Mockito.*;

class Test {
void test() {
try (MockedStatic<A> mockA1 = mockStatic(A.class)) {
mockA1.when(() -> A.getNumber()).thenThrow(new IllegalStateException());
}
}
}
"""
)
);
}

@Test
void retainsAllConsecutiveReturnValues() {
rewriteRun(
//language=java
java(
"""
import org.example.A;

import static org.mockito.Mockito.*;

class Test {
void test() {
when(A.getNumber()).thenReturn(-1, -2, -3);
}
}
""",
"""
import org.example.A;
import org.mockito.MockedStatic;

import static org.mockito.Mockito.*;

class Test {
void test() {
try (MockedStatic<A> mockA1 = mockStatic(A.class)) {
mockA1.when(() -> A.getNumber()).thenReturn(-1, -2, -3);
}
}
}
"""
)
);
}

@Test
void retainsThenCallRealMethodWithoutArguments() {
rewriteRun(
//language=java
java(
"""
import org.example.A;

import static org.mockito.Mockito.*;

class Test {
void test() {
when(A.getNumber()).thenCallRealMethod();
}
}
""",
"""
import org.example.A;
import org.mockito.MockedStatic;

import static org.mockito.Mockito.*;

class Test {
void test() {
try (MockedStatic<A> mockA1 = mockStatic(A.class)) {
mockA1.when(() -> A.getNumber()).thenCallRealMethod();
}
}
}
"""
)
);
}

@Test
void retainsStubbingMethodWhenReusingMockedStatic() {
rewriteRun(
//language=java
java(
"""
import org.example.A;

import static org.mockito.Mockito.*;

class Test {
void test() {
when(A.getNumber()).thenReturn(-1);
when(A.getNumber()).thenThrow(new IllegalStateException());
}
}
""",
"""
import org.example.A;
import org.mockito.MockedStatic;

import static org.mockito.Mockito.*;

class Test {
void test() {
try (MockedStatic<A> mockA1 = mockStatic(A.class)) {
mockA1.when(() -> A.getNumber()).thenReturn(-1);
mockA1.when(() -> A.getNumber()).thenThrow(new IllegalStateException());
}
}
}
"""
)
);
}

@Nested
class UsingJunit4 {
@Test
Expand Down Expand Up @@ -962,6 +1134,51 @@ void test1() {
);
}

@Test
void retainsThenThrow_inBeforeEach() {
rewriteRun(
//language=java
java(
"""
import org.example.A;
import org.junit.jupiter.api.BeforeEach;

import static org.mockito.Mockito.*;

class Test {
@BeforeEach
public void setUp() {
when(A.getNumber()).thenThrow(new IllegalStateException());
}
}
""",
"""
import org.example.A;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.mockito.MockedStatic;

import static org.mockito.Mockito.*;

class Test {
private MockedStatic<A> mockA1;

@BeforeEach
public void setUp() {
mockA1 = mockStatic(A.class);
mockA1.when(() -> A.getNumber()).thenThrow(new IllegalStateException());
}

@AfterEach
public void tearDown() {
mockA1.close();
}
}
"""
)
);
}

@Test
void handlesStaticMocks_inBeforeEach_withExistingAfterEach() {
rewriteRun(
Expand Down Expand Up @@ -2166,6 +2383,45 @@ fun testStaticMethod() {
);
}

@Test
void shouldRetainKotlinStubbingMethodOtherThanThenReturn() {
rewriteRun(
spec -> spec.afterTypeValidationOptions(TypeValidation.none()),
//language=kotlin
kotlin(
"""
import org.junit.jupiter.api.Test
import org.mockito.Mockito.`when`
import org.mockito.Mockito.mockStatic
import java.util.Calendar

class MyTest {
@Test
fun testStaticMethod() {
mockStatic(Calendar::class.java).use {
`when`(Calendar.getInstance()).thenThrow(IllegalStateException())
}
}
}
""",
"""
import org.junit.jupiter.api.Test
import org.mockito.Mockito.mockStatic
import java.util.Calendar

class MyTest {
@Test
fun testStaticMethod() {
mockStatic(Calendar::class.java).use {
it.`when`<Calendar> { Calendar.getInstance() }.thenThrow(IllegalStateException())
}
}
}
"""
)
);
}

@Test
void shouldNotRewriteKotlinMockitoWhenWhenStaticClassDoesNotMatchUseReceiver() {
rewriteRun(
Expand Down
Loading