在项目中,经常会需要测试程序中的某个功能或者某个方法,来判断程序的正确性或性能。如何在Spring Boot项目中完成单元测试呢。
详细分解
1、首先需要有必备的工具包。Spring-Boot测试工具包
- Spring Boot提供了一些注解和工具去帮助开发者测试他们的应用。相较于SpringBoot1.3,SpringBoot1.4对测试有了大的改进,以下示例适用SpringBoot1.4.1以及以上版本。在项目中使用Spring Boot Test支持,只需要在pom.xml引入如下配置即可:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
SpringBoot提供了spring-boot-start-test
启动器,该启动器提供了常见的单元测试库:
JUnit: 一个Java语言的单元测试框架
Spring Test & Spring Boot Test:为Spring Boot应用提供集成测试和工具支持
AssertJ:支持流式断言的Java测试框架
Hamcrest:一个匹配器库
Mockito:一个java mock框架
JSONassert:一个针对JSON的断言库
JsonPath:JSON XPath库
2、导入相关的注解。
这里介绍一些Spring Boot单元测试常用的注解,更多详细请到Spring Boot官网[查看]
(http://docs.spring.io/spring-boot/docs/1.4.1.RELEASE/reference/htmlsingle/#boot-features-testing)。
@RunWith(SpringRunner.class)
JUnit运行使用Spring的测试支持。SpringRunner是SpringJUnit4ClassRunner的新名字,这样做的目的仅仅是为了让名字看起来更简单一点。
@SpringBootTest
该注解为SpringApplication创建上下文并支持Spring Boot特性,其webEnvironment提供如下配置:
Mock
-加载WebApplicationContext并提供Mock Servlet环境,嵌入的Servlet容器不会被启动。
RANDOM_PORT
-加载一个EmbeddedWebApplicationContext并提供一个真实的servlet环境。嵌入的Servlet容器将被启动并在一个随机端口上监听。
DEFINED_PORT
-加载一个EmbeddedWebApplicationContext并提供一个真实的servlet环境。嵌入的Servlet容器将被启动并在一个默认的端口上监听
(application.properties配置端口或者默认端口8080)。
NONE
-使用SpringApplication加载一个ApplicationContext,但是不提供任何的servlet环境。
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)
public class SpringbootRabbitmqApplicationTests {
@Autowired
private Sender sender;
@Test
public void contextLoads() {
sender.send();
}
}
@MockBean
在你的ApplicationContext里为一个bean定义一个Mockito mock。
@SpyBean
定制化Mock某些方法。使用@SpyBean除了被打过桩的函数,其它的函数都将真实返回。
@WebMvcTest
该注解被限制为一个单一的controller,需要利用@MockBean去Mock合作者(如service)。
@RunWith就是一个运行器,可以指定用哪个测试框架运行
@RunWith(JUnit4.class)就是指用
JUnit4
来运行@RunWith(SpringJUnit4ClassRunner.class)使用了Spring的
SpringJUnit4ClassRunner
,以便在测试开始的时候自动创建Spring的应用上下文。注解了@RunWith就可以直接使用Spring容器,直接使用@Test注解,不用启动Spring容器;
这里SpringBoot选择的是@RunWith(SpringRunner.class);
@SpringBootTest(classes = SkynetApplication.class)用来指定配置;
代码如下:
/**
* @author
* @Date:2017/11/28
* @Time:下午3:03
* Description:
*/
@RunWith(SpringRunner.class)
@SpringBootTest(classes = SkynetApplication.class)
public classTestIndex {
@Autowired
private TbTestMapper tbTestMapper;
@Test
public void testInsert(){
TbTest tbTest =newTbTest();
tbTest.setAge(1);
tbTest.setBrithday(newDate());
tbTest.setHigh(175);
tbTest.setIsboy((short)1);
tbTestMapper.insertSelective(tbTest);
}
3、在需要测试的方法中添加@Test方法运行即可
测试用例设计
1. 测试用例设计方法
根据目前现状,单元测试主要用来进行程序核心逻辑测试。逻辑覆盖测试是通过对程序逻辑结构的遍历来实现程序逻辑覆盖。从对源代码的覆盖程度不同分为以下六种标准,本文只对其中的五种进行分析(路径覆盖除外),下面从一段代码开始。
public int example(int x, int y, int z){
if (x>1 && z>2){
x = x + y;
}
if (y == 3 || x > 5){
x = x - 2;
}
return x;
}
一般单元测试不会根据代码来写用例,而是会根据流程图来编写测试用例,以上代码画出的流程图如下:
语句覆盖
概念
设计足够多的测试用例,使得被测试程序中的每条可执行语句至少被执行一次。测试用例
数据 | 执行路径 |
---|---|
{x=6;y=3;z=3} | a->c->b->d->e->f |
- 测试的充分性
假设语句`x1&&z>2`中的`&&`写成了`||`上面的测试用例是检查不出来的。
判定覆盖
概念
设计足够的测试用例使得代码中的判断真、假分支至少被执行一次。我们标记x>1&&z>2 为P1 y==3 || x>5为P2。测试用例
数据 | P1 | P2 | 执行路径 |
---|---|---|---|
{x=3;y=3;z=3} | T | T | a->c->b->d->e->f |
{x=0;y=2;z=3} | F | F | a->c->d->f |
- 测试的充分性
假设语句`y==3 || x>5`中的`||`写成了`&&`上面的测试用例是检查不出来的。和语句覆盖相比:由于判定覆盖不是在判断假分支就是在判断真分支,所以满足了判定覆盖就一定会满足语句覆盖。
条件覆盖
判定/条件覆盖
条件组合覆盖
实战
1、对service进行测试:
在service中建立要测试的方法:
@Service
public class GirlService {
@Autowired
private GirlRepository girlRepository;
/**
* 通过id查询一个女生的信息
* @param id
* @return
*/
public Girl findOne(Integer id){
return girlRepository.findOne(id);
}
}
在test文件夹下已经有一个idea初始化项目时创建的文件GirlApplicationTests
方式一:手动建测试类
新建一个针对测试service中的方法进行测试的类GirlServiceTest:
@RunWith(SpringRunner.class) //表示在测试环境中运行
@SpringBootTest //启动整个springboot工程
public class GirlServiceTest {
@Autowired
private GirlService girlService;
@Test
public void findOneTest(){
Girl girl = girlService.findOne(12);
Assert.assertEquals(new Integer(14),girl.getAge());
}
}
方式二:利用Idea工具进行测试
在要测试的方法中选中右击:
选择创建一个测试类:
可以勾选需要进行测试的方法:
选完之后会在项目的测试包下创建一个service包,service包中创建了测试类
新建出来测试类之后,依然要像(方法一)一样,加上@Runwith、@SpringBootTest
二、对controller进行测试(API测试,并直接能得到测试结果)
对controller中的girlList方法进行测试:
@RestController
public class GirlController {
/**
* getLogger方法中的参数与类名对应
*/
private final static Logger logger = LoggerFactory.getLogger(GirlController.class);
@Autowired
private GirlRepository girlRepository;
@Autowired
private GirlService girlService;
/**
* 查询所有女生
* @return
*/
@GetMapping(value = "/girls")
public List<Girl> girlList(){
// System.out.println("我是girlList方法");
logger.info("我是girlList方法");
return girlRepository.findAll();
}
}
用以上同样的步骤让idea创建出测试类
需要模拟该方法通过什么请求,url地址是什么来进行测试:
GirlControllerTest:
@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class GirlControllerTest {
@Autowired
private MockMvc mvc;
//测试希望返回的状态码为200
@Test
public void girlList() throws Exception {
mvc.perform(MockMvcRequestBuilders.get("/girls"))
.andExpect(MockMvcResultMatchers.status().isOk())
.andExpect(MockMvcResultMatchers.content().string("abc")); //对内容进行判断,期望返回的内容是abc
}
}
运行结果:
三、对controller进行测试(含Service)
在测试Controller时需要进行隔离测试,这个时候需要Mock Service层的服务。
@RunWith(SpringRunner.class)
@WebMvcTest(ScoreController.class)
public class ScoreControllerTestNew {
@Autowired
private MockMvc mockMvc;
@MockBean
private ICalculateService calculateService;
@MockBean
private IModelMonitorService modelMonitorService;
@MockBean
private IScoreConfigService scoreConfigService;
@MockBean
private IModelProductService modelProductService;
@Before
public void setUp(){
}
@Test
public void testScore() throws Exception {
given(this.modelProductService.get(anyLong()))
.willReturn(null);
String jsonStr = "{\"data\":{\"debit_account_balance_code\":40,\"credit_consume_count\":1,\"debit_start_age\":1,\"debit_consume_sum_code\":2,\"age\":38},\"modelProductId\":5}";
RequestBuilder requestBuilder = null;
requestBuilder = post("/scoreApi/score").contentType(MediaType.APPLICATION_JSON).content(jsonStr);
this.mockMvc.perform(requestBuilder).andExpect(status().isOk()).andExpect(MockMvcResultMatchers.content().string("{}"));
}
}
四、对service进行测试(测试Service和测试Controller类似,同样采用隔离法)
@RunWith(SpringRunner.class)
@SpringBootTest
public class ServiceTest {
@MockBean
private ModelMonitorMapper modelMonitorMapper;
@Autowired
private IModelMonitorService modelServiceServiceImpl;
@Test
public void testModelServiceServiceImpl(){
given(modelMonitorMapper.insert(anyObject()))
.willReturn(0);
int n = modelServiceServiceImpl.insert(new ModelMonitor());
assertThat(n).isEqualTo(0);
}
}
五、对Dao进行测试
测试的时候为了防止引入脏数据使用注解@Transactional和@Rollback在测试完成后进行回滚。
@RunWith(SpringRunner.class)
@SpringBootTest
@Transactional
public class ScoreControllerTestNew {
@Autowired
private ModelMonitorMapper modelMonitorMapper;
@Test
@Rollback
public void testDao() throws Exception {
ModelMonitor modelMonitor = new ModelMonitor();
modelMonitor.setModelProductId(Long.parseLong("5"));
modelMonitor.setLogit(21.144779999999997);
modelMonitor.setDerivedVariables("{\"debit_account_balance_code\":1.0,\"credit_consume_count\":1.0,\"debit_start_age\":1.0,\"debit_consume_sum_code\":1.0,\"age\":1.0}");
modelMonitor.setScore("300");
modelMonitor.setSrcData("{\"data\":{\"debit_account_balance_code\":40,\"credit_consume_count\":1,\"debit_start_age\":1,\"debit_consume_sum_code\":2,\"age\":38},\"modelProductId\":5}");
int n = modelMonitorMapper.insert(modelMonitor);
assertThat(n).as("检查数据是否成功插入").isEqualTo(0);
}
}
注意:
对于所有的单元测试,在项目打包的时候会自动执行
希望打包的时候跳过单元测试:
mvn clean package -D maven.test.skip=true