07、单元测试

@RunWith、@Rule 和@ClassRule 替换成@ExtendWith。

Junit & TestNG

Spring Boot Test 各个场景 —— 有点过时
JUnit 5 Test - MockMvc, Mockito, JPA - 韩语

@SpringbootTest注解

启动Springboot，准备DI等，可以用@Autowire这些注解。如果不加@SpringBootTest，就是普通的类没有DI

Mockito

  1. 官方文档
  2. FAQ
  3. [译] 使用强大的 Mockito 来测试你的代码

只看4.1-4.4，spy和mock的区别参见其它资料和项目代码

  1. Mockito when(…).thenReturn(…)和doReturn(…).when(…)的区别
  2. mock同一类中的其它方法
  1. @mock是org.mockito包的，@mockBean是springBoot提供的
  2. @Mock: 与框架无关，不是创建Spring Context，而是通过Mockito实例化对象进行单元测试。We can achieve this mocking behavior using @Mock whether we use Spring Boot or any other framework like Jakarta EE, Quarkus, Micronaut, Helidon, etc.
  3. 集成测试@SpringBootTest或@WebMvcTest or @DataJpaTest，会创建一个所谓的Spring Test Context，This context is similar to the application context during runtime as we can request beans from it (@Autowired). Usually, it only contains a subset of our beans (making our tests faster). As we can customize the Spring Test Context to our needs, we can decide whether we want the actual or a mocked version of one of our beans inside the context（通过@Autowire真实地注入其它bean，或者@MockBean以Mock的方式注入其它bean）。
  4. Advice: @mockBean会不断创建applicationContext（打破原来的缓存），降低测试速度。

@MockBean 危害
或者在不能直接mock依赖的时候用@Mockbean，比如context.getBean这种。但是这种用法不好。

@Spy和@SpyBean

@MockBean 不同的是，@SpyBean不会生成一个 Bean 的替代品装配到类中，而是会监听一个真正的 Bean 中某些特定的方法(用doReturn)，并在调用这些方法时给出指定的反馈。却不会影响这个 Bean 其它的功能。

reset

单元测试，每个方法里的when..return互不影响；
集成测试，@MockBean是单例的，贯穿于每个method，所以需要在beforeEach中reset

Can I “reset” a mock?

Recently we decided to go on with this feature for tricky scenarios where mocks are created by the container (see issue 55). Before that, the lack of a reset method was deliberate to promote good testing habits and to make the API simpler. Instead of reset() please consider writing simple, small and focused test methods over lengthy, over-specified tests. The discussion about this feature was here.

ArgumentMatchers和ArgumentCaptor

  • Using Mockito ArgumentCaptor
  • 在Mockito.when()的地方，用ArgumentMatchers，不用ArgumentCaptor。这样就可以直接通过ArgumentMatchers对参数进行了verify ```java Credentials credentials = new Credentials(“baeldung”, “correct_password”, “correct_key”); // eq已经进行了verify Mockito.when(platform.authenticate(Mockito.eq(credentials))) .thenReturn(AuthenticationStatus.AUTHENTICATED);

assertTrue(emailService.authenticatedSuccessfully(credentials));

  2. - 对没有进行stubbing的内部方法调用，使用ArgumentCaptor，再用verify语句验证
  3. ```java
  4. Credentials credentials = new Credentials("baeldung", "correct_password", "correct_key");
  5. Mockito.when(platform.authenticate(credentialsCaptor.capture()))
  6.   .thenReturn(AuthenticationStatus.AUTHENTICATED);
  8. assertTrue(emailService.authenticatedSuccessfully(credentials));
  9. // 这里还有多写一个
  10. assertEquals(credentials, credentialsCaptor.getValue());

MockitoExtension

  1. // Junit5的较高版本使用
  2. // @ExtendWith(MockitoExtension.class)
  3. class ShipMethodMapperTest {
  5.     @InjectMocks
  6.     private ShipMethodMapperImpl shipMethodMapper;
  8.     // Junit5的较低版本使用
  9.     @BeforeEach
  10.     void init() {
  11.         MockitoAnnotations.initMocks(this);
  12.     }
  13. }

mock static静态方法

@Test public void test1() { // 创建 mock MyClass test = Mockito.mock(MyClass.class);

  1.     // 自定义 getUniqueId() 的返回值
  2.     when(test.getUniqueId()).thenReturn(43);
  4.     // 在测试中使用mock对象
  5.     assertEquals(test.getUniqueId(), 43);

}

// 返回多个值 @Test public void testMoreThanOneReturnValue() { Iterator i= mock(Iterator.class); when(i.next()).thenReturn(“Mockito”).thenReturn(“rocks”); String result=i.next()+” “+i.next(); // 断言 assertEquals(“Mockito rocks”, result); }

// 如何根据输入来返回值 @Test public void testReturnValueDependentOnMethodParameter() { Comparable c= mock(Comparable.class); when(c.compareTo(“Mockito”)).thenReturn(1); when(c.compareTo(“Eclipse”)).thenReturn(2); // 断言 assertEquals(1,c.compareTo(“Mockito”)); }

// 如何让返回值不依赖于输入 @Test public void testReturnValueInDependentOnMethodParameter() { Comparable c= mock(Comparable.class); when(c.compareTo(anyInt())).thenReturn(-1); // 断言 assertEquals(-1 ,c.compareTo(9)); }

// 根据参数类型来返回值 @Test public void testReturnValueInDependentOnMethodParameter() { Comparable c= mock(Comparable.class); when(c.compareTo(isA(Todo.class))).thenReturn(0); // 断言 Todo todo = new Todo(5); assertEquals(todo ,c.compareTo(new Todo(1))); }

  1. <a name="R6gij"></a>
  2. ## Mock interface和非public类
  4. 1. @Mock可以mock interface，@InjectMocks不能mock interface，只能mock实现类
  5. 1. 不能@mock非public类，包括包可见类。解决方式：包可见类实现interface，@mock interface
  6. <a name="rmTXv"></a>
  7. ## Mock final
  9. 1. final依赖类用@Mock，可能只作用于第一个method **TODO：待确认**
  10. ```java
  11. public class SampleImpl implements Sample {
  13.     // 不能加final
  14.     private Sub sub;
  15.     // private final Sub sub;
  17.     public SampleImpl(Sub sub) {
  18.         this.sub = sub;
  19.     }
  20. }
  22. public class SampleTest {
  24.     @InjectMocks
  25.     private Sample sample;
  27.     @Mock
  28.     private Sub sub;
  29. }

PowerMock

  • Introduction to PowerMock
  • Using PowerMockito to Mock Final and Static Methods in Java Unit Testing 看到Mock Object Construction (new) with PowerMockito，后面应该不是重点。

    The test class needs to extend the “PowerMockTestCase” class. According to the PowerMockito documentations, extending the “PowerMockTestCase” class is just one of the options to make the test class to work, but it also mentioned that extending the “PowerMockTestCase” class is the “safe” option.

the scope of the final and static mocks is limited to the test method where they are specified. the scope of the mocks created by regular Mockito goes beyond the limit of the test method where the mock is created.

  1. /**
  2.  * cacheHelper is produced by Spring ApplicationContext getBean, @MockBean has problem,
  3.  * so use PowerMock to mock static method SpringContext.getBean to get cacheHelper instance
  4.  */
  5. @PrepareForTest({SpringContext.class})
  6. @PowerMockIgnore({"javax.management.*", "javax.script.*", "org.*", "com.sun.org.apache.xerces.*", "javax.xml.*"})
  7. public class ViewHierarchyTerrServiceTest extends PowerMockTestCase {}

MockMvc

springboot 单元测试 (controller层） 方法 — MockMvc

  • mockMvc.perform

执行一个请求

  • MockMvcRequestBuilders.post(“/appProducer/getAppLatestVersion”)

    构造一个请求，get请求就用.get方法

  • MockHttpServletRequestBuilder.header(“user-agent”, “MicroMessenger”)

    请求头设置

  • MockHttpServletRequestBuilder.param(“appId”, “1001”)

    传递参数, get请求也可以通过这种方式传值，也可在地址后加参数方式MockMvcRequestBuilders.get(“/appProducer/getAppLatestVersion?appId=1001”)

  • contentType(MediaType.APPLICATION_JSON_UTF8)

    代表发送端发送的数据格式是application/json;charset=UTF-8

  • accept(MediaType.APPLICATION_JSON_UTF8)

代表客户端希望接受的数据类型为application/json;charset=UTF-8

  • session(session)

    注入一个session，这样拦截器才可以通过

  • ResultActions.andExpect

添加执行完成后的断言

  • ResultActions.andExpect(MockMvcResultMatchers.status().isOk())

方法看请求的状态响应码是否为200如果不是则抛异常，测试不通过

  • ResultActions.andExpect(jsonPath(“$.status”, not(“E”)))

使用jsonPath解析JSON返回值，判断具体的内容, 此处不希望status返回E，如果返回E测试不通过

  • ResultActions.andDo

添加一个结果处理器，表示要对结果做点什么事情，比如此处使用MockMvcResultHandlers.print()输出整个响应结果信息

  1.     @Test
  2.     public void create_happyPath() throws Exception {
  4.         DeepdrawOrder order = new DeepdrawOrder();
  5.         DeepdrawOrderDTO orderDTO = helper.createOrderDTO();
  6.         DeepdrawOrderDTO responseOrder = new DeepdrawOrderDTO();
  7.         doReturn(order).when(orderController).validateAndConvertToOrder(any(), any());
  8.         doReturn(order).when(orderService).create(ArgumentMatchers.isA(DeepdrawOrder.class));
  9.         doReturn(responseOrder).when(orderConverter).convertToDTO(ArgumentMatchers.isA(DeepdrawOrder.class));
  10.         String RequestBody = JsonUtils.toJson(orderDTO, new TypeReference<DeepdrawOrderDTO>() {});
  12.         MvcResult result = mvc.perform(post("/admin/order/create").contentType(APPLICATION_JSON_UTF8).content(RequestBody)).andExpect(status().isOk()).andReturn();
  14.         String expected = new ObjectMapper().writeValueAsString(ResponseUtils.success(responseOrder));
  15.         assertThat(result.getResponse().getContentAsString(), is(expected));
  16.         ArgumentCaptor<DeepdrawOrderDTO> orderDTOCaptor = ArgumentCaptor.forClass(DeepdrawOrderDTO.class);
  17.         verify(orderController).validateAndConvertToOrder(any(), orderDTOCaptor.capture());
  18.         assertThat(orderDTOCaptor.getValue().getPayType(), is(PayType.ALIPAY));
  19.     }

集成测试

新版SpringBoot默认就用一个@SpringBootTest就可以。
test包下application.yml
关于ApplicationContext：

The component classes to use for loading an ApplicationContext. Can also be specified using @ContextConfiguration(classes=…). If no explicit classes are defined the test will look for nested @Configuration classes, before falling back to a @SpringBootConfiguration search. Returns: the component classes used to load the application context

Spring Boot provides a @SpringBootTest annotation, which can be used as an alternative to the standard spring-test @ContextConfiguration annotation when you need Spring Boot features. The annotation works by creating the ApplicationContext used in your tests through SpringApplication. If you are using JUnit 5, there is no need to add the equivalent @ExtendWith(SpringExtension.class) as @SpringBootTest and the other @…Test annotations are already annotated with it.

TestRestTemplate

  1. 简易版

    1. @RunWith(SpringJUnit4ClassRunner.class)
    2. @ContextConfiguration(locations = "classpath:applicationContext.xml")
    3. public class CustomerDaoTest {
    5.  @Autowired
    6.  private CustomerDao customerDao;
    8.  @Test
    9.  public void testFindById() {
    11.      Optional<Customer> customer = customerDao.findById(1L);
    12.      assertThat(customer.get().getCustId(), Matchers.is(1L));
    13.  }
    14. }

  2. AbstractTransactionalJUnit4SpringContextTests

SpringTxTestCase.java

  1. SpringBoot集成测试（参考性不大了）

    1. /**
    2. * 集成测试抽象基类
    3. */
    4. @ExtendWith(SpringExtension.class)
    5. @SpringBootTest(classes = {Application.class, RepositoryTestConfig.class})
    6. @Transactional
    7. @Rollback
    8. @Tag("integration")
    9. @TestPropertySource(locations = "classpath:application-test.properties")
    10. @ActiveProfiles({"test", "repo-integration-test"})
    11. public abstract class AbstractRepositoryTest<T> {
    13.  @Autowired
    14.  protected T repo;
    15. }

    jacoco

    The JaCoCo Plugin of gradle

    测试

    Entity&Validation

    Difference Between @NotNull, @NotEmpty, and @NotBlank Constraints in Bean Validation

    Repository

    新版不能用@DataJpaTest，直接用@SpringBootTest

    Service

    ```java public class UserServiceImplTest { @InjectMocks private UserServiceImpl userServiceImpl;

    @Mock private UserRepository userRepository;

    // 新版要使用openMocks @BeforeEach public void init() {

    1.  MockitoAnnotations.openMocks(this);

    }

    // 如果mock了userRepository.findByUsername，但调用的是service.findById，会报空指针 @Test public void findByUsername_shouldReturnMockUser_ifMockReturnAnyUser() {

    1.  User foundUser = User.builder().username("Tom2").build();
    2.  when(userRepository.findByUsername("Tom")).thenReturn(Optional.of(foundUser));
    4.  User resultUser = userServiceImpl.findByUsername("Tom").orElse(null);
    6.  Assertions.assertEquals("Tom2", resultUser.getUsername());

    } }

  1. <a name="H6mIc"></a>
  2. ## controller
  3. [springboot 单元测试 (controller层） 方法 -- MockMvc](https://blog.csdn.net/coolcoffee168/article/details/88638042)<br />[案例：settingControllerTest](http://116.62.122.39/deepdraw/deepdraw/blob/dev/src/test/java/com/soomey/controller/authorized/merchant/setting/SettingControllerTest.java)
  5. <a name="lam0f"></a>
  6. # 案例
  7. 不能mock私有函数，只有mock私有函数里的service。 `merchantService.getCurrentMerchant` 。<br />any()参数加具体的类，实际执行时传的是null，则失败，只能any()不加参数。
  8. ```java
  9. @ResponseBody
  10. @PostMapping(value = "/productField/batchChangeFieldsStatus")
  11. public String batchChangeFieldsStatus(HttpSession session, @RequestParam("fieldIds") Long[] fieldIds) {
  12.     List<ProductField> fields = getFieldsByIds(fieldIds);
  13.     Merchant merchant = getCurrentMerchant(session);
  14.     doBatchChangeFieldsStatus(fields, merchant);
  15.     if (!fields.stream().allMatch(field -> canChangeFieldStatus(field))) {
  16.         return ControllerUtils.fail("EMPTY_PRODUCT_FIELD_OPTIONS");
  17.     }
  18.     return ControllerUtils.success();
  19. }    
  21. @Test
  22. public void batchChangeFieldsStatus_shouldBeFail_If_NotAllFieldsCanBeChanged() throws Exception {
  23.     Merchant merchant = mock(Merchant.class);
  24.     when(merchantService.getCurrentMerchant(any(Session.class))).thenReturn(merchant);
  25.     doReturn(false).when(settingContoller).canChangeFieldStatus(any());
  26.     doNothing().when(settingContoller).doBatchChangeFieldsStatus(anyList(), any());
  28.     MvcResult result = mvc.perform(post("/authorized/merchant/setting/productField/batchChangeFieldsStatus")
  29.                                    .session(new MockHttpSession()).params(composeFieldIdsParams("1"))
  30.                                   ).andExpect(status().isOk()).andReturn();
  32.     assertEquals("{\"successful\":false,\"errorCode\":\"EMPTY_PRODUCT_FIELD_OPTIONS\"}", result.getResponse().getContentAsString());
  33. }
  • SYNNEX GetBestShipMethod

    问题

    mock final类

    待研究

    @ExtendWith

    when-to-use-extendwith-spring-or-mockito
    1. @ExtendWith(SpringExtension.class)
    2. @ExtendWith(MockitoExtension.class)
    3. class Test {}

    org.hamcrest.Matchers
    API

    Matchers.contains(a, b): a、b的顺序也要符合

assertThat

  1. // 错误 判断null == null
  2. assertThat(result, isNull());
  3. // 正确
  4. assertNull(result);

抛出错误

关于Java：您如何断言在JUnit 4测试中抛出某个异常？

  1. @Test(expectedExceptions = ArithmeticException.class) 
  2. public void givenNumber_whenThrowsException_thenCorrect() { 
  3.     int i = 1 / 0;
  4. }
  1. publc class Test {
  3.     // @Rule
  4.     // public ExpectedException expectedException = ExpectedException.none();
  6.     @Test
  7.     public void getByAccountOrId_shouldBeNull_ifFoundNoneByAccountOrId() {
  9.         when(merchantDao.listByAccount(anyString())).thenReturn(Collections.emptyList());
  10.         when(entityDao.get(any())).thenThrow(IllegalArgumentException.class);
  11.         // 结合mockito使用目前还遇到问题，会报错：Expected test to throw an instance of java.lang.IllegalArgumentException
  12.         // expectedException.expect(IllegalArgumentException.class);
  14.         Merchant result = service.getByAccountOrId("");
  16.         // catch中如果有返回值return null,还是可以断言返回值
  17.         assertNull(result);
  18.     }
  19. }

@BeforeEach执行时机

  1. @Before
  2. public void setupValidatorInstance() {
  3.     validator = Validation.buildDefaultValidatorFactory().getValidator();
  4. }

坑：idea中如果直接测试某一个方法，不会执行beforeEach，要在类上面点击执行
image.png

dataProvider不要用static

用例设计

  1. 最小用例原则：对于集合的测试，每种条件（不同的项）一个用例 —— 使用singletonList

    同一包下

    测试代码和源代码要放在同一包下，否则sonar扫描不到。
    idea ctrl+shift+T的时候注意路径！

    Maven/idea执行单元测试

    Maven Surefire
    1. This plugin helps in making the execution of unit test cases of a maven project or application and generate the reports of the testing results in the test phase of the build lifecycle.
    2. There is no need for any extra configurations to specify which provider is used and available for the test cases in the maven project.
    3. One of the most commonly used and preferred methods of using this plugin is to specify the version of this plugin in the plugins element of your pom.xml file or parent pom.xml file of your maven project.
    4. An alternative way to use the maven surefire plugin is to call the test phase of the maven builds lifecycle which will invoke this plugin automatically.
    • Junit(5.x,3.8 or 4.x version)
    • POJO(Plain Old Java Object)
    • TestNG