# 테스트 이름 표기

## @DisplayName

테스트 클레스, 메서드에 이름을 붙여주는 경우에 사용하며, 메서드 이름은 그대로 둔 채 테스트명을 변경하고 싶을 때 사용한다.

```java
    @Test
    @DisplayName("통합 배치 수행 테스트")
    public void test() throws Exception {
```

![image-20211221222903050](/files/PooVdhDDdNt896eY2s5T)

## @DisplayNameGeneration

클래스에 어노테이션을 붙이면, `@Test` 메서드 이름에 정의된 DisplayNameGenerator로 이름을 변형시켜준다.

| DisplayNameGenerator 클래스명 | 설명                                                                                                             |
| ------------------------- | -------------------------------------------------------------------------------------------------------------- |
| **Standard**              | 기존 클래스, 메서드명 사용(default)                                                                                       |
| Simple                    | 괄호`(`, `)` 제외                                                                                                  |
| ReplaceUnderscores        | `_`(언더바)로 표시한 모든 부분이 공백으로 처리                                                                                   |
| IndicativeSentences       | <p>클래스명 + 구분자(<code>,</code>) + 메서드명으로 변경<br>이때 구분자는 <code>@IndicativeSentencesGeneration</code> 으로 커스텀 가능</p> |

```java
@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
public class MybatisBatchItemWriterTest {

    @Test
    public void sqlSessionFactory_테스트() {}
    
    @Test
    public void sqlSessionTemplate_테스트() {}
}
```

![image-20211221223821268](/files/4aiBmulcUokBSzmHRvJB)

### @IndicativeSentencesGeneration

구분자를 커스텀하게 사용할 수 있게 해준다.

| 파라미터명     | 타입명                                     | 설명                               |
| --------- | --------------------------------------- | -------------------------------- |
| seperator | String                                  | 구분자( default : `,`)              |
| generator | `Class<? extends DisplayNameGenerator>` | 정의된 DisplayNameGenerator 중 하나 사용 |

```java
@IndicativeSentencesGeneration(separator = "> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
class MybatisBatchItemWriterTest {
    @Test
    public void sqlSessionFactory_테스트() {}
    
    @Test
    public void sqlSessionTemplate_테스트() {}
}
```

![image-20211221224410466](/files/jU9Siv2WVZJgegHVqTIW)

## 어노테이션 우선 순위

1. @DisplayName
2. @DisplayNameGeneration
3. properties에 명시한 Default 값

   ```groovy
   junit.jupiter.displayname.generator.default = org.junit.jupiter.api.DisplayNameGenerator$ReplaceUnderscores
   ```
4. DisplayNameGenerator.Standard.class

## 참고

* [민동현 - JUnit5 완벽가이드](https://donghyeon.dev/junit/2021/04/11/JUnit5-%EC%99%84%EB%B2%BD-%EA%B0%80%EC%9D%B4%EB%93%9C/)
* [노력남자 - JUnit 5 (2) - Test Results 테스트명 바꾸기](https://effortguy.tistory.com/114?category=841326)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dahye-jeong.gitbook.io/vue-js/master-2/spring/2020-04-12-test/junit5/2021-12-21-display-name.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.