【Junit5】表示名のカスタマイズ（@DisplayName）

2022年6月8日

当ページのリンクには広告が含まれています。

概要

Junit5で表示名をカスタマイズする方法です。
Junit4については以下を参考にしてください。
　↓
https://irof.hateblo.jp/entry/20130124/p1

できること

テストクラスとテストメソッドに付与することができます。
今回付与したテストメソッドは以下です。
・@Test
・@ParameterizedTest
・@TestFactory
・@TestTemplate

テスト名には定数のみ付与できます。
そのため、変数として与える場合はfinalである必要があります。

実装例

import org.junit.jupiter.api.*;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;

@DisplayName("特殊なテストケース")
class DisplayNameTest {

    @ParameterizedTest
    @CsvSource({"str"})
    @DisplayName("ParameterizedTest")
    void testWithDisplayNameForParameterizedTest(String str) {
    }

    @TestFactory
    @DisplayName("TestFactory")
    void testWithDisplayNameForTestFactory() {
    }

    @TestTemplate
    @DisplayName("TestTemplate")
    void testWithDisplayNameForTestTemplate(String parameter) {
    }

    @RepeatedTest(3)
    @DisplayName("RepeatedTest_3")
    void testWithDisplayNameForRepeatedTest3() {
    }

    @Test
    @DisplayName("スペースを 含む カスタムの テスト名")
    void testWithDisplayNameContainingSpaces() {
    }

    @Test
    @DisplayName("╯°□°）╯")
    void testWithDisplayNameContainingSpecialCharacters() {
    }

    @Test
    @DisplayName("?")
    void testWithDisplayNameContainingEmoji() {
    }

    @Test
    @DisplayName("123.456")
    void testWithDisplayNameHasDot() {
    }

    final String testName = "testName as field.";

    @Test
    @DisplayName(testName)
    void testWithDisplayNameGivenField() {
    }

}

import org.junit.jupiter.api.*;

import org.junit.jupiter.params.ParameterizedTest;

import org.junit.jupiter.params.provider.CsvSource;

@DisplayName("特殊なテストケース")

class DisplayNameTest {

@ParameterizedTest

@CsvSource({"str"})

@DisplayName("ParameterizedTest")

void testWithDisplayNameForParameterizedTest(String str) {

}

@TestFactory

@DisplayName("TestFactory")

void testWithDisplayNameForTestFactory() {

}

@TestTemplate

@DisplayName("TestTemplate")

void testWithDisplayNameForTestTemplate(String parameter) {

}

@RepeatedTest(3)

@DisplayName("RepeatedTest_3")

void testWithDisplayNameForRepeatedTest3() {

}

@Test

@DisplayName("スペースを含むカスタムのテスト名")

void testWithDisplayNameContainingSpaces() {

}

@Test

@DisplayName("╯°□°）╯")

void testWithDisplayNameContainingSpecialCharacters() {

}

@Test

@DisplayName("?")

void testWithDisplayNameContainingEmoji() {

}

@Test

@DisplayName("123.456")

void testWithDisplayNameHasDot() {

}

final String testName = "testName as field.";

@Test

@DisplayName(testName)

void testWithDisplayNameGivenField() {

}

■実行結果

※@TestTemplateは実装が無いのでエラーになっています。

まとめ

@DisplayNameはクラスとテストメソッドに付与できる。
変数名で与えるときは変数をfinalにする。

参考

Junit5 ユーザーガイド 3.3.表示名

よかったらシェアしてね！

URLをコピーしました！

URLをコピーしました！

この記事を書いた人

近藤巧

リーマンショックの影響で26歳の時にIT業界から離れ、紆余曲折を経て34歳でエンジニアに復帰。
現在はフリーランスエンジニア兼コアファクトリ合同会社代表。
得意な言語はJava。

新人教育経験あり（わからなくて進まない子を放置しない方針）
Javaの新人教育にお困りでしたらお声がけください。

■保有資格
・Java Gold SE 11