-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add recipe to consolidate @ExtendWith and @ContextConfiguration (#297)
* Add recipe to replace @ExtendWith and @ContextConfiguration with @SpringJUnitConfig (#296) * Override getSingleSourceApplicableTest for UsesType checks Also apply default formatter for consistency * Adopt String.formatted instead of String concatenation * Consistently use replace with instead of into * Adopt Applicability.and(..) to require both annotations * Move and temporarily disable inclusion in update chain --------- Co-authored-by: Tim te Beek <[email protected]>
- Loading branch information
Showing
5 changed files
with
477 additions
and
8 deletions.
There are no files selected for viewing
145 changes: 145 additions & 0 deletions
145
...main/java/org/openrewrite/java/spring/boot2/ReplaceExtendWithAndContextConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /* | ||
| * Copyright 2023 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.spring.boot2; | ||
|
|
||
| import org.openrewrite.Applicability; | ||
| import org.openrewrite.ExecutionContext; | ||
| import org.openrewrite.Recipe; | ||
| import org.openrewrite.TreeVisitor; | ||
| import org.openrewrite.java.AnnotationMatcher; | ||
| import org.openrewrite.java.ChangeType; | ||
| import org.openrewrite.java.JavaIsoVisitor; | ||
| import org.openrewrite.java.JavaTemplate; | ||
| import org.openrewrite.java.search.UsesType; | ||
| import org.openrewrite.java.tree.Expression; | ||
| import org.openrewrite.java.tree.J; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.CopyOnWriteArrayList; | ||
|
|
||
| public class ReplaceExtendWithAndContextConfiguration extends Recipe { | ||
| private static final String FQN_EXTEND_WITH = "org.junit.jupiter.api.extension.ExtendWith"; | ||
| private static final String FQN_CONTEXT_CONFIGURATION = "org.springframework.test.context.ContextConfiguration"; | ||
| private static final String FQN_SPRING_JUNIT_CONFIG = "org.springframework.test.context.junit.jupiter.SpringJUnitConfig"; | ||
|
|
||
| public ReplaceExtendWithAndContextConfiguration() { | ||
| doNext(new UnnecessarySpringExtension()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return "Replace `@ExtendWith` and `@ContextConfiguration` with `@SpringJunitConfig`"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescription() { | ||
| return "Replaces `@ExtendWith(SpringRunner.class)` and `@ContextConfiguration` with `@SpringJunitConfig`, " + | ||
| "preserving attributes on `@ContextConfiguration`, unless `@ContextConfiguration(loader = ...)` is used."; | ||
| } | ||
|
|
||
| @Override | ||
| public Duration getEstimatedEffortPerOccurrence() { | ||
| return Duration.ofMinutes(2); | ||
| } | ||
|
|
||
| @Override | ||
| protected TreeVisitor<?, ExecutionContext> getSingleSourceApplicableTest() { | ||
| return Applicability.and(new UsesType<>(FQN_EXTEND_WITH), new UsesType<>(FQN_CONTEXT_CONFIGURATION)); | ||
| } | ||
|
|
||
| @Override | ||
| protected TreeVisitor<?, ExecutionContext> getVisitor() { | ||
| return new JavaIsoVisitor<ExecutionContext>() { | ||
| private final AnnotationMatcher CONTEXT_CONFIGURATION_ANNOTATION_MATCHER = new AnnotationMatcher("@" + FQN_CONTEXT_CONFIGURATION, true); | ||
|
|
||
| @Override | ||
| public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext context) { | ||
| J.Annotation a = super.visitAnnotation(annotation, context); | ||
|
|
||
| if (CONTEXT_CONFIGURATION_ANNOTATION_MATCHER.matches(a) && getCursor().getParentOrThrow().getValue() instanceof J.ClassDeclaration) { | ||
| // @SpringJUnitConfig supports every attribute on @ContextConfiguration except loader() | ||
| // If it's present, skip the transformation since removing @ContextConfiguration will do harm | ||
| Optional<J.Assignment> loaderArg = findLoaderArgument(a); | ||
| if (loaderArg.isPresent()) { | ||
| return a; | ||
| } | ||
|
|
||
| // @ContextConfiguration value() is an alias for locations() | ||
| // @SpringJUnitConfig value() is an alias for classes() | ||
| // Since these are incompatible, we need to map value() to locations() | ||
| // If value() is present (either explicitly or implicitly), replace it with locations() | ||
| // Note that it's invalid to specify both value() and locations() on @ContextConfiguration | ||
| if (a.getArguments() != null) { | ||
| List<Expression> newArgs = new CopyOnWriteArrayList<>(a.getArguments()); | ||
| replaceValueArgumentWithLocations(a, newArgs); | ||
| a = a.withArguments(newArgs); | ||
| } | ||
|
|
||
| // Change the @ContextConfiguration annotation to @SpringJUnitConfig | ||
| maybeRemoveImport(FQN_CONTEXT_CONFIGURATION); | ||
| maybeAddImport(FQN_SPRING_JUNIT_CONFIG); | ||
| a = (J.Annotation) new ChangeType(FQN_CONTEXT_CONFIGURATION, FQN_SPRING_JUNIT_CONFIG, false) | ||
| .getVisitor().visit(a, context, getCursor()); | ||
| } | ||
|
|
||
| return a != null ? autoFormat(a, context) : annotation; | ||
| } | ||
|
|
||
| private void replaceValueArgumentWithLocations(J.Annotation a, List<Expression> newArgs) { | ||
| for (int i = 0; i < newArgs.size(); i++) { | ||
| Expression expression = newArgs.get(i); | ||
| if (expression instanceof J.Assignment) { | ||
| J.Assignment assignment = (J.Assignment) expression; | ||
| String name = ((J.Identifier) assignment.getVariable()).getSimpleName(); | ||
| if (name.equals("value")) { | ||
| J.Assignment as = createLocationsAssignment(a, assignment.getAssignment()) | ||
| .withPrefix(expression.getPrefix()); | ||
| newArgs.set(i, as); | ||
| break; | ||
| } | ||
| } else { | ||
| // The implicit assignment to "value" | ||
| J.Assignment as = createLocationsAssignment(a, expression).withPrefix(expression.getPrefix()); | ||
| newArgs.set(i, as); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private J.Assignment createLocationsAssignment(J.Annotation annotation, Expression value) { | ||
| return (J.Assignment) ((J.Annotation) annotation.withTemplate( | ||
| JavaTemplate.builder(this::getCursor, "locations = #{any(String)}").build(), | ||
| annotation.getCoordinates().replaceArguments(), | ||
| value | ||
| )).getArguments().get(0); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| private static Optional<J.Assignment> findLoaderArgument(J.Annotation annotation) { | ||
| if (annotation.getArguments() == null) { | ||
| return Optional.empty(); | ||
| } | ||
| return annotation.getArguments().stream() | ||
| .filter(arg -> arg instanceof J.Assignment | ||
| && ((J.Assignment) arg).getVariable() instanceof J.Identifier | ||
| && "loader".equals(((J.Identifier) ((J.Assignment) arg).getVariable()).getSimpleName())) | ||
| .map(J.Assignment.class::cast) | ||
| .findFirst(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.