如何使用 Mockito 模拟 Java 路径 API？

Question

Java Path API 是 Java File API 的更好替代品，但是静态方法的大量使用使得 Mockito 难以模拟。在我自己的 class 中，我注入了一个 FileSystem 实例，我在单元测试期间将其替换为模拟。

但是，我需要模拟很多方法（并且还创建了很多模拟）来实现这一点。在我的测试 classes 中，这种情况反复发生了很多次。所以我开始考虑设置一个简单的 API 来注册 Path-s 并声明相关行为。

例如，我需要检查流打开时的错误处理。主要class:

class MyClass {
    private FileSystem fileSystem;

    public MyClass(FileSystem fileSystem) {
        this.fileSystem = fileSystem;
    }

    public void operation() {
        String filename = /* such way to retrieve filename, ie database access */
        try (InputStream in = Files.newInputStream(fileSystem.getPath(filename))) {
            /* file content handling */
        } catch (IOException e) {
            /* business error management */
        }
    }
}

测试class:

 class MyClassTest {

     @Test
     public void operation_encounterIOException() {
         //Arrange
         MyClass instance = new MyClass(fileSystem);

         FileSystem fileSystem = mock(FileSystem.class);
         FileSystemProvider fileSystemProvider = mock(FileSystemProvider.class);
         Path path = mock(Path.class);
         doReturn(path).when(fileSystem).getPath("/dir/file.txt");
         doReturn(fileSystemProvider).when(path).provider();
         doThrow(new IOException("fileOperation_checkError")).when(fileSystemProvider).newInputStream(path, (OpenOption)anyVararg());

         //Act
         instance.operation();

         //Assert
         /* ... */
     }

     @Test
     public void operation_normalBehaviour() {
         //Arrange
         MyClass instance = new MyClass(fileSystem);

         FileSystem fileSystem = mock(FileSystem.class);
         FileSystemProvider fileSystemProvider = mock(FileSystemProvider.class);
         Path path = mock(Path.class);
         doReturn(path).when(fileSystem).getPath("/dir/file.txt");
         doReturn(fileSystemProvider).when(path).provider();
         ByteArrayInputStream in = new ByteArrayInputStream(/* arranged content */);
         doReturn(in).when(fileSystemProvider).newInputStream(path, (OpenOption)anyVararg());

         //Act
         instance.operation();

         //Assert
         /* ... */
     }
 }

我有很多这样的 classes/tests，模拟设置可能更棘手，因为静态方法可能会通过路径 API 调用 3-6 个非静态方法。我重构了测试以避免大多数冗余代码，但随着我的 Path API 使用量的增加，我的简单 API 往往非常有限。所以又到了重构的时候了。

但是，我正在考虑的逻辑似乎很难看，需要大量代码才能实现基本用法。我想减轻 API 模拟的方式（无论 Java 路径 API 与否）基于以下原则：

创建实现接口或扩展 class 以模拟的抽象 classes。
实现我不想模拟的方法。
调用 "partial mock" 时我想执行（按优先顺序）：显式模拟方法、实现方法、默认答案。

为了实现第三步，我考虑创建一个 Answer 来查找已实现的方法并回退到默认答案。然后这个 Answer 的实例在模拟创建时被传递。

是否有直接从 Mockito 或其他方法来处理问题的现有方法？

Answer 1

你的问题是你违反了Single Responsibility Principle。

您有两个顾虑：

查找并定位一个文件，得到一个InputStream
处理文件。
- 实际上，这很可能也应该分解为子关注点，但这超出了这个问题的范围。

您正试图以一种方法完成这两项工作，这迫使您做大量的额外工作。相反，将工作分成两个不同的 classes。例如，如果您的代码是这样构造的：

class MyClass {
  private FileSystem fileSystem;
  private final StreamProcessor processor;

  public MyClass(FileSystem fileSystem, StreamProcessor processor) {
    this.fileSystem = fileSystem;
    this.processor = processor;
  }

  public void operation() {
    String filename = /* such way to retrieve filename, ie database access */
    try (InputStream in = Files.newInputStream(fileSystem.getPath(filename))) {
        processor.process(in);
    } catch (IOException e) {
        /* business error management */
    }
  }
}

class StreamProcessor {
  public StreamProcessor() {
    // maybe set dependencies, depending on the need of your app
  }

  public void process(InputStream in) throws IOException {
    /* file content handling */
  }
}

现在我们将责任分为两个地方。 class 执行您要测试的所有业务逻辑工作，来自 InputStream，只需要一个输入流。事实上，我什至不会嘲笑它，因为它只是数据。您可以以任何方式加载 InputStream ，例如使用您在问题中提到的 ByteArrayInputStream 。 您的 StreamProcessor 测试 .

中的 Java 路径 API 不需要任何代码

此外，如果您以常用方式访问文件，则只需进行一次测试即可确保该行为有效。您还可以使 StreamProcessor 成为一个接口，然后，在代码库的不同部分，对不同类型的文件执行不同的工作，同时将不同的 StreamProcessor 传递到文件 API.

评论中你说：

Sounds good but I have to live with tons of legacy code. I'm starting to introduce unit test and don't want to refactor too much "application" code.

最好的方法就是我上面说的。但是，如果您想进行最小数量的更改以添加测试，您应该这样做：

旧代码：

public void operation() {
  String filename = /* such way to retrieve filename, ie database access */
  try (InputStream in = Files.newInputStream(fileSystem.getPath(filename))) {
    /* file content handling */
  } catch (IOException e) {
    /* business error management */
  }
}

新代码：

public void operation() {
  String filename = /* such way to retrieve filename, ie database access */
  try (InputStream in = Files.newInputStream(fileSystem.getPath(filename))) {
    new StreamProcessor().process(in);
  } catch (IOException e) {
    /* business error management */
  }
}

public class StreamProcessor {
  public void process(InputStream in) throws IOException {
    /* file content handling */
    /* just cut-paste the other code */
  }
}

这是执行我上面描述的最少侵入性的方法。我描述的原始方式是更好，但显然这是一个更复杂的重构。这种方式应该几乎不涉及其他代码更改，但可以让您编写测试。

如何使用 Mockito 模拟 Java 路径 API？

How do I mock Java Path API with Mockito?

java

unit-testing

path

mocking

mockito