相信每个软件从业者都意识到测试在项目中重要性。“爱恨交织”足以形容我们和测试用例关系。爱它为我们发现的巨坑,恨它则因为绞尽脑汁构建测试场景。
毋庸置疑的是:测试用例是项目管理不可或缺部分。为了更好的服务项目,丰富而完整的测试用例是必要的。
在编写测试用例时,函数中调用的其它函数,或者引用外部资源。在不使用资源的情况下,我们想做到更好的测试,需要模拟外部函数的结果。今天的主角ScalaMock是便于我们模拟外部结果测试组件。
ScalaMock介绍
ScalaMock和JUnit, NUnit*测试框架不同,它没有提供底层的测试代码,而是基于两种测试框架之上(ScalaTest和Specs2)。它类似于给测试框架提供构建“假”的代码运行环境或者叫“桩”。为编写测试用例提供便捷语法糖,很甜很甜那种,哈哈。本文通过使用scalamock构造简单的测试场景,来展现其功能。
用例运行环境
一切没有预置前提的说明文档都必然是耍流氓,_
// Add the ScalaMock library (versions 4.0.0 onwards)
libraryDependencies += "org.scalamock" %% "scalamock" % "4.4.0" % Test
// also add ScalaTest as a framework to run the tests
//scala test inter scala mock sugar
libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.8" % Test</pre>
本文用例基于 scalmock 4.4.0和scalatest 3.0.8的版本。
ScalaMock的是与非
ScalaMock 运行基于 scalatest,我们编写的用例形式上要遵循scalatest的形式。从以下3个方面介绍scalamock.
- 匿名函数mock
- trait mock
- class mock
在介绍使用场景前,先看看scalamock语法样式。
- ScalaMock语法样式
//匿名函数格式: mockFunction,入参 string,int , 返回值String
val funcMock = mockFunction[String, Int, String]
// 格式 变量 expects()关键字+ returning关键字 + 返回值("wayne mock") + 附加属性(once()只执行一次)
funcMock expects("hello world", 18) returning "wayne mock" once() //once
//样式含义是:当输入期望特定的输入时,返回returning 值。
基于函数的Mock
函数mock关键字是:mockFunction
.
- 匿名函数mock
//定义函数mock
val funcMock = mockFunction[String, Int, String]
funcMock expects("hello world", 18) returning "function mock" atLeastOnce() //call at least once
//调用
println(funcMock("hello world", 18)) //输出: function mock </pre>
atLeastOnce()
使用scalamock 时,设置属性表示mock的内容被调用的次数。
匿名函数mock使用频率不高,更多使用trait
class
方式进行mock。下文有匿名函数进行mock的使用场景。
基于trait
的mock
trait
进行mock操作关键字是:mock
.
源码如下:
trait MyMockTest {
def funcOnePara(name: String): String = { //一个参数
name
}
def funcTwoPara(name: String, age:Int): String = name //2个参数
def funcNoArgs: String = "func no args" //无参数函数
val valPara="variable param"
}
-
mock trait 示例
- mock
trait
无参数示例
- mock
val my = mock[MyMockTest]
(my.funcNoArgs _ ).expects().returning("no args") //mock funcNoArgs返回no args
my.funcNoArgs shouldBe("no args")//scala test 结果比较
定义了my
变量之后,就可以对trait
内所有的函数进行mock操作了。其它没有mock的函数不影响。
trait TraitExtend extends MyMockTest
val my = mock[TraitExtend]
println(my.funNoArgs) //输出func no args
-
trait
有参调用mock
trait 有参数mock编写方式有两种,仅仅是写法上差异,本质上没有差别
- 根据参数类型进行mock
//使用指定 参数类型的方式,mock 有参函数
(my.funcOnePara(_:String)).expects("wayne") returning("one para")
println(my.funcOnePara("wayne"))
- 根据匿名函数,使用类型推导方式 mock
//使用指定 匿名函数的方式,利用依赖函数推导,mock 有参函数
(my.funcOnePara _ :String => String).expects("wayne") returning("one para")
println(my.funcOnePara("wayne"))
-
val/var
变量不支持mock
我们无法在外部使用其它val变量时,模拟伪装其结果。 只能通过其它方式,见后文。
基于class
的mock
编写测试用例时,我们遇见更多场景是函数中调用其它类函数,或者引用外部资源。在不使用资源的情况下,做到更好的测试,我们需要对外部函数进行mock操作。基于class进行mock是更普适使用场景。
class
进行mock操作关键字是:mock
.
//源码示例
class MyMockClass {
var age: Int = 0
def funcMock = ""
}
class
的构成和trait
构成类似,因此mock的方式也是一致的。类中函数模拟示例,和trait没有任何区别。
//mock class without param
val t = mock[MyMockClass]
(t.funcMock _ ) expects() returning("mock class function")
println(t.funcMock)
值得关注的是:不论mock那种类型,都是对该类型进行操作。只影响指定输入和返回值的函数,对其它没有影响
基于case class
的mock
样例类在scala中是特殊的存在,即作为数据的承载者,有具备处理能力。我们采用投机的版本进行mock,你们函数的mock。定义样例类Person
进行mock测试。示例如下:
case class Person(age:Int, address:String)
//case class mock 一个变量或者函数 没有mock必要
val caseMock = mockFunction[Unit,Person]
(caseMock).expects().returning(Person(age= 12))
println(caseMock().age)
我们看到给Person
mock的方法是采用我们上文提到的匿名函数。
ScalaMock其它支持特性
支持重载方法的重载
支持java的类和接口
支持边界测试,即给出边界值,抛出异常
支持统计函数调用次数,和函数调用次数类似
支持对返回值类型排序
支持在多线程环境进行mock
ScalaMock 力所不及
如果看到scalaMock的实现原理,我们会发现我们常用的 单例对象、有参数class都不能进行mock操作。
下面列举下scalamock
不支持的特征
不支持 final/private等关键字mock
-
不支持单例object对象 mock
注:一个可支持mock的方法是:把单例对象修改成
trait
对象,或者把调用单例对象封装到实现调用类中,通过mock方法形式达到mock 单例对象的目的,曲线“救国”吧。
以上叙述scalamock用法,由于其内在的约束,要想用好scalamock,既要了解用法,更重要的是编码的合理性。工具有优越性建立在优秀的代码之上。
下一篇,介绍scala的其它mock组件。