# JUnit 5で例外をテストする方法（assertThrows）

## 目次

1. JUnit 5の概要  

   1-1. JUnitの進化  

   1-2. JUnit 5の新機能  

2. assertThrowsの基本的な使用法  

   2-1. assertThrowsメソッドの概要  

   2-2. 基本的な使用例  

3. 例外メッセージや原因の検証  

   3-1. 例外メッセージの検証  

   3-2. 原因の検証  

4. カスタム例外のテスト  

   4-1. カスタム例外の作成  

   4-2. カスタム例外のテスト  

5. 例外が発生しないことを確認する方法  

   5-1. assertDoesNotThrow使用例  

6. assertThrowsにおける注意点  

   6-1. パフォーマンスへの影響  

   6-2. 例外が発生しないケースの対処  

7. まとめ

## 1. JUnit 5の概要

### 1-1. JUnitの進化

JUnitはJavaの単体テストフレームワークとして広く利用されており、1997年のリリース以来、多くのバージョンが存在します。JUnit 4は特に長期間使用されていましたが、最近ではJUnit 5が主流になりつつあります。JUnit 5では、モジュラーシステムへの対応や、拡張性の向上が図られています。

### 1-2. JUnit 5の新機能

JUnit 5では、プラットフォーム、Jupiter、Vintageの3つのサブプロジェクトから構成される新しいアーキテクチャが採用されました。これにより、既存のJUnit 4テストと共存しつつ、新しいテスト記述が可能になります。特に、`@Test`アノテーションにおける`expected`属性が廃止され、代わりに`assertThrows`メソッドを使用することが推奨されています。

## 2. assertThrowsの基本的な使用法

### 2-1. assertThrowsメソッドの概要

`assertThrows`はJUnit 5で導入されたメソッドで、テストケースが期待通りの例外をスローすることを確認します。このメソッドは例外の検証をより柔軟かつ詳細に行うことができるようになっています。

次に、`assertThrows`メソッドの基本的なシグネチャを示します。

![img](/mosaic-code.jpg)

ここで、`expectedType`はスローされることが期待される例外の型で、`executable`は例外がスローされることを期待する実行可能なコードです。

### 2-2. 基本的な使用例

以下は、`assertThrows`を使用した基本的な例です。この例では、`divide`メソッドが`ArithmeticException`をスローすることを確認します。

![img](/mosaic-code.jpg)

ここで、`Calculator`クラスの`divide`メソッドは0で割ろうとすることで`ArithmeticException`をスローします。この例では、無名クラスの代わりにラムダ式を使用してコードを明確に記述しています。

## 3. 例外メッセージや原因の検証

### 3-1. 例外メッセージの検証

例外がスローされた場合、そのメッセージを確認することが重要です。`assertThrows`メソッドはスローされた例外を返すため、その後にメッセージを検証することができます。

![img](/mosaic-code.jpg)

このテストケースでは、`ArithmeticException`のメッセージが`"/ by zero"`であることを確認しています。

### 3-2. 原因の検証

例外が他の例外を原因として発生する場合、原因を検証することもできます。`getCause()`メソッドを使用して原因を取得し、期待される例外の型やメッセージをさらに確認することができます。

![img](/mosaic-code.jpg)

上記のように`assertTrue`を使用することで、原因となる例外が特定の型であることを確認できます。

## 4. カスタム例外のテスト

### 4-1. カスタム例外の作成

カスタム例外は、特定のビジネスロジックやエラーハンドリングを表現するために有効です。Javaでは例外クラスを拡張してカスタム例外を作成できます。

![img](/mosaic-code.jpg)

### 4-2. カスタム例外のテスト

カスタム例外も`assertThrows`を用いてテストすることができます。

![img](/mosaic-code.jpg)

このテストは、`CustomException`が特定のメッセージを伴ってスローされることを検証します。

## 5. 例外が発生しないことを確認する方法

### 5-1. assertDoesNotThrow使用例

`assertDoesNotThrow`メソッドは、指定したコードブロックが例外をスローしないことを保証します。テスト対象のメソッドが例外をスローしないことを確認したい場合に有効です。

![img](/mosaic-code.jpg)

この例では、`divide`メソッドが例外をスローしないことをチェックしています。

## 6. assertThrowsにおける注意点

### 6-1. パフォーマンスへの影響

`assertThrows`は、テスト中に例外が発生しない場合、テストを失敗としてマークします。したがって、例外を起こすコードのパスが正確でなければ、パフォーマンスに影響を与える可能性があります。

### 6-2. 例外が発生しないケースの対処

テストコードには、期待される例外が発生しないケースを明示的に処理することも重要です。単に例外が発生しないことを確認するだけでなく、例外の発生有無を判定するために適切なコントロールフローを用意する必要があります。

## 7. まとめ

JUnit 5の`assertThrows`メソッドを利用することで、例外発生のテストを柔軟かつ明確に記述することが可能です。例外がスローされた際の詳細な検証に留まらず、スローされないことを保証するテストもまた重要です。この記事を通じて、例外テストをより精密に実施し、システムの安定性を向上させる手助けになれば幸いです。

# JUnit 5で例外をテストする方法（assertThrows）

## 目次

1. JUnit 5の概要  

   1-1. JUnitの進化  

   1-2. JUnit 5の新機能  

2. assertThrowsの基本的な使用法  

   2-1. assertThrowsメソッドの概要  

   2-2. 基本的な使用例  

3. 例外メッセージや原因の検証  

   3-1. 例外メッセージの検証  

   3-2. 原因の検証  

4. カスタム例外のテスト  

   4-1. カスタム例外の作成  

   4-2. カスタム例外のテスト  

5. 例外が発生しないことを確認する方法  

   5-1. assertDoesNotThrow使用例  

6. assertThrowsにおける注意点  

   6-1. パフォーマンスへの影響  

   6-2. 例外が発生しないケースの対処  

7. まとめ

## 1. JUnit 5の概要

### 1-1. JUnitの進化

JUnitはJavaの単体テストフレームワークとして広く利用されており、1997年のリリース以来、多くのバージョンが存在します。JUnit 4は特に長期間使用されていましたが、最近ではJUnit 5が主流になりつつあります。JUnit 5では、モジュラーシステムへの対応や、拡張性の向上が図られています。

### 1-2. JUnit 5の新機能

JUnit 5では、プラットフォーム、Jupiter、Vintageの3つのサブプロジェクトから構成される新しいアーキテクチャが採用されました。これにより、既存のJUnit 4テストと共存しつつ、新しいテスト記述が可能になります。特に、`@Test`アノテーションにおける`expected`属性が廃止され、代わりに`assertThrows`メソッドを使用することが推奨されています。

## 2. assertThrowsの基本的な使用法

### 2-1. assertThrowsメソッドの概要

`assertThrows`はJUnit 5で導入されたメソッドで、テストケースが期待通りの例外をスローすることを確認します。このメソッドは例外の検証をより柔軟かつ詳細に行うことができるようになっています。

次に、`assertThrows`メソッドの基本的なシグネチャを示します。

```java

<T extends Throwable> T assertThrows(Class<T> expectedType, Executable executable)

```

ここで、`expectedType`はスローされることが期待される例外の型で、`executable`は例外がスローされることを期待する実行可能なコードです。

### 2-2. 基本的な使用例

以下は、`assertThrows`を使用した基本的な例です。この例では、`divide`メソッドが`ArithmeticException`をスローすることを確認します。

```java

import static org.junit.jupiter.api.Assertions.assertThrows;

import org.junit.jupiter.api.Test;

public class CalculatorTest {

    @Test

    void testDivideByZero() {

        Calculator calculator = new Calculator();

        assertThrows(ArithmeticException.class, () -> calculator.divide(1, 0));

    }

}

```

ここで、`Calculator`クラスの`divide`メソッドは0で割ろうとすることで`ArithmeticException`をスローします。この例では、無名クラスの代わりにラムダ式を使用してコードを明確に記述しています。

## 3. 例外メッセージや原因の検証

### 3-1. 例外メッセージの検証

例外がスローされた場合、そのメッセージを確認することが重要です。`assertThrows`メソッドはスローされた例外を返すため、その後にメッセージを検証することができます。

```java

@Test

void testDivideByZeroMessage() {

    Calculator calculator = new Calculator();

    ArithmeticException exception = assertThrows(

        ArithmeticException.class,

        () -> calculator.divide(1, 0)

    );

    assertEquals("/ by zero", exception.getMessage());

}

```

このテストケースでは、`ArithmeticException`のメッセージが`"/ by zero"`であることを確認しています。

### 3-2. 原因の検証

例外が他の例外を原因として発生する場合、原因を検証することもできます。`getCause()`メソッドを使用して原因を取得し、期待される例外の型やメッセージをさらに確認することができます。

```java

import static org.junit.jupiter.api.Assertions.assertTrue;

// Snippet of a test method

void testCustomExceptionCause() {

    MyService myService = new MyService();

    CustomException exception = assertThrows(

        CustomException.class,

        () -> myService.performOperation()

    );

    assertTrue(exception.getCause() instanceof SpecificException);

}

```

上記のように`assertTrue`を使用することで、原因となる例外が特定の型であることを確認できます。

## 4. カスタム例外のテスト

### 4-1. カスタム例外の作成

カスタム例外は、特定のビジネスロジックやエラーハンドリングを表現するために有効です。Javaでは例外クラスを拡張してカスタム例外を作成できます。

```java

public class CustomException extends Exception {

    public CustomException(String message) {

        super(message);

    }

}

```

### 4-2. カスタム例外のテスト

カスタム例外も`assertThrows`を用いてテストすることができます。

```java

@Test

void testCustomExceptionThrown() {

    CustomService customService = new CustomService();

    CustomException exception = assertThrows(

        CustomException.class,

        () -> customService.triggerException()

    );

    assertEquals("Custom error message", exception.getMessage());

}

```

このテストは、`CustomException`が特定のメッセージを伴ってスローされることを検証します。

## 5. 例外が発生しないことを確認する方法

### 5-1. assertDoesNotThrow使用例

`assertDoesNotThrow`メソッドは、指定したコードブロックが例外をスローしないことを保証します。テスト対象のメソッドが例外をスローしないことを確認したい場合に有効です。

```java

@Test

void testNoExceptionThrown() {

    Calculator calculator = new Calculator();

    assertDoesNotThrow(() -> calculator.divide(1, 2));

}

```

この例では、`divide`メソッドが例外をスローしないことをチェックしています。

## 6. assertThrowsにおける注意点

### 6-1. パフォーマンスへの影響

`assertThrows`は、テスト中に例外が発生しない場合、テストを失敗としてマークします。したがって、例外を起こすコードのパスが正確でなければ、パフォーマンスに影響を与える可能性があります。

### 6-2. 例外が発生しないケースの対処

テストコードには、期待される例外が発生しないケースを明示的に処理することも重要です。単に例外が発生しないことを確認するだけでなく、例外の発生有無を判定するために適切なコントロールフローを用意する必要があります。

## 7. まとめ

JUnit 5の`assertThrows`メソッドを利用することで、例外発生のテストを柔軟かつ明確に記述することが可能です。例外がスローされた際の詳細な検証に留まらず、スローされないことを保証するテストもまた重要です。この記事を通じて、例外テストをより精密に実施し、システムの安定性を向上させる手助けになれば幸いです。

JUnit 5で例外をテストする方法（assertThrows）

目次

続きを読むには単価診断を受けてください（30秒）