在“学习”代码的过程中竟然惊奇的发现同事写了测试用例,对于一直使用PostMan来进行接口测试的我表示非常不理解,测试用例到底有什么神奇之处?
需求分析
带着疑问翻看了测试用例,发现同事用它来实现了管理后台登录自动生成Token的功能。
生成Token用PostMan不是也很好实现吗?何必要多此一举?
百闻不如见面,直接上图
看到这张图是不是很熟悉?市面上的大部分登录界面都长这样吧。我们来简单分析下这个登录功能:
- 调用生成图片验证码接口,将生成的验证码图片返回前端,将验证码的文本保存到Redis缓存中;
- 调用短信验证码接口,将短信发送到对应的手机号,将验证码也保存到Redis缓存中;
- 调用登录接口,将填写信息进行校验,返回登录Token;
如果我们使用PostMan的话,得写三个请求才能获取到最终需要的Token,比较繁琐,而如果使用同事写的测试用例,可以直接运行获取到Token。那他是如何实现的呢?
Mock
在了解实现之前,我们先来了解下什么是Mock?Mock的翻译是虚假的、模拟的。它的作用就是在测试环境中创建一个类的虚假对象,用来替换掉真实的对象,以达到方便测试的目的。
举个例子:假如你正在开发下订单的需求,此时你需要调用B服务来完成减积分的操作,而此时B服务还在开发中,你就可以Mock一个对象,模拟B服务的返回结果,根据结果来完成自己的逻辑开发。
当然,SpringBoot也为我们提供了Mock单元测试,需要引入依赖
<dependency>n <groupId>org.springframework.boot</groupId>n <artifactId>spring-boot-starter-test</artifactId>n <scope>test</scope>n</dependency>n
该依赖提供了以下类库
- JUnit:JAVA应用单元测试框架,默认依赖版本是4.12(JUnit5和JUnit4差别比较大,集成方式不同);
- Spring Test & Spring Boot Test:测试支持;
- AssertJ:断言库,提供流式的断言支持;
- Hamcrest:对象匹配断言和约束组件;
- Mockito:Java mock框架;
- JSONassert:JSON断言库;
- JsonPath:JSON XPath操作类库;
注解
使用Mock之前,我们再来了解几个测试过程中用到的注解。
@SpringBootTest
@SpringBootTest为SpringBoot的单元测试环境提供支持。在使用Mock的过程中,我们会发现启动测试程序并不会占用我们的应用端口,本质上来讲就是它不会去启动服务器。
经过翻阅资料发现,它的这一特性跟它的内部属性值webEnvironment息息相关,它提供了四个枚举值供我们选择:
- MOCK:默认值,如果servlet API在类路径上,则创建一个带有模拟servlet环境的WebApplicationContext,如果Spring WebFlux在类路径上,则创建一个ReactiveWebApplicationContext,否则创建一个常规的ApplicationContext,该选择下不会启动嵌入式服务器;
- RANDOM_PORT:加载WebServerApplicationContext并提供真实的Web环境,启用的是随机web容器端口;
- DEFINED_PORT:加载WebServerApplicationContext并提供真实的Web环境,和RANDOM_PORT不同的是启用配置文件中定义的端口;
- NONE:通过SpringApplication加载ApplicationContext,但不提供任何Web环境;
如果测试时带有@Transactional注解,默认情况下每个测试方法执行完就会回滚事务。但是当webEnvironment设置为RANDOM_PORT或者DEFINED_PORT时,会隐式地提供真实的servlet web环境,此时事务是不会回滚的。
@RunWith(SpringRunner.class)
运行器,选择不同的Runner调用测试代码,此处指定用SpringRunner来运行。有了该注解,测试类要注入的类才能实例化到Spring容器中。
JUnit4需要添加该注解,JUnit5则不需要
方法注解
- @Test:使用该注解标注的public void方法会表示为一个测试方法;
- @BeforeClass:表示在类中的任意public static void方法执行之前执行;
- @AfterClass:表示在类中的任意public static void方法之后执行;
- @Before:表示在任意使用@Test注解标注的public void方法执行之前执行;
- @After:表示在任意使用@Test注解标注的public void方法执行之后执行;
- @Ignore:执行测试时将忽略掉此方法,如果用于修饰类,则忽略整个类;
实战
因为使用的是SpringSecurity鉴权,所以还得引入依赖
<dependency>n <groupId>org.springframework.security</groupId>n <artifactId>spring-security-test</artifactId>n <scope>test</scope>n</dependency>n
首先,我们先来初始化MockMvc对象
//wac 是 WebApplicationContext 对象nMockMvc mvc = MockMvcBuilders.webAppContextSetup(wac).n apply(springSecurity())n .build(); n
图形验证码
调用图形验证码接口
//perform:执行一个RequestBuilders请求,会自动执行SpringMVC的流程并映射到相应的控制器执行处理nMvcResult mvcResult = mvc.perform(n //模拟发送 GET 请求n MockMvcRequestBuilders.get("/login/capture").n //接受参数n .accept(MediaType.APPLICATION_JSON_UTF8)n //请求类型n .contentType(MediaType.APPLICATION_JSON)n .session(session)n )n //期待的结果状态值 200n .andExpect(MockMvcResultMatchers.status().isOk())n //获取方法的返回值 MvcResultn .andReturn();n
获取到返回结果之后进行解析,并保存到Redis缓存中。
短信验证码
mvc.perform(n //模拟发送 POST 请求n MockMvcRequestBuilders.post("/login/sendSmsCode")n .accept(MediaType.APPLICATION_JSON_UTF8)n .contentType(MediaType.APPLICATION_JSON)n // 填充内容n .content(JsonUtils.toString(req))n .session(session)n)n .andExpect(MockMvcResultMatchers.status().isOk())n .andReturn();n
模拟发送短信验证码接口,可以从Redis缓存中获取到短信验证码。
登录
MvcResult mResult = mvc.perform(n MockMvcRequestBuilders.post("/login")n .accept(MediaType.APPLICATION_JSON_UTF8)n .contentType(MediaType.APPLICATION_JSON)n .content(JsonUtils.toString(smsLoginDto))n .session(session)n )n .andExpect(MockMvcResultMatchers.status().isOk())n .andReturn();n
我们解析返回结果就可以获取Token了。
为了让需要登录的接口直接使用我们生成的Token,我们可以把获取图形验证码、短信验证码、登录的接口放在一个方法中,用@Before注释,这样在调用接口之前都会去获取一下Token。我们再把它放到MockHttpSession中,使用的时候直接获取即可。
测试
为了便于测试,我们将上边的方法封装成一个基础类,让使用Token的方法所在的类继承一下该类,就可以使用Token了。
@Testnpublic void test() throws Exception {n PageDTO req = new PageDTO();n req.setPageSize(10);n req.setPageNo(1);n WrapperResult<PageInfo<PostResumeVO>> iPageWrapperResult = this.doPost(n req,n "/resume/mid/getPage",n new TypeReference<WrapperResult<PageInfo<PostResumeVO>>>() {n });n this.outputPretty(iPageWrapperResult);n}n
查看执行结果执行成功。
当然你也可以只在test()方法中获取Token,然后用其他工具去调用接口。
看到这儿,你是不是也摩拳擦掌,想把自己获取复杂Token的操作改成Mock方式?心动不如行动,GO GO GO!