JUnitの表示名 – @DisplayName

JUnitの@DisplayNameアノテーションは、テストクラスやテストメソッドにカスタム名を提供するために使用されます。ディスプレイ名には、スペース、特殊文字、さらには絵文字も使用できます。

JUnitの表示名の例

デフォルトでは、JUnitのレポートではクラス名とメソッド名がIDEのテストレポートに表示されます。@DisplayNameを使用して、テストクラスとメソッドに関する簡単に読めるカスタム名と情報を指定することができます。では、JUnit Jupiterの@DisplayNameアノテーションのいくつかの例を見てみましょう。テストクラスのディスプレイ名。

@DisplayName("MyTestClass")
public class DisplayNameTest {
}

メソッドの表示名

@Test
@DisplayName("Example Test Method with No Business Logic")
void test() {
	assertTrue(3 > 0);
}

表示名（ディスプレイネーム）と絵文字

@Test
@DisplayName("MyTestMethod ☺")
void test1(TestInfo testInfo) {
	assertEquals("MyTestMethod ☺", testInfo.getDisplayName());
}

メソッド内でTestInfoをメソッド引数に注入することで、テストメソッドの表示名を取得できることに注意してください。

レポートに表示されるJUnitの表示名

要点を要約すると、日本語での自然な文章を1つ提供します。

JUnit Jupiterの@DisplayNameアノテーションは、テストに直接的な利益を提供しません。しかし、レポートに表示されるテストメソッドに関する情報を提供し、非技術的なユーザーでも簡単に理解できるようにするために使用することができます。

弊社のGitHubリポジトリで、完全なクラスと他のJUnitの例をご覧いただけます。