Document automated migration from Hamcrest to AssertJ

[timtebeek]

Hi! The documentation already has a section on migrating from JUnit to AssertJ with scripts. The documentation does not yet document a way to migrate from Hamcrest assertions to AssertJ.

An automated migration from Hamcrest to AssertJ is (in large part) possible with the OSS OpenRewrite, either by running Migrate Hamcrest to AssertJ assertions or the broader AssertJ best practices recipe. The latter also migrates JUnit to AssertJ, and adopts more expressive assertions for AssertJ, as seen in this example PR for Spring Security.

Would you all be open to adding a section to the docs to document the Hamcrest and JUnit to AssertJ migration with OpenRewrite?

I'd be happy to help write such a section, but wanted to reach out before I do so, and ask how you would like to position the above as compared to the regex script based approach that exists currently.

[scordio]

Great idea, @timtebeek!

I think a subchapter of https://assertj.github.io/doc/#assertj-migration (e.g., 2.7.3) could be a good place for it.

Thanks for the help!

[timtebeek]

@mike-solomon was kind enough to help out in writing a chapter on OpenRewrite migrations for AssertJ, which includes migrating away from Hamcrest

• Add OpenRewrite to migrations list #148

Thanks again for offering to include this in the docs, and thanks to Mike for the write up.