如何对调用Jersey Client API的代码进行单元测试？

Question

我编写了调用Jersey客户端API的代码,后者又调用了一个不受我控制的Web服务.我不希望我的单元测试调用实际的Web服务.

为调用Jersey客户端API的代码编写单元测试的最佳方法是什么？我应该使用Jersey服务器API编写JAX-RS Web服务,然后使用Jersey Test Framework进行单元测试吗？或者我应该模拟泽西岛网络服务电话？我可以访问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调用.

Answer 1

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

在@ BeforeClass/@之前JUnit测试方法写一些像(Mockito示例)

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

然后在您的测试中,您可以使用res对象,就像它是真实对象一样,并在其上调用mock方法.您也可以抛出异常,而不是返回值.Mockito非常酷.

Answer 2

通常你真正关注的是"我使用Jersey客户端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请求.它过于冗长,而不是测试希望的结果,你只是复制你认为使用Jersey客户端DSL正确的步骤.

而不是上述,我的目标是嘲笑一个简单的服务.为此,我使用了启动Jetty服务器的WireMock,在那里我可以存储诸如"期望对此URL的请求,使用此消息进行响应并验证有效负载是否为此"之类的内容.

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

基于WireMock的Jersey Client测试的设置如下所示:

@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));
}