java - 使用 Mockito 模拟比特流读取器

Question

我目前正在调试一个相当复杂的算法，用于修复比特流中的错误。一个BitReader界面非常简单，主要的读取方法是这样的:

/**
  Reads bits from the stream.
  @param length number of bits to read (<= 64)
  @return read bits in the least significant bits
*/
long read(int length) throws IOException;

目的是测试BitStreamFixer是否真正修复了流(以一种很难在这里描述的方式)。基本上我需要向它提供“损坏的”输入并测试它的输出是否尽可能正确(某些输入无法完全修复)，如下所示:

BitStreamFixer fixer = new BitStreamFixer(input);
int word1 = fixer.readWord();
int word2 = fixer.readWord();
// possibly a loop here
assertEquals(VALID_WORD1, word1);
assertEquals(VALID_WORD2, word2);
// maybe a loop here too

现在，BitStreamFixer 类接受 BitReader 的实例。当对修复程序进行单元测试时，我显然需要一个这样的实例。但我在哪里可以得到一个呢？我有两个明显的选择:要么给它一个 BitReader 的真正实现，要么模拟它。

前一个选项并不是很吸引人，因为它会创建对另一个与正在测试的类无关的对象的依赖。此外，这并不是那么容易，因为现有的 BitReader 实现读取输入流，所以我需要一个文件或以某种方式准备的字节数组，这是一件乏味的事情.

后一个选项看起来更好并且适合通常的单元测试方法。然而，由于我什至不应该知道修复程序将给read什么参数，所以模拟它并不容易。我必须采用 when(bitReader.read(anyInt())).thenAnswer(...) 方法，实现一个自定义答案，这将创建大量需要处理的逻辑- 向被测对象提供所需大小的适当位 block 。考虑到我正在使用的比特流具有相当复杂的高级结构，这并不容易。在单元测试中引入逻辑也不太好闻。

你觉得呢，还有其他选择吗？或者也许其中之一可以以我没有注意到的方式得到改进？

Answer 1

编写、测试和使用清晰的可重用测试助手。

一般来说，在单元测试中，您应该通过观​​察系统与您确实有信心的系统成功交互来建立对系统的信心。。当然，您还希望系统快速、确定性且易于阅读/修改，但最终这些都是次要的，而不是您的系统工作的断言。

您列出了两个选项:

• 使用模拟 BitReader ，您对预测系统的交互有足够的信心，可以设置整个“当 A 然后 B”对话。当您拥有独立方法的小型 API 表面(例如 RPC 层)时，模拟可能非常容易，但当您拥有具有不可预测方法调用的有状态对象时，模拟可能会非常困难。模拟对于确定性地 stub 非确定性系统进一步有用，例如外部服务器或伪随机源，或尚不存在的系统；这些都不适合您。

  因为你的read方法可以采用各种各样的参数，每个参数都是有效的并且会改变系统的状态，那么在这里使用模拟可能不是一个明智的主意。除非调用的顺序是 BitStreamFixer使得 BitReader具有足够的确定性，可以作为其契约(Contract)的一部分，模拟 BitReader可能会导致脆弱的测试:即使系统功能完美，当实现发生变化时，测试也会中断。您会想避免这种情况。

  请注意，模拟永远不应该产生“复杂的逻辑”，而只能产生复杂的设置。您使用模拟来避免在测试中使用真实逻辑。

• 使用真实的BitReader ，这听起来构建起来会很痛苦且不透明。不过，这可能是最现实的解决方案，特别是如果您已经完成了编写和测试。

  您担心“引入新的依赖项”，但如果您的 BitReader 实现存在并且快速、确定性且经过充分测试，那么使用它不会比使用测试中真正的 ArrayList 或 ByteArrayInputStream。听起来这里唯一真正的问题是创建字节数组会使维护测试变得困难，这是一个有效的考虑因素。

不过，在评论中，真正的答案来自:构建 BitWriter你失踪了。

@Test public void shouldFixBrokenStream() {
  BitReader bitReader = new StreamBitReader(BitWriter.create()
      .pushBits(16, 0x8080)
      .pushBits(12, 0x000)   // invalid 12-bit sequence
      .pushBits(16, 0x8080)
      .asByteArrayInputStream());
  BitStreamFixer fixer = new BitStreamFixer(bitReader);
  assertEquals(0x80808080, fixer.read(32));
}

/** Of course, you could skip the BitReader yourself, and just make a new one. */
@Test public void shouldFixBrokenStream_bitReader() {
  BitReader bitReader = new InMemoryBitReader();
  bitReader.pushBits(16, 0x8080);
  bitReader.pushBits(12, 0x000);   // invalid 12-bit sequence
  bitReader.pushBits(16, 0x8080);

  BitStreamFixer fixer = new BitStreamFixer(bitReader);
  assertEquals(0x80808080, fixer.read(32));
}

这比离线构建不透明的比特流并将其复制粘贴到测试中(特别是注释良好的情况下)更具可读性，比模拟更不易损坏，并且比匿名内部本身更易于测试类(或基于答案的版本)。您也可能可以在多个测试用例甚至多个测试中使用类似的系统。