单元测试中mock的使用及mock神器jmockit实践
在最近的r应用的单元测试中,经常需要用到mock,可以说mock在ut (unit test)中是无处不在的。而在r的ut实践中也找到了一种很简洁的mock方式,不仅解决了ut中所有需要mock的地方,而且可以很少量的代码来完成mock。详见下文。
一.Mock的使用场景:
比如以下场景:
1. mock掉外部依赖的应用的HSF service的调用,比如uic,tp 的hsf服务依赖。
2. 对DAO层(访问mysql、oracle、tair、tfs等底层存储)的调用mock等。
3. 对系统间异步交互notify消息的mock。
4. 对method_A里面调用到的method_B 的mock 。
5. 对一些应用里面自己的 class(abstract, final, static),interface,annotation ,enum,native等的mock。
二. Mock工具的原理:
mock工具工作的原理大都如下:
1. record阶段:录制期望。也可以理解为数据准备阶段。创建依赖的class 或interface或method ,模拟返回的数据,及调用的次数等。
2. replay阶段:通过调用被测代码,执行测试。期间会invoke 到 第一阶段record的mock对象或方法。
3. verify阶段:验证。可以验证调用返回是否正确。及mock的方法调用次数,顺序等。
三. 当前的一些Mock工具的比较:
历史曾经或当前比较流行的Mock工具有EasyMock、jMock、Mockito、Unitils Mock、PowerMock、jmockit等工具。
他们的功能对比如下:
从这里可以看到,当前为什么jmockit为什么这么火爆了!所以我们的UT中的mock工具也选择了目前无所不能的jmockit。
而在使用的过程中,感觉到jmockit的 Auto-injection of mocks 及 Special fields for "any" argument matching 及各种有用的 Annotation 给测试代码精简和测试效率提升带来了实实在在的好处。
四. Jmockit的简介:
JMockit 是用以帮助开发人员编写测试程序的一组工具和API,它(https://code.google.com/p/jmockit/)完全基于 Java 5 SE 的 java.lang.instrument 包开发,内部使用 ASM 库来修改Java的Bytecode。正是由于基于instrument,可以修改字节码。所以这也是它强大的原因。
Jmockit可以mock的种类包含了:1.class(abstract, final, static) ;2.interface ;3.enum ;4.annotation ;5.native 。
Jmockit 有两种mock的方式:
1. Behavior-oriented(Expectations & Verifications) ;
2. State-oriented(MockUp<GenericType>) 。
通俗点讲,Behavior-oriented是基于行为的mock,对mock目标代码的行为进行模仿,更像黑盒测试。State-oriented 是基于状态的mock,是站在目标测试代码内部的。可以对传入的参数进行检查、匹配,才返回某些结果,类似白盒。而State-oriented的 new MockUp基本上可以mock任何代码或逻辑。非常强大。
以下是jmockit的APIs和tools:
可以看到jmockit常用的Expectation、NonStrictExpectations 期望录制 及Annotation @Tested、@Mocked,@NonStrict、@Injectable 等简洁的mock代码风格。而且jmockit 还自带了code coverage的工具供本地UT时候看逻辑覆盖或代码覆盖率使用。
五.Jmockit的实践:
第一步:添加jmockit的jar包依赖
在refund的单元测试过程中,第一步:应用pom中引入jmockit的jar包,可以顺带引入jmockit自带的code coverage的jar。
第二步:一个完整的Jmockit的示例:
这个是对refundmanager里面查询可退款金额范围 queryRefundFeeRange的单元测试。通过看被测代码可以看到这个方法的实现里面调用了
feeResultDO = confirmGoodsService.queryConfirmToSellerRefundFee(detailId);
这个外部的hsf依赖 获取了feeResultDO 。
这个hsf调用是需要mock的。
传统的mock或ut ,对 confirmGoodsService 这个bean是需要初始化,通过spring的配置,初始化加载等 一大堆代码。
jmockit通过了注解的方式:
@Injectable private ConfirmGoodsService confirmGoodsService ; |
一个Annotation就搞定了所有的配置,加载等问题。直接复用开发代码里面的bean,节省了大量的代码。
另外 @Tested RefundManagerImpl refundManagerImpl = new RefundManagerImpl();
这里也用到了注解 @Tested 表示被测试的class 。
另外还有常用的注解:@Mocked,@NonStrict等。
而这段代码就是mock的核心:录制被mock的method的行为及期望返回:
new Expectations(){ { confirmGoodsService.queryConfirmToSellerRefundFee(anyLong); result = feeResultDOmock; times = 1; } } ; |
其中
result 可以返回任意需要的测试类型;
times 表示期望被调用的次数。
是不是看起来非常简洁明了。
而上面该段代码如果 换成基于状态的mockup 代码如下:
采用MockUp的方式,可以mock任意的mock对象或方法,因为它直接改写了原method的实现逻辑,直接返回需要的数据。
这也是jmockit彪悍的地方之一。
最后数据回收,防止各个testcase的mock相互影响的方式:
Mockit.tearDownMocks();
这一步也可以省略。
还要重点介绍的就是mock期望里面的入参 any。
这个any系列的万能入参类型,也可以节省很多mock代码,可以高效的准备任何入参类型。
以上,一个最简单的,也最实用的jmockit的示例。
jmockit的更多,对interface及method的单元测试的示例,将在后续总结汇总。
六、 Jmockit自带的code coverage :
工程的 pom文件中引入 jmockit-coverage 后,本地eclipse启动单元测试后, 会自动统计单元测试的代码覆盖率。关于行覆盖,方法覆盖,类覆盖,分支逻辑覆盖等各种数据都可以看到。
IDE启动UT时候,加载 code coverage 组件,
点击进去,可以看到具体的覆盖逻辑:
其中绿色部分表示源代码被run过。
代码覆盖对指导单元测试的测试逻辑,覆盖等提供了直观的指示。
以上,就是在单元测试中mock技术的应用:Jmockit的使用介绍及实际应用示例。它在单元测试中确实可以很少的代码mock掉外部依赖,提高ut的效率,并且 自带的code coverage可很方便的看到ut对被测代码的覆盖效果,指导测试设计。