望文生义,Groovy/Spock测试框架

单元测试重要不重要?大多数受访者会回答重要;单元测试好不好写?超过一半的受访者会回答不好写;单元测试这种重要却又不好写的设定恐怕会让不少人在使用它时分分钟想暴走。撇开高大上的测试思想、模式不谈,究竟有哪些实际的问题阻碍了我们去写好测试?是不是解决了这些问题就有可能让单元测试变成康庄大道,先让我大开脑洞帮大家分析分析。

Reason1:英文没学好

很多时候当你想好了要怎么实现,这里用一个模式,那里用一个框架的时候,却发现写不了测试,为啥?不知道自己要测的玩意怎么用英语来表达。想用套路却又无处安放——方法名怎么写啊,我该should个啥或者该test个啥啊,我只会简单的大学英语4级的简单句法,对,就那种主语(I/You/He/She/It)+动词(tell/make/use)+宾语+(well/success/fail)的啊。

尴尬

Reason2:框架套路深

Java开发者在单元测试时均会使用mockito或powermock,但mockito和powermock均包含了许多样本代码,导致测试代码变得冗长而难以维护。同时还得注意各种各样的步骤和规则,经常能看到由于误用测试套件而发生的“惨案”,如果没有“老司机”的指引解决问题的周期会变得遥遥无期,因为看着那些让人不好理解(见Reason1)的异常信息绝对让人生无可恋。

生无可恋

也许还能抢救一下

难道就不能整个句法简单(英语4级完全cover)、套路一般的测试框架?这个真可以有,使用Groovy/Spock就可以了。下面通过一个简单例子来展示Groovy/Spock框架,例子中将包含一个service类,负责处理User对象,以及一个数据访问层。

public class User {

    private int id;
    private String name;
    private int age;

    // Accessors omitted
}

接下来是DAO接口:

public interface UserDao {
    public User get(int id);
}

最后是service类:

public class UserService {

    private UserDao userDao;
    
    public UserService(UserDao userDao) {
        this.userDao = userDao;
    }
    
    public User findUser(int id){
        return null;
    }
}

采用Groovy/Spock针对UserService编写测试

class UserServiceTest extends Specification {

    UserService service
    UserDao dao = Mock(UserDao)

    def setup(){
      service = new UserService(dao)
    }

    def "it gets a user by id"(){
      given:
      def id = 1

      when:
      def result = service.findUser(id)

      then:
      1 * dao.get(id) >> new User(id:id, name:"James", age:27)
      result.id == 1
      result.name == "James"
      result.age == 27
    }
}

上述测试代码使用了groovy,这是一种非常类似Java的语言但是它的语法更加轻,例如它不用像Java语言那样,在每句结尾加上分号;它也不需要使用public修饰符,因为public是默认的。上述测试类继承自spock.lang.Specification,这是Spock基类,继承该基类后就可以使用given,when,then等代码块。关键的重点来了:

  • 在Spock中创建mock对象非常容易,只需要使用Mock(Class)这样的语句即可。如上所述,mock后的DAO对象被传入userService中。Setup方法会在每个测试方法运行前被执行。

  • Groovy的一个显著特点是可以使用字符串文本来命名方法,将这个特点应用在测试方法上就能使得测试方法可以更加容易被阅读和理解(妥妥标准英语4级水平句式)。

这福利如何?绝对是业界良心啊,一举解决两大困扰写好单元测试的难题还不额外增加负担,听着都觉得美,此外Groovy/Spock还有其他的一些好用的特色。

Given, when, then

Spock是一个BDD测试框架,因此对于Spock中涉及的given,when,then样式最简单的理解就是:

Given 给定一些条件,When 当执行一些操作时,Then 期望得到某个结果。如上述测试方法中Given,给定id=1,即测试的变量;而在When中则是被测试方法,如在上述代码中调用findUser();Then则是断言,即检查被测试方法的输出结果,Then的第一句语句虽然看上去可怕,但实际上却非常容易理解:

1 * dao.get(id) >> new User(id:id, name:"James", age:27)

该行表示了对于mock对象dao的期望值,即期望调用dao.get()方法1次,而“>>”是spock的特色,表示“then return”含义。因此该句翻译过来的意思是:期望调用1次dao.get()方法,当执行该方法后,请返回一个新的User对象。此外在构造方法中使用具名参数也是groovy的另一特点。Then中剩余的代码对result对象进行检查。

望文生义有木有,简单易懂的符号开发人员一看就明白,还不会产生歧义,并且Groovy/Spock还能做得更好:

  • 可以命名spock块,例如将given命名为“Some variables”,有助于开发者在测试代码中更加清楚的表达含义

  • 当对mock对象方法调用次数不关心时,可以使用_ * mock.method()

  • 在then块中可使用下划线来通配方法及类,例如,0 * mock._ 表示期望mock对象的任何方法都未被调用,或0 * . 表示期望任何对象的任何方法都未被调用

  • 通常按given,when,then编写测试,但实际上从when开始编写测试会更加容易发现测试需要的given和测试的输出结果(then)

  • expect块对于测试不需要对mock对象进行断言的简单方法更加有效

  • 当对于传递给mock对象的参数不关注时,可以使用通配符参数

结语

单元测试是为了协助开发者的,而不是起相反作用的,只有有效地降低开发者在单元测试上的成本,才能让单元测试真正地融入每个开发者的行动中,而Groovy/Spock在这方面提供了很多快捷方式来帮助开发者写出更加优雅的单元测试,逐步摆脱编程语言的语法束缚,利用纯粹的书写或口头表达方式,让单元测试成为真正的人人能懂的“望文生义”好代码,真正地成为产品代码的 living docs。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345