flyway+junit5做集成测试、单元测试

骑猪看日落 2022-09-09 06:46 234阅读 0赞

## 适用场景 ##

*  功能开发完成后，后端开发人员进行代码自测
 *  代码重构后，集成测试

## 一些注解 ##

*  相关源码包: junit-jupiter-api

<table> 
 <thead> 
  <tr> 
   <th>annotations</th> 
   <th>description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Test</td> 
   <td>用例</td> 
  </tr> 
  <tr> 
   <td>@ParameterizedTest</td> 
   <td>参数化用例</td> 
  </tr> 
  <tr> 
   <td>@DisplayName</td> 
   <td>标识用例的名称</td> 
  </tr> 
  <tr> 
   <td>@BeforeEach</td> 
   <td>每个用例运行之前操作</td> 
  </tr> 
  <tr> 
   <td>@AfterEach</td> 
   <td>每个用例运行之后操作</td> 
  </tr> 
  <tr> 
   <td>@BeforeAll</td> 
   <td>本类的每个用例运行之前操作</td> 
  </tr> 
  <tr> 
   <td>@AfterAll</td> 
   <td>本类的每个用例运行之前操作</td> 
  </tr> 
  <tr> 
   <td>@Nested</td> 
   <td>标识为嵌套用例集合，该标识下，@BeforeAll与AfterAll，仅运行一次</td> 
  </tr> 
 </tbody> 
</table>

# Getting Started #

## 场景一 ##

*  我要测试一个dao的sql是否写的正确

// 声明一个测试类
    @SpringBootTest
    @TestPropertySource("classpath:application-test.properties")
    public class ExampleTestApplicationTests { 
        @Autowired
        private UserInfoDao userInfoDao;
    
        // 声明一个测试函数
        @Test
        @DisplayName("用例: 用户更新")
        public void updateUserInfo() { 
           UserInfo userInfo = UserInfo.builder().id(1L).userName("香槟").build();
    
           int result = userInfoDao.updateById(userInfo);
    
           Assertions.assertEquals(1,result);
        }
    }

## 场景二 ##

*  测试接口异常
 *  通过Assertions.assertThrows(…)来断言,获取异常
 *  JdbcTestUtil2是我针对JdbcTestUtil自己扩展的，用来准备数据、校验数据；这里准备数据与校验数据不直接用dao的原因(**测试场景脱离业务代码，防止业务dao语句存在问题而影响测试结果**)

@Test
        public void registerDuplicate() { 
            String prepareStatement = "INSERT INTO `user_info` (`id`, `user_name`) VALUES ('101', '香槟')";
            int prepareRows = JdbcTestUtil2.updateTable(jdbcTemplate, prepareStatement);
            Assertions.assertEquals(1, prepareRows);
    
            DataIntegrityViolationException exception = Assertions.assertThrows(DataIntegrityViolationException.class, () -> { 
                userInfoService.register("香槟");
            });
            Throwable rootCause = Optional.ofNullable(ExceptionUtils.getRootCause(exception)).orElse(exception);
            Assertions.assertEquals("Duplicate entry '香槟' for key 'idx_uinfo_uname'", rootCause.getMessage());
        }

## 场景三 ##

*  测试下Controller接口
 *  mockMvc是针对DispatcherServlet进行操作的，这就需要我们手动添加一些filters，这与interrupter不同

@Autowired
        private WebApplicationContext webApplicationContext;
    
        public MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext)
                .addFilters(webApplicationContext.getBean(LoggerFilter.class))
                .build();
    
        @Test
        @DisplayName("注册成功")
        public void registerSuccess() throws Exception { 
            MvcResult mvcResult = mockMvc.perform(
                            MockMvcRequestBuilders.get("/api/user/register")
                                    .header("traceId", "123456")
                                    .param("userName", "香槟"))
                    .andExpect(MockMvcResultMatchers.status().is2xxSuccessful())
                    .andReturn();
            String responseStr = mvcResult.getResponse().getContentAsString();
            BaseResult<Object> baseResult = objectMapper.readValue(responseStr, new TypeReference<BaseResult<Object>>() { 
            });
            Assertions.assertEquals("success", baseResult.getCode());
        }

## 场景四 ##

*  接口入参条件不同，返回的结果是相同的，这时候写多个@Test函数，会造成代码重复性较高，也不利维护
 *  引入 @ParameterizedTest 参数化用例，该注解仅适用于同返回结果，Assertions…相同场景

@ParameterizedTest
        @CsvSource({ 
                "'99999899',123456",
                "'99999899',dfadfdf",
                "'99999899',0000000",
        })
        public void userInfoModify(ArgumentsAccessor arguments) throws Exception { 
            UserInfoModifyCommand build = UserInfoModifyCommand.builder()
                    .oldPassword((String) arguments.get(0))
                    .password((String) arguments.get(1))
                    .build();
    
             // .......
        }

## 场景五 ##

*  用例归类;往往我们一个Controller/Bean的Method有多个场景需要测试，这时候如果在idea-structure里会看到几十个的method，非常不利于阅读
 *  引入 @Nested 、内部类

@Nested
      @DisplayName("注册")
      class registerTest { 
    
          @Test
          @DisplayName("注册成功")  
          public void registerSuccess(){ 
            // ......
          }
    
          @Test
          @DisplayName("重复注册")
          public void registerDuplicate(){ 
            // ......
          }
      }

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAOTPlubTnmoTpppnmp58_size_10_color_FFFFFF_t_70_g_se_x_16_pic_center]

## 场景六 ##

*  每个测试用例的数据需要隔离; 所以我们可以在执行用例前，清一下表数据
 *  show tables; => TableName.getAllTableNames()

@BeforeEach
        public void cleanTable() { 
            JdbcTestUtils.deleteFromTables(jdbcTemplate, TableName.getAllTableNames());
        }

## 场景七 ##

*  外部渠道、中间件由于存在不稳定性及依赖关系，我们需要对相关的API进行Mock  
    [mockito][]

// mock下 userDao
        @MockBean
        private UserDao userDao;
     
        @Test
        @DisplayName("用例: 注册成功")
        public void registerSuccess() { 
          
            Mockito.when(userDao.save(Mockito.any()))
                    .thenReturn(UserInfo.builder().userName("小西").build());
    
            Mockito.when(userDao.save(Mockito.any())).thenThrow(new IllegalArgumentException("异常"));
    
            // ....... do something
        }

## 场景八 ##

*  DDL语句自动执行
 *  引入 [flywaydb][]

<dependency>
                <groupId>org.flywaydb</groupId>
                <artifactId>flyway-core</artifactId>
            </dependency>

![在这里插入图片描述][bd312e4cdb6d4f27bcd5e5664d3bd0cb.png_pic_center]

![在这里插入图片描述][3d7d382a0c024015b6038de7ac2df268.png_pic_center]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAOTPlubTnmoTpppnmp58_size_10_color_FFFFFF_t_70_g_se_x_16_pic_center]: /images/20220829/1be2b6bb6b2e46df9d329dcd01baf2eb.png
[mockito]: https://javadoc.io/static/org.mockito/mockito-core/3.11.2/org/mockito/Mockito.html
[flywaydb]: https://flywaydb.org/documentation/getstarted/
[bd312e4cdb6d4f27bcd5e5664d3bd0cb.png_pic_center]: /images/20220829/c998a41863ed4c10a3890a4786c38885.png
[3d7d382a0c024015b6038de7ac2df268.png_pic_center]: /images/20220829/99a72c132f5c4e3d8961da6a2fb02e8b.png