org.openrewrite.java.testing.junit5.RemoveTryCatchFailBlocks Maven / Gradle / Ivy
Show all versions of rewrite-testing-frameworks Show documentation
/*
* Copyright 2024 the original author or authors.
*
* Licensed under the Moderne Source Available License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://docs.moderne.io/licensing/moderne-source-available-license
*
* 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.junit5;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.*;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.*;
import java.util.Collections;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.stream.Stream;
public class RemoveTryCatchFailBlocks extends Recipe {
private static final MethodMatcher ASSERT_FAIL_NO_ARG = new MethodMatcher("org.junit.jupiter.api.Assertions fail()");
private static final MethodMatcher ASSERT_FAIL_STRING_ARG = new MethodMatcher("org.junit.jupiter.api.Assertions fail(String)");
private static final MethodMatcher ASSERT_FAIL_THROWABLE_ARG = new MethodMatcher("org.junit.jupiter.api.Assertions fail(.., Throwable)");
private static final MethodMatcher GET_MESSAGE_MATCHER = new MethodMatcher("java.lang.Throwable getMessage()");
@Override
public String getDisplayName() {
return "Replace `fail()` in `try-catch` blocks with `Assertions.assertDoesNotThrow(() -> { ... })`";
}
@Override
public String getDescription() {
return "Replace `try-catch` blocks where `catch` merely contains a `fail()` for `fail(String)` statement " +
"with `Assertions.assertDoesNotThrow(() -> { ... })`.";
}
@Override
public Set getTags() {
return Collections.singleton("RSPEC-S3658");
}
@Override
public TreeVisitor getVisitor() {
return Preconditions.check(new UsesMethod<>("org.junit.jupiter.api.Assertions fail(..)", false), new RemoveTryCatchBlocksFromUnitsTestsVisitor());
}
private static class RemoveTryCatchBlocksFromUnitsTestsVisitor extends JavaVisitor {
@Override
public J visitTry(J.Try jtry, ExecutionContext ctx) {
J.Try try_ = (J.Try) super.visitTry(jtry, ctx);
// only one catch block, such that we know it's safe to apply this recipe, and doesn't have resources
if (try_.getResources() != null || try_.getCatches().size() != 1 || try_.getFinally() != null) {
return try_;
}
// Skip if any return is found, since we can't return from `assertDoesNotThrow`
AtomicBoolean returnFound = new AtomicBoolean(false);
new JavaIsoVisitor() {
@Override
public J.Return visitReturn(J.Return _return, AtomicBoolean atomicBoolean) {
atomicBoolean.set(true);
return _return;
}
}.visit(try_, returnFound, getCursor().getParentOrThrow());
if (returnFound.get()) {
return try_;
}
/*
Only one statement in the catch block, which is a fail(), with no or a simple String argument.
We would not want to convert for instance fail(cleanUpAndReturnMessage()) might still have side
effects that we don't want to remove.
*/
J.Try.Catch catchBlock = try_.getCatches().get(0);
if (catchBlock.getBody().getStatements().size() != 1) {
return try_;
}
Statement statement = catchBlock.getBody().getStatements().get(0);
if (!(statement instanceof J.MethodInvocation)) {
return try_;
}
J.MethodInvocation failCall = (J.MethodInvocation) statement;
if (!ASSERT_FAIL_NO_ARG.matches(failCall) &&
!ASSERT_FAIL_STRING_ARG.matches(failCall) &&
!ASSERT_FAIL_THROWABLE_ARG.matches(failCall)) {
return try_;
}
// Only replace known cases
Expression failCallArgument = failCall.getArguments().get(0);
if (failCallArgument instanceof J.Empty) {
return replaceWithAssertDoesNotThrowWithoutStringExpression(ctx, try_);
} else if (failCallArgument instanceof J.MethodInvocation && GET_MESSAGE_MATCHER.matches(failCallArgument)) {
return replaceWithAssertDoesNotThrowWithoutStringExpression(ctx, try_);
} else if (failCallArgument instanceof J.Literal) {
return replaceWithAssertDoesNotThrowWithStringExpression(ctx, try_, failCallArgument);
} else if (isException(failCallArgument)) {
return replaceWithAssertDoesNotThrowWithoutStringExpression(ctx, try_);
} else if (failCallArgument instanceof J.Binary) {
J.Binary binaryArg = (J.Binary) failCallArgument;
Expression left = binaryArg.getLeft();
Expression right = binaryArg.getRight();
// Rewrite fail("message: " + e), fail("message: " + e.getMessage())
if (left instanceof J.Literal && (GET_MESSAGE_MATCHER.matches(right) || isException(right))) {
return replaceWithAssertDoesNotThrowWithStringExpression(ctx, try_, left);
}
}
// Fall back to making no change at all
return try_;
}
private static boolean isException(Expression expression) {
return expression instanceof J.Identifier && TypeUtils.isAssignableTo("java.lang.Throwable", expression.getType());
}
private J.MethodInvocation replaceWithAssertDoesNotThrowWithoutStringExpression(ExecutionContext ctx, J.Try try_) {
maybeAddImport("org.junit.jupiter.api.Assertions");
maybeRemoveCatchTypes(try_);
return JavaTemplate.builder("Assertions.assertDoesNotThrow(() -> #{any()})")
.contextSensitive()
.imports("org.junit.jupiter.api.Assertions")
.javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "junit-jupiter-api-5.9"))
.build()
.apply(getCursor(), try_.getCoordinates().replace(), try_.getBody());
}
private void maybeRemoveCatchTypes(J.Try try_) {
maybeRemoveImport("org.junit.jupiter.api.Assertions.fail");
JavaType catchType = try_.getCatches().get(0).getParameter().getTree().getType();
if (catchType != null) {
Stream.of(catchType)
.flatMap(t -> t instanceof JavaType.MultiCatch ? ((JavaType.MultiCatch) t).getThrowableTypes().stream() : Stream.of(t))
.map(TypeUtils::asFullyQualified)
.filter(Objects::nonNull)
.forEach(t -> maybeRemoveImport(t.getFullyQualifiedName()));
}
}
private J.MethodInvocation replaceWithAssertDoesNotThrowWithStringExpression(ExecutionContext ctx, J.Try try_, Expression failCallArgument) {
// Retain the fail(String) call argument
maybeAddImport("org.junit.jupiter.api.Assertions");
maybeRemoveCatchTypes(try_);
return JavaTemplate.builder("Assertions.assertDoesNotThrow(() -> #{any()}, #{any(String)})")
.contextSensitive()
.imports("org.junit.jupiter.api.Assertions")
.javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "junit-jupiter-api-5.9"))
.build()
.apply(getCursor(), try_.getCoordinates().replace(), try_.getBody(), failCallArgument);
}
}
}