1. Mock、Stub勉強会(ruby)
瀬尾直利
2011/05/20

2. アウトライン
MockとStubとは
MockとStubの使い分け
Mock Frameworkの構文比較
More about RR (Double Ruby)

3. MockとStubとは
Test Doubleという概念の一部。
Double とは、代役のことで、テスト用にオブジェクトを
入れ替えるときに一般的に用いられる言葉。
[1] xUnit Test Patterns by Gerard Meszaros
http://xunitpatterns.com/Test%20Double.html

4. Test Doubleの種類
Dummy
受け渡されることはあるが実際に使用されることはない。パラメータリ
ストを埋めたいだけといった場合に利用されることが多い。
Fake
実際に動作するように実装されてはいるが、手抜きされており製品版
には向かない。
Stub
テスト時の呼び出しに対してあらかじめ決められた値を返すもの。
Spy
呼び出しに基づく情報を記録するスタブ。例えば、何通メールが送ら
れたかだけカウントするメールサービスなどが該当する。
Mock
テスト時の呼び出しの仕様を表したもの。期待されない呼び出しが行
なわれた場合は例外をスローできる。期待された呼び出しがすべて行わ
れたか確認できる。

5. Mock サンプルコード on Mocha (1)
# expect a class method
Duck.expects(:quack)
Duck.quack
# => verify success
# expect an instance method of a real object
duck = Duck.new
duck.expects(:quack)
# => verify success
# traditional mocking
duck = mock(’duck’)
duck.expects(:quack)
duck.quack
# => verify success

6. Mock サンプルコード on Mocha (2)
# expect multiple invocations
duck = mock(’duck’)
duck.expects(:quack).times(3)
duck.quack
duck.quack
duck.quack
# => verify success
# specifying parameters and specifying a return value
duck = mock('duck')
duck.expects(:waddle).with(2).returns(3)
duck.waddle(2) # 3
# => verify success
duck.waddle(1) # 3
# => verify failure

7. Stub サンプルコード on Mocha
# return values and exceptions
duck = Duck.new # = mock('duck')
duck.stubs(:flag).returns(true,false).then.raises(BrokenWingError)
duck.flap # => true
duck.flap # => false
duck.flap # => raises BrokenWingError
※ ここでは返り値のテストはしていない。

8. イメージ付きま
した？

9. アウトライン
MockとStubとは
MockとStubの使い分け
Mock Frameworkの構文比較
More about RR (Double Ruby)

10. MockとStubの使い分け
Mock は呼び出しの verification をする。
Stub はそれをしない。
→ で、結局どう使い分ける？
テストの観点の違い[3]
相互作用(振る舞い)中心のテスト → Mock。
状態中心のテスト → Stub。

11. 相互作用中心のテスト
テスト対象のシステムと外部のコンポーネントとの間
で正しいやり取りがされるかのテスト。
いわばプロトコルのテスト。
外部のコンポーネントを Mock で置き換え、システム
が正しい呼び出しをしているかを監視する。
例えば MVC でいう Controller の単体テスト。
Modelが正しく実装された時にControllerが正しく動
作することが、Modelがなくても保証される。

12. 状態中心のテスト
テスト対象のシステムが正しい結果を返すかというテ
スト。
最終的に返ってくる結果だけが重要。
外部のシステムとの統合が面倒な時に Stub を利用
してテストを簡単にする。
入出力の例を Stub を使って記述する。

13. サンプルコード) 振る舞い中心のテスト
left_tire = mock('left_tire')
right_tire = mock('right_tire')
robot = Robot.new(left_tire, right_tire)
left_tire.expects(:move).with(-5)
right_tire.expects(:move).with(+5)
robot.turn_left
# behaviour verification
left_tire.verify
right_tire.verify

14. サンプルコード) 状態中心のテスト
left_tire = mock('left_tire').stub(:move).returns(-5);
right_tire = mock('right_tire').stub(:move).returns(+5);
robot = Robot.new(left_tire, right_tire)
initial_position = robot.position
Initial_direction = robot.direction
robot.turn_left
# state verification
assert_equal initial_position, robot.position
assert robot.direction > initial_direction

15. ここまで
おｋ？

16. アウトライン
Test Double
MockとStubの違い
Mock Frameworkの構文比較
More about RR

17. Mock Frameworkの構文比較
RR
Mocha
Rspec/mocks
Flexmock
の構文を比較してみた[4]。

18. Mock
期待: Userクラスのfindメソッドに引数'99'が渡され、
変数userが返される。
RR
mock(User).find('99') { user }
Mocha
User.expects(:find).with('99').returns(user)
Spec/mocks
User.should_receive(:find).with('99').and_return(user)
Flexmock
flexstub(User).should_receive(:find).with('99').and_return(user).once

19. Stub (1)
期待: Userクラスのfindメソッドに引数‘99’が渡された場合、
user1が、それ以外の場合 user2 が返される。
RR
stub(User).find('99') { user1 }
stub(User).find { user2 }
Mocha
User.stubs(:find).with(anything).returns(user2)
User.stubs(:find).with('99').returns(user1)

20. Stub (2)
期待: Userクラスのfindメソッドに引数‘99’が渡された場合、
user1が、それ以外の場合 user2 が返される。
Spec/mocks
users = {
'99' => user1,
'default' => user2
}
User.stub!(:find).and_return do |id|
users[id] || users['default']
end
Flexmock
users = {
'99' => user1,
'default' => user2
}
flexstub(User).should_receive(:find).and_return do |id|
users[id] || users['default']
end

21. 所感
可読性はMochaやrspec
実際のコードに近いのはRR
短くかけるのはRR
どう？

22. アウトライン
MockとStubとは
MockとStubの使い分け
Mock Frameworkの構文比較
More about RR (Double Ruby)

23. RRの使い方[6]
test/unit
class Test::Unit::TestCase
include RR::Adapters::TestUnit
end
rspec
Spec::Runner.configure do |config|
config.mock_with :rr
# もしくは、バージョンの非互換性で動作しない場合は
# config.mock_with RR::Adapters::Rspec
end
単独使用
require 'rr'
extend RR::Adapters::RRMethods
object = Object.new
mock(object).method_name {:return_value}
object.method_name # :return_value が返ります
RR.verify # ダブルの期待を満たしているかを検証します

24. RRのメソッド
mock もしくは mock!
stub もしくは stub!
dont_allow もしくは dont_allow!
proxy もしくは proxy!
instance_of もしくは instance_of!
! が付いているメソッドは純粋なダブルオブジェクトを作成します。
obj = MyObject.new
mock(obj).hello # 上書き。Partial Mocking
obj = mock! # Pure mock object. Traditional Mocking
obj.hello

25. Mock サンプルコード on RR
どういう意味でしょうか？
意味でしょうか
Q. どういう意味でしょうか？
view = View.new
mock(view).render(:partial => "user_info") {"Information"}
次の方法でモックへ渡される引数をいくつでも許せます。
方法でモックへ渡される引数をいくつでも許せます。
でモックへ 引数をいくつでも
mock(view).render.with_any_args.twice do |*args|
if args.first == {:partial => "user_info}
"User Info"
else
"Stuff in the view #{args.inspect}"
end
end

26. Stub サンプルコード on RR
どういう意味でしょうか？
意味でしょうか
Q. どういう意味でしょうか？
jane = User.new('Jane')
bob = User.new('Bob')
stub(User).find('42') {jane}
stub(User).find('99') {bob}
stub(User).find do |id|
raise "Unexpected id #{id.inspect} passed to me"
end

27. dont_allow サンプルコード
決して呼ばれない期待。呼び出されると例外が発生。
して呼ばれない期待。
期待 されると例外が発生。
例外
dont_allow(User).find('42')
User.find('42') # TimesCalledError 例外が送出されます

28. mock.proxy サンプルコード
返り値を置き換えない mock
class Test
def method_a
“a”
end
end
test = Test.new
mock.proxy(test).method_a # expects once called
puts test.method_a # a
# normal mock
mock(test).method_a # expects once called
puts test.method_a # 空
実際の処理をさせ、
実際の処理をさせ、返り値を受け取り、偽装して返す。
をさせ 偽装して返
して
view = controller.template
mock.proxy(view).render(:partial => "user_info") do |html|
html.should include("John Doe")
"Different html"
end

29. stub.proxy サンプルコード
返り値をインターセプト
view = controller.template
stub.proxy(view).render(:partial => "user_info") do |html|
html.should include("Joe Smith")
html
end

30. instance_of サンプルコード
あるクラスの全てのインスタンスをStubする。
あるクラスの全てのインスタンスを する。
する
mock.instance_of(User).valid? { false }
※ Mocha だと any_instance_of なのでもう少しわかりやすい・・・

31. Spy サンプルコード
メソッド呼
メソッド呼び出しの記録
しの記録
rspec
subject = Object.new
stub(subject).foo
subject.foo(1)
subject.should have_received.foo(1)
subject.should have_received.bar # this fails

32. Double graphs
例) 期待 #foo メソッドが呼び出され、その返り値に対して、
期待: メソッドが呼 され、その返 して、
#bar メソッドが呼び出される。
メソッドが呼 される。
object = Object.new
stub(object).foo.stub!.bar{:baz}
object.foo.bar # success and returns :baz

33. ワイルドカード
anything
mock(object).foobar(1, anything)
object.foobar(1, :my_symbol)
is_a
mock(object).foobar(is_a(Time))
object.foobar(Time.now)
numeric
mock(object).foobar(numeric)
object.foobar(99)
boolean
mock(object).foobar(boolean)
object.foobar(false)
duck_type
mock(object)foobar(duck_type(:walk, :talk))
arg = Object.new
def arg.walk; ‘walk’; end
def arg.talk; ‘talk’; end
object.foobar(arg) # expects arg has methods, walk and talk.

34. ワイルドカード
Ranges
mock(object).foobar(1..10)
object.foobar(5)
Regexps
mock(object).foobar(/on/)
object.foobar(“ruby on rails”)
hash_including
mock(object).foobar(hash_including(:blue => "#0000FF“, :red => "#FF0000"))
object.foobar({:red => "#FF0000", :blue => "#0000FF", :green => "#00FF00"})
satify
mock(object).foobar(satisfy {|arg| arg.length == 2})
object.foobar("xy")
any_times
mock(object).method_name(anything).times(any_times) {return_value}

35. 最後に
実際のコード
を見てみよう！

36. 参考文献
[1] Test Double at XUnitPatterns.com
http://xunitpatterns.com/Test%20Double.html
[2] テストダブル
http://capsctrl.que.jp/kdmsnr/wiki/bliki/?TestDouble
[3] ricollab Web Tech Blog » Blog Archive » Mock と Stub について
http://blogs.ricollab.jp/webtech/2009/09/mock_and_stub/
[4] brian - Introducing RR
http://pivotallabs.com/users/brian/blog/articles/352-
introducing-rr
[5] An Introduction to Mock Objects in Ruby by James Mead
http://jamesmead.org/talks/2007-07-09-introduction-to-mock-
objects-in-ruby-at-lrug/
[6] RR README.doc
https://gist.github.com/330284/fb3fdbf2dd91a800ed83de37b8d
15ea84c3dd2c8