单元测试集合的最佳方法？

Question

我只是想知道人们如何进行单元测试并断言“预期”集合与“实际”集合相同/相似（顺序并不重要）。

为了执行此断言，我编写了简单的断言 API：-

public void assertCollection(Collection<?> expectedCollection, Collection<?> actualCollection) {
    assertNotNull(expectedCollection);
    assertNotNull(actualCollection);
    assertEquals(expectedCollection.size(), actualCollection.size());
    assertTrue(expectedCollection.containsAll(actualCollection));
    assertTrue(actualCollection.containsAll(expectedCollection));
}

嗯，它有效。如果我只断言一堆整数或字符串，那就非常简单了。例如，如果我试图断言 Hibernate 域的集合，这也可能会非常痛苦。 collection.containsAll(..) 依赖 equals(..) 来执行检查，但我总是覆盖 Hibernate 域中的 equals(..) 以仅检查业务键（这是Hibernate 网站）而不是该域的所有字段。当然，仅检查业务键是有意义的，但有时我真的想确保所有字段都正确，而不仅仅是业务键（例如，新的数据输入记录）。因此，在这种情况下，我不能乱用domain.equals(..)，而且似乎我需要实现一些比较器只是出于单元测试的目的，而不是依赖collection.containsAll(..)。

我可以在这里利用一些测试库吗？您如何测试您的收藏？

谢谢。

Answer 1

我不确定您使用的是哪个版本的 JUnit，但最近的 JUnit 有一个 assertThat 方法，该方法采用 Hamcrest Matcher 作为参数。它们是可组合的，因此您可以构建有关集合的复杂断言。

例如，如果您想断言集合 A 包含集合 B 中的每个元素，您可以编写：

import static org.junit.Assert.*;
import static org.junit.matchers.JUnitMatchers.*;
import static org.hamcrest.core.IsCollectionContaining.*;
import static org.hamcrest.collection.IsCollectionWithSize.*;
import org.hamcrest.beans.SamePropertyValuesAs;

public class CollectionTests {

    /*
    * Tests that a contains every element in b (using the equals()
    * method of each element) and that a has the same size as b.
    */
    @Test
    public void test() {
        Collection<Foo> a = doSomething();
        Collection<Foo> b = expectedAnswer;

        assertThat(a, both(hasItems(b)).and(hasSize(b.size())));
    }

    /*
    * Tests that a contains every element in b (using introspection
    * to compare bean properties) and that a has the same size as b.
    */
    @Test
    public void testBeans() {
        Collection<Foo> a = doSomething();
        Collection<Foo> b = expectedAnswer;
        Collection<Matcher<Foo>> bBeanMatchers =
          new LinkedList<Matcher<Foo>>();

        // create a matcher that checks for the property values of each Foo
        for(Foo foo: B)
            bBeanMatchers.add(new SamePropertyValuesAs(foo));

        assertThat(a, both(hasItems(bBeanMatchers)).and(hasSize(b.size())))
    }
}

第一个测试仅在每个对象上使用 equalTo() 匹配器（这将委托给您的 equals 实现）。如果这还不够强大，您可以使用第二种情况，它将使用 getter 和 setter 来比较每个元素。最后，您甚至可以编写自己的匹配器。 Hamcrest 包没有提供用于按字段匹配的匹配器（而不是匹配 bean 属性），但编写 FieldMatcher 很简单（而且确实是一个很好的练习）。

匹配器一开始有点奇怪，但是如果您按照他们的示例制作新的匹配器，它有一个返回匹配器的静态方法，您可以执行一堆 import static ，您的代码基本上读起来就像英文句子（“断言 a 既具有 b 中的项，又与 b 的大小相同”）。您可以使用这些东西构建令人印象深刻的 DSL，并使您的测试代码更加优雅。

Answer 2

如果 equals 方法没有检查所有字段，您可以使用 Unitils http://unitils.org/ <代码>ReflectionAssert类。调用

ReflectionAssert.assertReflectionEquals(expectedCollection,actualCollection)

将逐个字段反射地比较每个元素（这不仅适用于集合，它适用于任何对象）。

Answer 3

如果您还没有构建集合，则还有另一种选择：

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.allOf;
import static org.hamcrest.beans.HasPropertyWithValue.hasProperty;
import static org.hamcrest.Matchers.is;

@Test
@SuppressWarnings("unchecked")
public void test_returnsList(){

    arrange();
  
    List<MyBean> myList = act();
    
    assertThat(myList , contains(allOf(hasProperty("id",          is(7L)), 
                                       hasProperty("name",        is("testName1")),
                                       hasProperty("description", is("testDesc1"))),
                                 allOf(hasProperty("id",          is(11L)), 
                                       hasProperty("name",        is("testName2")),
                                       hasProperty("description", is("testDesc2")))));
}

使用 containsInAnyOrder 如果您不想检查对象的顺序。

PS 任何有助于避免被抑制的警告的帮助将不胜感激。

Answer 4

我无法让 jasonmp85 的答案 按原样工作。我包含了我使用的导入，因为一些 junit jars 包含旧的 hamcrest 东西以方便使用。这对我有用，但是断言循环绝对不如 hasItems(..) 就像杰森的答案中写的那样好。

import org.hamcrest.Matcher;
import org.hamcrest.beans.SamePropertyValuesAs;
import org.hamcrest.collection.IsCollectionWithSize;

import static org.hamcrest.CoreMatchers.hasItem;
import static org.hamcrest.MatcherAssert.assertThat;

...

/*
* Tests that a contains every element in b (using introspection
* to compare bean properties) and that a has the same size as b.
*/
@Test
public void testBeans() {
    Collection<Foo> a = doSomething();
    Collection<Foo> b = expectedAnswer;
    Collection<Matcher<Foo>> bBeanMatchers = new LinkedList<Matcher<Foo>>();

    // create a matcher that checks for the property values of each Foo
    for(Foo foo: B)
        bBeanMatchers.add(new SamePropertyValuesAs(foo));

    // check that each matcher matches something in the list
    for (Matcher<Foo> mf : bBeanMatchers)
        assertThat(a, hasItem(mf));

    // check that list sizes match
    assertThat(a, IsCollectionWithSize.hasSize(b.size()));
}

...