java - 如何使用 assertj 对键和值进行更深入的匹配

Question

假设我有这样的课程：

public class Character {
   public Character(String name){
      this.name = name;
   }
   private String name;
   public String getName() { return name; }
}

后来，一张地图

Map<Character, Integer> characterAges = new HashMap<Character, Integer>();
characterAges.put(new Character("Frodo"), 34);

使用 assertj，测试 characterAges 是否包含“Frodo”字符的最佳方法是什么？对于这个年龄，我可以这样做：

assertThat(characterAges).hasValue(34);

我知道我可以做到：

assertThat(characterAges.keySet())
               .extracting("name")
               .contains("Frodo");

但后来我失去了流利度。我真正想要的是这样的：

assertThat(characterAges)
               .hasKey(key.extracting("name").contains("Frodo")
               .hasValue(34);

甚至更好，这样我就可以确保我的键和值匹配：

assertThat(characterAges)
               .hasEntry(key.extracting("name").contains("Frodo"), 34);

这样的事情可能吗？

score 5 · Accepted Answer

对此没有简单的解决方案。一种方法是为字符映射实现自定义断言。这是此问题的简单自定义断言示例：

public class CharacterMapAssert extends AbstractMapAssert<MapAssert<Character, Integer>, Map<Character, Integer>, Character, Integer> {

    public CharacterMapAssert(Map<Character, Integer> actual) {
        super(actual, CharacterMapAssert.class);
    }

    public static CharacterMapAssert assertThat(Map<Character, Integer> actual) {
        return new CharacterMapAssert(actual);
    }

    public CharacterMapAssert hasNameWithAge(String name, int age) {
        isNotNull();

        for (Map.Entry<Character, Integer> entrySet : actual.entrySet()) {
            if (entrySet.getKey().getName().contains(name) && (int) entrySet.getValue() == age) {
                return this;
            }
        }

        String msg = String.format("entry with name %s and age %s does not exist", name, age);
        throw new AssertionError(msg);
    }

}

在测试用例中：

assertThat(characterAges).hasNameWithAge("Frodo", 34);

请注意，您可以为每个自定义数据结构编写自己的断言。对于您Character的课程，您可以使用AssertJ 断言生成器生成断言。

更新 Java 8

使用 Java 8 还可以使用 Lambda 表达式

    assertThat(characterAges).matches(
            (Map<Character, Integer> t)
            -> t.entrySet().stream().anyMatch((Map.Entry<Character, Integer> t1)
                    -> "Frodo".equals(t1.getKey().getName()) && 34 == t1.getValue()),
            "is Frodo and 34 years old"
    );

score 5 · Accepted Answer

你也可以这样做：

assertThat(characterAges).contains(entry("Frodo", 34), ...);

见https://github.com/joel-costigliola/assertj-core/wiki/New-and-noteworthy#new-map-assertions

score 3 · Accepted Answer

AbstractMapAssert的以下方法将为您工作：

containsExactlyEntriesOf验证实际地图是否仅包含给定地图的条目，而没有其他内容，按顺序排列。这应该与 TreeMap 一起使用。HashMap 不保证顺序，您的测试将随机失败。
containsExactlyInAnyOrderEntriesOf验证实际地图是否仅包含给定的条目，不包含其他任何顺序。这将适用于 HashMap。

import java.util.Map;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;

public class TestMapAssertions {

    @Test
    public void testCreateMap() {
        //Call
        Map<String, String> actual = ClassUnderTest.createMap();

        //Assert
        Assertions.assertThat(actual).containsExactlyInAnyOrderEntriesOf(
                Map.of("Key1", "Value1", "Key2", "Value2")
        );
    }

    public static class ClassUnderTest {

        public static Map<String, String> createMap() {
            return Map.of("Key1", "Value1", "Key2", "Value2");
        }
    }
}

score 2 · Accepted Answer

我不确定介绍的日期/版本，但现在有很多断言MapAssert。来自http://joel-costigliola.github.io/assertj/core-8/api/org/assertj/core/api/MapAssert.html：

contains(Map.Entry... entries) - 验证实际地图是否以任何顺序包含给定条目。

containsAnyOf(Map.Entry... entries) - 验证实际地图是否包含至少一个给定条目。

containsExactly(Map.Entry... entries) - 验证实际地图是否按顺序仅包含给定的条目而没有其他内容。

containsKeys(KEY... keys) - 验证实际地图是否包含给定的键。

containsOnly(Map.Entry... entries) - 验证实际地图是否仅包含给定的条目，不包含其他任何顺序。

containsOnlyKeys(KEY... keys) - 验证实际地图是否仅包含给定的键，不包含其他任何顺序。

containsValues(VALUE... values) - 验证实际地图是否包含给定值。

doesNotContain(Map.Entry... entries) - 验证实际地图不包含给定条目。

doesNotContainKeys(KEY... keys) - 验证实际地图不包含任何给定的键。

extracting(Function,Object>... extractors) - 使用给定的函数将被测对象的值提取到一个列表中，这个新列表成为被测对象。

对于你的例子，containsExactly()应该做的伎俩。

score 0 · Accepted Answer

从 3.6.0 开始，您可以使用hasEntrySatisfying：

 assertThat(characterAges)
            .hasSize(1)
            .hasEntrySatisfying(aKey, e ->
                    assertThat(e)
                            .isEqualTo(99.99)
            );

在您的情况下，如果您不能使用键进行查找，您可以使用基于条件的hasEntrySatisfying（更详细）。

score 0 · Accepted Answer

如果您不想走自定义断言路线，并且可以在测试中访问 SUT（被测系统）中的字符实例，则另一个选项可能是

在 SUT 中：

Character frodo = new Character("Frodo");
characterAges.put(frodo, 34);

并且在测试中

MapEntry frodoAge34 = MapEntry.entry(frodo, 34);
assertThat(characterAges).contains(frodoAge34);

score 0 · Accepted Answer

使用.entrySet()with怎么样.extracting()？

assertThat(characterAges.entrySet())
 .extracting(
       entry -> entry.getKey().getName(), 
       Map.Entry::getValue)
 .contains(tuple("Frodo", 34));

java - 如何使用 assertj 对键和值进行更深入的匹配

7 回答 7

Related

Reference