話說(shuō)昨日,健哥讓我分享下怎么用rspec寫模型的測(cè)試,頓時(shí)一臉懵逼,因?yàn)橹粫?huì)些拳腳貓功夫,趕緊百度谷歌相關(guān)知識(shí),七湊八湊,湊出來(lái)下面這篇總結(jié),參考過(guò)的文檔和博客如下(感興趣的可以去看看):
- rspec入門教程: http://www.lxweimin.com/p/1db9ee327357
- 1000 個(gè)小時(shí)學(xué)會(huì) Rails - 003 RSpec 行為驅(qū)動(dòng)測(cè)試簡(jiǎn)介: https://ruby-china.org/topics/2848
- RSpec 中 let 和 subject 的區(qū)別:https://ruby-china.org/topics/9271
- Ruby on Rails 自動(dòng)化測(cè)試: https://ihower.tw/rails4/testing.html
- let和before的區(qū)別: http://stackoverflow.com/questions/5974360/rspec-difference-between-let-and-before-block
Step1. 新建一個(gè)rails應(yīng)用
話不多說(shuō),讓我們創(chuàng)建一個(gè)rails 新應(yīng)用,從頭開始體驗(yàn)這一奇妙的旅程;
rails new demo
該應(yīng)用結(jié)構(gòu)如下:
可以看到,在rails中,默認(rèn)使用的測(cè)試工具是Test::Unit
,而不是Rspec
,怎么替換掉呢?
Step 2: 安裝 Rspec
在Rails的配置文件Gemfile配置文件中,配置下面信息
group :development, :test do
gem 'byebug', platform: :mri
gem 'rspec-rails', '3.5.1'
# gem 'factory_girl_rails', '4.7.0'
# gem 'faker', '1.6.6'
end
我們沒有必要單獨(dú)的安裝RSpec
, 因?yàn)樗莚spec-rails的依賴件會(huì)被自動(dòng)安裝, 執(zhí)行bundle install
或者bundle install --without production
來(lái)安裝使用的gem.
執(zhí)行安裝RSpec
的命令:
rails generate rspec:install
該命令執(zhí)行完畢之后,會(huì)產(chǎn)生一個(gè)文件夾spec,該文件夾下面有spec/spec_helper.rb
這個(gè)文件,spec_helper.rb
用來(lái)設(shè)置測(cè)試的配置信息.
下面是spec的固定的規(guī)范,固定的格式.
describe XXX do
it XXX do ......
end
end
包含了一個(gè) describe 塊以及其中的一個(gè)測(cè)試用例(sample),以 it "..." do 開頭的代碼塊就是一個(gè)用例.
可以看到,spec文件夾以及相關(guān)文件創(chuàng)建完成。
Step 3:創(chuàng)建模型和方法
既然我們要介紹模型測(cè)試的方法,那么讓我們創(chuàng)建一個(gè)模型: Girl(女孩,相信大家都比較喜歡),來(lái)做一個(gè)簡(jiǎn)單的測(cè)試演示:
rails generate model Girl
該命令創(chuàng)建的文件如下:
note:在spec/models/ 創(chuàng)建的 girl_spec.rb文件就是我們寫測(cè)試用例的地方(一般這種文件的后綴常用_spec)。
創(chuàng)建模型后, 執(zhí)行遷移命令:
bin/rake db:migrate
下面讓我們開始編寫模型方法:
既然是girl,大家肯定都關(guān)心其是否單身,是否漂亮。
如果單身的話,就代表自己有機(jī)會(huì)追到她,如果既單身又漂亮的話,一般就會(huì)符合我等屌絲的口味。
我們定義這兩個(gè)屬性,以及對(duì)應(yīng)的方法;
app/models/girl.rb 文件內(nèi)容如下:
class Girl < ApplicationRecord
attr_accessor :single, :beautiful
def initialize(params)
self.single = params[:single]
self.beautiful = params[:beautiful]
end
# 是否有機(jī)會(huì)
def have_chance?
self.single
end
# 是否符合你的口味
def suit_my_taste??
self.single && self.beautiful
end
end
Step 4: 編寫測(cè)試用例 并執(zhí)行
針對(duì)我們編寫的兩個(gè)模型方法,我們開始在girl_spec.rb文件中編寫相應(yīng)的測(cè)試:
以 it "..." do 開頭的代碼塊就是一個(gè)用例.
首先構(gòu)建一個(gè)單身,但不漂亮的女孩,來(lái)作為我們的測(cè)試數(shù)據(jù);
expect 語(yǔ)句 可以對(duì)返回的結(jié)果進(jìn)行期望值處理,滿足expect語(yǔ)句,即代表通過(guò)此測(cè)試用例;
require 'rails_helper'
RSpec.describe Girl, type: :model do
# 測(cè)試用例1
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 have_chance? 方法
it "have chance? {single but not beautiful}" do
params = { single: true, beautiful: false }
girl = Girl.new(params)
expect(girl.have_chance?).to eq(true)
end
end
rspec測(cè)試命令格式: ruby rspec file_path/file_name
運(yùn)行如下測(cè)試命令:運(yùn)行g(shù)irl_spec.rb文件中的所有測(cè)試用例
rspec spec/models/girl_spec.rb
運(yùn)行結(jié)果如下圖:
和
Test::Unit
一樣,用一個(gè)極富深意的點(diǎn),告訴我們測(cè)試通過(guò)!太棒了!這是我們寫的第一個(gè) RSpec
測(cè)試,歡呼!1 example, 0 failures 代表: 總共1個(gè)測(cè)試用例,有0個(gè)運(yùn)行失敗;
接下來(lái),書寫第2個(gè)測(cè)試用例-(測(cè)試該女孩是否符合你的口味)
在
girl_spec.rb
文件中,添加第2個(gè)測(cè)試用例:
require 'rails_helper'
RSpec.describe Girl, type: :model do
# 測(cè)試用例1
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 have_chance? 方法
it "have chance? {single but not beautiful}" do
params = { single: true, beautiful: false }
girl = Girl.new(params)
expect(girl.have_chance?).to eq(true)
end
# 測(cè)試用例2
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 suit_my_taste? 方法
it "suit my taste? {single but not beautiful}" do
params = { single: true, beautiful: false }
girl = Girl.new(params)
expect(girl.suit_my_taste?).to eq(true)
end
end
運(yùn)行如下測(cè)試命令:運(yùn)行g(shù)irl_spec.rb文件中的所有測(cè)試用例
rspec spec/models/girl_spec.rb
運(yùn)行結(jié)果如下圖:
如圖所示:首行返回了
.F
, "."代表第1個(gè)測(cè)試用例通過(guò),"F"第2個(gè)測(cè)試用例沒通過(guò)(False)在
Failures
(失敗詳情中 )可以看到:expected:true, got:false,(期望值true, 實(shí)際獲得false), 所以沒通過(guò)。
2 examples, 1 failure 代表: 總共2個(gè)測(cè)試用例,有1個(gè)運(yùn)行失敗;
解釋:很顯然,在我們expect語(yǔ)句中,期望值是true,實(shí)際上,該女孩單身,但不漂亮;
suit_my_taste?
方法 會(huì)返回false; 所以無(wú)法通過(guò)expect語(yǔ)句,則該測(cè)試用例會(huì)返回false,代表沒通過(guò)此測(cè)試用例;
接下來(lái),在第3個(gè)測(cè)試用例中,創(chuàng)建一個(gè) 既單身又漂亮的女孩 來(lái)測(cè)試 suit_my_taste?
方法 的返回結(jié)果;
require 'rails_helper'
RSpec.describe Girl, type: :model do
# 測(cè)試用例1
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 have_chance? 方法
it "have chance? {single but not beautiful}" do
params = { single: true, beautiful: false }
girl = Girl.new(params)
expect(girl.have_chance?).to eq(true)
end
# 測(cè)試用例2
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 suit_my_taste? 方法
it "suit my taste? {single but not beautiful}" do
params = { single: true, beautiful: false }
girl = Girl.new(params)
expect(girl.suit_my_taste?).to eq(true)
end
# 測(cè)試用例3
# 創(chuàng)建了一個(gè) 既單身又漂亮的 女孩, 來(lái)驗(yàn)證 suit_my_taste? 方法
it "suit my taste? {single but not beautiful}" do
params = { single: true, beautiful: true }
girl = Girl.new(params)
expect(girl.suit_my_taste?).to eq(true)
end
end
Tips 1:如果只想運(yùn)行g(shù)irl_spec.rb測(cè)試文件中的某一個(gè)測(cè)試用例,該怎么處理?
rspec 測(cè)試單個(gè)用例的命令格式: ruby rspec file_path/file_name:LineNumber
即:加上冒號(hào)和it語(yǔ)句塊對(duì)應(yīng)的行號(hào);
運(yùn)行如下測(cè)試命令:運(yùn)行g(shù)irl_spec.rb文件中的第3個(gè)測(cè)試用例:(第3個(gè)it ...do 對(duì)應(yīng)的行號(hào)為23)
rspec spec/models/girl_spec.rb:23
運(yùn)行結(jié)果如下圖:
解釋:"."代表 該測(cè)試用例通過(guò)。
Step 5: 優(yōu)化
Tip 2: 為了遵循Ruby
的 DRY原則(Don't repeat yourself), 下面介紹一下before,subject,let的用法;
1. before的用法
before(:each)會(huì)在每個(gè)測(cè)試用例執(zhí)行前, (每段it之前執(zhí)行)
before(:all) 會(huì)所有測(cè)試用例執(zhí)行前,只執(zhí)行一次,(整段describe前只執(zhí)行一次)
假設(shè)要為構(gòu)建出的不同實(shí)例對(duì)象,測(cè)試它們的每個(gè)模型方法,
在此,我選用before(:all)來(lái)優(yōu)化代碼:
require 'rails_helper'
RSpec.describe Girl, type: :model do
before(:all) do
params_1 = { single: true, beautiful: false }
params_2 = { single: true, beautiful: true }
@girl_1 = Girl.new(params_1)
@girl_2 = Girl.new(params_2)
end
########################################################
# 測(cè)試用例1-1
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 have_chance? 方法
it "have chance? {single but not beautiful}" do
expect(@girl_1.have_chance?).to eq(true)
end
# 測(cè)試用例1-2
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 suit_my_taste? 方法
it "suit my taste? {single but not beautiful}" do
expect(@girl_1.suit_my_taste?).to eq(true)
end
########################################################
# 測(cè)試用例2-1
# 創(chuàng)建了一個(gè) 單身 但不漂亮的 女孩, 來(lái)驗(yàn)證 have_chance? 方法
it "have chance? {single but not beautiful}" do
expect(@girl_2.have_chance?).to eq(true)
end
# 測(cè)試用例2-2
# 創(chuàng)建了一個(gè) 既單身又漂亮的 女孩, 來(lái)驗(yàn)證 suit_my_taste? 方法
it "suit my taste? {single but not beautiful}" do
expect(@girl_2.suit_my_taste?).to eq(true)
end
end
運(yùn)行如下測(cè)試命令:運(yùn)行g(shù)irl_spec.rb文件中的所有測(cè)試用例
rspec spec/models/girl_spec.rb
運(yùn)行結(jié)果如下圖:
解釋:".F.."代表第2個(gè)測(cè)試用例沒通過(guò),其他測(cè)試用例均通過(guò)。
2. subject用法
subject { ... } 定義了一個(gè)叫做 subject 的方法, 它返回了代碼塊內(nèi)定義的那個(gè)對(duì)象.
subject可以用來(lái)配合should進(jìn)行隱式調(diào)用,何為隱式調(diào)用?(見參考鏈接3,本文暫不講述)
如果你要使用主動(dòng)式的 expect,那么可以給subject起名字(非隱式調(diào)用):
在上述girl_spec.rb
文件中 添加如下代碼 也可行:
# 使用 subject
subject(:girl_1){ @girl_1 }
subject(:girl_2){ @girl_2 }
it "girl_1.have chance?" do
expect(girl_1.have_chance?).to eq(true)
end
it "girl_1.suit my taste?" do
expect(girl_1.suit_my_taste?).to eq(true)
end
it "girl_2.have chance?" do
expect(girl_2.have_chance?).to eq(true)
end
it "girl_2.suit my taste?" do
expect(girl_2.suit_my_taste?).to eq(true)
end
3. let的用法
let和before 有區(qū)別,詳見參考鏈接5
在上述girl_spec.rb 文件中 添加如下代碼 也可行:
# 使用let
let(:girl1){ Girl.new({ single: true, beautiful: false }) }
let(:girl2){ Girl.new({ single: true, beautiful: true }) }
it "girl1.have chance?" do
expect(girl1.have_chance?).to eq(true)
end
it "girl1.suit my taste?" do
expect(girl1.suit_my_taste?).to eq(true)
end
it "girl2.have chance?" do
expect(girl2.have_chance?).to eq(true)
end
it "girl2.suit my taste?" do
expect(girl2.suit_my_taste?).to eq(true)
end
結(jié)語(yǔ)
是不是不過(guò)癮?大家是否也發(fā)現(xiàn),要對(duì)自己的模型方法進(jìn)行一個(gè)完善的測(cè)試,需要構(gòu)建合法的數(shù)據(jù),手動(dòng)構(gòu)建數(shù)據(jù)的量太少,無(wú)法滿足大量測(cè)試數(shù)據(jù)的需求,于是乎,工廠女孩(factory_girl
)就要出場(chǎng)了, 另外一個(gè)角色就是faker
(這個(gè)可不是LOL界的faker大魔王), 它能夠構(gòu)建類似真實(shí)的數(shù)據(jù),兩者結(jié)合,威力無(wú)窮,欲知后事如何,且聽下回分解...