用Ruby實現(xiàn)一個單元測試框架的教程

在去年的YOW Melbourne開發(fā)者大會上，我參加了一些研習班。這些研習班由@coreyhaines和 @rains負責，因此TDD（測試驅(qū)動開發(fā)）成為了主要討論的內(nèi)容。通常這不是一個問題，但是令人沮喪的是（考慮到這是2010年舉辦的開發(fā)者大會），那時上網(wǎng)還不是很方便，我剛裝上linux的筆記本無法下載Rspec。幸運的是幾周前，我決定自己寫一個單元測試框架（因為我有這個能力:)），接著我就有了一個可用的測試框架，問題解決了。但是，這讓我想到一個問題，最少可以用多少代碼寫成一個可用的單元測試框架？

一個最小可用的單元測試

剛開始寫一個單元測試框架的時候代碼是很少的，但當我想給它加入一些特性時就變得沒有那么精煉了:) 幸運的是重寫是很容易的。我們真正需要做的是執(zhí)行下面的代碼：
 

describe "some test" do
 it "should be true" do
  true.should == true
 end
 
 it "should show that an expression can be true" do
  (5 == 5).should == true
 end
 
 it "should be failing deliberately" do
  5.should == 6
 end
end

正如你看到的，它很像是一個基本的Rspec測試。讓我們寫一些代碼來執(zhí)行它。

譯注：RSpec 工具是一個 Ruby 軟件包，可以用它構(gòu)建有關(guān)您的軟件的規(guī)范。該規(guī)范實際上是一個描述系統(tǒng)行為的測試。

構(gòu)建一個簡單的框架

首先要做的是使用“describe”來定義一個新的測試。既然我們想要把”describe” block放在任何地方（例如，文件本身），我們需要對Ruby做一點擴展?！皃uts”函數(shù)在Kernel block中，因此可以在任何地方使用（因為Object類包含了Kernel并且Ruby中的每個對象都繼承自Object類），同樣的我們會把describe放到Kernel block中以賦予同樣的能力）：
 

module Kernel
 def describe(description, block)
  tests = Dsl.new.parse(description, block)
  tests.execute
 end
end

譯注：Ruby block：Ruby語言的block功能類似回調(diào)函數(shù)。

正如你看到的，”describe”接收一個用來描述測試的字符串和包含了測試代碼的block。在這里，我們將測試的代碼和”describe”分開講解（例如，”it” block）。因此我們創(chuàng)建了Dsl類，用它的parse函數(shù)處理待測試的block，結(jié)果會產(chǎn)生一個可以執(zhí)行我們所有測試的對象，但是不要高興得太早。Dsl類看上去是這樣的：

class Dsl
 def initialize
  @tests = {}
 end
 def parse(description, block)
  self.instance_eval(block)
  Executor.new(description, @tests)
 end
 def it(description, block)
  @tests[description] = block
 end
end

這里要做的是在Dsl對象的上下文里對block求值：
 

self.instance_eval(block)

我們的Dsl對象有一個”it”函數(shù)，同樣也接收一個描述和一個block，這里和describe block包含的內(nèi)容完全一致，一切都運行得很好（例如，我們基本上會在幾個函數(shù)調(diào)用時使用”it”函數(shù)，每次都傳入一個描述和一個block）。我們還可以在Dsl對象中定義其他的函數(shù)，并且這些函數(shù)會成為允許在”describe” block中使用的“語言”的一部分）。

在describe block中，”it”函數(shù)會為每個”it” block調(diào)用一次。每次調(diào)用時，會把輸入的block以測試描述作為鍵值存儲在哈希表中。完成這些以后，我們只要創(chuàng)建一個Executor對象，可以對我們所有的測試block進行迭代，調(diào)用它們并產(chǎn)生執(zhí)行結(jié)果。Executor代碼如下：
 

class Executor
 def initialize(description, tests)
  @description = description
  @tests = tests
  @success_count = 0
  @failure_count = 0
 end
 def execute
  puts "#{@description}"
  @tests.each_pair do |name, block|
   print " - #{name}"
   result = self.instance_eval(block)
   result ? @success_count += 1 : @failure_count += 1
   puts result ? " SUCCESS" : " FAILURE"
  end
  summary
 end
 def summary
  puts "\n#{@tests.keys.size} tests, #{@success_count} success, #{@failure_count} failure"
 end
end

我們的executor代碼非常簡單。輸出”describe” block的描述，然后遍歷所有存儲的”it” block并且在executor對象中執(zhí)行它們。這么處理沒有什么特別原因，但這意味著executor對象同樣也可以包含其他函數(shù)，并且可以在”it” block中作為一種“語言”來使用（比如，我們dsl的一部分可以定義為executor的一個函數(shù)）。譬如，我們可以在executor上定義下列函數(shù)：
 

def should_be_five(x)
 5 == x
end

這個函數(shù)同樣可以在”it” block內(nèi)部使用，但對于我們這個簡單的測試沒有這個必要。

所以，”it” block會計算并存儲結(jié)果，通常結(jié)果只是”it” block最后一個語句的返回值（按照常規(guī)的Ruby）。這里，我們希望確保最后一個語句總是返回一個布爾值（標明測試通過或失?。ㄟ^它我們可以輸出一些有意義提示。

我們還差最后一步，”should”函數(shù)代碼如下：
 

true.should == true
5.should == 5

每個對象都應當提供自己”should”函數(shù)，代碼如下：
 

class Object
 def should
  self
 end
end

這個函數(shù)并沒有真正做什么工作（僅僅是返回對象本身）；它僅僅是一個讓測試讀起來更好的語法。

在這個階段，我們只是將測試計算的結(jié)構(gòu)轉(zhuǎn)換成一個字符串，表明測試結(jié)果通過或失敗并輸出。在這個過程中，我們會統(tǒng)計通過或失敗的測試數(shù)量，所以可以在最后給出一個總結(jié)報告。這就是我們所需要的所有的代碼，如果我們將他們放到一起，就是下面的44行代碼：

module Kernel
 def describe(description, block)
  tests = Dsl.new.parse(description, block)
  tests.execute
 end
end
class Object
 def should
  self
 end
end
class Dsl
 def initialize
  @tests = {}
 end
 def parse(description, block)
  self.instance_eval(block)
  Executor.new(description, @tests)
 end
 def it(description, block)
  @tests[description] = block
 end
end
class Executor
 def initialize(description, tests)
  @description = description
  @tests = tests
  @success_count = 0
  @failure_count = 0
 end
 def execute
  puts "#{@description}"
  @tests.each_pair do |name, block|
   print " - #{name}"
   result = self.instance_eval(block)
   result ? @success_count += 1 : @failure_count += 1
   puts result ? " SUCCESS" : " FAILURE"
  end
  summary
 end
 def summary
  puts "\n#{@tests.keys.size} tests, #{@success_count} success, #{@failure_count} failure"
 end
end

如果我們“需要”使用這個框架執(zhí)行最初的那個測試，我們會得到下面輸出結(jié)果：

    some test

    - should be true SUCCESS

    - should show that an expression can be true SUCCESS

    - should be failing deliberately FAILURE

    3 tests, 2 success, 1 failure

太好了！現(xiàn)在，如果你因沒有一個單元測試框架而煩惱并且不想莽撞地寫代碼，只要花上5分鐘你就可以得到一個能夠助你一臂之力的測試框架。當然，這里有一些略微夸大；你很快就會想到這里缺少額外的驗證API、更好的輸出、對象仿真和測試樁等等。然而，我們可以很容易的在精簡的框架上擴展其中的一些功能（例如，增加額外的DSL元素）——只消花費很小的努力。如果你不相信我，可以看看bacon ，它只用了幾百行代碼就完成了Rspec一個精簡版。我編寫的Attest測試框架是另一個很好的例子（這么說有自賣自夸的嫌疑:P）。這兩者都缺少任何內(nèi)建的test double 支持，我會在另外一個時間討論如何添加test double支持。

譯注：Test Double：在對象編程中“自動化單元測試”的專業(yè)術(shù)語，涵蓋的類型有Test Stub（測試樁）、Mock Object、Test Spy、Fake Object和Dummy Object。