如何对调用泽西岛客户端 API 的单元测试代码？

unit-testing java junit jax-rs jersey

2022-09-01 14:39:22

我编写了调用泽西岛客户端API的代码，而该API又调用了我无法控制的Web服务。我不希望我的单元测试调用实际的 Web 服务。

为调用 Jersey 客户端 API 的代码编写单元测试的最佳方法是什么？我是否应该使用泽西服务器 API 编写 JAX-RS Web 服务，然后使用泽西岛测试框架进行单元测试？还是我应该嘲笑泽西岛的网络服务呼叫？我可以访问JMock。或者我应该尝试另一种方法？

在我的研究过程中，我发现这个讨论描述了各种选择，但我确实找到了一个完整的解决方案。是否有任何代码示例可以显示建议的 JUnit 方法？我在泽西岛的文档中找到任何内容。

以下是相关的源代码：

public String getResult(URI uri) throws Exception {
  // error handling code removed for clarity
  ClientConfig clientConfig = new DefaultClientConfig();
  Client client = Client.create(clientConfig);
  WebResource service = client.resource(uri);
  String result = service.accept(accept).get(String.class);
  return result;
}

以下是我想通过的测试代码示例。我想测试（1）传入有效的URI并获取有效的字符串，以及（2）传入无效的（无论出于何种原因 - 无法访问或未经授权）URI并获取异常。

@Test
public void testGetResult_ValidUri() throws Exception {
  String xml = retriever.getResult(VALID_URI);
  Assert.assertFalse(StringUtils.isBlank(xml));
}

@Test(expected = IllegalArgumentException.class)
public void testGetResult_InvalidUri() throws Exception {
  retriever.getResult(INVALID_URI);
}

以上所有内容都是对我的代码所做工作的简单描述。实际上，在此之上有一个层，它接受两个 URI，首先尝试调用第一个 URI，如果该 URI 失败，则尝试调用第二个 URI。我希望单元测试涵盖（1）第一个URI成功，（2）第一个URI失败，第二个URI成功，以及（3）两个URI失败。此代码非常复杂，我想使用 JUnit 测试这些不同的方案，但要执行此操作，我要么需要运行实际的备用 Web 服务，要么模拟 Jersey 客户端 API 调用。

答案 1

尝试使用 Mockito 或 Easymock 来模拟服务调用。您只需要模拟这些实际使用的方法 - 无需模拟每个方法。您可以为 WebResource 类创建模拟对象，然后模拟接受方法调用。

在@BeforeClass/@Before JUnit测试方法中，写类似的东西（Mockito示例）

WebResource res = mock(WebResource.class);
when(res.accept(something)).thenReturn(thatWhatYouWant);

然后在测试中，您可以使用 res 对象，就好像它是真实对象一样，并对其调用 mock 方法。除了返回值之外，您还可以引发异常。Mockito很酷。

答案 2

通常，您真正想要的是“我使用泽西岛客户端 DSL 的方式是否使用正确的有效负载和 URL 参数生成对正确 URL 的请求”。使用Mockito测试它非常冗长，设置代码通常最终看起来像这样：

    when(authentication.queryParam(eq("sa"), anyBoolean())).thenReturn(testAuthentication);
    when(testAuthentication.resolveTemplate("channel", "smf")).thenReturn(testAuthentication);
    when(testAuthentication.request(
            MediaType.APPLICATION_JSON_TYPE)).thenReturn(mockRequestBuilder);
    when(mockRequestBuilder.post(any(Entity.class))).thenReturn(mockResponse);
    when(mockResponse.readEntity(ResponseWrapper.class)).thenReturn(successfulAuthResponse());

这基本上只是针对单个 REST 请求。它过于冗长，而不是测试希望的结果，你只是复制你认为在使用泽西岛客户端DSL时正确的步骤。

而不是上面，我的目标是嘲笑一个简单的服务。为此，我使用了WireMock，它启动了一个Jetty服务器，我可以在其中存根诸如“期望对此URL的请求，使用此消息进行响应并验证有效负载是否为此”之类的内容。

我知道这是在集成测试上的边缘，它比仅仅使用Mockito慢一点，但我重视测试真正的结果，在这种情况下，我更重视测试的可读性。

基于WireMock的泽西岛客户端测试的设置如下所示：

@Test
public void exactUrlOnly() {
    stubFor(get(urlEqualTo("/some/thing"))
            .willReturn(aResponse()
                .withHeader("Content-Type", "text/plain")
                .withBody("Hello world!")));

   assertThat(testClient.get("/some/thing").statusCode(), is(200));
   assertThat(testClient.get("/some/thing/else").statusCode(), is(404));
}