rails-rspec

一、為什么需要測(cè)試:

測(cè)試對(duì)于程序來(lái)說(shuō)堰酿,不是必不必要的問題疾宏,而是怎么測(cè)的問題。就算不寫測(cè)試触创,你一樣在人肉測(cè)試坎藐。只不過人肉測(cè)試效率太低,出錯(cuò)率也高哼绑,對(duì)于中等和以上規(guī)模的程序岩馍,需要寫測(cè)試來(lái)代替人肉測(cè)試,以減輕工作強(qiáng)度罷了抖韩。

功能和代碼不斷的擴(kuò)充蛀恩,不斷重構(gòu)和優(yōu)化,這個(gè)過程中茂浮,沒有好的測(cè)試双谆,基本就掉入修bug泥潭了壳咕。有話說(shuō)改一個(gè)bug帶來(lái)3個(gè)bug,自動(dòng)測(cè)試一定程度上可以減輕這個(gè)狀況顽馋〈丫總之,邏輯簡(jiǎn)單趣避,或者寫完沒有更改的必要,類似這種代碼人肉測(cè)測(cè)也無(wú)可厚非新翎,邏輯稍微復(fù)雜的程帕,以后更改的可能性存在的, 那么自動(dòng)測(cè)試毫無(wú)疑問是必要的。

二地啰、安裝

在Gemfile配置文件中愁拭,配置如下信息

group :test do
  gem 'rspec-rails', '~> 3.7'
end

執(zhí)行bundle install來(lái)安裝這個(gè)gem,此gem依賴gem rspec亏吝,所以不用單獨(dú)安裝rspec岭埠。
然后執(zhí)行 rails generate rspec:install生成rspec相關(guān)文件,會(huì)生成以下三個(gè)文件

.rspec
spec/spec_helper.rb
spec/rails_helper.rb

運(yùn)行rspec命令執(zhí)行測(cè)試
bundle exec rspecbundle exec rake spec
此命令會(huì)執(zhí)行spec文件夾下的所有以_spec.rb結(jié)尾的文件蔚鸥。

三惜论、示例

下面是要測(cè)試的model文件

# models/app/user.rb
class App::User < ApplicationRecord
    def is_employee?
      self.app_user_type.to_i == 21
    end
end

我們要測(cè)試user.rb文件下的實(shí)例方法is_employee?,這個(gè)方法可能返回兩個(gè)值truefalse止喷,所以我們的測(cè)試要分兩種情況

#spec/models/app/user_spec.rb
require "rails_helper"
RSpec.describe App::User, :type => :model do
  describe '#is_employee?' do
    context "when app_user is employee" do
      it "should respond with true" do
        app_user = App::User.create!(true_name: '王先生', mobile: '13700000000', app_user_type: 1)
        expect(app_user.is_employee?).to eq(false)
      end
    end
    context "when app_user is not employee" do
      it "should respond with false" do
        app_user = App::User.create!(true_name: '王先生', mobile: '13700000000', app_user_type: 21)
        expect(app_user.is_employee?).to eq(true)
      end
    end
  end
end

(注釋:通常馆类,我們使用describe來(lái)描述方法。遵循ruby注釋規(guī)范弹谁,在方法名前使用點(diǎn)號(hào)‘.’或‘::’表示測(cè)試的是類方法乾巧,用“#”表示測(cè)試的是實(shí)例方法)

然后在控制臺(tái)執(zhí)行bundle exec rspec(或者只執(zhí)行某個(gè)文件rspec spec/models/app/user_spec.rb),在控制臺(tái)會(huì)看到下面的內(nèi)容:

表示執(zhí)行成功兩段測(cè)試预愤,0個(gè)失敗

如果失敗了是什么情況呢沟于?我們把第一段的eq(false)改成eq(true)看一下運(yùn)行結(jié)果:

錯(cuò)誤信息一目了然

四、數(shù)據(jù)準(zhǔn)備方法let

如果再添加user的其他實(shí)例方法植康,我需要在新的測(cè)試?yán)又性賱?chuàng)建一個(gè)app_user實(shí)例旷太,再測(cè)試的例子越來(lái)越多時(shí)會(huì)發(fā)現(xiàn)數(shù)據(jù)準(zhǔn)備占了大部分的代碼量。

# 這一段:
let(:app_user) { App::User.new }

# 基本上和這一段完全等同
def app_user
  @app_user ||= App::User.new
end

這時(shí)我們就需要用到let方法销睁,如下:

#spec/models/app/user_spec.rb
require "rails_helper"
RSpec.describe App::User, :type => :model do
  describe '#is_employee?' do
    let(:app_user) {App::User.create!(true_name: '王先生', mobile: '13700000000', app_user_type: 1)}
    let (:employee_user) {App::User.create!(true_name: '王先生', mobile: '13700000000', app_user_type: 21)}
    context "when app_user is employee"
        ...
    context "when app_user is not employee"
        ...
  end
end

其實(shí)還有一個(gè)方法before泳秀,可以這樣寫(但我們通常不用before)

describe '#is_employee?' do
   before { @app_user = App::User.create :app_user_type, :mobile, :true_name}
   it "should respond with false" do
        expect(@app_user.is_employee?).to eq(true)
   end
end

當(dāng)需要給一個(gè)變量賦值時(shí),使用 let 而不是before來(lái)創(chuàng)建這個(gè)實(shí)例變量榄攀。let采用了 lazy load 的機(jī)制嗜傅,只有在第一次用到的時(shí)候才會(huì)加載,然后就被緩存檩赢,直到測(cè)試結(jié)束吕嘀。

before(:each)會(huì)自動(dòng)初始化變量违寞。如果其中的某一個(gè)測(cè)試用力不需要這些變量,依然需要初始化偶房,如初始化變量需要很多時(shí)間趁曼,對(duì)這個(gè)測(cè)試的初始化會(huì)浪費(fèi)多余的時(shí)間和資源.

五、factory_bot

一個(gè)讓數(shù)據(jù)準(zhǔn)備更方便的工具

rails下安裝:gem "factory_bot_rails"

配置棕洋,在config/environments/test.rb下配置如下內(nèi)容:

RSpec.configure do |config|
  config.include FactoryBot::Syntax::Methods
end

在spec下創(chuàng)建一個(gè)factories文件夾挡闰,在這個(gè)文件夾下做FactoryBot數(shù)據(jù)相關(guān)的配置

比如上面提到的App::User的配置:

FactoryBot.define do
  # employee賬號(hào)
  factory :employee_user, class: 'App::User' do
    id 10360
    app_user_type 21
    true_name '吳先生'
    mobile 13700000000
  end
  # 非employee賬號(hào)
  factory :app_user, class: 'App::User' do
    id 10361
    app_user_type 3
    true_name '王先生'
    mobile 13700000000
  end
end

然后我們的測(cè)試就可以這樣寫:

describe '#is_employee?' do
    let (:app_user) {build(:app_user)}
    let (:employee_user) {build(:employee_user)}
    context "when app_user is employee" do
      it "should respond with true" do
        expect(app_user.is_employee?).to eq(false)
      end
    end
    context "when app_user is not employee" do
      it "should respond with false" do
        expect(employee_user.is_employee?).to eq(true)
      end
    end
end

在FactoryBot定義時(shí)我們可以只定義一個(gè)app_user,employee_user可以這樣生成:

let(:app_user) {  build(:app_user)  }
let(:employee_user) {  build(:app_user, app_user_type: 3)  }

build相當(dāng)于App::User.new, FactoryBot還有create等其他方法掰盘,具體方法參考https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md

六摄悯、模擬方法--mock
# models/app/user.rb
def type_name
    self.is_employee? ? '高級(jí)賬號(hào)' : '普通賬號(hào)'
end

如果self.is_employee?判斷很多,在測(cè)試type_name方法時(shí)我們不用過多的為is_employee?準(zhǔn)備數(shù)據(jù)愧捕,我們應(yīng)該只關(guān)注type_name方法的測(cè)試奢驯,這時(shí)候我們只需要這樣:

  app_user.should_receive(:is_employee?).and_return(true)
  expect(app_user.type_name).to eq('高級(jí)賬號(hào)')

通過mock方法,我們可以模擬某些值或方法次绘,在上面的方法中瘪阁,我們模擬方法is_employee?始終返回true。

FactoryGirl模擬真實(shí)的字段邮偎,mock可以模擬模型不存在的字段管跺,mock可以用來(lái)虛擬比較復(fù)雜的屬性或方法。

七禾进、rspec斷言

rspec 提供豐富多樣的斷言形式伙菜,滿足我們的大部分需求,下面是其中一部分語(yǔ)法:

1命迈、equal:
expect(actual).to be(expected) # passes if actual.equal?(expected)
expect(actual).to equal(expected) # passes if actual.equal?(expected)
expect(actual).not_to eq(expected) 

2贩绕、比較:
expect(actual).to be > expected
expect(actual).to be >= expected
expect(actual).to be <= expected
expect(actual).to be < expected
expect(actual).to be_within(delta).of(expected)

3、正則表示式:
expect(actual).to match(/expression/)
Note: The new expect syntax no longer supports the=~ matcher.

4壶愤、Types/classes:
expect(actual).to be_an_instance_of(expected) # passes if actual.class == expected
expect(actual).to be_a(expected) # passes if actual.is_a?(expected)
expect(actual).to be_an(expected) # an alias for be_a
expect(actual).to be_a_kind_of(expected) # another alias

5淑倾、真假匹配:
expect(actual).to be_truthy # passes if actual is truthy (not nil or false)
expect(actual).to be true # passes if actual == true
expect(actual).to be_falsy # passes if actual is falsy (nil or false)
expect(actual).to be false # passes if actual == false
expect(actual).to be_nil # passes if actual is nil
expect(actual).to_not be_nil # passes if actual is not nil

6、報(bào)錯(cuò)部分:
expect { ... }.to raise_error
expect { ... }.to raise_error(ErrorClass)
expect { ... }.to raise_error("message")
expect { ... }.to raise_error(ErrorClass, "message")

7征椒、throws:
expect { ... }.to throw_symbol
expect { ... }.to throw_symbol(:symbol)
expect { ... }.to throw_symbol(:symbol, 'value')

8娇哆、謂詞匹配器:
expect(actual).to be_xxx # passes if actual.xxx?expect(actual).to have_xxx(:arg) # passes if actual.has_xxx?(:arg)

9、集合:
expect(actual).to include(expected)
expect(actual).to start_with(expected)
expect(actual).to end_with(expected)
expect(actual).to contain_exactly(individual, items)# …which is the same as:expect(actual).to  match_array( expected_array ) 

例子:
expect([1, 2, 3]).to include(1)
expect([1, 2, 3]).to include(1, 2)
expect([1, 2, 3]).to start_with(1)
expect([1, 2, 3]).to start_with(1, 2)
expect([1, 2, 3]).to end_with(3)
expect([1, 2, 3]).to end_with(2, 3)
expect({:a => 'b'}).to include(:a => 'b')
expect("this string").to include("is str")
expect("this string").to start_with("this")
expect("this string").to end_with("ring")
expect([1, 2, 3]).to contain_exactly(2, 3, 1)
expect([1, 2, 3]).to match_array([3, 2, 1])
八勃救、測(cè)試報(bào)告

執(zhí)行下面的命令生成測(cè)試報(bào)錯(cuò)碍讨,生成的文件在項(xiàng)目根目錄下
rspec --format html --out rspec_test.html
下面是測(cè)試報(bào)告的頁(yè)面:

測(cè)試報(bào)告

九、結(jié)束語(yǔ)

看看這篇文章蒙秒,理解為什么需要測(cè)試勃黍,對(duì)自己的代碼負(fù)責(zé)!
https://chloerei.com/2015/10/26/testing-guide/

人非圣賢孰能無(wú)過晕讲,不同于 C/C++這類編譯型語(yǔ)言覆获,ruby作為解釋型語(yǔ)言马澈,有些語(yǔ)法性的錯(cuò)誤有時(shí)較難發(fā)現(xiàn),測(cè)試能為我們規(guī)避不少這類問題弄息!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末痊班,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子摹量,更是在濱河造成了極大的恐慌涤伐,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,000評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件缨称,死亡現(xiàn)場(chǎng)離奇詭異凝果,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)具钥,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,745評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)液兽,“玉大人骂删,你說(shuō)我怎么就攤上這事∷膯” “怎么了宁玫?”我有些...
    開封第一講書人閱讀 168,561評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)柑晒。 經(jīng)常有香客問我欧瘪,道長(zhǎng),這世上最難降的妖魔是什么匙赞? 我笑而不...
    開封第一講書人閱讀 59,782評(píng)論 1 298
  • 正文 為了忘掉前任佛掖,我火速辦了婚禮,結(jié)果婚禮上涌庭,老公的妹妹穿的比我還像新娘芥被。我一直安慰自己,他們只是感情好坐榆,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,798評(píng)論 6 397
  • 文/花漫 我一把揭開白布拴魄。 她就那樣靜靜地躺著,像睡著了一般席镀。 火紅的嫁衣襯著肌膚如雪匹中。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,394評(píng)論 1 310
  • 那天,我揣著相機(jī)與錄音沃粗,去河邊找鬼友绝。 笑死,一個(gè)胖子當(dāng)著我的面吹牛焊切,可吹牛的內(nèi)容都是我干的扮授。 我是一名探鬼主播,決...
    沈念sama閱讀 40,952評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼专肪,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼刹勃!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起嚎尤,我...
    開封第一講書人閱讀 39,852評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤荔仁,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后芽死,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體乏梁,經(jīng)...
    沈念sama閱讀 46,409評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,483評(píng)論 3 341
  • 正文 我和宋清朗相戀三年关贵,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了遇骑。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,615評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡揖曾,死狀恐怖落萎,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情炭剪,我是刑警寧澤练链,帶...
    沈念sama閱讀 36,303評(píng)論 5 350
  • 正文 年R本政府宣布,位于F島的核電站奴拦,受9級(jí)特大地震影響媒鼓,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜错妖,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,979評(píng)論 3 334
  • 文/蒙蒙 一绿鸣、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧暂氯,春花似錦枚驻、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,470評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至晾剖,卻和暖如春锉矢,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背齿尽。 一陣腳步聲響...
    開封第一講書人閱讀 33,571評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工沽损, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人循头。 一個(gè)月前我還...
    沈念sama閱讀 49,041評(píng)論 3 377
  • 正文 我出身青樓绵估,卻偏偏與公主長(zhǎng)得像炎疆,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子国裳,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,630評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容

  • 這是一個(gè)簡(jiǎn)單的關(guān)于Rails Rspec的簡(jiǎn)單的介紹 1 安裝Rspec 在Rails的配置文件Gemfile配置...
    AQ王浩閱讀 27,015評(píng)論 6 28
  • 加速測(cè)試的方法 這里所說(shuō)的“速度”有兩層含義形入。 其一,當(dāng)然是測(cè)試運(yùn)行所用的時(shí)間缝左。我們這個(gè)小程序的測(cè)試已經(jīng)開始出現(xiàn)慢...
    AQ王浩閱讀 2,531評(píng)論 1 9
  • 簡(jiǎn)單的測(cè)試文件 測(cè)試文件model: *** 在每個(gè)測(cè)試文件的開頭是:require 'rails_helper'...
    天醒了我亮了閱讀 511評(píng)論 0 0
  • 加速測(cè)試的方法 這里所說(shuō)的“速度”有兩層含義亿遂。 其一,當(dāng)然是測(cè)試運(yùn)行所用的時(shí)間渺杉。我們這個(gè)小程序的測(cè)試已經(jīng)開始出現(xiàn)慢...
    AQ王浩閱讀 955評(píng)論 0 1
  • 固件:Rails 默認(rèn)提供了快速生成示例數(shù)據(jù)的工具,叫做“固件”蛇数。固件是一個(gè)yaml格式的文件,可以用來(lái)生成示例數(shù)...
    天醒了我亮了閱讀 482評(píng)論 0 1