Skip to content
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

Jump to bottom

Add @MockitoSettings(strictness = ...) based on how Mockito is used, not based on version alone #623

Merged
merged 10 commits into from
Oct 30, 2024
+428 −74
Merged

Add @MockitoSettings(strictness = ...) based on how Mockito is used, not based on version alone #623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ffdcd85
The default strictness of Mockito did not change until v4
Oct 29, 2024
5e2c512
Merge branch 'main' into issue_622
timtebeek Oct 29, 2024
98e8c5c
Revert "The default strictness of Mockito did not change until v4"
Jenson3210 Oct 29, 2024
086117b
Added the MockitoSettings for MockitoRule strictness or silent method…
Jenson3210 Oct 29, 2024
50510c6
Repositioned stuff a bit
Jenson3210 Oct 30, 2024
9c108a3
Apply formatter to tests
timtebeek Oct 30, 2024
36b7a89
Demonstrate failure when using static import
timtebeek Oct 30, 2024
65ea162
Poll strictness message before updateCursor
timtebeek Oct 30, 2024
38f5b45
Workaround left over prefix on modifier after adding annotation
timtebeek Oct 30, 2024
3e97e83
Remove unused import
timtebeek Oct 30, 2024
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
41 changes: 39 additions & 2 deletions src/main/java/org/openrewrite/java/testing/junit5/MockitoJUnitToMockitoExtension.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.internal.ListUtils;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.JavaParser;
import org.openrewrite.java.JavaTemplate;
Expand Down Expand Up @@ -74,6 +75,7 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
public static class MockitoRuleToMockitoExtensionVisitor extends JavaIsoVisitor<ExecutionContext> {
private static final String MOCKITO_RULE_INVOCATION_KEY = "mockitoRuleInvocation";
private static final String MOCKITO_TEST_RULE_INVOCATION_KEY = "mockitoTestRuleInvocation";
private static final String STRICTNESS_KEY = "strictness";

private static final String EXTEND_WITH_MOCKITO_EXTENSION = "@org.junit.jupiter.api.extension.ExtendWith(org.mockito.junit.jupiter.MockitoExtension.class)";
private static final String RUN_WITH_MOCKITO_JUNIT_RUNNER = "@org.junit.runner.RunWith(org.mockito.runners.MockitoJUnitRunner.class)";
Expand All @@ -100,6 +102,7 @@ public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, Ex
if (classDecl.getBody().getStatements().size() != cd.getBody().getStatements().size() &&
(FindAnnotations.find(classDecl.withBody(null), RUN_WITH_MOCKITO_JUNIT_RUNNER).isEmpty() &&
FindAnnotations.find(classDecl.withBody(null), EXTEND_WITH_MOCKITO_EXTENSION).isEmpty())) {
String strictness = getCursor().pollMessage(STRICTNESS_KEY);

cd = JavaTemplate.builder("@ExtendWith(MockitoExtension.class)")
.javaParser(JavaParser.fromJavaVersion()
Expand All @@ -110,6 +113,23 @@ public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, Ex

maybeAddImport("org.junit.jupiter.api.extension.ExtendWith");
maybeAddImport("org.mockito.junit.jupiter.MockitoExtension");

if (strictness != null) {
cd = JavaTemplate.builder("@MockitoSettings(strictness = " + strictness + ")")
.doBeforeParseTemplate(System.out::println)
.javaParser(JavaParser.fromJavaVersion()
.classpathFromResources(ctx, "junit-jupiter-api-5.9", "mockito-junit-jupiter-3.12"))
.imports("org.mockito.junit.jupiter.MockitoSettings", "org.mockito.quality.Strictness")
.build()
.apply(updateCursor(cd), cd.getCoordinates().addAnnotation(Comparator.comparing(J.Annotation::getSimpleName)));
maybeAddImport("org.mockito.junit.jupiter.MockitoSettings", false);
maybeAddImport("org.mockito.quality.Strictness", false);
}

// Workaround first modifier incorrectly getting a trailing space as part of the prefix
cd = cd.withModifiers(ListUtils.mapFirst(cd.getModifiers(),
modifier -> modifier.withPrefix(modifier.getPrefix().withWhitespace(
modifier.getPrefix().getLastWhitespace().replaceAll(" $", "")))));
}
}

Expand All @@ -119,10 +139,27 @@ public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, Ex
@Override
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
if (method.getMethodType() != null) {
String key = null;
if (TypeUtils.isOfClassType(method.getMethodType().getDeclaringType(), "org.mockito.junit.MockitoRule")) {
getCursor().putMessageOnFirstEnclosing(J.MethodDeclaration.class, MOCKITO_RULE_INVOCATION_KEY, method);
key = MOCKITO_RULE_INVOCATION_KEY;
} else if (TypeUtils.isOfClassType(method.getMethodType().getDeclaringType(), "org.mockito.junit.MockitoTestRule")) {
getCursor().putMessageOnFirstEnclosing(J.MethodDeclaration.class, MOCKITO_TEST_RULE_INVOCATION_KEY, method);
key = MOCKITO_TEST_RULE_INVOCATION_KEY;
}
if (key != null) {
getCursor().putMessageOnFirstEnclosing(J.MethodDeclaration.class, key, method);
String strictness = null;
switch (method.getSimpleName()) {
case "strictness":
strictness = method.getArguments().get(0).toString();
break;
case "silent":
strictness = "Strictness.LENIENT";
break;
}
if (strictness != null && !strictness.contains("STRICT_STUBS")) {
strictness = strictness.startsWith("Strictness.") ? strictness : "Strictness." + strictness;
getCursor().putMessageOnFirstEnclosing(J.ClassDeclaration.class, STRICTNESS_KEY, strictness);
}
}
}

Expand Down
Loading