Migrating from Fest 2.x to AssertJ to avoid ambiguous references to assertThat

[timo-abele]

What version of OpenRewrite are you using?

I am using

• Maven plugin v5.18.0
• rewrite-testing-frameworks v2.2.0

How are you running OpenRewrite?

I am using the Maven plugin, and my project is a single module project.

<plugin>
    <groupId>org.openrewrite.maven</groupId>
    <artifactId>rewrite-maven-plugin</artifactId>
    <version>5.18.0</version>
    <configuration>
        <activeRecipes>
            <recipe>org.openrewrite.java.testing.assertj.Assertj</recipe>
        </activeRecipes>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-testing-frameworks</artifactId>
            <version>2.2.0</version>
        </dependency>
    </dependencies>
</plugin>

What is the smallest, simplest way to reproduce the problem?

import static org.fest.assertions.Assertions.assertThat;
import org.assertj.core.api.Assertions;

class A {
    @Test
    void foo() {
        Assertions.assertThat(1 + 1).isEqualTo(2); //assertJ
        assertThat(1+1).isEqualTo(2);    //fest
    }
}

What did you expect to see?

import static org.assertj.core.api.Assertions.assertThat;

class A {
    @Test
    void foo() {
        assertThat(1 + 1).isEqualTo(2);
        assertThat(1+1).isEqualTo(2);
    }
}

What did you see instead?

import static org.assertj.core.api.Assertions.assertThat;
import static org.fest.assertions.Assertions.assertThat;

class A {
    @Test
    void foo() {
        assertThat(1 + 1).isEqualTo(2);
        assertThat(1+1).isEqualTo(2);
    }
}

What is the full stack trace of any errors you encountered?

Project won't compile, job testCompile says

reference to assertThat is ambiguous

Are you interested in contributing a fix to OpenRewrite?

No

[timtebeek]

Thanks for pointing this out! Wasn't aware of Fest, and understand how that leads to ambiguity here. It seems the AssertJ recipes that we have are hardwired to use static imports, as for instance seen here.

rewrite-testing-frameworks/src/main/java/org/openrewrite/java/testing/assertj/JUnitAssertEqualsToAssertThat.java

Lines 69 to 74 in 368384a

	return JavaTemplate.builder("assertThat(#{any()}).isEqualTo(#{any()});")
	.contextSensitive()
	.staticImports("org.assertj.core.api.Assertions.assertThat")
	.javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "assertj-core-3.24"))
	.build()
	.apply(getCursor(), method.getCoordinates().replace(), actual, expected);

Looks like we can first migrate Fest to AssertJ as seen here: https://joel-costigliola.github.io/assertj/assertj-core-migrating-from-fest.html This would be very similar to what we already do here.

rewrite-testing-frameworks/src/main/resources/META-INF/rewrite/assertj.yml

Lines 32 to 46 in 964e677

	name: org.openrewrite.java.testing.assertj.StaticImports
	displayName: Statically import AssertJ's `assertThat`
	description: Consistently use a static import rather than inlining the `Assertions` class name in tests.
	tags:
	- testing
	- assertj
	recipeList:
	- org.openrewrite.java.ChangeMethodTargetToStatic:
	methodPattern: "org.assertj.core.api.AssertionsForClassTypes assertThat(..)"
	fullyQualifiedTargetTypeName: "org.assertj.core.api.Assertions"
	- org.openrewrite.java.ChangeMethodTargetToStatic:
	methodPattern: "org.assertj.core.api.AssertionsForInterfaceTypes assertThat(..)"
	fullyQualifiedTargetTypeName: "org.assertj.core.api.Assertions"
	- org.openrewrite.java.UseStaticImport:
	methodPattern: "org.assertj.core.api.Assertions *(..)"

Should be fairly straightforward especially for the 2.x version of Fest. I'd expect no more than a handful of Yaml recipes to get the bulk of the usages migrated, which would then also avoid these conflicts here.