-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
85 changed files
with
5,161 additions
and
1,283 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
Binary file not shown.
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 |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| distributionBase=GRADLE_USER_HOME | ||
| distributionPath=wrapper/dists | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip | ||
| networkTimeout=10000 | ||
| zipStoreBase=GRADLE_USER_HOME | ||
| zipStorePath=wrapper/dists | ||
| distributionSha256Sum=9d926787066a081739e8200858338b4a69e837c3a821a33aca9db09dd4a41026 |
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
245 changes: 245 additions & 0 deletions
245
src/main/java/org/openrewrite/java/testing/assertj/AdoptAssertJDurationAssertions.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,245 @@ | ||
| /* | ||
| * 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.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.JavaParser; | ||
| import org.openrewrite.java.JavaTemplate; | ||
| import org.openrewrite.java.MethodMatcher; | ||
| import org.openrewrite.java.search.UsesMethod; | ||
| import org.openrewrite.java.tree.Expression; | ||
| import org.openrewrite.java.tree.J; | ||
| import org.openrewrite.java.tree.JavaType; | ||
| import org.openrewrite.java.tree.TypeUtils; | ||
| import org.openrewrite.staticanalysis.SimplifyDurationCreationUnits; | ||
|
|
||
| import java.util.*; | ||
|
|
||
| public class AdoptAssertJDurationAssertions extends Recipe { | ||
|
|
||
| static final String DURATION_ASSERT_HAS_LONG = "org.assertj.core.api.AbstractDurationAssert has*(long)"; | ||
|
|
||
| static final String INTEGER_ASSERT_IS_EQUAL_TO = "org.assertj.core.api.AbstractIntegerAssert isEqualTo(..)"; | ||
| static final String INTEGER_ASSERT_IS_GREATER_THAN = "org.assertj.core.api.AbstractIntegerAssert isGreaterThan(..)"; | ||
| static final String INTEGER_ASSERT_IS_LESS_THAN = "org.assertj.core.api.AbstractIntegerAssert isLessThan(..)"; | ||
|
|
||
| static final String LONG_ASSERT_IS_LESS_THAN = "org.assertj.core.api.AbstractLongAssert isLessThan(..)"; | ||
| static final String LONG_ASSERT_IS_GREATER_THAN = "org.assertj.core.api.AbstractLongAssert isGreaterThan(..)"; | ||
| static final String LONG_ASSERT_IS_EQUAL_TO = "org.assertj.core.api.AbstractLongAssert isEqualTo(..)"; | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return "Adopt AssertJ Duration assertions"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescription() { | ||
| return "Adopt AssertJ `DurationAssert` assertions for more expressive messages."; | ||
| } | ||
|
|
||
| @Override | ||
| public TreeVisitor<?, ExecutionContext> getVisitor() { | ||
| return Preconditions.check(Preconditions.or( | ||
| new UsesMethod<>(DURATION_ASSERT_HAS_LONG, true), | ||
|
|
||
| new UsesMethod<>(INTEGER_ASSERT_IS_EQUAL_TO, true), | ||
| new UsesMethod<>(INTEGER_ASSERT_IS_GREATER_THAN, true), | ||
| new UsesMethod<>(INTEGER_ASSERT_IS_LESS_THAN, true), | ||
|
|
||
| new UsesMethod<>(LONG_ASSERT_IS_EQUAL_TO, true), | ||
| new UsesMethod<>(LONG_ASSERT_IS_GREATER_THAN, true), | ||
| new UsesMethod<>(LONG_ASSERT_IS_LESS_THAN, true) | ||
| ), new AdoptAssertJDurationAssertionsVisitor() | ||
| ); | ||
| } | ||
|
|
||
| @SuppressWarnings("DataFlowIssue") | ||
| private static class AdoptAssertJDurationAssertionsVisitor extends JavaIsoVisitor<ExecutionContext> { | ||
| private static final MethodMatcher ASSERT_THAT_MATCHER = new MethodMatcher("org.assertj.core.api.Assertions assertThat(..)"); | ||
| private static final MethodMatcher GET_NANO_MATCHER = new MethodMatcher("java.time.Duration getNano()"); | ||
| private static final MethodMatcher GET_SECONDS_MATCHER = new MethodMatcher("java.time.Duration getSeconds()"); | ||
| private static final MethodMatcher AS_MATCHER = new MethodMatcher("org.assertj.core.api.AbstractObjectAssert as(..)"); | ||
| private static final MethodMatcher TIME_UNIT_MATCHERS = new MethodMatcher(DURATION_ASSERT_HAS_LONG, true); | ||
| private static final List<MethodMatcher> IS_MATCHERS = Arrays.asList( | ||
| new MethodMatcher(INTEGER_ASSERT_IS_EQUAL_TO, true), | ||
| new MethodMatcher(INTEGER_ASSERT_IS_GREATER_THAN, true), | ||
| new MethodMatcher(INTEGER_ASSERT_IS_LESS_THAN, true), | ||
|
|
||
| new MethodMatcher(LONG_ASSERT_IS_EQUAL_TO, true), | ||
| new MethodMatcher(LONG_ASSERT_IS_GREATER_THAN, true), | ||
| new MethodMatcher(LONG_ASSERT_IS_LESS_THAN, true) | ||
| ); | ||
| private static final Map<String, String> METHOD_MAP = new HashMap<String, String>() {{ | ||
| put("getSeconds", "hasSeconds"); | ||
| put("getNano", "hasNanos"); | ||
|
|
||
| put("hasNanos", "hasMillis"); | ||
| put("hasMillis", "hasSeconds"); | ||
| put("hasSeconds", "hasMinutes"); | ||
| put("hasMinutes", "hasHours"); | ||
| put("hasHours", "hasDays"); | ||
|
|
||
| put("isGreaterThan", "isPositive"); | ||
| put("isLessThan", "isNegative"); | ||
| put("isEqualTo", "isZero"); | ||
| }}; | ||
|
|
||
| @Override | ||
| public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { | ||
| J.MethodInvocation mi = super.visitMethodInvocation(method, ctx); | ||
| if (TIME_UNIT_MATCHERS.matches(mi)) { | ||
| return simplifyTimeUnits(mi, ctx); | ||
| } else if (IS_MATCHERS.stream().anyMatch(matcher -> matcher.matches(mi))) { | ||
| return simplifyMultipleAssertions(mi, ctx); | ||
| } | ||
| return mi; | ||
| } | ||
|
|
||
| private J.MethodInvocation simplifyMultipleAssertions(J.MethodInvocation m, ExecutionContext ctx) { | ||
| Expression isEqualToArg = m.getArguments().get(0); | ||
| Expression select = m.getSelect(); | ||
| List<Object> templateParameters = new ArrayList<>(); | ||
| templateParameters.add(null); | ||
| Expression asDescription = null; | ||
|
|
||
| if (AS_MATCHER.matches(select)) { | ||
| asDescription = ((J.MethodInvocation) select).getArguments().get(0); | ||
| select = ((J.MethodInvocation) select).getSelect(); | ||
| templateParameters.add(asDescription); | ||
| } | ||
|
|
||
| if (!ASSERT_THAT_MATCHER.matches(select)) { | ||
| return m; | ||
| } | ||
|
|
||
| Expression assertThatArgumentExpr = ((J.MethodInvocation) select).getArguments().get(0); | ||
| if (!(assertThatArgumentExpr instanceof J.MethodInvocation)) { | ||
| return m; | ||
| } | ||
| J.MethodInvocation assertThatArg = (J.MethodInvocation) assertThatArgumentExpr; | ||
|
|
||
| if (isZero(isEqualToArg) && checkIfRelatedToDuration(assertThatArg)) { | ||
| String formatted_template = formatTemplate("assertThat(#{any()}).%s();", m.getSimpleName(), asDescription); | ||
| templateParameters.set(0, assertThatArg); | ||
| return applyTemplate(ctx, m, formatted_template, templateParameters.toArray()); | ||
| } | ||
|
|
||
| if (GET_NANO_MATCHER.matches(assertThatArg) || GET_SECONDS_MATCHER.matches(assertThatArg)) { | ||
| Expression assertThatArgSelect = assertThatArg.getSelect(); | ||
| String methodName = assertThatArg.getSimpleName(); | ||
| String formatted_template = formatTemplate("assertThat(#{any()}).%s(#{any()});", methodName, asDescription); | ||
| templateParameters.set(0, assertThatArgSelect); | ||
| templateParameters.add(isEqualToArg); | ||
|
|
||
| return applyTemplate(ctx, m, formatted_template, templateParameters.toArray()); | ||
| } | ||
|
|
||
| return m; | ||
| } | ||
|
|
||
| private boolean isZero(Expression isEqualToArg) { | ||
| if (isEqualToArg instanceof J.Literal) { | ||
| J.Literal literal = (J.Literal) isEqualToArg; | ||
| return literal.getValue() instanceof Number && ((Number) literal.getValue()).longValue() == 0; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private J.MethodInvocation simplifyTimeUnits(J.MethodInvocation m, ExecutionContext ctx) { | ||
| Expression arg = m.getArguments().get(0); | ||
| Long argValue = SimplifyDurationCreationUnits.getConstantIntegralValue(arg); | ||
| if (argValue == null) { | ||
| return m; | ||
| } | ||
|
|
||
| List<Object> unitInfo = getUnitInfo(m.getSimpleName(), Math.toIntExact(argValue)); | ||
| String methodName = (String) unitInfo.get(0); | ||
| int methodArg = (int) unitInfo.get(1); | ||
| if (!(m.getSimpleName().equals(methodName))) { | ||
| // update method invocation with new name and arg | ||
| String template = String.format("#{any()}.%s(%d)", methodName, methodArg); | ||
| return applyTemplate(ctx, m, template, m.getSelect()); | ||
| } | ||
|
|
||
| return m; | ||
| } | ||
|
|
||
| private static List<Object> getUnitInfo(String name, int argValue) { | ||
| final int timeLength; | ||
| if (name.equals("hasSeconds") || name.equals("hasMinutes")) { | ||
| timeLength = 60; | ||
| } else if (name.equals("hasNanos") || name.equals("hasMillis")) { | ||
| timeLength = 1000; | ||
| } else if (name.equals("hasHours")) { | ||
| timeLength = 24; | ||
| } else { | ||
| return Arrays.asList(name, argValue); | ||
| } | ||
|
|
||
| if (argValue % timeLength == 0) { | ||
| String newName = METHOD_MAP.get(name); | ||
| return getUnitInfo(newName, argValue / timeLength); | ||
| } else { | ||
| // returning name, newArg | ||
| return Arrays.asList(name, argValue); | ||
| } | ||
| } | ||
|
|
||
| private J.MethodInvocation applyTemplate(ExecutionContext ctx, J.MethodInvocation m, String template, Object... parameters) { | ||
| J.MethodInvocation invocation = JavaTemplate.builder(template) | ||
| .contextSensitive() | ||
| .javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "assertj-core-3.24")) | ||
| .build() | ||
| .apply(getCursor(), m.getCoordinates().replace(), parameters); | ||
|
|
||
| // retain whitespace formatting | ||
| if (invocation.getPadding().getSelect() != null && m.getPadding().getSelect() != null) { | ||
| return invocation.getPadding() | ||
| .withSelect( | ||
| invocation.getPadding().getSelect() | ||
| .withAfter(m.getPadding().getSelect().getAfter()) | ||
| ); | ||
| } | ||
| return invocation; | ||
| } | ||
|
|
||
| private boolean checkIfRelatedToDuration(J.MethodInvocation argument) { | ||
| // assertThat(<selectMethod()>.<argument()>).isEqual(0) | ||
| if (argument.getSelect() != null) { | ||
| if (argument.getSelect() instanceof J.MethodInvocation) { | ||
| J.MethodInvocation selectMethod = (J.MethodInvocation) argument.getSelect(); | ||
| return TypeUtils.isOfType(selectMethod.getType(), JavaType.buildType("java.time.Duration")); | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| @SuppressWarnings("ConstantValue") | ||
| private String formatTemplate(String template, String methodName, Object asDescriptionArg) { | ||
| String replacementMethod = METHOD_MAP.get(methodName); | ||
| if (asDescriptionArg == null) { | ||
| return String.format(template, replacementMethod); | ||
| } | ||
| StringBuilder newTemplate = new StringBuilder(template); | ||
| newTemplate.insert(newTemplate.indexOf(").") + 1, ".as(#{any()})"); | ||
| return String.format(newTemplate.toString(), replacementMethod); | ||
| } | ||
| } | ||
| } |
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.