JUnit의 @Rule을 사용하는 예제는 무엇인가요?

질문: JUnit의 `@Rule`을 사용하는 예제는 무엇인가요?

답변:
JUnit에서 `@Rule`은 테스트 메서드를 실행하기 전후에 특정 동작을 자동으로 처리해주는 기능입니다. 주로 리소스 관리, 예외 검증, 임시 폴더 생성 등 반복적인 작업을 쉽게 처리할 때 사용됩니다.

아래는 `@Rule`을 사용한 대표적인 예제입니다:

```java
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.rules.ExpectedException;

import java.io.File;
import java.io.IOException;

import static org.junit.Assert.*;

public class RuleExampleTest {

// 임시 폴더 생성 및 테스트가 끝난 후 삭제
@Rule
public TemporaryFolder tempFolder = new TemporaryFolder();

// 예외 검증용 Rule
@Rule public ExpectedException expectedException = ExpectedException.none();

@Test
public void testTemporaryFolder() throws IOException {
// 임시 폴더 내에 새로운 파일 생성
File tempFile = tempFolder.newFile("testfile.txt");
assertTrue(tempFile.exists());
}

@Test
public void testExpectedException() {
expectedException.expect(IllegalArgumentException.class);
expectedException.expectMessage("Invalid argument");

// 예외 발생 코드
throw new IllegalArgumentException("Invalid argument");
}
}
```

설명:
- `TemporaryFolder` Rule은 테스트 중 임시 폴더 및 파일을 만들어주고 테스트가 끝나면 자동으로 삭제합니다. 테스트 내에서 파일 I/O를 할 때 매우 유용합니다.
- `ExpectedException` Rule은 특정 예외가 발생하는지, 메시지가 맞는지 등을 미리 정의하고 테스트 중에 해당 예외가 발생하는지 검증합니다.
- 각각 `@Rule`로 선언하며, JUnit이 테스트 실행 전에 자동으로 이 규칙들을 적용합니다.

이 외에도 다양한 Rule들이 있어 테스트 준비 및 후처리를 간단하게 작성할 수 있습니다. JUnit 4에서 주로 사용되며, JUnit 5에서는 `@ExtendWith`와 `Extension` API를 더 권장합니다.

JUnit의 @Rule은 테스트 실행 전후에 특정 동작을 수행하거나 테스트의 환경을 설정하는 데 사용되는 설정 도구입니다.

@Rule을 사용하면 테스트 메서드나 클래스에 반복적으로 적용되는 공통 작업을 캡슐화해서 코드 중복을 줄이고 테스트의 가독성을 높일 수 있습니다.

가장 흔한 예 중 하나는 TemporaryFolder 룰로, 테스트 중 임시 폴더와 파일을 자동으로 생성하고 테스트가 끝난 후 삭제해 줍니다.

이를 통해 테스트 파일 시스템 조작 후 정리(clean-up)를 신경쓰지 않아도 되며, 테스트 간에 깨끗한 환경을 보장할 수 있습니다.

아래는 TemporaryFolder 사용 예제입니다.

```java import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; import java.io.File; import java.io.IOException; import java.nio.file.Files; import static org.junit.Assert.assertTrue; public class ExampleTest { @Rule public TemporaryFolder tempFolder = new TemporaryFolder(); @Test public void testUsingTempFolder() throws IOException { // 임시 폴더 내에 새 파일 생성 File tempFile = tempFolder.newFile("tempFile.txt"); // 파일에 데이터 쓰기 String content = "Hello, JUnit Rule!"; Files.write(tempFile.toPath(), content.getBytes()); // 파일이 실제로 존재하는지 확인 assertTrue(tempFile.exists()); // 필요하면 파일 내용도 읽고 테스트할 수 있음 String readContent = new String(Files.readAllBytes(tempFile.toPath())); assertTrue(readContent.contains("Hello")); } } ``` 위 예제에서, - `@Rule` 어노테이션이 붙은 `TemporaryFolder` 인스턴스는 각 테스트 메서드마다 임시 폴더를 하나 생성합니다.

- 테스트 메서드 내에서 `tempFolder.newFile("tempFile.txt")`를 호출해 임시 파일을 생성하고 사용합니다.

- 테스트가 공통된 환경에서 실행되도록 해 주며, 테스트 실패, 성공 관계없이 임시 파일 및 폴더를 자동으로 삭제해 줍니다.

이처럼 @Rule은 단순히 임시폴더뿐 아니라, 예외 기대, 타임아웃, 로그 캡처 같은 다양한 부가기능을 쉽게 적용할 수 있는 JUnit의 강력한 기능입니다.

또 다른 예로는 ExpectedException 룰을 들 수 있는데, 이는 테스트 중 특정 예외가 발생하는지 검증할 때 편리합니다.

```java import org.junit.Rule; import org.junit.Test; import org.junit.rules.ExpectedException; public class ExceptionTest { @Rule public ExpectedException thrown = ExpectedException.none(); @Test public void testException() { thrown.expect(IllegalArgumentException.class); thrown.expectMessage("Invalid argument"); // 이 라인에서 IllegalArgumentException이 발생해야 테스트 통과 throw new IllegalArgumentException("Invalid argument passed"); } } ``` @Rule은 테스트 실행 중 필요한 반복적이고 공통적인 설정이나 수행작업을 캡슐화하여 간결하고 읽기 쉬운 테스트 코드를 작성하게 도와주는 JUnit의 구조적 도구입니다.