mockcpp简单使用指引
mock工具介绍
mock工具的作用是指定函数的行为(模拟函数的行为)。可以对入参进行校验,对出参进行设定,还可以指定函数的返回值。
上面代码中带“/”或者“|”的表示在该位置可能有多种选择;带中括号的表示是可选的。
几个相关概念:
(1)mock规范:每个MOCKER(function)开始,跟一系列的.stubs、.with、.will等的内容的整体,称为一个mock规范。
(2)核心关键字:指stubs/defaults/expects/before/with/after/will/then/id等这些直接跟在点后面的关键字。
(3)扩展关键字:指once()/eq()/check()/returnValue()/repeat()等这些作为核心关键字参数的关键字。(AMOCK的follow在mockcpp中是check)
mockcpp的sample代码
一段简单的mockcpp使用sample代码:(带有完整核心关键字)TEST(mockcpp simple sample)
{
MOCKER(function) / MOCK_METHOD(mocker, method)
.stubs() / defaults() / expects(once())
[.before("some-mocker-id")]
[.with(eq(3))]
[.after("some-mocker-id")]
.will(returnValue(1)) / .will(repeat(1, 20))
[.then(returnValue(2))]
[.id("some-mocker-id")]
}
下面是一段比较详细的mockcpp使用sample代码:(带有完整扩展关键字)
TEST(mockcpp detail sample)
{
MOCKER(function) / MOCK_METHOD(mocker, method)
.stubs() / defaults() / expects(never() | once() | exactly(3) | atLeast(3) | atMost(3) )
[.before("some-mocker-id")]
[.with( any() | eq(3) | neq(3) | gt(3) | lt(3) | spy(var_out) | check(check_func)
| outBound(var_out) | outBoundP(var_out_addr, var_size) | mirror(var_in_addr, var_size)
| smirror(string) | contains(string) | startWith(string) | endWith(string) )]
[.after("some-mocker-id")]
.will( returnValue(1) | repeat(1, 20) | returnObjectList(r1, r2)
| invoke(func_stub) | ignoreReturnValue()
| increase(from, to) | increase(from) | throws(exception))
[.then(returnValue(2))]
[.id("some-mocker-id")]
}
注:
1、扩展关键字分类:
expects里面的叫匹配关键字(Matcher);
with里面的叫约束关键字(Constraint);
will/then里面的叫桩关键字(Stub)。
2、spy的作用是监视执行该被mock的函数function被调用时传入的值,会保存在var_out中,供用例中其它地方使用。
3、outBound的作用是设置函数function的出参的值。多半是把该值作为后面部分被测代码的输入。(注意与spy区别)
4、outBoundP,与outBound作用相同,只是用于数组的情况。
5、mirror的作用是对数组类型的入参进行检查。(outBoundP是设置出参的值,两者是不同的)
6、check的作用是进行定制化的入参检查,比如只检查结构体的部分成员。可以通过函数指针或者仿函数的方式指定,用仿函数还能预先保存一些值,非常方便。
7、check也能够用于设置出参的情况。
下面是结合上面sample的mockcpp使用说明
1、mock C函数用MOCKER;
mock 类成员方法先用MockObject mocker;声明一个mock对象,再用MOCK_METHOD(mocker, method)。
2、紧跟着MOCKER/MOCK_METHOD之后的是stubs、或者defaults、或者expects,三个必须有一个。(这是与AMOCK不同的地方,在这个层次上确定这三个关键字必须有一个,可以让mock语法更清晰)
stubs 表示指定函数的行为,不校验次数。
expects 与stubs的区别就是校验次数。(.expects(once()) / .expects(never()) / .expects(exactly(123)))
defaults 表示定义一个默认的mock规范,但它优先级很低;如果后面有stubs或者expects重新指定函数行为,就会按照新指定的来运行。
3、用will指定函数的返回值;
如果要指定20次调用都返回1,则用.will(repeat(1, 20));
要指定第一次返回1,第二次返回2,第三次返回3,就用
.will(returnValue(1))
.then(returnValue(2))
.then(returnValue(3))
如果你指定了前三次的返回值依次为1、2、3,那么第四次、第五次调用,都是返回最后的返回值3。
4、用id给一个mock规范指定一个名字,然后可以用after、before来指定多个mock应该的调用顺序。
注意before在with前,after在with后,id在整个mock规范的最后。
5、使用mockcpp时,校验是否按照mock规范进行调用的,应该用:
GlobalMockObject::verify();
verify之后,会自动执行reset。(如果是对象的mock,应该用mocker.verify(),同样也会自动reset。)
如果单单只想reset,也可以:(这很少见,难道前面你定义的mock规范都不想要了,也不校验?那为何要定义呢?)
GlobalMockObject::reset();