如何使用mockito来模拟grpc ServiceBlockingStub抛出StatusRuntimeException(Status.UNAVAILABLE)？

Question

我想模拟我的 grpc 客户端，以通过抛出 new StatusRuntimeException(Status.UNAVAILABLE) 来确保它能够抵御故障（这是在将 java.net.ConnectException: Connection refused 抛出到 grpc 客户端时抛出的异常）。但是，生成的类是 final 的，所以 mock 不起作用。

如何让 BlahServiceBlockingStub 抛出 new StatusRuntimeException(Status.UNAVAILABLE) 而无需重构我的代码以围绕 BlahServiceBlockingStub 创建一个包装类？

这是我尝试过的（BlahServiceBlockingStub 是由 grpc 生成的）：

    @Test
    public void test() {
        BlahServiceBlockingStub blahServiceBlockingStub = mock(BlahServiceBlockingStub.class);

        when(blahServiceBlockingStub.blah(any())).thenThrow(new StatusRuntimeException(Status.UNAVAILABLE));


        blahServiceBlockingStub.blah(null);
    }

不幸的是，我得到了预期的以下异常：

org.mockito.exceptions.base.MockitoException: 
Cannot mock/spy class BlahServiceGrpc$BlahServiceBlockingStub
Mockito cannot mock/spy following:
  - final classes
  - anonymous classes
  - primitive types

    at MyTestClass.test(MyTestClass.java:655)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
.
.
.

因为我尝试模拟 grpc 生成的最终类：

  public static final class BlahServiceBlockingStub extends io.grpc.stub.AbstractStub<BlahServiceBlockingStub> {
    private BlahServiceBlockingStub(io.grpc.Channel channel) {
      super(channel);
    }

Answer 1

您有几个选择：

• 不推荐：使用Mockito v2 to mock final classes and methods。
• 不推荐：使用powermock to mocks final classes and methods。
• 推荐：（正如 Eric 在他的回答中已经提到的）使用 gRPC Java 测试框架，如 GrpcCleanupRule 和 InProcessServerBuilder。有关示例，请参阅 HelloWorldClientTest。
• 推荐：做over-the-wire gRPC API mocking/simulation。使用第三方工具，为您的 API 创建在线 API 模拟/模拟器。例如，Traffic Parrot。

请注意为什么在这种情况下模拟 final 可能是个坏主意： 根据具体情况，模拟 final 类或方法可能不是一个好主意。细节决定成败。在您的情况下，您正在创建生成代码的模拟，因此您假设生成的代码将来会如何表现。 gRPC 和 Protobuf 仍在快速发展，因此做出这些假设可能会有风险，因为它们可能会发生变化，而您不会注意到，因为您不会根据生成的代码检查模拟。因此，除非您真的必须这样做，否则模拟生成的代码并不是一个好主意。

Answer 2

不要模拟客户端存根或任何其他最终类/方法。 gRPC 团队可能会不遗余力地破坏您对此类模拟的使用，因为它们非常脆弱并且会产生“不可能”的结果。

模拟服务，而不是客户端存根。当与过程中传输相结合时，它会产生快速、可靠的测试。这与grpc-java hello world example 中演示的方法相同。

@Rule
public final GrpcCleanupRule grpcCleanup = new GrpcCleanupRule();

@Test
public void test() {
    // This can be a mock, but is easier here as a fake implementation
    BlahServiceImplBase serviceImpl = new BlahServiceImplBase() {
        @Override public void blah(Request req, StreamObserver<Response> resp) {
            resp.onError(new StatusRuntimeException(Status.UNAVAILABLE));
        }
    };
    // Note that the channel and server can be created in any order
    grpcCleanup.register(InProcessServerBuilder.forName("mytest")
        .directExecutor().addService(serviceImpl).build().start());
    ManagedChannel chan = grpcCleanup.register(
        InProcessChannelBuilder.forName("mytest").directExecutor().build();
    BlahServiceBlockingStub blahServiceBlockingStub
        = BlahServiceGrpc.newBlockingStub();

    blahServiceBlockingStub.blah(null);
}

在进行多个测试时，您可以将服务器、通道和存根创建提升到字段或 @Before 中，从单独的测试中取出。这样做时，在服务器上使用MutableHandlerRegistry 作为fallbackHandlerRegistry() 会很方便。这允许您在服务器启动后注册服务。有关该方法的更完整示例，请参阅route guide example。

Answer 3

我最终得到了一个丑陋的解决方法。

我在引用 BlahServiceBlockingStub 的类上创建了一个新方法和一个 spy()。

生成的代码最终看起来像：

    @Test
    public void test() {
        MyClass myClass = spy(myClass);

        doThrow(new StatusRuntimeException(Status.UNAVAILABLE)).when(myClass).newMethod(any());

        // changed to call myClass.newMethod() instead of blahServiceBlockingStub.blah
        myClass.myExistingMethod(); 
    }

Answer 4

如何使用 mockito 模拟最终类/方法：

添加依赖Mockito Inline

创建文件src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker

一行：mock-maker-inline

现在您可以模拟 final 方法和类。

Mockito docs about mocking