Question

我想测试列表是否包含对象的实例。

例如，使用单个实例：

assertThat(mylist).containsExactly(Matchers.any(ExpectedType.class));

从经过测试的obj返回的数组确实只包含一个实例ExpectedType的对象。但是我的测试失败了：

java.lang.AssertionError：＆lt; [ExpectedType @ 7c781c42]＆gt;包含＆lt; [ExpectedType的实例]＆gt;。它缺少＆lt; [ExpectedType的一个实例]＆gt;并有意外的项目＆lt; [ExpectedType @ 7c781c42]＆gt;

我该怎么写这个测试？

Answer 1

您正在尝试编写测试，以查看List是否包含使用Hamcrest 和 Truth的特定类的一个实例。相反，您应该使用 Hamcrest 或真相来编写此测试。 Hamcrest和Truth都是使测试更具表现力的库，每个库都有自己特定的用法，风格和语法。如果你愿意，你可以在你的测试中一起使用它们，但是当你正在做的时候将它们的方法链接在一起是行不通的。（也许你感到困惑，因为两个库都可以有以assertThat开头的断言？）所以对于这个特定的测试，你需要选择其中一个并继续使用它。

但是，这两个库都缺少内置功能，即检查List是否有一个且只有一个项满足条件。因此，对于任一库，您有两个选择：要么可以对列表进行一些预处理，以便可以使用内置断言，要么可以扩展库的语言以使其具有此功能。

以下是演示两个库的两个选项的示例类：

import com.google.common.collect.FluentIterable;
import com.google.common.truth.*;
import org.hamcrest.*;
import org.junit.Test;

import java.util.*;

import static com.google.common.truth.Truth.assertAbout;
import static com.google.common.truth.Truth.assert_;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.*;

public class ExactlyOneInstanceTest {
    List<Object> myList = Arrays.asList("", 3, 'A', new Object());

    @Test
    public void hamcrestBuiltInTestExactlyOneInstance() {
        long theNumberOfStringsInMyList = myList.stream().filter(o -> o instanceof String).count();
        assertThat(theNumberOfStringsInMyList, equalTo(1L));
    }

    @Test
    public void hamcrestExtendedTestExactlyOneInstance() {
        assertThat(myList, HasExactlyOne.itemThat(is(instanceOf(String.class))));
    }

    @Test
    public void truthBuiltInTestExactlyOneInstance() {
        long theNumberOfStringsInMyList = myList.stream().filter(o -> o instanceof String).count();
        // can't static import Truth.assertThat because of name clash,
        // but we can use this alternative form
        assert_().that(theNumberOfStringsInMyList).isEqualTo(1);
    }

    @Test
    public void truthExtendedTestExactlyOneInstance() {
        assertAbout(iterable()).that(myList).containsExactlyOneInstanceOf(String.class);
    }


    // Hamcrest custom matcher
    static class HasExactlyOne<T> extends TypeSafeDiagnosingMatcher<Iterable<? super T>> {
        Matcher<? super T> elementMatcher;

        HasExactlyOne(Matcher<? super T> elementMatcher) {
            this.elementMatcher = elementMatcher;
        }

        @Factory
        public static <T> Matcher<Iterable<? super T>> itemThat(Matcher<? super T> itemMatcher) {
            return new HasExactlyOne<>(itemMatcher);
        }

        @Override
        public void describeTo(Description description) {
            description
                .appendText("a collection containing exactly one item that ")
                .appendDescriptionOf(elementMatcher);
        }

        @Override
        protected boolean matchesSafely(Iterable<? super T> item, Description mismatchDescription) {
            return FluentIterable.from(item).filter(o -> elementMatcher.matches(o)).size() == 1;
        }
    }

    // Truth custom extension
    static <T> SubjectFactory<ExtendedIterableSubject<T>, Iterable<T>> iterable() {
        return new SubjectFactory<ExtendedIterableSubject<T>, Iterable<T>>() {
            @Override
            public ExtendedIterableSubject<T> getSubject(FailureStrategy fs, Iterable<T> target) {
                return new ExtendedIterableSubject<>(fs, target);
            }
        };
    }

    static class ExtendedIterableSubject<T> extends IterableSubject<ExtendedIterableSubject<T>, T, Iterable<T>> {
        ExtendedIterableSubject(FailureStrategy failureStrategy, Iterable<T> list) {
            super(failureStrategy, list);
        }

        void containsExactlyOneInstanceOf(Class<?> clazz) {
            if (FluentIterable.from(getSubject()).filter(clazz).size() != 1) {
                fail("contains exactly one instance of", clazz.getName());
            }
        }
    }
}

尝试运行并查看该类，并使用对您来说最自然的方式。在编写未来的测试时，只需尝试坚持使用可用的内置断言，并尝试使@Test方法的意图及其断言立即可读。如果您发现多次编写相同的代码，或者测试方法不是那么容易阅读，那么请重构和/或扩展您正在使用的库的语言。重复，直到测试完所有，所有测试都很容易理解。享受！

Answer 2

更简单的解决方法是

for (Object elt : myList) {
    assertThat(elt).isInstanceOf(ExpectedType.class);
}

heenenee's answer更优雅：

assertThat(iterable()).that(myList).containsInstancesOf(ExpectedType.class);

Answer 3

首先，请注意IterableSubject.containsExactly()断言输入＆＃34; 包含所提供的对象或失败。＆＃34;这意味着 - 即使您可以在此处传递Matcher个对象 - 我们确认该列表只包含一个ExpectedType实例。现有的答案都没有正确地强制执行不变量（而是heenenee的方法断言ExpectedType 的一个实例和任意数量的其他实例，并且您的解决方案断言该列表包含 ExpectedType个实例的任意数量。在我阅读你的问题时，你确实打算断言确切的一个属性，但无论这表明接受的解决方案存在问题 - 它可能会意外地导致你没有打算做出的断言。

当我遇到像这样的Truth API的限制时，我总是尝试的第一件事就是将断言分成单独的步骤。这经常被证明易于编写，易于阅读，并且通常是防错的。可以理解的是，人们经常试图用真理寻找优雅的单行，但一般来说，在进行连续断言时没有错误。

在这里很难击败这个策略：

assertThat(ls).hasSize(1);
assertThat(Iterables.getOnlyElement(ls)).isInstanceOf(String.class);

如果可迭代的大小不是1，我们会得到一个错误告诉我们（以及可迭代的内容）。如果是，我们断言唯一的元素是String的实例。完成！

对于 n 实例的一般情况，代码确实变得有点混乱，但它仍然是合理的。我们只使用assertWithMessage()在isInstanceOf()断言中包含有关列表的其他上下文：

assertThat(ls).hasSize(n);
for (int i = 0; i < ls.size(); i++) {
  assertWithMessage("list: %s - index: %s", ls, i)
      .that(ls.get(i)).isInstanceOf(String.class);
}

这比实现自己的自定义Subject更具可读性和更清晰正确。

从Truth 0.29开始，您可以使用＆＃34; Fuzzy Truth＆＃34; AKA Correspondence。这允许您实质上描述集合的一些转换，然后断言该转换的结果。在这种情况下，我们将创建INSTANCEOF_CORRESPONDENCE：

private static final Correspondence<Object, Class<?>> INSTANCEOF_CORRESPONDENCE =
    new Correspondence<Object, Class<?>>() {
      @Override
      public boolean compare(@Nullable Object actual, @Nullable Class<?> expected) {
        return expected.isInstance(actual);
      }

      @Override
      public String toString() {
        return "is instanceof";
      }
    };

现在你可以写一个漂亮的单行！

assertThat(ls).comparingElementsUsing(INSTANCEOF_CORRESPONDENCE)
    .containsExactly(String.class);

这种方法相对于自定义主题的最大好处是它更具可扩展性 - 如果你决定做出不同的断言，Correspondence实现不需要改变，只需要你的断言：

assertThat(ls).comparingElementsUsing(INSTANCEOF_CORRESPONDENCE)
    .doesNotContain(Integer.class);

还有tentative plans支持方法引用和lambdas .comparingElementsUsing()，以便您能够编写如下内容：

assertThat(ls).comparingElementsUsing((o, c) -> c.isInstance(o), "is instanceof")
    .containsExactly(String.class);

如何断言List只包含特定类的一个实例？

3 个答案: