More than 5 years have passed since last update.

AssertJ版：テストでよく使う検証メソッド一覧

Posted at 2015-11-22

はじめに

AssertJ ～Fluent assertions for java～

JUnit でよく使う Matcher はこちらによくまとまっています。
HamcrestのMatchersに定義されているメソッドの使い方メモ

今回はこれの AssertJ 版的な位置づけで用意してみようと思います。
ただし、全ての検証メソッドを網羅しているわけではありませんので、その点についてはご容赦下さい。

バージョン

Java

1.8

AssertJ

3.2.0

基本的な比較

isEqualTo/isNotEqualTo: 同値検証

AssertJBasicLearning.java

@Test
public void 同値検証() {
    assertThat("Foo").isEqualTo("Foo");
    assertThat("Foo").isNotEqualTo("Bar");
}

isNull/isNotNull: Null 検証

AssertJBasicLearning.java

@Test
public void null検証() {
    Object actual = null;
    assertThat(actual).isNull();

    actual = "Foo";
    assertThat(actual).isNotNull();
}

isEqualByComparingTo/isNotEqualByComparingTo: compareToによる検証

AssertJBasicLearning.java

@Test
public void compareToによる検証() {
    Foo foo1 = new Foo();
    Foo foo2 = new Foo();

    assertThat(foo1).isEqualByComparingTo(foo2);
}

private static final class Foo implements Comparable<Foo> {
    @Override
    public int compareTo(Foo other) {
        return 0;
    }
}

isSameAs/isNotSameAs: 同一インスタンス検証

AssertJBasicLearning.java

@Test
public void インスタンス検証() {
    Bar bar1 = new Bar();
    Bar bar2 = bar1;

    assertThat(bar1).isSameAs(bar2);
}

private static class Bar { }

isInstanceOf/isNotInstanceOf: インスタンス型検証

AssertJBasicLearning.java

@Test
public void 型検証() {
    Baz baz = new Baz();
    Qux qux = new Qux();

    assertThat(baz).isInstanceOf(Baz.class);
    assertThat(qux).isInstanceOf(Baz.class).isInstanceOf(Qux.class);
}

private static class Baz { }
private static final class Qux extends Baz { }

hasToString: toString 検証

AssertJBasicLearning.java

@Test
public void toStringによる検証() {
    FooBar fooBar = new FooBar();

    assertThat(fooBar).hasToString("FooBar");
}

private static final class FooBar {
    @Override
    public String toString() {
        return "FooBar";
    }
}

as: 検証内容の注釈

AssertJBasicLearning.java

@Test
public void 失敗時に表示される検証内容を設定() {
    assertThat("Foo").as("AssertJ sample").isEqualTo("Bar");

    // org.junit.ComparisonFailure: [AssertJ sample] expected:<"[Bar]"> but was:<"[Foo]">
}

文字列比較

startsWith: 接頭辞検証

AssertJStringLearning.java

@Test
public void 接頭辞検証() {
    assertThat("FooBar").startsWith("Foo");
}

endsWith: 接尾辞検証

AssertJStringLearning.java

@Test
public void 接尾辞検証() {
    assertThat("FooBar").endsWith("Bar");
}

isEqualToIgnoringCase: 大文字小文字を無視した検証

AssertJStringLearning.java

@Test
public void 大文字小文字検証検証() {
    assertThat("Foo").isNotEqualTo("FOO").isEqualToIgnoringCase("FOO");
}

isEqualToIgnoringWhitespace: 空白を無視した検証

タブ (\t) も 1 つのスペースとしてカウントされる
先頭と末尾のスペースは無視される
複数のスペースは 1 つにまとめられる
大文字小文字は無視しない

AssertJStringLearning.java

@Test
public void スペース無視検証() {
    assertThat("Foo BAR baz").isEqualToIgnoringWhitespace(" Foo   BAR\tbaz ");
    assertThat(" Foo   BAR\tbaz ").isEqualToIgnoringWhitespace("Foo BAR baz");
}

isEmpty: 空文字検証

AssertJStringLearning.java

@Test
public void 空文字検証() {
    assertThat("").isEmpty();
}

isNullOrEmpty: 空文字 Null 検証

AssertJStringLearning.java

@Test
public void 空文字null検証() {
    String actual = "";
    assertThat(actual).isNullOrEmpty();

    actual = null;
    assertThat(actual).isNullOrEmpty();
}

matches: 正規表現を使った検証

AssertJStringLearning.java

@Test
public void 正規表現検証() {
    String actual = "FooBarBaz";
    assertThat(actual).matches("F..B..B..").matches("F.*z");
}

containsOnlyDigits: 数字検証

AssertJStringLearning.java

@Test
public void 数字検証() {
    String actual = "1234567890";
    assertThat(actual).containsOnlyDigits();
}

hasLineCount: 行数検証

AssertJStringLearning.java

@Test
public void 行数検証() {
    String actual = "foo";
    assertThat(actual).hasLineCount(1);

    actual = "foo\nbar\nbaz";
    assertThat(actual).hasLineCount(3);

    actual = "foo\r\nbar\r\nbaz";
    assertThat(actual).hasLineCount(3);
}

数値比較

isBetween: 範囲検証

指定した値を含む

AssertJNumberLearning.java

@Test
public void 範囲検証() {
    assertThat(7).isBetween(0, 9).isBetween(7, 7);
    assertThat(7).isCloseTo(5, within(2)); // 5 ± 2 -> OK
    assertThat(7).isCloseTo(5, within(1)); // 5 ± 1 -> NG
}

isGreaterThan/isGreaterThanOrEqualTo: 大なり検証

AssertJNumberLearning.java

@Test
public void 大なり検証() {
    assertThat(7).isGreaterThan(6).isGreaterThanOrEqualTo(7);
}

isLessThan/isLessThanOrEqualTo: 小なり検証

AssertJNumberLearning.java

@Test
public void なり検証() {
    assertThat(7).isLessThan(8).isLessThanOrEqualTo(7);
}

Collection 比較