java - Mockito JUnit 测试简单的 api 调用

Question

我认为自己是单元测试的新手，对 Mockito 和 junit 完全陌生。我必须为一些简单的 api 调用编写单元测试。但我的测试对我来说似乎毫无意义，我不知道我哪里出了问题。我已向现有 Web 服务 ManagerWS.java 添加了一个方法，请参见下文。

ManagerWS.java方法:

public String healthCheck(String userId) { 
    String healthCheckUrlEndpoint  = this.baseUrl()+"/health";
    logger.debug("Calling health check: {}", healthCheckUrlEndpoint);
    HttpHeaders healthCheckHeaders = new HttpHeaders();
    healthCheckHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);
    healthCheckHeaders.add(USER_KEY, userId);
    healthCheckHeaders.add(TOKEN_NAME, TOKEN_VALUE);
    healthCheckHeaders.add(Constants.ACCEPT_LANGUAGE_HEADER, LocaleContextHolder.getLocale().toString());
    healthCheckHeaders.add(CORRELATION_HEADER, myService.get(AppLoggingMDCService.LOG_KEY_REQUEST_ID));
    HttpEntity<Object> request = new HttpEntity<Object>(healthCheckHeaders);
    ResponseEntity<String> response;        
    try {
        response = makeRequest(HttpMethod.GET, healthCheckUrlEndpoint, request, String.class); 
    } catch (Exception e) {
        logger.error("Exception encountered during health check", e);
        throw e;
    }       
    logger.debug("RESPONSE : http status: {} - body: {}", response.getStatusCode(), response.getBody());
    return response.getStatusCode().toString();
}

逻辑很简单。构造 url、创建 header 并将 header 添加到请求中。发出请求并从响应中提取状态代码。这是我的测试。注意:该类使用@RunWith(SpringRunner.class)，我使用@Mock作为依赖项，使用@InjectMocks作为本地实例ManagerWS 。 ManagerWS.java 是正在测试的服务调用。

测试级测试方法:

    @Test
    public void testHealthCheck() throws Exception {
    //Given
    managerWS = new ManagerWS(templateFactory, configParamService, mdcService, env);    
    String url = "http://baseurl/health";
    HttpHeaders headers = new HttpHeaders();    
    HttpEntity<Object> request = new HttpEntity<Object>(headers);   
    ResponseEntity<String> response = new ResponseEntity<>(HttpStatus.OK);
    //when
    when(managerWS.makeRequest(HttpMethod.GET, url, request, String.class)).thenReturn(response);
    String actualStatus = response.getStatusCode().toString();  
    //then
    Assert.assertEquals("200",actualStatus);
}

对我来说，这个测试似乎很愚蠢(因为缺少一个更好的词)。我基本上将状态设置为“200”并断言我设置的是“200”。这并没有多大意义。对我来说，它实际上没有任何作用。我尝试使用 spy (ManagerWS.class)。但我实际上是在捕获救命稻草，而没有完全理解。

SonarQube 仍然提示“单元测试未涵盖”。我完全不知道如何编写这个测试。我还必须对其他三个调用进行类似的测试。

我对测试完全是新手，我看不到我的错误。请指教。

Answer 1

SonarQube still complains with "Not covered by unit tests".

您的单元测试不会从要测试的方法的入口点进行测试:healthCheck(String)，因此单元测试不涵盖它。此外，您还模拟了要测试的方法部分:

when(managerWS.makeRequest(HttpMethod.GET, url, request, String.class)).thenReturn(response);

所以你的方法确实看起来是错误的。
事实上，为这段代码编写单元测试看起来也是错误的，或者至少看起来像一个没有什么值(value)的白盒测试。
为什么 ？您的逻辑取决于:

response = makeRequest(HttpMethod.GET, healthCheckUrlEndpoint, request, String.class); 

但是您可以知道它是否仅在运行时(使用正在运行的 HTTP 服务器)才有效。因此，您可以做的一件事就是模拟所有内容，监视被测对象并验证实现中的每个语句是否已执行:没有可读的测试，没有健壮性，并且很少/没有值(value)。

您的方法本质上依赖于副作用，作为集成测试进行测试会更有意义:

  ManagerWS managerWS; // real ManagerWS implementation without mock

  @Test
  public void healthCheck() throws Exception {
    //Given
    String url = "http://baseurl/health";
    // When
    String actual managerWS.healthCheck(url);
    // Then
    String expected = "...";
    Assertions.assertEquals(expected, actual);
  }

顺便说一句，如果您使用 Spring，我建议您查看测试切片 @WebMvcTest，它专注于被测组件的 Web 部分。它主要允许测试 HTTP 部分/逻辑( header 、请求、响应)。