Java & Spring Weekly

AssertJ Shorts №4 - Recursive Comparison и Factories

Как верно заметили в комментариях, я не рассказал еще про некоторые важные фишки AssertJ, такие как usingRecursiveComparison и InstanceOfAssertFactory. Спасибо, что заметили, исправляюсь!

Иногда обычный assertThat(actual).isEqualTo(expected) не работает — например, если сравниваемые объекты содержат вложенные поля, коллекции или даже циклические ссылки. В таких случаях на помощь приходит usingRecursiveComparison().

Он позволяет сравнивать объекты рекурсивно, т.е. по всем вложенным полям, даже если это разные экземпляры одного класса.


record Address(String city, String zip) {}
record User(String name, Address address) {}

@Test
void recursive_comparison_simple() {
    User actual = new User("Alice", new Address("London", "12345"));
    User expected = new User("Alice", new Address("London", "12345"));

    assertThat(actual)
        .usingRecursiveComparison()
        .isEqualTo(expected);
}

Без usingRecursiveComparsion тест бы упал, так как объекты Address разные.

Кроме рекурсивного сравнения, usingRecursiveComparison позволяет исключать некоторые поля из сравнения. Особенно полезно, например, для полей типа createdAt и updatedAt, значения которых точно не совпадают у разных объектов:


record User(String name, int age) {}

@Test
void ignore_field() {
    User actual = new User("Alice", 30);
    User expected = new User("Alice", 99); // возраст не важен

    assertThat(actual)
        .usingRecursiveComparison()
        .ignoringFields("age")
        .isEqualTo(expected);
}

Еще более интересная возможность - сравнивать списки объектов через usingRecursiveFieldByFieldElementComparator:


List<User> actual = List.of(new User("Alice", new Address("London", "12345")));
List<User> expected = List.of(new User("Alice", new Address("London", "12345")));

assertThat(actual)
    .usingRecursiveFieldByFieldElementComparator()
    .containsExactlyElementsOf(expected);

Некоторые поля нужно сравнивать по особым правилам, например, BigDecimal с учетом или без учета точности. Здесь помогут withComparatorForFields и withEqualsForType:


record Price(BigDecimal amount) {}

@Test
void with_comparator_for_field() {
    Price actual = new Price(new BigDecimal("10.005"));
    Price expected = new Price(new BigDecimal("10.004"));

    Comparator<BigDecimal> roundedComparator =
        Comparator.comparing(bd -> bd.setScale(2, RoundingMode.HALF_UP));

    assertThat(actual)
        .usingRecursiveComparison()
        .withComparatorForFields(roundedComparator, "amount")
        .isEqualTo(expected);
}

Здесь amount сравнивается уже после округления до двух знаков после запятой.

Если одни и те же настройки сравнения используются несколько раз, их можно вытащить в отдельную конфигурацию и использовать несколько раз:


RecursiveComparisonConfiguration config = RecursiveComparisonConfiguration.builder()
    .withIgnoredFields("id", "timestamp")
    .withIgnoreAllActualNullFields(true)
    .build();

assertThat(actual)
    .usingRecursiveComparison(config)
    .isEqualTo(expected);

И кратко про InstanceOfAssertFactory - совсем забыл, насколько крутая это фича. В обычных ассёртах мы можем легко проверять свойства объектов, но при использовании методов вроде extracting() или filteredOn() тип выводится как Object, и AssertJ не знает, какие методы доступны у результата.

Чтобы сохранить тип и использовать нужные ассёрты, можно использовать InstanceOfAssertFactory. Без InstanceOfAssertFactory:


List<Person> people = List.of(new Employee("Alice", "HR"), new Manager("Bob", 5));

assertThat(people)
    .filteredOn(p -> p instanceof Manager)
    .first() // тип Object
    .extracting("teamSize") // работает, но не типобезопасно
    .isEqualTo(5);

А теперь с InstanceOfAssertFactory:

❤2

274 views08:02