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.

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

More best pratices for AssertJ #548

Merged
merged 6 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.testing.assertj;

import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.J.MethodInvocation;
import org.openrewrite.java.tree.JavaType.Method;

import java.util.Collections;

/**
* AssertJ has a more idiomatic way of asserting that a boolean is true. This
* recipe will find instances of:
*
* -`assertThat(boolean).isEqualTo(true)` and replace them with `isTrue()`.
* -`assertThat(boolean).isEqualTo(false)` and replace them with `isFalse()`.
*/
public class IsEqualToBoolean extends Recipe {

private static final MethodMatcher IS_EQUAL_TO = new MethodMatcher(
"org.assertj.core.api.AbstractBooleanAssert isEqualTo(boolean)");

@Override
public String getDisplayName() {
return "Convert `assertThat(String).isEqualTo(true)` to `isTrue()` and `isEqualTo(false)` to `isFalse()`";
}

@Override
public String getDescription() {
return "Adopt idiomatic AssertJ assertion for true booleans.";
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return Preconditions.check(new UsesMethod<>(IS_EQUAL_TO), new JavaIsoVisitor<ExecutionContext>() {
@Override
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
MethodInvocation mi = super.visitMethodInvocation(method, ctx);
if (IS_EQUAL_TO.matches(mi)) {
String methodName;
if (J.Literal.isLiteralValue(mi.getArguments().get(0), true)) {
methodName = "isTrue";
} else {
methodName = "isFalse";
}
Method isBooleanMethod = mi.getMethodType().withName(methodName);
return mi.withName(mi.getName().withSimpleName(methodName).withType(isBooleanMethod))
.withMethodType(isBooleanMethod).withArguments(Collections.emptyList());
}
return mi;
}
});
}
}
11 changes: 11 additions & 0 deletions src/main/resources/META-INF/rewrite/assertj.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ recipeList:
- org.openrewrite.java.testing.hamcrest.MigrateHamcrestToAssertJ
- org.openrewrite.java.testing.assertj.JUnitToAssertj
- org.openrewrite.java.testing.assertj.StaticImports
- org.openrewrite.java.testing.assertj.IsEqualToBoolean
- org.openrewrite.java.testing.assertj.SimplifyChainedAssertJAssertions
- org.openrewrite.java.testing.assertj.IsEqualToEmptyString

Expand Down Expand Up @@ -337,6 +338,16 @@ recipeList:
assertToReplace: isSameAs
dedicatedAssertion: containsSame
requiredType: java.util.Optional
- org.openrewrite.java.testing.assertj.SimplifyChainedAssertJAssertion:
chainedAssertion: hasNext
assertToReplace: isTrue
dedicatedAssertion: hasNext
requiredType: java.util.Iterator
- org.openrewrite.java.testing.assertj.SimplifyChainedAssertJAssertion:
chainedAssertion: hasNext
assertToReplace: isFalse
dedicatedAssertion: isExhausted
requiredType: java.util.Iterator

---
type: specs.openrewrite.org/v1beta/recipe
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.testing.assertj;

import static org.openrewrite.java.Assertions.java;

velo marked this conversation as resolved.
Show resolved Hide resolved
import org.junit.jupiter.api.Test;
import org.openrewrite.InMemoryExecutionContext;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

class IsEqualToBooleanTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec
.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(), "assertj-core-3.24"))
.recipe(new IsEqualToBoolean());
}

@Test
velo marked this conversation as resolved.
Show resolved Hide resolved
void convertsIsEqualToTrue() {
rewriteRun(
// language=java
java("""
import static org.assertj.core.api.Assertions.assertThat;
class Test {
void test() {
assertThat(true).isEqualTo(true);
}
}
""", """
import static org.assertj.core.api.Assertions.assertThat;
class Test {
void test() {
assertThat(true).isTrue();
}
}
"""));
}

@Test
void convertsIsEqualToFalse() {
rewriteRun(
// language=java
java("""
velo marked this conversation as resolved.
Show resolved Hide resolved
import static org.assertj.core.api.Assertions.assertThat;
class Test {
void test() {
assertThat(false).isEqualTo(false);
}
}
""", """
import static org.assertj.core.api.Assertions.assertThat;
class Test {
void test() {
assertThat(false).isFalse();
}
}
"""));
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.testing.assertj;

import static org.openrewrite.java.Assertions.java;

velo marked this conversation as resolved.
Show resolved Hide resolved
import org.junit.jupiter.api.Test;
import org.openrewrite.InMemoryExecutionContext;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

class IsEqualToEmptyStringTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec
.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(), "assertj-core-3.24"))
.recipe(new IsEqualToEmptyString());
}

@Test
velo marked this conversation as resolved.
Show resolved Hide resolved
void convertsIsEqualToEmptyString() {
rewriteRun(
// language=java
java("""
import static org.assertj.core.api.Assertions.assertThat;
class Test {
void test() {
assertThat("test").isEqualTo("");
}
}
""", """
import static org.assertj.core.api.Assertions.assertThat;
class Test {
void test() {
assertThat("test").isEmpty();
}
}
"""));
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -414,4 +414,45 @@ void test() {
rewriteRun(java(before, after));
}
}


@Nested
class Iteratorz {
private static Stream<Arguments> collectionReplacements() {
return Stream.of(
Arguments.arguments("hasNext", "isTrue", "hasNext"),
Arguments.arguments("hasNext", "isFalse", "isExhausted")
);
}

@ParameterizedTest
@MethodSource("collectionReplacements")
void collectionReplacements(String chainedAssertion, String assertToReplace, String dedicatedAssertion) {
//language=java
String template = """
import java.util.Iterator;

import static org.assertj.core.api.Assertions.assertThat;

class A {
void test(Iterator<String> iterator, Iterator<String> otherIterator) {
String something = "";
%s
}
}
""";
String assertBefore = "assertThat(iterator.%s()).%s();";
String assertAfter = "assertThat(iterator).%s();";

String formattedAssertBefore = assertBefore.formatted(chainedAssertion, assertToReplace);

String before = String.format(template, formattedAssertBefore);
String after = String.format(template, assertAfter.formatted(dedicatedAssertion));

rewriteRun(
java(before, after)
);
}

}
}