Skip to content

Track Hamcrest not(..) negation locally instead of on the ExecutionContext #1214

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
Oct 24, 2026
Merged

Track Hamcrest not(..) negation locally instead of on the ExecutionContext #1214

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
4 changes: 2 additions & 2 deletions src/main/java/org/openrewrite/java/testing/hamcrest/HamcrestInstanceOfToJUnit5.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,15 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation mi, Execution
}

J.MethodInvocation matcherInvocation = (J.MethodInvocation) hamcrestMatcher;
boolean logicalContext = true;
while (RemoveNotMatcherVisitor.NOT_MATCHER.matches(matcherInvocation)) {
logicalContext = !logicalContext;
maybeRemoveImport("org.hamcrest.Matchers.not");
maybeRemoveImport("org.hamcrest.CoreMatchers.not");
matcherInvocation = (J.MethodInvocation) new RemoveNotMatcherVisitor().visit(matcherInvocation, ctx, getCursor());
}

if (INSTANCE_OF_MATCHER.matches(matcherInvocation) || IS_A_MATCHER.matches(matcherInvocation)) {
boolean logicalContext = RemoveNotMatcherVisitor.getLogicalContext(matcherInvocation, ctx);

String templateString = (logicalContext ?
"assertInstanceOf(#{any(java.lang.Class)}, #{any(java.lang.Object)}" :
"assertFalse(#{any(java.lang.Class)}.isAssignableFrom(#{any(java.lang.Object)}.getClass())") +
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/openrewrite/java/testing/hamcrest/HamcrestMatcherToJUnit5.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
J.MethodInvocation matcherInvocation = (J.MethodInvocation) hamcrestMatcher;
maybeRemoveImport("org.hamcrest.MatcherAssert.assertThat");

boolean logicalContext = true;
while (RemoveNotMatcherVisitor.NOT_MATCHER.matches(matcherInvocation)) {
logicalContext = !logicalContext;
maybeRemoveImport("org.hamcrest.Matchers.not");
maybeRemoveImport("org.hamcrest.CoreMatchers.not");
matcherInvocation = (J.MethodInvocation) new RemoveNotMatcherVisitor().visit(matcherInvocation, ctx, getCursor());
Expand All @@ -165,8 +167,6 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
}
}

boolean logicalContext = RemoveNotMatcherVisitor.getLogicalContext(matcherInvocation, ctx);

Replacement replacement;
try {
replacement = Replacement.valueOf(matcherInvocation.getSimpleName().toUpperCase());
Expand Down
43 changes: 7 additions & 36 deletions src/main/java/org/openrewrite/java/testing/hamcrest/RemoveNotMatcherVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,54 +22,25 @@
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.tree.J;

import java.security.InvalidParameterException;
import java.util.Objects;

class RemoveNotMatcherVisitor extends JavaIsoVisitor<ExecutionContext> {
static final MethodMatcher NOT_MATCHER = new MethodMatcher("org.hamcrest.*Matchers not(..)");

public static boolean getLogicalContext(J.MethodInvocation mi, ExecutionContext ctx) throws InvalidParameterException {
Object msg = ctx.getMessage(mi.toString());
if (msg == null) {
return true;
}
if (msg instanceof Boolean) {
return (Boolean) msg;
}
throw new InvalidParameterException();
}

@Override
@SuppressWarnings("ConstantConditions")
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation mi, ExecutionContext ctx) {
if (NOT_MATCHER.matches(mi)) {
boolean logicalContext;
if (ctx.pollMessage(mi.toString()) != null) {
logicalContext = ctx.getMessage(mi.toString());
} else {
logicalContext = true;
}

maybeRemoveImport("org.hamcrest.Matchers.not");

J.MethodInvocation result;
if (Objects.requireNonNull(mi.getArguments().get(0).getType()).toString().startsWith("org.hamcrest")) {
result = mi.getArguments().get(0).withPrefix(mi.getPrefix());
} else {
JavaTemplate template = JavaTemplate.builder("equalTo(#{any(java.lang.Object)})")
.javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "hamcrest-3"))
.staticImports("org.hamcrest.Matchers.equalTo")
.build();
maybeAddImport("org.hamcrest.Matchers", "equalTo");
result = template.apply(getCursor(), mi.getCoordinates().replace(), mi.getArguments().get(0));
return mi.getArguments().get(0).withPrefix(mi.getPrefix());
}

ctx.putMessage(result.toString(), !logicalContext); // FIXME Do not store on the use execution context

return result;
}
if (ctx.pollMessage(mi.toString()) == null) {
ctx.putMessage(mi.toString(), true); // FIXME Do not store on the use execution context
maybeAddImport("org.hamcrest.Matchers", "equalTo");
return JavaTemplate.builder("equalTo(#{any(java.lang.Object)})")
.javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "hamcrest-3"))
.staticImports("org.hamcrest.Matchers.equalTo")
.build()
.apply(getCursor(), mi.getCoordinates().replace(), mi.getArguments().get(0));
}
return super.visitMethodInvocation(mi, ctx);
}
Expand Down
4 changes: 1 addition & 3 deletions src/test/java/org/openrewrite/java/testing/hamcrest/HamcrestInstanceOfToJUnit5Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,14 @@
import java.util.concurrent.TimeUnit;

import static org.openrewrite.java.Assertions.java;
import static org.openrewrite.test.TypeValidation.all;

class HamcrestInstanceOfToJUnit5Test implements RewriteTest {
@Override
public void defaults(RecipeSpec spec) {
spec
.parser(JavaParser.fromJavaVersion()
.classpathFromResources(new InMemoryExecutionContext(), "junit-jupiter-api-5", "hamcrest-3"))
.recipe(new HamcrestInstanceOfToJUnit5())
.typeValidationOptions(all().immutableExecutionContext(false));
.recipe(new HamcrestInstanceOfToJUnit5());
}

@DocumentExample
Expand Down
70 changes: 62 additions & 8 deletions src/test/java/org/openrewrite/java/testing/hamcrest/HamcrestMatcherToJUnit5Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@

import static org.openrewrite.java.Assertions.java;
import static org.openrewrite.kotlin.Assertions.kotlin;
import static org.openrewrite.test.TypeValidation.all;

class HamcrestMatcherToJUnit5Test implements RewriteTest {
@Override
Expand Down Expand Up @@ -128,7 +127,6 @@ void testEquals() {
void notEqualToString() {
//language=java
rewriteRun(
spec -> spec.typeValidationOptions(all().immutableExecutionContext(false)),
java(
"""
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -167,7 +165,6 @@ void testEquals() {
void notWithBareValue() {
//language=java
rewriteRun(
spec -> spec.typeValidationOptions(all().immutableExecutionContext(false)),
java(
"""
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -206,7 +203,6 @@ void testEquals() {
void notFromCoreMatchers() {
//language=java
rewriteRun(
spec -> spec.typeValidationOptions(all().immutableExecutionContext(false)),
java(
"""
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -241,6 +237,67 @@ void testEquals() {
);
}

@Test
void negationDoesNotLeakIntoLaterAssertions() {
//language=java
rewriteRun(
java(
"""
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;

class ATest {
void test(Object a, Object b) {
assertThat(a, not(nullValue()));
assertThat(b, nullValue());
}
}
""",
"""
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;

class ATest {
void test(Object a, Object b) {
assertNotNull(a);
assertNull(b);
}
}
"""
)
);
}

@Test
void doubleNegation() {
//language=java
rewriteRun(
java(
"""
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;

class ATest {
void test(Object a) {
assertThat(a, not(not(nullValue())));
}
}
""",
"""
import static org.junit.jupiter.api.Assertions.assertNull;

class ATest {
void test(Object a) {
assertNull(a);
}
}
"""
)
);
}

@Test
void greaterThan() {
//language=java
Expand Down Expand Up @@ -549,7 +606,6 @@ void testNullValue() {
void sameInstance() {
//language=java
rewriteRun(
spec -> spec.typeValidationOptions(all().immutableExecutionContext(false)),
java(
"""
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -1062,9 +1118,7 @@ fun testEquals() {
@Test
void notEqualToKotlin() {
rewriteRun(
// Unwrapping not() stores logical context on the ExecutionContext (see RemoveNotMatcherVisitor)
spec -> spec.typeValidationOptions(all().immutableExecutionContext(false))
.parser(KotlinParser.builder()
spec -> spec.parser(KotlinParser.builder()
.classpathFromResources(new InMemoryExecutionContext(), "junit-jupiter-api-5", "hamcrest-3")),
//language=kotlin
kotlin(
Expand Down
2 changes: 0 additions & 2 deletions src/test/java/org/openrewrite/java/testing/hamcrest/MigrateHamcrestToJUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import org.openrewrite.test.RewriteTest;

import static org.openrewrite.java.Assertions.java;
import static org.openrewrite.test.TypeValidation.all;

class MigrateHamcrestToJUnitTest implements RewriteTest {
@Override
Expand All @@ -39,7 +38,6 @@ public void defaults(RecipeSpec spec) {
void equalToString() {
//language=java
rewriteRun(
spec -> spec.typeValidationOptions(all().immutableExecutionContext(false)),
java(
"""
import org.junit.jupiter.api.Test;
Expand Down
4 changes: 1 addition & 3 deletions src/test/java/org/openrewrite/java/testing/hamcrest/RemoveNotMatcherTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,14 @@

import static org.openrewrite.java.Assertions.java;
import static org.openrewrite.test.RewriteTest.toRecipe;
import static org.openrewrite.test.TypeValidation.all;

class RemoveNotMatcherTest implements RewriteTest {
@Override
public void defaults(RecipeSpec spec) {
spec
.parser(JavaParser.fromJavaVersion()
.classpathFromResources(new InMemoryExecutionContext(), "junit-jupiter-api-5", "hamcrest-3"))
.recipe(toRecipe(RemoveNotMatcherVisitor::new))
.typeValidationOptions(all().immutableExecutionContext(false));
.recipe(toRecipe(RemoveNotMatcherVisitor::new));
}

@DocumentExample
Expand Down
Loading