org.openrewrite.java.spring.boot2.UnnecessarySpringExtension Maven / Gradle / Ivy
Show all versions of rewrite-spring Show documentation
/*
* Copyright 2021 the original author or authors.
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* 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.spring.boot2;
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.RemoveAnnotation;
import org.openrewrite.java.search.FindAnnotations;
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.java.tree.TypeUtils;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
public class UnnecessarySpringExtension extends Recipe {
// All the following annotations apply the @SpringExtension
private static final List SPRING_BOOT_TEST_ANNOTATIONS = Arrays.asList(
"org.springframework.boot.test.context.SpringBootTest",
"org.springframework.boot.test.autoconfigure.jdbc.JdbcTest",
"org.springframework.boot.test.autoconfigure.web.client.RestClientTest",
"org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest",
"org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest",
"org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest",
"org.springframework.boot.test.autoconfigure.webservices.client.WebServiceClientTest",
"org.springframework.boot.test.autoconfigure.jooq.JooqTest",
"org.springframework.boot.test.autoconfigure.json.JsonTest",
"org.springframework.boot.test.autoconfigure.data.cassandra.DataCassandraTest",
"org.springframework.boot.test.autoconfigure.data.jdbc.DataJdbcTest",
"org.springframework.boot.test.autoconfigure.data.ldap.DataLdapTest",
"org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest",
"org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest",
"org.springframework.boot.test.autoconfigure.data.r2dbc.DataR2dbcTest",
"org.springframework.boot.test.autoconfigure.data.redis.DataRedisTest",
"org.springframework.batch.test.context.SpringBatchTest",
"org.springframework.test.context.junit.jupiter.SpringJUnitConfig"
);
private static final String EXTEND_WITH_SPRING_EXTENSION_ANNOTATION_PATTERN = "@org.junit.jupiter.api.extension.ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class)";
@Override
public String getDisplayName() {
return "Remove `@SpringExtension`";
}
@Override
public String getDescription() {
return "`@SpringBootTest` and all test slice annotations already applies `@SpringExtension` as of Spring Boot 2.1.0.";
}
@Override
public TreeVisitor getVisitor() {
return Preconditions.check(new UsesType<>("org.springframework.test.context.junit.jupiter.SpringExtension", false),
new JavaIsoVisitor() {
@Override
public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) {
// Clear the class body to make annotation search and replace faster
// noinspection ConstantConditions
J.ClassDeclaration c = classDecl.withBody(null);
AtomicBoolean annotationFound = new AtomicBoolean(false);
new FindBootTestAnnotation().visit(c, annotationFound);
if (annotationFound.get()) {
if (!FindAnnotations.find(c, EXTEND_WITH_SPRING_EXTENSION_ANNOTATION_PATTERN).isEmpty()) {
c = (J.ClassDeclaration) new RemoveAnnotation(EXTEND_WITH_SPRING_EXTENSION_ANNOTATION_PATTERN)
.getVisitor().visit(c, ctx, getCursor().getParentOrThrow());
assert c != null;
maybeRemoveImport("org.springframework.test.context.junit.jupiter.SpringExtension");
maybeRemoveImport("org.junit.jupiter.api.extension.ExtendWith");
return super.visitClassDeclaration(c.withBody(classDecl.getBody()), ctx);
}
}
return super.visitClassDeclaration(classDecl, ctx);
}
});
}
// Using this visitor vs making 15 calls to findAnnotations.
private static class FindBootTestAnnotation extends JavaIsoVisitor {
@Override
public J.Annotation visitAnnotation(J.Annotation annotation, AtomicBoolean found) {
J.Annotation a = super.visitAnnotation(annotation, found);
if (!found.get()) {
JavaType.FullyQualified fullyQualified = TypeUtils.asFullyQualified(a.getType());
if (fullyQualified != null && SPRING_BOOT_TEST_ANNOTATIONS.contains(fullyQualified.getFullyQualifiedName())) {
found.set(true);
}
}
return a;
}
}
}