Skip to content

Reuse MockedStatic for consecutive stubbings of the same class #1005

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

Open
timtebeek wants to merge 2 commits into
base: main
Choose a base branch
from
+83 −30
Open

Reuse MockedStatic for consecutive stubbings of the same class #1005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3815bef
Reuse `MockedStatic` for consecutive stubbings of the same class
timtebeek May 22, 2026
442e196
Inline single-arg overload
timtebeek May 22, 2026
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
47 changes: 34 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 @@ -81,12 +81,14 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {

private JavaIsoVisitor<ExecutionContext> javaVisitor() {
return new JavaIsoVisitor<ExecutionContext>() {
private final Map<String, String> generatedMocks = new HashMap<>();

@Override
public J.Block visitBlock(J.Block block, ExecutionContext ctx) {
J.MethodDeclaration containingMethod = getCursor().firstEnclosing(J.MethodDeclaration.class);
List<Statement> newStatements = isMethodDeclarationWithAnnotation(containingMethod, BEFORE) ?
maybeStatementsToMockedStatic(block, block.getStatements(), ctx) :
maybeWrapStatementsInTryWithResourcesMockedStatic(block, block.getStatements(), ctx);
maybeWrapStatementsInTryWithResourcesMockedStatic(block, block.getStatements(), ctx, new HashMap<>());

J.Block b = super.visitBlock(block.withStatements(newStatements), ctx);
return maybeAutoFormat(block, b, ctx);
Expand All @@ -108,7 +110,8 @@ private List<Statement> maybeStatementsToMockedStatic(J.Block m, List<Statement>
return list;
}

private List<Statement> maybeWrapStatementsInTryWithResourcesMockedStatic(J.Block block, List<Statement> statements, ExecutionContext ctx) {
private List<Statement> maybeWrapStatementsInTryWithResourcesMockedStatic(J.Block block, List<Statement> statements, ExecutionContext ctx,
Map<String, String> pendingResources) {
AtomicBoolean restInTry = new AtomicBoolean(false);
return ListUtils.map(statements, (index, statement) -> {
if (restInTry.get()) {
Expand All @@ -120,7 +123,11 @@ private List<Statement> maybeWrapStatementsInTryWithResourcesMockedStatic(J.Bloc
if (whenArg != null) {
JavaType.@Nullable Class invokedType = getTypeFromInvocation(whenArg);
if (invokedType != null) {
Optional<String> nameOfWrappingMockedStatic = tryGetMatchedWrappingResourceName(getCursor(), invokedType);
String pending = pendingResources.get(invokedType.getFullyQualifiedName());
if (pending != null) {
return reuseMockedStatic(block, (J.MethodInvocation) statement, pending, whenArg, ctx);
}
Optional<String> nameOfWrappingMockedStatic = tryGetMatchedWrappingResourceName(getCursor(), invokedType, generatedMocks);
if (nameOfWrappingMockedStatic.isPresent()) {
return reuseMockedStatic(block, (J.MethodInvocation) statement, nameOfWrappingMockedStatic.get(), whenArg, ctx);
}
Expand All @@ -129,15 +136,17 @@ private List<Statement> maybeWrapStatementsInTryWithResourcesMockedStatic(J.Bloc
return reuseMockedStatic(block, (J.MethodInvocation) statement, staticMockedVariable, whenArg, ctx);
}
restInTry.set(true);
return tryWithMockedStatic(block, statements, index, (J.MethodInvocation) statement, invokedType.getClassName(), whenArg, ctx);
return tryWithMockedStatic(block, statements, index, (J.MethodInvocation) statement, invokedType, whenArg, ctx, pendingResources);
}
}
return statement;
});
}

private J.Try tryWithMockedStatic(J.Block block, List<Statement> statements, Integer index,
J.MethodInvocation statement, String className, J.MethodInvocation whenArg, ExecutionContext ctx) {
J.MethodInvocation statement, JavaType.Class invokedType, J.MethodInvocation whenArg, ExecutionContext ctx,
Map<String, String> pendingResources) {
String className = invokedType.getClassName();
String variableName = generateVariableName("mock" + className + ++varCounter, updateCursor(block), INCREMENT_NUMBER);
Expression thenReturnArg = statement.getArguments().get(0);

Expand All @@ -152,19 +161,25 @@ private J.Try tryWithMockedStatic(J.Block block, List<Statement> statements, Int
List<Statement> handledStatements = ListUtils.concat(precedingStatements, try_);
List<Statement> remainingStatements = statements.subList(index + 1, statements.size());

Map<String, String> nextPending = new HashMap<>(pendingResources);
nextPending.put(invokedType.getFullyQualifiedName(), variableName);
generatedMocks.put(variableName, invokedType.getFullyQualifiedName());

List<Statement> newStatements = ListUtils.concatAll(
try_.getBody().getStatements(),
maybeWrapStatementsInTryWithResourcesMockedStatic(block.withStatements(handledStatements), remainingStatements, ctx));
maybeWrapStatementsInTryWithResourcesMockedStatic(block.withStatements(handledStatements), remainingStatements, ctx, nextPending));

return try_.withBody(try_.getBody().withStatements(newStatements))
.withPrefix(statement.getPrefix());
}

private Statement reuseMockedStatic(J.Block block, J.MethodInvocation statement, Object variable, J.MethodInvocation whenArg, ExecutionContext ctx) {
String mockedStaticVariableTemplate = variable instanceof J ? "#{any()}" : "#{}";
return javaTemplateMockStatic(mockedStaticVariableTemplate + ".when(() -> #{any()}).thenReturn(#{any()});", ctx)
.<J.Block>apply(getCursor(), block.getCoordinates().firstStatement(), variable, whenArg, statement.getArguments().get(0))
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))
.getStatements().get(0);
return replacement.withPrefix(statement.getPrefix());
}

private List<Statement> mockedStatic(J.Block block, J.MethodInvocation statement, String className, J.MethodInvocation whenArg, ExecutionContext ctx) {
Expand Down Expand Up @@ -375,11 +390,17 @@ private static String getReturnTypeName(J.MethodInvocation whenArg) {
return "Any";
}

private static List<J.Try.Resource> getMatchingFilteredResources(@Nullable List<J.Try.Resource> resources, JavaType className) {
private static List<J.Try.Resource> getMatchingFilteredResources(@Nullable List<J.Try.Resource> resources, JavaType className, Map<String, String> generatedMocks) {
if (resources == null) {
return emptyList();
}
return ListUtils.filter(resources,res -> isMockedStaticOfType(className, ((J.VariableDeclarations) res.getVariableDeclarations()).getTypeAsFullyQualified()));
JavaType.FullyQualified fq = TypeUtils.asFullyQualified(className);
String fqn = fq == null ? null : fq.getFullyQualifiedName();
return ListUtils.filter(resources, res -> {
J.VariableDeclarations vd = (J.VariableDeclarations) res.getVariableDeclarations();
return isMockedStaticOfType(className, vd.getTypeAsFullyQualified()) ||
fqn != null && fqn.equals(generatedMocks.get(vd.getVariables().get(0).getSimpleName()));
});
}

private static boolean isMockedStaticOfType(JavaType mockedType, @Nullable JavaType comparisonType) {
Expand All @@ -390,16 +411,16 @@ private static boolean isMockedStaticOfType(JavaType mockedType, @Nullable JavaT
return false;
}

private static Optional<String> tryGetMatchedWrappingResourceName(Cursor cursor, JavaType className) {
private static Optional<String> tryGetMatchedWrappingResourceName(Cursor cursor, JavaType className, Map<String, String> generatedMocks) {
try {
Cursor foundParentCursor = cursor.dropParentUntil(val -> {
if (val instanceof J.Try) {
List<J.Try.Resource> filteredResources = getMatchingFilteredResources(((J.Try) val).getResources(), className);
List<J.Try.Resource> filteredResources = getMatchingFilteredResources(((J.Try) val).getResources(), className, generatedMocks);
return !filteredResources.isEmpty();
}
return false;
});
return getMatchingFilteredResources(((J.Try) foundParentCursor.getValue()).getResources(), className)
return getMatchingFilteredResources(((J.Try) foundParentCursor.getValue()).getResources(), className, generatedMocks)
.stream()
.findFirst()
.map(res -> ((J.VariableDeclarations) res.getVariableDeclarations()).getVariables().get(0).getSimpleName());
Expand Down
66 changes: 49 additions & 17 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 @@ -248,24 +248,56 @@ void test() {
mockA1.when(() -> A.getNumber()).thenReturn(-1);
assertEquals(A.getNumber(), -1);

try (MockedStatic<A> mockA2 = mockStatic(A.class)) {
mockA2.when(() -> A.getNumber()).thenReturn(-2);
assertEquals(A.getNumber(), -2);

if (true) {
try (MockedStatic<A> mockA3 = mockStatic(A.class)) {
mockA3.when(() -> A.getNumber()).thenReturn(-3);
assertEquals(A.getNumber(), -3);

try (MockedStatic<A> mockA4 = mockStatic(A.class)) {
mockA4.when(() -> A.getNumber()).thenReturn(-4);
assertEquals(A.getNumber(), -4);
}
}
}

assertEquals(A.getNumber(), -2);
mockA1.when(() -> A.getNumber()).thenReturn(-2);
assertEquals(A.getNumber(), -2);

if (true) {
mockA1.when(() -> A.getNumber()).thenReturn(-3);
assertEquals(A.getNumber(), -3);

mockA1.when(() -> A.getNumber()).thenReturn(-4);
assertEquals(A.getNumber(), -4);
}

assertEquals(A.getNumber(), -2);
}
}
}
"""
)
);
}

@Test
void shouldShareSingleMockedStaticForConsecutiveStubbingsOfSameClass() {
// https://github.com/openrewrite/rewrite-testing-frameworks/issues/1004
rewriteRun(
//language=java
java(
"""
import org.example.A;

import static org.mockito.Mockito.when;

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

import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.when;

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