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

Troubleshoot mismatched AssertJ AbstractStringAssert.isEqualTo("") #91

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ dependencies {
testImplementation("org.junit.jupiter:junit-jupiter-api:latest.release")
testImplementation("org.junit.jupiter:junit-jupiter-params:latest.release")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:latest.release")
testImplementation("org.assertj:assertj-core:latest.release")
}

tasks.withType<Test> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import com.google.errorprone.refaster.annotation.BeforeTemplate;
import com.google.testing.compile.Compilation;
import com.google.testing.compile.JavaFileObjects;
import org.assertj.core.api.AbstractStringAssert;
import org.intellij.lang.annotations.Language;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
Expand All @@ -45,6 +46,7 @@ class RefasterTemplateProcessorTest {
"UseStringIsEmpty",
"SimplifyBooleans",
"FindListAdd",
"AbstractStringAssertStringIsEmpty"
})
void generateRecipe(String recipeName) {
Compilation compilation = compileResource("refaster/" + recipeName + ".java");
Expand Down Expand Up @@ -133,7 +135,8 @@ static Compilation compile(JavaFileObject javaFileObject, TypeAwareProcessor pro
fileForClass(org.openrewrite.Recipe.class),
fileForClass(org.openrewrite.java.JavaTemplate.class),
fileForClass(org.slf4j.Logger.class),
fileForClass(Primitive.class)
fileForClass(Primitive.class),
fileForClass(AbstractStringAssert.class)
))
.compile(javaFileObject);
}
Expand Down
33 changes: 33 additions & 0 deletions src/test/resources/refaster/AbstractStringAssertStringIsEmpty.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* 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 foo;

import com.google.errorprone.refaster.annotation.AfterTemplate;
import com.google.errorprone.refaster.annotation.BeforeTemplate;
import org.assertj.core.api.AbstractStringAssert;

public class AbstractStringAssertStringIsEmpty {

@BeforeTemplate
void before(AbstractStringAssert<?> stringAssert) {
stringAssert.isEqualTo("");
}

@AfterTemplate
void after(AbstractStringAssert<?> stringAssert) {
stringAssert.isEmpty();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/*
* 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 foo;

import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.internal.lang.NonNullApi;
import org.openrewrite.java.JavaParser;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.search.*;
import org.openrewrite.java.template.Primitive;
import org.openrewrite.java.template.function.*;
import org.openrewrite.java.template.internal.AbstractRefasterJavaVisitor;
import org.openrewrite.java.tree.*;

import java.util.*;

import static org.openrewrite.java.template.internal.AbstractRefasterJavaVisitor.EmbeddingOption.*;

/**
* OpenRewrite recipe created for Refaster template {@code AbstractStringAssertStringIsEmpty}.
*/
@SuppressWarnings("all")
@NonNullApi
public class AbstractStringAssertStringIsEmptyRecipe extends Recipe {

/**
* Instantiates a new instance.
*/
public AbstractStringAssertStringIsEmptyRecipe() {}

@Override
public String getDisplayName() {
return "Refaster template `AbstractStringAssertStringIsEmpty`";
}

@Override
public String getDescription() {
return "Recipe created for the following Refaster template:\n```java\npublic class AbstractStringAssertStringIsEmpty {\n \n @BeforeTemplate()\n void before(AbstractStringAssert<?> stringAssert) {\n stringAssert.isEqualTo(\"\");\n }\n \n @AfterTemplate()\n void after(AbstractStringAssert<?> stringAssert) {\n stringAssert.isEmpty();\n }\n}\n```\n.";
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
JavaVisitor<ExecutionContext> javaVisitor = new AbstractRefasterJavaVisitor() {
final JavaTemplate before = JavaTemplate
.builder("#{stringAssert:any(org.assertj.core.api.AbstractStringAssert<?>)}.isEqualTo(\"\");")
.javaParser(JavaParser.fromJavaVersion().classpath(JavaParser.runtimeClasspath()))
.build();
final JavaTemplate after = JavaTemplate
.builder("#{stringAssert:any(org.assertj.core.api.AbstractStringAssert<?>)}.isEmpty();")
.javaParser(JavaParser.fromJavaVersion().classpath(JavaParser.runtimeClasspath()))
.build();

@Override
public J visitMethodInvocation(J.MethodInvocation elem, ExecutionContext ctx) {
JavaTemplate.Matcher matcher;
if ((matcher = before.matcher(getCursor())).find()) {
return embed(
after.apply(getCursor(), elem.getCoordinates().replace(), matcher.parameter(0)),
getCursor(),
ctx,
SHORTEN_NAMES
);
}
return super.visitMethodInvocation(elem, ctx);
}

};
return Preconditions.check(
Preconditions.and(
new UsesType<>("org.assertj.core.api.AbstractStringAssert", true),
new UsesMethod<>("org.assertj.core.api.AbstractStringAssert isEqualTo(..)")
),
javaVisitor
);
}
}
Loading