Limit RemoveIsMatcher to invocations within assertThat (#374)

* started adding more unit tests to test the issue

* is matcher now also checks if is invocation is directly inside assertThat before making a change

* Update src/test/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcherTest.java

Co-authored-by: Tim te Beek <[email protected]>

* Update src/main/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcher.java

Co-authored-by: Tim te Beek <[email protected]>

* Update src/test/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcherTest.java

Co-authored-by: Tim te Beek <[email protected]>

* Update src/test/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcherTest.java

Co-authored-by: Tim te Beek <[email protected]>

* Update src/test/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcherTest.java

Co-authored-by: Tim te Beek <[email protected]>

---------

Co-authored-by: Tim te Beek <[email protected]>

Author: AlekSimpson

src/main/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcher.java

@@ -15,13 +15,13 @@
  */
 package org.openrewrite.java.testing.hamcrest;
 
-import org.openrewrite.ExecutionContext;
-import org.openrewrite.Recipe;
-import org.openrewrite.TreeVisitor;
+import org.openrewrite.*;
 import org.openrewrite.java.JavaVisitor;
 import org.openrewrite.java.MethodMatcher;
+import org.openrewrite.java.TreeVisitingPrinter;
 import org.openrewrite.java.tree.J;
 
+@SuppressWarnings("NullableProblems")
 public class RemoveIsMatcher extends Recipe {
     @Override
     public String getDisplayName() {
@@ -34,13 +34,16 @@ public String getDescription() {
     }
 
     static final MethodMatcher IS_MATCHER = new MethodMatcher("org.hamcrest.Matchers is(org.hamcrest.Matcher)");
+    static final MethodMatcher ASSERT_THAT_MATCHER = new MethodMatcher("org.hamcrest.MatcherAssert assertThat(..)");
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
         return new JavaVisitor<ExecutionContext>() {
             @Override
             public J visitMethodInvocation(J.MethodInvocation mi, ExecutionContext ctx) {
-                if (IS_MATCHER.matches(mi)) {
+                if (ASSERT_THAT_MATCHER.matches(mi)) {
+                    getCursor().putMessage("ASSERT_THAT", mi);
+                } else if (IS_MATCHER.matches(mi) && getCursor().pollNearestMessage("ASSERT_THAT") != null) {
                     maybeRemoveImport("org.hamcrest.Matchers.is");
                     return mi.getArguments().get(0).withPrefix(mi.getPrefix());
                 }

src/test/java/org/openrewrite/java/testing/hamcrest/RemoveIsMatcherTest.java

@@ -68,4 +68,90 @@ void testEquals() {
             """));
     }
 
+    @Test
+    void isNotCalledInAssertThat() {
+        //language=java
+        rewriteRun(
+          java(
+            """
+              import org.junit.jupiter.api.Test;
+              import static org.hamcrest.Matchers.is;
+              import static org.hamcrest.Matchers.equalTo;
+              
+              class ATest {
+                  @Test
+                  void testMethod() {
+                      String str1 = "Hello world!";
+                      Matcher<String> x = is(equalTo(str1));
+                  }
+              }
+              """
+          )
+        );
+    }
+
+    @Test
+    void isNotDirectlyInAssertThat() {
+        //language=java
+        rewriteRun(
+          java(
+            """
+              import org.junit.jupiter.api.Test;
+              import static org.hamcrest.MatcherAssert.assertThat;
+              import static org.hamcrest.Matchers.*;
+              
+              class ATest {
+                  @Test
+                  void testMethod() {
+                      String str1 = "Hello world!";
+                      String str2 = "Hello world!";
+                      assertThat(str1, not(is(equalTo(str2))));
+                  }
+              }
+              """,
+            """
+              import org.junit.jupiter.api.Test;
+              import static org.hamcrest.MatcherAssert.assertThat;
+              import static org.hamcrest.Matchers.not;
+              import static org.hamcrest.Matchers.equalTo;
+              
+              class ATest {
+                  @Test
+                  void testMethod() {
+                      String str1 = "Hello world!";
+                      String str2 = "Hello world!";
+                      assertThat(str1, not(equalTo(str2)));
+                  }
+              }
+              """
+          )
+        );
+    }
+
+    @Test
+    void noReplacementForOtherMethodInvocations() {
+        //language=java
+        rewriteRun(
+          java(
+            """
+              import org.junit.jupiter.api.Test;
+              import static org.hamcrest.MatcherAssert.assertThat;
+              import static org.hamcrest.Matcher;
+              import static org.hamcrest.Matchers.*;
+              
+              class ATest {
+                  @Test
+                  void testMethod() {
+                      String str1 = "Hello world!";
+                      String str2 = "Hello world!";
+                      foo(is(equalTo(str2)));
+                  }
+                  
+                  void foo(Matcher<String> matcher) {
+                  }
+              }
+              """
+          )
+        );
+    }
 }