👀

IntelliJ IDEAでAssertJを使うとClick to see differenceが表示されない場合の対処法

2021/10/23に公開

Gradle

はじめに

IntelliJ IDEAには、ユニットテストが失敗したときに assertEquals のexpected (期待した値) とactual (実際の値) の差分をわかりやすく表示する機能があります。

テストのログから差分が検出されると「Click to see difference」というリンクが表示され、それをクリックすると差分が左右に表示されます。

Click to see differenceというリンク

差分の表示

これは非常に便利な機能ですが、AssertJとJUnit 5とGradleを組み合わせた場合、次のように「Click to see difference」が表示されないことがあります。

Click to see differenceが表示されない

対応策

この場合、以下のいずれかの対応をすると表示されるようになります。

AssertJではなくJUnit 5のアサーション (assertEquals) を使う。
JUnit 5ではなく、JUnit 4を使う。
テストランナーとして、GradleではなくIntelliJ IDEAを使う。

1を行った場合、次の画像のようにエラーメッセージの形式が変わります。Click to see differenceの実装には、ハードコードされた正規表現が使われているよう ^[1] で、JUnit 5のエラーメッセージ形式はこの正規表現にマッチするため、差分が表示されます。逆に言うと、AssertJはエラーメッセージをJUnitのものよりわかりやすくしているために、IntelliJの正規表現にマッチしなくなっていたのです。

対応策1

2を行った場合も、1と同様にエラーメッセージの形式が変わり、差分が表示されるようになります。AssertJでは、JUnit 5がクラスパス上に見つからず、かつJUnit 4が見つかる場合に、JUnit 4の形式 (org.junit.ComparisonFailure) でエラーを出力するという実装 ^[2] になっているためです。

対応策2

3を行った場合、IntelliJは差分をログの文字列から検知するのではなく、例外オブジェクト org.opentest4j.AssertionFailedError から直接expectedとactualの値を取得するようになるようです。これによって、エラーメッセージの形式を変更することなく、差分を検知できるわけです。ただし、テストランナーを変更すると、コンパイル速度が速くなる代わりに、予期しない差異が生まれる可能性があることに注意が必要です。

対応策3

まとめ

以下のIssueにある通り、特別に対応しなくても差分が表示される方が嬉しいですが、正規表現で差分を検出するアプローチは多様なライブラリへの対応が難しいので、望みは薄いかもしれません。開発環境とCI環境で差異が出るのはなるべく避けたいではありますが、 DXを考えると上記の3の対応が現実的かなと考えています。

環境

試した環境は以下の通りです。

IntelliJ IDEA 2021.2.3 (Community Edition)
AdoptOpenJDK 14.0.2
Gradle 7.1
AssertJ 3.21.0
JUnit 5.8.1 / 4.13.2

ソースコードは以下の場所に置いてあります。

参考

脚注

はじめに

対応策

まとめ

環境

参考

Discussion