什么是单元测试
维基百科中是这样描述的:在计算机编程中,单元测试又称为模块测试,是针对程序模块来进行正确性检验的测试工作。程序单元是应用的最小可测试部件。在过程化编程中,一个单元就是单个程序、函数、过程等;对于面向对象编程,最小单元就是方法,包括基类、抽象类、或者派生类中的方法。
单元测试和集成测试的区别
回到测试的本质来看,测试工作就是模拟真实环境,在代码正式上线前进行验证的工作,即使没有任何工具和方法,这项工作也能够通过人工操作来手动完成。但这种方式显然不符合软件从业者的习惯,于是开始出现了各种各样的自动化测试方法,框架和工具。单元测试和集成测试使用的测试框架和工具大部分是相同的,而社区中对集成测试的介绍不尽相同,导致很多看过不同文章的同学对这两种测试的认知存在争议。首先需要达成一致的是,无论是单元测试还是集成测试,它们都是自动化测试。为了更好地区分,我们可以这样理解:和生产代码以及单元测试代码在同一个代码仓库中,由开发同学自己编写的,对外部环境(数据库、文件系统、外部系统、消息队列等)有真实调用的测试就是集成测试。下表中也从各种角度来对比了单元测试、集成测试和系统级别测试(包括端到端测试、链路测试、自动化回归测试、UI测试等)的区别。
实例:
以下是一个简单的服务代码
@Servicepublic class UserService { /** 定义依赖对象 */ /** 用户DAO */ @Autowired private UserDAO userDAO; /** * 查询用户 * * @param companyId 公司标识 * @param startIndex 开始序号 * @param pageSize 分页大小 * @return 用户分页数据 */ public PageDataVO<UserVO> queryUser(Long companyId, Long startIndex, Integer pageSize) { //入参校验 if(ValidationUtil.validate(companyId)){ throw new InvalidRequestException(companyId, "Invalid company Id"); } // 查询用户数据 // 查询用户数据: 总共数量 Long totalSize = userDAO.countByCompany(companyId); // 查询接口数据: 数据列表 List<UserVO> dataList = null; if (NumberHelper.isPositive(totalSize)) { dataList = userDAO.queryByCompany(companyId, startIndex, pageSize); } // 返回分页数据 return new PageDataVO<>(totalSize, dataList); }}
单元测试
@RunWith(MockitoJUnitRunner.class)public class UserServiceTest { /** 定义静态常量 */ /** 资源路径 */ private static final String RESOURCE_PATH = "testUserService/"; /** 模拟依赖对象 */ /** 用户DAO */ @Mock private UserDAO userDAO; /** 定义测试对象 */ /** 用户服务 */ @InjectMocks private UserService userService; /** * 测试: 查询用户-无数据 */ @Test public void testQueryUser_Succeed_NoData() { // 模拟依赖方法 // 模拟依赖方法: userDAO.countByCompany Long companyId = 123L; Long startIndex = 90L; Integer pageSize = 10; Mockito.doReturn(0L).when(userDAO).countByCompany(companyId); // 调用测试方法 String path = RESOURCE_PATH + "testQueryUserWithoutData/"; PageDataVO<UserVO> pageData = userService.queryUser(companyId, startIndex, pageSize); String text = ResourceHelper.getResourceAsString(getClass(), path + "pageData.json"); Assert.assertEquals("分页数据不一致", text, JSON.toJSONString(pageData)); // 验证依赖方法 // 验证依赖方法: userDAO.countByCompany Mockito.verify(userDAO).countByCompany(companyId); // 验证依赖对象 Mockito.verifyNoMoreInteractions(userDAO); } /** * 测试: 查询用户-有数据 */ @Test public void testQueryUser_Succeed_WithData() { // 模拟依赖方法 String path = RESOURCE_PATH + "testQueryUserWithData/"; // 模拟依赖方法: userDAO.countByCompany Long companyId = 123L; Mockito.doReturn(91L).when(userDAO).countByCompany(companyId); // 模拟依赖方法: userDAO.queryByCompany Long startIndex = 90L; Integer pageSize = 10; String text = ResourceHelper.getResourceAsString(getClass(), path + "dataList.json"); List<UserVO> dataList = JSON.parseArray(text, UserVO.class); Mockito.doReturn(dataList).when(userDAO).queryByCompany(companyId, startIndex, pageSize); // 调用测试方法 PageDataVO<UserVO> pageData = userService.queryUser(companyId, startIndex, pageSize); text = ResourceHelper.getResourceAsString(getClass(), path + "pageData.json"); Assert.assertEquals("分页数据不一致", text, JSON.toJSONString(pageData)); // 验证依赖方法 // 验证依赖方法: userDAO.countByCompany Mockito.verify(userDAO).countByCompany(companyId); // 验证依赖方法: userDAO.queryByCompany Mockito.verify(userDAO).queryByCompany(companyId, startIndex, pageSize); // 验证依赖对象 Mockito.verifyNoMoreInteractions(userDAO); } @Test public void testQueryUser_Fail_WithBadInput() {}}// void 方法可以用Argument Captor 验证
单元测试带来的好处有:
单测成本低,速度快。
单测是最佳的、自动化的、可执行的文档。
测试的要诀是:测试你最担心出错的部分,这样你就能从测试工作中得到最大的利益,100%覆盖率的单测会逐渐消磨开发人员对测试的耐心和好感。
单测驱动设计,提升代码简洁度,确保安全重构,代码修改后,单测仍然能通过,能够增强开发者的信心。
快速反馈,更快的发现问题。
定位缺陷比集成测试更快更准确,降低修复成本。
单元测试开发规范
【强制】好的单元测试必须遵守AIR原则。说明:单元测试在线上运行时,感觉像空气(AIR)一样感觉不到,但在测试质量的保障上,却是非常关键的。好的单元测试宏观上来说,具有自动化、独立性、可重复执行的特点。
A:Automatic(自动化)
I:Independent(独立性)
R:Repeatable(可重复)
【强制】单元测试应该是全自动执行的,并且非交互式的。测试用例通常是被定期执行的,执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用System.out来进行人肉验证,必须使用assert来验证。
【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护,单元测试用例之间决不能互相调用,也不能依赖执行的先后次序。反例:method2需要依赖method1的执行,将执行结果做为method2的参数输入。
【强制】单元测试是可以重复执行的,不能受到外界环境的影响。说明:单元测试通常会被放到持续集成中,每次有代码check in时单元测试都会被执行。如果单测对外部环境(网络、服务、中间件等)有依赖,容易导致持续集成机制的不可用。正例:为了不受外界环境影响,要求设计代码时就把SUT的依赖改成注入,在测试时用spring 这样的DI框架注入一个本地(内存)实现或者Mock实现。
【强制】对于单元测试,要保证测试粒度足够小,有助于精确定位问题。单测粒度至多是类级别,一般是方法级别。说明:只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑,那是集成测试的领域。
【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。说明:新增代码及时补充单元测试,如果新增代码影响了原有单元测试,请及时修正。
【强制】单元测试代码必须写在如下工程目录:src/test/java,不允许写在业务代码目录下。说明:源码编译时会跳过此目录,而单元测试框架默认是扫描此目录。
【推荐】单元测试的基本目标:语句覆盖率达到70%;核心模块的语句覆盖率和分支覆盖率都要达到100%。说明:在工程规约>应用分层中提到的DAO层,Manager层,可重用度高的Service,都应该进行单元测试。
【推荐】编写单元测试代码遵守BCDE原则,以保证被测试模块的交付质量。
B:Border,边界值测试,包括循环边界、特殊取值、特殊时间点、数据顺序等。
C:Correct,正确的输入,并得到预期的结果。
D:Design,与设计文档相结合,来编写单元测试。
E:Error,强制错误信息输入(如:非法数据、异常流程、非业务允许输入等),并得到预期的结果。
【推荐】对于数据库相关的查询,更新,删除等操作,不能假设数据库里的数据是存在的,或者直接操作数据库把数据插入进去,请使用程序插入或者导入数据的方式来准备数据。反例:删除某一行数据的单元测试,在数据库中,先直接手动增加一行作为删除目标,但是这一行新增数据并不符合业务插入规则,导致测试结果异常。
【推荐】和数据库相关的单元测试,可以设定自动回滚机制,不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。正例:在企业智能事业部的内部单元测试中,使用ENTERPRISE_INTELLIGENCE_UNIT_TEST_的前缀来标识单元测试相关代码。
【推荐】对于不可测的代码在适当时机做必要的重构,使代码变得可测,避免为了达到测试要求而书写不规范测试代码。
【推荐】在设计评审阶段,开发人员需要和测试人员一起确定单元测试范围,单元测试最好覆盖所有测试用例(UC)。
【推荐】单元测试作为一种质量保障手段,在项目提测前完成单元测试,不建议项目发布后补充单元测试用例。
【参考】为了更方便地进行单元测试,业务代码应避免以下情况:
构造方法中做的事情过多。
存在过多的全局变量和静态方法。
存在过多的外部依赖。
存在过多的条件语句。说明:多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。
【参考】不要对单元测试存在如下误解:
那是测试同学干的事情。本文是开发规约,凡是本文出现的内容都是与开发同学强相关的。
单元测试代码是多余的。软件系统的整体功能是否正常,与各单元部件的测试正常与否是强相关的。
单元测试代码不需要维护。一年半载后,那么单元测试几乎处于废弃状态。
单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。