Spock測試框架

介紹

Spock是一個為groovy和java語言應用程序來測試和規(guī)范的框架。這個框架的突出點在于它美妙和高效表達規(guī)范的語言。得益于JUnit runner区赵，Spock能夠在大多數(shù)IDE、編譯工具、持續(xù)集成服務下工作页徐。Spock的靈感源于JUnit,jMock, RSpec, Groovy, Scala, Vulcans以及其他優(yōu)秀的框架形態(tài)。
PS：如果有使用dubbo的同學银萍，這里推薦一個dubbo-postman工具:dubbo-postman

基本概念描述

Spock要求具備基本的groovy和單元測試知識泞坦。如果是java程序員，則不需要對groovy感到陌生砖顷，因為會java基本就會使用groovy了贰锁。

Spock測試類的一般結(jié)構(gòu)

首先看一下測試模板方法的定義和JUnit的對比：


和JUnit對比

Spock基于Groovy,所以像寫java測試類一樣赃梧，需要先創(chuàng)建一個groovy文件。
在一個groovy文件里面的第一行：import spock.lang.*,同時這個類需要繼承Specification豌熄。
舉例:

class MyFirstSpecification extends Specification {
  // 變量字段
  // 測試模板方法
  // 測試方法
  // 測試幫助方法
}

Spock的模板方法說明：

def setupSpec() {}    // runs once -  before the first feature method
def setup() {}        // runs before every feature method
def cleanup() {}      // runs after every feature method
def cleanupSpec() {}  // runs once -  after the last feature method

定義變量：

def obj = new ClassUnderSpecification()
def coll = new Collaborator()

定義測試方法：

def "pushing an element on the stack"() {
  // 測試代碼塊授嘀，最重要的地方
}

代碼塊結(jié)構(gòu)和測試各個概念階段的映射：


測試代碼塊各階段映射

代碼塊結(jié)構(gòu)在def定義的方法內(nèi)容里面：

given:
def stack = new Stack()
def elem = "push me"

when:   // 執(zhí)行需要測試的代碼
then:   // 驗證執(zhí)行結(jié)果

條件判斷：

when:
stack.push(elem)

then:
!stack.empty
stack.size() == 1
stack.peek() == elem

條件不滿足的情況輸出結(jié)果舉例:

Condition not satisfied:

stack.size() == 2
|     |      |
|     1      false
[push me]

驗證拋出異常舉例：

when:
stack.pop()

then:
thrown(EmptyStackException)
stack.empty

訪問異常內(nèi)容：

when:
stack.pop()

then:
def e = thrown(EmptyStackException)
e.cause == null

驗證不會拋出異常舉例：

//hashmap允許null的key
def "HashMap accepts null key"() {
  given:
  def map = new HashMap()

  when:
  map.put(null, "elem")

  then:
  notThrown(NullPointerException)
}

基于測試的交互，通過mock構(gòu)造依賴的外部對象

def "events are published to all subscribers"() {
  given:
  def subscriber1 = Mock(Subscriber)//通過Mock構(gòu)造一個依賴的對象
  def subscriber2 = Mock(Subscriber)
  def publisher = new Publisher()
  publisher.add(subscriber1)
  publisher.add(subscriber2)

  when:
  publisher.fire("event")

  then:
  1 * subscriber1.receive("event")//驗證方法名為receive锣险，以及參數(shù)"event"為的方法執(zhí)行一次
  1 * subscriber2.receive("event")
}

expect代碼塊：

expect:
Math.max(1, 2) == 2

cleanup代碼塊

given:
def file = new File("/some/path")
file.createNewFile()

// ...

cleanup:
file.delete()

where代碼塊蹄皱，可能是Spock最厲害的地方了：

def "computing the maximum of two numbers"() {
  expect:
  Math.max(a, b) == c

  where:
  a << [5, 3]//執(zhí)行兩次測試，值依次為5芯肤，3巷折，下面類似
  b << [1, 9]
  c << [5, 9]
}

測試的時候幫助方法的處理：

def "offered PC matches preferred configuration"() {
  when:
  def pc = shop.buyPc()

  then:
  pc.vendor == "Sunny"
  pc.clockRate >= 2333
  pc.ram >= 4096
  pc.os == "Linux"
}

額外定義一個幫助方法：

def "offered PC matches preferred configuration"() {
  when:
  def pc = shop.buyPc()

  then:
  matchesPreferredConfiguration(pc)
}

def matchesPreferredConfiguration(pc) {
  pc.vendor == "Sunny"
  && pc.clockRate >= 2333
  && pc.ram >= 4096
  && pc.os == "Linux"
}

輸出結(jié)果，結(jié)果沒有顯示具體的哪個判斷失敗了：

Condition not satisfied:

matchesPreferredConfiguration(pc)
|                             |
false                         ...

使用assert可以達到這個目的：

void matchesPreferredConfiguration(pc) {
  assert pc.vendor == "Sunny"
  assert pc.clockRate >= 2333
  assert pc.ram >= 4096
  assert pc.os == "Linux"
}

最終輸出結(jié)果崖咨，可以看到具體的錯誤條件：

Condition not satisfied:

assert pc.clockRate >= 2333
       |  |         |
       |  1666      false
       ...

在預期值斷言的時候使用with：

def "offered PC matches preferred configuration"() {
  when:
  def pc = shop.buyPc()

  then:
  with(pc) {
    vendor == "Sunny"
    clockRate >= 2333
    ram >= 406
    os == "Linux"
  }
}

使用mock對象的時候也可以用with：

def service = Mock(Service) // has start(), stop(), and doWork() methods
def app = new Application(service) // controls the lifecycle of the service

when:
app.run()

then:
with(service) {
  1 * start()
  1 * doWork()
  1 * stop()
}

當多個預期值一起斷言的時候使用verifyAll :

def "offered PC matches preferred configuration"() {
  when:
  def pc = shop.buyPc()

  then:
  verifyAll(pc) {
    vendor == "Sunny"
    clockRate >= 2333
    ram >= 406
    os == "Linux"
  }
}

在沒有對象參數(shù)的時候也可以這樣：

expect:
  verifyAll {
    2 == 2
    4 == 4
  }

文檔規(guī)范：

given: "open a database connection"
// code goes here

and可以增加多個使代碼根據(jù)可讀性：

given: "open a database connection"
// code goes here

and: "seed the customer table"
// code goes here

and: "seed the product table"
// code goes here

測試行為規(guī)范的一般模式：
給定條件....
當怎么樣的時候...
應該怎樣

given: "an empty bank account"
// ...
when: "the account is credited $10"
// ...

then: "the account's balance is $10"
// ...

擴展注解：
@Timeout 設置方法執(zhí)行的時間
@Ignore 跳過這個測試方法和JUnit類似
@IgnoreRest 跳過其他所有的測試方法锻拘，只執(zhí)行這個測試方法

數(shù)據(jù)驅(qū)動測試

在where里面可以通過數(shù)據(jù)表格，數(shù)據(jù)管道击蹲，指定變量三種情況對不同的測試case進行賦值署拟，特別是在當需要測試很多種情況的的時候，這個模式具有非常高的可讀性和簡潔性：

...
where:
a | _
3 | _
7 | _
0 | _

b << [5, 0, 0]

c = a > b ? a : b

基于測試的交互

場景如下歌豺，一個發(fā)送者向多個訂閱者發(fā)送消息

class PublisherSpec extends Specification {
  Publisher publisher = new Publisher()
  Subscriber subscriber = Mock()
  Subscriber subscriber2 = Mock()

  def setup() {
    publisher.subscribers << subscriber // << is a Groovy shorthand for List.add()
    publisher.subscribers << subscriber2
  }

期待執(zhí)行一次接收方法：

def "should send messages to all subscribers"() {
  when:
  publisher.send("hello")

  then:
  1 * subscriber.receive("hello")
  1 * subscriber2.receive("hello")
}

斷言表達式解釋：

1 * subscriber.receive("hello")
|   |          |       |
|   |          |       關聯(lián)參數(shù)
|   |          關聯(lián)目標方法
|   關聯(lián)目標對象
執(zhí)行次數(shù)

在mock創(chuàng)建的時候可以定義多個交互行為：

class MySpec extends Specification {
    Subscriber subscriber = Mock {
        1 * receive("hello")
        1 * receive("goodbye")
    }
}

一個測試代碼的多個交互通過when區(qū)分：

when:
publisher.send("message1")

then:
1 * subscriber.receive("message1")

when:
publisher.send("message2")

then:
1 * subscriber.receive("message2")

結(jié)果輸出：

Too many invocations for:

2 * subscriber.receive(_) (3 invocations)
打樁：

很多時候我們測試的時候不需要執(zhí)行真正的方法推穷，因為在測試代碼里面構(gòu)建一個真實的對象是比較麻煩的，特別是使用一些依賴注入框架的時候类咧，因此有了打樁的功能：

interface Subscriber {
    String receive(String message)
}

模擬返回值：

subscriber.receive(_) >> "ok"

表達式解釋：

subscriber.receive(_) >> "ok"
|          |       |     |
|          |       |     任何參數(shù)的這個方法調(diào)用都會返回"ok"
|          |       argument constraint
|          method constraint
target constraint

需要調(diào)用多次返回不同結(jié)果的時候可以這樣定義：

subscriber.receive(_) >>> ["ok", "error", "error", "ok"]

有時候我們測試的一個方法調(diào)用了類的其他方法馒铃，而其他的方法可能依賴了外部的對象，為了避免引入外部對象痕惋，可以使用部分mock功能減少構(gòu)建外部對象的繁瑣：

// this is now the object under specification, not a collaborator
MessagePersister persister = Spy {
  // 這個方法的任意參數(shù)調(diào)用都返回true
  isPersistable(_) >> true
}

when:
persister.receive("msg")

then:
// when里面的receive會調(diào)用persist区宇，前提是isPersistable是true，因為mock的值是true血巍，這個方法一定會被調(diào)用
1 * persister.persist("msg")

和springboot集成

spring本身提供了spring-test測試模塊萧锉，需要和Spock一起使用的話，只需要在Specification類上面加上SpringApplicationConfiguration這個注解就可以了述寡，如果是mvc應用還需加上WebAppConfiguration這個柿隙，其他的使用和原來一樣。

maven配置

在pom.xml里面添加

<!-- Spock依賴 -->
    <dependency>
      <groupId>org.spockframework</groupId>
      <artifactId>spock-core</artifactId>
      <version>1.2-groovy-2.4</version>
      <scope>test</scope>
    </dependency>
    <!-- Spock需要的groovy依賴 -->
    <dependency> 
      <groupId>org.codehaus.groovy</groupId>
      <artifactId>groovy-all</artifactId>
      <version>2.4.15</version>
    </dependency>

<!--...... -->
<!--編譯插件配置： -->
 <plugin>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>2.20.1</version>
        <configuration>
          <useFile>false</useFile>
          <includes>
            <include>**/*Test.java</include><!--指定JUnit的測試類名稱后綴-->
            <include>**/*Spec.java</include><!--指定Spock的測試類名稱后綴-->
          </includes>
        </configuration>
      </plugin>

總結(jié)

Spock整體上是一個規(guī)范描述型的測試框架鲫凶，測試代碼非常易讀禀崖。對于java程序員，上手非常容易螟炫，在學習的時候可以先在一個項目上使用波附，當你發(fā)下它的優(yōu)點的時候，你會盡可能的把其他的測試代碼也改成用Spock來寫，這個過程可能會花費你更多的時間掸屡，但是當你熟悉了以后封寞，它帶給你的收益一定是值得的。不要猶豫仅财，學習新框架最快的方式就是馬上動手狈究。

參考鏈接

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市盏求，隨后出現(xiàn)的幾起案子抖锥，更是在濱河造成了極大的恐慌，老刑警劉巖碎罚，帶你破解...
    沈念sama閱讀 218,755評論 6贊 507
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件磅废，死亡現(xiàn)場離奇詭異，居然都是意外死亡荆烈，警方通過查閱死者的電腦和手機拯勉，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3贊 395
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來耙考，“玉大人谜喊，你說我怎么就攤上這事潭兽【胧迹” “怎么了？”我有些...
    開封第一講書人閱讀 165,138評論 0贊 355
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵山卦，是天一觀的道長鞋邑。 經(jīng)常有香客問我，道長账蓉，這世上最難降的妖魔是什么枚碗？ 我笑而不...
    開封第一講書人閱讀 58,791評論 1贊 295
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮铸本，結(jié)果婚禮上肮雨，老公的妹妹穿的比我還像新娘。我一直安慰自己箱玷，他們只是感情好怨规，可當我...
    茶點故事閱讀 67,794評論 6贊 392
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著锡足，像睡著了一般波丰。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上舶得，一...
    開封第一講書人閱讀 51,631評論 1贊 305
  • 城市分裂傳說
    那天掰烟，我揣著相機與錄音，去河邊找鬼。 笑死纫骑，一個胖子當著我的面吹牛蝎亚，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播先馆，決...
    沈念sama閱讀 40,362評論 3贊 418
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼颖对，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了磨隘？” 一聲冷哼從身側(cè)響起缤底，我...
    開封第一講書人閱讀 39,264評論 0贊 276
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎番捂，沒想到半個月后个唧，有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 45,724評論 1贊 315
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡设预，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3贊 336
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年徙歼，在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片鳖枕。...
    茶點故事閱讀 40,040評論 1贊 350
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡魄梯，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出宾符，到底是詐尸還是另有隱情酿秸，我是刑警寧澤，帶...
    沈念sama閱讀 35,742評論 5贊 346
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布魏烫，位于F島的核電站辣苏，受9級特大地震影響，放射性物質(zhì)發(fā)生泄漏哄褒。R本人自食惡果不足惜稀蟋，卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3贊 330
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望呐赡。 院中可真熱鬧退客，春花似錦、人聲如沸链嘀。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0贊 22
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽管闷。三九已至粥脚，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間包个，已是汗流浹背刷允。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1贊 270
  • 情欲美人皮
    我被黑心中介騙來泰國打工冤留， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人树灶。 一個月前我還...
    沈念sama閱讀 48,247評論 3贊 371
  • 代替公主和親
    正文 我出身青樓纤怒，卻偏偏與公主長得像，于是被迫代替她去往敵國和親天通。 傳聞我的和親對象是個殘疾皇子泊窘，可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2贊 355