JUnit 4とJUnit 5のアサーション

JUnit 4およびJUnit 5のアサーション

1. 前書き

この記事では、JUnit内で利用可能なアサーションについて詳しく説明します。

migrating from JUnit 4 to JUnit 5とA Guide to JUnit 5の記事に続いて、JUnit4とJUnit5で利用可能なさまざまなアサーションについて詳しく説明します。

また、JUnit5でアサーションに加えられた機能強化についても説明します。

2. アサーション

Assertions are utility methods to support asserting conditions in tests;これらのメソッドには、JUnit 4のAssertクラス、およびJUnit 5のAssertionsクラスからアクセスできます。

テストとアサーション自体の可読性を高めるために、それぞれのクラスを静的にimportすることを常にお勧めします。このようにして、プレフィックスとして表現クラスを使用せずに、アサーションメソッド自体を直接参照できます。

JUnit4で利用可能なアサーションの調査を始めましょう。

3. JUnit4でのアサーション

このバージョンのライブラリでは、すべてのプリミティブ型、Objects,およびarrays（プリミティブまたはObjects).のいずれか）でアサーションを使用できます。

アサーション内のパラメーターの順序は、期待値の後に実際の値が続きます。オプションで、最初のパラメーターは、評価された条件のメッセージ出力を表すStringメッセージにすることができます。

assertThatアサーションの定義方法がわずかに異なるのは1つだけですが、後で説明します。

assertEqualsから始めましょう。

3.1. assertEquals

assertEqualsアサーションは、期待値と実際の値が等しいことを確認します。

@Test
public void whenAssertingEquality_thenEqual() {
    String expected = "example";
    String actual = "example";

    assertEquals(expected, actual);
}

アサーションが失敗したときに表示するメッセージを指定することもできます。

assertEquals("failure - strings are not equal", expected, actual);

3.2. assertArrayEquals

2つの配列が等しいと主張したい場合は、assertArrayEquals:を使用できます。

@Test
public void whenAssertingArraysEquality_thenEqual() {
    char[] expected = {'J','u','n','i','t'};
    char[] actual = "Junit".toCharArray();

    assertArrayEquals(expected, actual);
}

両方の配列がnullの場合、アサーションはそれらを等しいと見なします。

@Test
public void givenNullArrays_whenAssertingArraysEquality_thenEqual() {
    int[] expected = null;
    int[] actual = null;

    assertArrayEquals(expected, actual);
}

3.3. assertNotNullおよびassertNull

オブジェクトがnullであるかどうかをテストする場合は、assertNullアサーションを使用できます。

@Test
public void whenAssertingNull_thenTrue() {
    Object car = null;

    assertNull("The car should be null", car);
}

逆に、オブジェクトがnullであってはならないことを表明したい場合は、assertNotNull assertion.を使用できます。

3.4. assertNotSameおよびassertSame

assertNotSameを使用すると、2つの変数が同じオブジェクトを参照していないかどうかを確認できます。

@Test
public void whenAssertingNotSameObject_thenDifferent() {
    Object cat = new Object();
    Object dog = new Object();

    assertNotSame(cat, dog);
}

それ以外の場合、2つの変数が同じオブジェクトを参照していることを確認する場合は、assertSameアサーションを使用できます。

3.5. assertTrueおよびassertFalse

特定の条件がtrueまたはfalseであることを確認する場合は、それぞれassertTrueアサーションまたはassertFalseアサーションを使用できます。

@Test
public void whenAssertingConditions_thenVerified() {
    assertTrue("5 is greater then 4", 5 > 4);
    assertFalse("5 is not greater then 6", 5 > 6);
}

3.6. fail

failアサーションは、AssertionFailedErrorをスローするテストに失敗します。実際の例外がスローされることを検証するため、または開発中にテストを失敗させる場合に使用できます。

最初のシナリオでどのように使用できるか見てみましょう。

@Test
public void whenCheckingExceptionMessage_thenEqual() {
    try {
        methodThatShouldThrowException();
        fail("Exception not thrown");
    } catch (UnsupportedOperationException e) {
        assertEquals("Operation Not Supported", e.getMessage());
    }
}

3.7. assertThat

assertThatアサーションは、他のアサーションと比較してパラメーターの順序が逆になっているJUnit4の唯一のアサーションです。

この場合、アサーションには、オプションの失敗メッセージ、実際の値、およびMatcherオブジェクトがあります。

このアサーションを使用して、配列に特定の値が含まれているかどうかを確認する方法を見てみましょう。

@Test
public void testAssertThatHasItems() {
    assertThat(
      Arrays.asList("Java", "Kotlin", "Scala"),
      hasItems("Java", "Kotlin"));
}

MatcherオブジェクトでのassertThatアサーションの強力な使用に関する追加情報は、Testing with Hamcrestで入手できます。

4. JUnit5アサーション

JUnit 5は、JUnit 4のアサーションメソッドの多くを保持しながら、Java 8サポートを利用する新しいメソッドをいくつか追加しました。

また、このバージョンのライブラリでは、すべてのプリミティブ型、Objects,、および配列（プリミティブまたはオブジェクトのいずれか）に対してアサーションを使用できます。

アサーションのパラメーターの順序が変更され、出力メッセージパラメーターが最後のパラメーターとして移動されました。 Java 8のサポートのおかげで、出力メッセージはSupplierになり、遅延評価が可能になります。

JUnit4でも利用可能なアサーションの確認を始めましょう。

4.1. assertArrayEquals

assertArrayEqualsアサーションは、期待される配列と実際の配列が等しいことを確認します。

@Test
public void whenAssertingArraysEquality_thenEqual() {
    char[] expected = { 'J', 'u', 'p', 'i', 't', 'e', 'r' };
    char[] actual = "Jupiter".toCharArray();

    assertArrayEquals(expected, actual, "Arrays should be equal");
}

配列が等しくない場合、メッセージ「Arrays should be equal」が出力として表示されます。

4.2. assertEquals

2つのfloatsが等しいと主張したい場合は、単純なassertEqualsの主張を使用できます。

@Test
public void whenAssertingEquality_thenEqual() {
    float square = 2 * 2;
    float rectangle = 2 * 2;

    assertEquals(square, rectangle);
}

ただし、実際の値が事前定義されたデルタによって期待値と異なることを表明する場合でも、assertEqualsを使用できますが、デルタ値を3番目のパラメーターとして渡す必要があります。

@Test
public void whenAssertingEqualityWithDelta_thenEqual() {
    float square = 2 * 2;
    float rectangle = 3 * 2;
    float delta = 2;

    assertEquals(square, rectangle, delta);
}

4.3. assertTrueおよびassertFalse

assertTrueアサーションを使用すると、提供された条件がtrueであることを確認できます。

@Test
public void whenAssertingConditions_thenVerified() {
    assertTrue(5 > 4, "5 is greater the 4");
    assertTrue(null == null, "null is equal to null");
}

ラムダ式のサポートのおかげで、boolean条件の代わりにBooleanSupplierをアサーションに提供することが可能です。

assertFalseアサーションを使用してBooleanSupplierの正しさをアサーションする方法を見てみましょう。

@Test
public void givenBooleanSupplier_whenAssertingCondition_thenVerified() {
    BooleanSupplier condition = () -> 5 > 6;

    assertFalse(condition, "5 is not greater then 6");
}

4.4. assertNullおよびassertNotNull

オブジェクトがnullではないことを表明したい場合は、assertNotNullアサーションを使用できます。

@Test
public void whenAssertingNotNull_thenTrue() {
    Object dog = new Object();

    assertNotNull(dog, () -> "The dog should not be null");
}

逆に、assertNullアサーションを使用して、実際がnullであるかどうかを確認できます。

@Test
public void whenAssertingNull_thenTrue() {
    Object cat = null;

    assertNull(cat, () -> "The cat should be null");
}

どちらの場合も、失敗メッセージはSupplierであるため、遅延して取得されます。

4.5. assertSameおよびassertNotSame

期待値と実際値が同じObjectを参照していることを表明する場合は、assertSameアサーションを使用する必要があります。

@Test
public void whenAssertingSameObject_thenSuccessfull() {
    String language = "Java";
    Optional optional = Optional.of(language);

    assertSame(language, optional.get());
}

逆に、assertNotSameを使用できます。

4.6. fail

failアサーションは、提供された失敗メッセージと根本的な原因でテストに失敗します。これは、開発が完了していないときにテストにマークを付けるのに役立ちます。

@Test
public void whenFailingATest_thenFailed() {
    // Test not completed
    fail("FAIL - test not completed");
}

4.7. assertAll

JUnit 5で導入された新しいアサーションの1つは、assertAllです。

このアサーションにより、すべてのアサーションが実行され、それらの失敗が一緒に報告されるグループ化されたアサーションの作成が可能になります。詳細には、このアサーションは、MultipleFailureErrorのメッセージ文字列に含まれる見出しとExecutable.のStreamを受け入れます。

グループ化されたアサーションを定義しましょう。

@Test
public void givenMultipleAssertion_whenAssertingAll_thenOK() {
    assertAll(
      "heading",
      () -> assertEquals(4, 2 * 2, "4 is 2 times 2"),
      () -> assertEquals("java", "JAVA".toLowerCase()),
      () -> assertEquals(null, null, "null is equal to null")
    );
}

グループ化されたアサーションの実行は、実行可能ファイルの1つがブラックリストに登録された例外（たとえば、OutOfMemoryError）をスローした場合にのみ中断されます。

4.8. assertIterableEquals

assertIterableEqualsは、期待されるイテラブルと実際のイテラブルが非常に等しいことを示しています。

等しくなるためには、両方のイテラブルが同じ順序で等しい要素を返す必要があり、等しくなるために2つのイテラブルが同じタイプである必要はありません。

この考慮事項を考慮して、異なるタイプの2つのリスト（たとえば、LinkedListとArrayList）が等しいと主張する方法を見てみましょう。

@Test
public void givenTwoLists_whenAssertingIterables_thenEquals() {
    Iterable al = new ArrayList<>(asList("Java", "Junit", "Test"));
    Iterable ll = new LinkedList<>(asList("Java", "Junit", "Test"));

    assertIterableEquals(al, ll);
}

assertArrayEqualsと同じように、両方の反復可能オブジェクトがnullの場合、それらは等しいと見なされます。

4.9. assertLinesMatch

assertLinesMatchは、Stringの予想されるリストが実際のリストと一致することを表明します。

この方法は、assertEqualsおよびassertIterableEqualsとは異なります。これは、予想される行と実際の行のペアごとに、次のアルゴリズムを実行するためです。

予想される行が実際の行と等しいかどうかを確認してください。はいの場合、次のペアで続行します
期待される行を正規表現として扱い、String。matches()メソッドを使用してチェックを実行します。はいの場合、次のペアで続行します
予想される行が早送りマーカーかどうかを確認します。「はい」の場合、早送りを適用し、ステップ1からアルゴリズムを繰り返します

このアサーションを使用して、Stringの2つのリストに一致する行があることをアサーションする方法を見てみましょう。

@Test
public void whenAssertingEqualityListOfStrings_thenEqual() {
    List expected = asList("Java", "\\d+", "JUnit");
    List actual = asList("Java", "11", "JUnit");

    assertLinesMatch(expected, actual);
}

4.10. assertNotEquals

assertEqualsを補完するものとして、assertNotEqualsアサーションは、期待値と実際の値が等しくないことを表明します。

@Test
public void whenAssertingEquality_thenNotEqual() {
    Integer value = 5; // result of an algorithm

    assertNotEquals(0, value, "The result cannot be 0");
}

両方がnullの場合、アサーションは失敗します。

4.11. assertThrows

単純さと読みやすさを向上させるために、新しいassertThrowsアサーションにより、実行可能ファイルが指定された例外タイプをスローした場合に、明確で簡単なアサーションを行うことができます。

スローされた例外をアサートする方法を見てみましょう。

@Test
void whenAssertingException_thenThrown() {
    Throwable exception = assertThrows(
      IllegalArgumentException.class,
      () -> {
          throw new IllegalArgumentException("Exception message");
      }
    );
    assertEquals("Exception message", exception.getMessage());
}

例外がスローされない場合、または異なるタイプの例外がスローされた場合、アサーションは失敗します。

**4.12. assertTimeoutおよび *assertTimeoutPreemptively***

指定されたExecutableの実行が指定されたTimeoutの前に終了することを表明したい場合は、assertTimeoutアサーションを使用できます。

@Test
public void whenAssertingTimeout_thenNotExceeded() {
    assertTimeout(
      ofSeconds(2),
      () -> {
        // code that requires less then 2 minutes to execute
        Thread.sleep(1000);
      }
    );
}

ただし、assertTimeoutアサーションを使用すると、提供された実行可能ファイルは、呼び出し元のコードの同じスレッドで実行されます。したがって、タイムアウトを超えても、サプライヤの実行が先制的に中止されることはありません。

実行可能ファイルがタイムアウトを超えたときに実行が中止されることを確認したい場合は、assertTimeoutPreemptivelyアサーションを使用できます。

どちらのアサーションも、Executable,の代わりにThrowingSupplierを受け入れることができます。これは、オブジェクトを返し、Throwable.をスローする可能性のある一般的なコードブロックを表します。

5. 結論

このチュートリアルでは、JUnit 4とJUnit 5の両方で利用可能なすべてのアサーションを取り上げました。

新しいアサーションの導入とラムダのサポートにより、JUnit 5で行われた改善を簡単に強調しました。

いつものように、この記事の完全なソースコードはover on GitHubで入手できます。

TOC

JUnit 4とJUnit 5のアサーション

JUnit 4およびJUnit 5のアサーション

1. 前書き

2. アサーション

3. JUnit4でのアサーション

3.1. assertEquals

3.2. assertArrayEquals

3.3. assertNotNullおよびassertNull

3.4. assertNotSameおよびassertSame

3.5. assertTrueおよびassertFalse

3.6. fail

3.7. assertThat

4. JUnit5アサーション

4.1. assertArrayEquals

4.2. assertEquals

4.3. assertTrueおよびassertFalse

4.4. assertNullおよびassertNotNull

4.5. assertSameおよびassertNotSame

4.6. fail

4.7. assertAll

4.8. assertIterableEquals

4.9. assertLinesMatch

4.10. assertNotEquals

4.11. assertThrows

**4.12. assertTimeoutおよび *assertTimeoutPreemptively***

5. 結論

Related

TOC

JUnit 4とJUnit 5のアサーション

JUnit 4およびJUnit 5のアサーション

1. 前書き

2. アサーション

3. JUnit4でのアサーション

3.1. assertEquals

3.2. assertArrayEquals

3.3. assertNotNullおよびassertNull

3.4. assertNotSameおよびassertSame

3.5. assertTrueおよびassertFalse

3.6. fail

3.7. assertThat

4. JUnit5アサーション

4.1. assertArrayEquals

4.2. assertEquals

4.3. assertTrueおよびassertFalse

4.4. assertNullおよびassertNotNull

4.5. assertSameおよびassertNotSame

4.6. fail

4.7. assertAll

4.8. assertIterableEquals

4.9. assertLinesMatch

4.10. assertNotEquals

4.11. assertThrows

4.12. assertTimeoutおよび assertTimeoutPreemptively

5. 結論

Related

**4.12. assertTimeoutおよび *assertTimeoutPreemptively***